HACKING 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537
  1. Hacking Tor: An Incomplete Guide
  2. ================================
  3. Getting started
  4. ---------------
  5. For full information on how Tor is supposed to work, look at the files in
  6. https://gitweb.torproject.org/torspec.git/tree
  7. For an explanation of how to change Tor's design to work differently, look at
  8. https://gitweb.torproject.org/torspec.git/blob_plain/HEAD:/proposals/001-process.txt
  9. For the latest version of the code, get a copy of git, and
  10. git clone https://git.torproject.org/git/tor
  11. We talk about Tor on the tor-talk mailing list. Design proposals and
  12. discussion belong on the tor-dev mailing list. We hang around on
  13. irc.oftc.net, with general discussion happening on #tor and development
  14. happening on #tor-dev.
  15. How we use Git branches
  16. -----------------------
  17. Each main development series (like 0.2.1, 0.2.2, etc) has its main work
  18. applied to a single branch. At most one series can be the development series
  19. at a time; all other series are maintenance series that get bug-fixes only.
  20. The development series is built in a git branch called "master"; the
  21. maintenance series are built in branches called "maint-0.2.0", "maint-0.2.1",
  22. and so on. We regularly merge the active maint branches forward.
  23. For all series except the development series, we also have a "release" branch
  24. (as in "release-0.2.1"). The release series is based on the corresponding
  25. maintenance series, except that it deliberately lags the maint series for
  26. most of its patches, so that bugfix patches are not typically included in a
  27. maintenance release until they've been tested for a while in a development
  28. release. Occasionally, we'll merge an urgent bugfix into the release branch
  29. before it gets merged into maint, but that's rare.
  30. If you're working on a bugfix for a bug that occurs in a particular version,
  31. base your bugfix branch on the "maint" branch for the first supported series
  32. that has that bug. (As of June 2013, we're supporting 0.2.3 and later.) If
  33. you're working on a new feature, base it on the master branch.
  34. How we log changes
  35. ------------------
  36. When you do a commit that needs a ChangeLog entry, add a new file to
  37. the "changes" toplevel subdirectory. It should have the format of a
  38. one-entry changelog section from the current ChangeLog file, as in
  39. o Major bugfixes:
  40. - Fix a potential buffer overflow. Fixes bug 99999; bugfix on
  41. 0.3.1.4-beta.
  42. To write a changes file, first categorize the change. Some common categories
  43. are: Minor bugfixes, Major bugfixes, Minor features, Major features, Code
  44. simplifications and refactoring. Then say what the change does. If
  45. it's a bugfix, mention what bug it fixes and when the bug was
  46. introduced. To find out which Git tag the change was introduced in,
  47. you can use "git describe --contains <sha1 of commit>".
  48. If at all possible, try to create this file in the same commit where
  49. you are making the change. Please give it a distinctive name that no
  50. other branch will use for the lifetime of your change.
  51. When we go to make a release, we will concatenate all the entries
  52. in changes to make a draft changelog, and clear the directory. We'll
  53. then edit the draft changelog into a nice readable format.
  54. What needs a changes file?::
  55. A not-exhaustive list: Anything that might change user-visible
  56. behavior. Anything that changes internals, documentation, or the build
  57. system enough that somebody could notice. Big or interesting code
  58. rewrites. Anything about which somebody might plausibly wonder "when
  59. did that happen, and/or why did we do that" 6 months down the line.
  60. Why use changes files instead of Git commit messages?::
  61. Git commit messages are written for developers, not users, and they
  62. are nigh-impossible to revise after the fact.
  63. Why use changes files instead of entries in the ChangeLog?::
  64. Having every single commit touch the ChangeLog file tended to create
  65. zillions of merge conflicts.
  66. Useful tools
  67. ------------
  68. These aren't strictly necessary for hacking on Tor, but they can help track
  69. down bugs.
  70. Jenkins
  71. ~~~~~~~
  72. https://jenkins.torproject.org
  73. Dmalloc
  74. ~~~~~~~
  75. The dmalloc library will keep track of memory allocation, so you can find out
  76. if we're leaking memory, doing any double-frees, or so on.
  77. dmalloc -l ~/dmalloc.log
  78. (run the commands it tells you)
  79. ./configure --with-dmalloc
  80. Valgrind
  81. ~~~~~~~~
  82. valgrind --leak-check=yes --error-limit=no --show-reachable=yes src/or/tor
  83. (Note that if you get a zillion openssl warnings, you will also need to
  84. pass --undef-value-errors=no to valgrind, or rebuild your openssl
  85. with -DPURIFY.)
  86. Running gcov for unit test coverage
  87. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  88. -----
  89. ./configure --enable-coverage
  90. make
  91. make check
  92. mkdir coverage-output
  93. ./contrib/coverage coverage-output
  94. -----
  95. (On OSX, you'll need to start with "--enable-coverage CC=clang".)
  96. Then, look at the .gcov files in coverage-output. '-' before a line means
  97. that the compiler generated no code for that line. '######' means that the
  98. line was never reached. Lines with numbers were called that number of times.
  99. If that doesn't work:
  100. * Try configuring Tor with --disable-gcc-hardening
  101. * You might need to run 'make clean' after you run './configure'.
  102. If you make changes to Tor and want to get another set of coverage results,
  103. you can run "make reset-gcov" to clear the intermediary gcov output.
  104. If you have two different "coverage-output" directories, and you want to see
  105. a meaningful diff between them, you can run:
  106. -----
  107. ./contrib/cov-diff coverage-output1 coverage-output2 | less
  108. -----
  109. In this diff, any lines that were visited at least once will have coverage
  110. "1". This lets you inspect what you (probably) really want to know: which
  111. untested lines were changed? Are there any new untested lines?
  112. Running integration tests
  113. ~~~~~~~~~~~~~~~~~~~~~~~~~
  114. We have the beginnings of a set of scripts to run integration tests using
  115. Chutney. To try them, set CHUTNEY_PATH to your chutney source directory, and
  116. run "make test-network".
  117. Profiling Tor with oprofile
  118. ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  119. The oprofile tool runs (on Linux only!) to tell you what functions Tor is
  120. spending its CPU time in, so we can identify berformance pottlenecks.
  121. Here are some basic instructions
  122. - Build tor with debugging symbols (you probably already have, unless
  123. you messed with CFLAGS during the build process).
  124. - Build all the libraries you care about with debugging symbols
  125. (probably you only care about libssl, maybe zlib and Libevent).
  126. - Copy this tor to a new directory
  127. - Copy all the libraries it uses to that dir too (ldd ./tor will
  128. tell you)
  129. - Set LD_LIBRARY_PATH to include that dir. ldd ./tor should now
  130. show you it's using the libs in that dir
  131. - Run that tor
  132. - Reset oprofiles counters/start it
  133. * "opcontrol --reset; opcontrol --start", if Nick remembers right.
  134. - After a while, have it dump the stats on tor and all the libs
  135. in that dir you created.
  136. * "opcontrol --dump;"
  137. * "opreport -l that_dir/*"
  138. - Profit
  139. Coding conventions
  140. ------------------
  141. Patch checklist
  142. ~~~~~~~~~~~~~~~
  143. If possible, send your patch as one of these (in descending order of
  144. preference)
  145. - A git branch we can pull from
  146. - Patches generated by git format-patch
  147. - A unified diff
  148. Did you remember...
  149. - To build your code while configured with --enable-gcc-warnings?
  150. - To run "make check-spaces" on your code?
  151. - To run "make check-docs" to see whether all new options are on
  152. the manpage?
  153. - To write unit tests, as possible?
  154. - To base your code on the appropriate branch?
  155. - To include a file in the "changes" directory as appropriate?
  156. Whitespace and C conformance
  157. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  158. Invoke "make check-spaces" from time to time, so it can tell you about
  159. deviations from our C whitespace style. Generally, we use:
  160. - Unix-style line endings
  161. - K&R-style indentation
  162. - No space before newlines
  163. - A blank line at the end of each file
  164. - Never more than one blank line in a row
  165. - Always spaces, never tabs
  166. - No more than 79-columns per line.
  167. - Two spaces per indent.
  168. - A space between control keywords and their corresponding paren
  169. "if (x)", "while (x)", and "switch (x)", never "if(x)", "while(x)", or
  170. "switch(x)".
  171. - A space between anything and an open brace.
  172. - No space between a function name and an opening paren. "puts(x)", not
  173. "puts (x)".
  174. - Function declarations at the start of the line.
  175. We try hard to build without warnings everywhere. In particular, if you're
  176. using gcc, you should invoke the configure script with the option
  177. "--enable-gcc-warnings". This will give a bunch of extra warning flags to
  178. the compiler, and help us find divergences from our preferred C style.
  179. Getting emacs to edit Tor source properly
  180. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  181. Nick likes to put the following snippet in his .emacs file:
  182. -----
  183. (add-hook 'c-mode-hook
  184. (lambda ()
  185. (font-lock-mode 1)
  186. (set-variable 'show-trailing-whitespace t)
  187. (let ((fname (expand-file-name (buffer-file-name))))
  188. (cond
  189. ((string-match "^/home/nickm/src/libevent" fname)
  190. (set-variable 'indent-tabs-mode t)
  191. (set-variable 'c-basic-offset 4)
  192. (set-variable 'tab-width 4))
  193. ((string-match "^/home/nickm/src/tor" fname)
  194. (set-variable 'indent-tabs-mode nil)
  195. (set-variable 'c-basic-offset 2))
  196. ((string-match "^/home/nickm/src/openssl" fname)
  197. (set-variable 'indent-tabs-mode t)
  198. (set-variable 'c-basic-offset 8)
  199. (set-variable 'tab-width 8))
  200. ))))
  201. -----
  202. You'll note that it defaults to showing all trailing whitespace. The "cond"
  203. test detects whether the file is one of a few C free software projects that I
  204. often edit, and sets up the indentation level and tab preferences to match
  205. what they want.
  206. If you want to try this out, you'll need to change the filename regex
  207. patterns to match where you keep your Tor files.
  208. If you use emacs for editing Tor and nothing else, you could always just say:
  209. -----
  210. (add-hook 'c-mode-hook
  211. (lambda ()
  212. (font-lock-mode 1)
  213. (set-variable 'show-trailing-whitespace t)
  214. (set-variable 'indent-tabs-mode nil)
  215. (set-variable 'c-basic-offset 2)))
  216. -----
  217. There is probably a better way to do this. No, we are probably not going
  218. to clutter the files with emacs stuff.
  219. Functions to use
  220. ~~~~~~~~~~~~~~~~
  221. We have some wrapper functions like tor_malloc, tor_free, tor_strdup, and
  222. tor_gettimeofday; use them instead of their generic equivalents. (They
  223. always succeed or exit.)
  224. You can get a full list of the compatibility functions that Tor provides by
  225. looking through src/common/util.h and src/common/compat.h. You can see the
  226. available containers in src/common/containers.h. You should probably
  227. familiarize yourself with these modules before you write too much code, or
  228. else you'll wind up reinventing the wheel.
  229. Use 'INLINE' instead of 'inline', so that we work properly on Windows.
  230. Calling and naming conventions
  231. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  232. Whenever possible, functions should return -1 on error and 0 on success.
  233. For multi-word identifiers, use lowercase words combined with
  234. underscores. (e.g., "multi_word_identifier"). Use ALL_CAPS for macros and
  235. constants.
  236. Typenames should end with "_t".
  237. Function names should be prefixed with a module name or object name. (In
  238. general, code to manipulate an object should be a module with the same name
  239. as the object, so it's hard to tell which convention is used.)
  240. Functions that do things should have imperative-verb names
  241. (e.g. buffer_clear, buffer_resize); functions that return booleans should
  242. have predicate names (e.g. buffer_is_empty, buffer_needs_resizing).
  243. If you find that you have four or more possible return code values, it's
  244. probably time to create an enum. If you find that you are passing three or
  245. more flags to a function, it's probably time to create a flags argument that
  246. takes a bitfield.
  247. What To Optimize
  248. ~~~~~~~~~~~~~~~~
  249. Don't optimize anything if it's not in the critical path. Right now, the
  250. critical path seems to be AES, logging, and the network itself. Feel free to
  251. do your own profiling to determine otherwise.
  252. Log conventions
  253. ~~~~~~~~~~~~~~~
  254. https://trac.torproject.org/projects/tor/wiki/doc/TorFAQ#loglevel
  255. No error or warning messages should be expected during normal OR or OP
  256. operation.
  257. If a library function is currently called such that failure always means ERR,
  258. then the library function should log WARN and let the caller log ERR.
  259. Every message of severity INFO or higher should either (A) be intelligible
  260. to end-users who don't know the Tor source; or (B) somehow inform the
  261. end-users that they aren't expected to understand the message (perhaps
  262. with a string like "internal error"). Option (A) is to be preferred to
  263. option (B).
  264. Doxygen
  265. ~~~~~~~~
  266. We use the 'doxygen' utility to generate documentation from our
  267. source code. Here's how to use it:
  268. 1. Begin every file that should be documented with
  269. /**
  270. * \file filename.c
  271. * \brief Short description of the file.
  272. **/
  273. (Doxygen will recognize any comment beginning with /** as special.)
  274. 2. Before any function, structure, #define, or variable you want to
  275. document, add a comment of the form:
  276. /** Describe the function's actions in imperative sentences.
  277. *
  278. * Use blank lines for paragraph breaks
  279. * - and
  280. * - hyphens
  281. * - for
  282. * - lists.
  283. *
  284. * Write <b>argument_names</b> in boldface.
  285. *
  286. * \code
  287. * place_example_code();
  288. * between_code_and_endcode_commands();
  289. * \endcode
  290. */
  291. 3. Make sure to escape the characters "<", ">", "\", "%" and "#" as "\<",
  292. "\>", "\\", "\%", and "\#".
  293. 4. To document structure members, you can use two forms:
  294. struct foo {
  295. /** You can put the comment before an element; */
  296. int a;
  297. int b; /**< Or use the less-than symbol to put the comment
  298. * after the element. */
  299. };
  300. 5. To generate documentation from the Tor source code, type:
  301. $ doxygen -g
  302. To generate a file called 'Doxyfile'. Edit that file and run
  303. 'doxygen' to generate the API documentation.
  304. 6. See the Doxygen manual for more information; this summary just
  305. scratches the surface.
  306. Doxygen comment conventions
  307. ^^^^^^^^^^^^^^^^^^^^^^^^^^^
  308. Say what functions do as a series of one or more imperative sentences, as
  309. though you were telling somebody how to be the function. In other words, DO
  310. NOT say:
  311. /** The strtol function parses a number.
  312. *
  313. * nptr -- the string to parse. It can include whitespace.
  314. * endptr -- a string pointer to hold the first thing that is not part
  315. * of the number, if present.
  316. * base -- the numeric base.
  317. * returns: the resulting number.
  318. */
  319. long strtol(const char *nptr, char **nptr, int base);
  320. Instead, please DO say:
  321. /** Parse a number in radix <b>base</b> from the string <b>nptr</b>,
  322. * and return the result. Skip all leading whitespace. If
  323. * <b>endptr</b> is not NULL, set *<b>endptr</b> to the first character
  324. * after the number parsed.
  325. **/
  326. long strtol(const char *nptr, char **nptr, int base);
  327. Doxygen comments are the contract in our abstraction-by-contract world: if
  328. the functions that call your function rely on it doing something, then your
  329. function should mention that it does that something in the documentation. If
  330. you rely on a function doing something beyond what is in its documentation,
  331. then you should watch out, or it might do something else later.
  332. Putting out a new release
  333. -------------------------
  334. Here are the steps Roger takes when putting out a new Tor release:
  335. 1) Use it for a while, as a client, as a relay, as a hidden service,
  336. and as a directory authority. See if it has any obvious bugs, and
  337. resolve those.
  338. 1.5) As applicable, merge the maint-X branch into the release-X branch.
  339. 2) Gather the changes/* files into a changelog entry, rewriting many
  340. of them and reordering to focus on what users and funders would find
  341. interesting and understandable.
  342. 2.1) Make sure that everything that wants a bug number has one.
  343. 2.2) Concatenate them.
  344. 2.3) Sort them by section. Within each section, try to make the
  345. first entry or two and the last entry most interesting: they're
  346. the ones that skimmers tend to read.
  347. 2.4) Clean them up:
  348. Standard idioms:
  349. "Fixes bug 9999; bugfix on 0.3.3.3-alpha."
  350. One period after a space.
  351. Make stuff very terse
  352. Make sure each section name ends with a colon
  353. Describe the user-visible problem right away
  354. Mention relevant config options by name. If they're rare or unusual,
  355. remind people what they're for
  356. Avoid starting lines with open-paren
  357. Present and imperative tense: not past.
  358. Try not to let any given section be longer than about a page. Break up
  359. long sections into subsections by some sort of common subtopic. This
  360. guideline is especially important when organizing Release Notes for
  361. new stable releases.
  362. If a given changes stanza showed up in a different release (e.g.
  363. maint-0.2.1), be sure to make the stanzas identical (so people can
  364. distinguish if these are the same change).
  365. 2.5) Merge them in.
  366. 2.6) Clean everything one last time.
  367. 2.7) Run it through fmt to make it pretty.
  368. 3) Compose a short release blurb to highlight the user-facing
  369. changes. Insert said release blurb into the ChangeLog stanza. If it's
  370. a stable release, add it to the ReleaseNotes file too. If we're adding
  371. to a release-0.2.x branch, manually commit the changelogs to the later
  372. git branches too.
  373. 4) Bump the version number in configure.ac and rebuild.
  374. 5) Make dist, put the tarball up somewhere, and tell #tor about it. Wait
  375. a while to see if anybody has problems building it. Try to get Sebastian
  376. or somebody to try building it on Windows.
  377. 6) Get at least two of weasel/arma/sebastian to put the new version number
  378. in their approved versions list.
  379. 7) Sign the tarball, then sign and push the git tag:
  380. gpg -ba <the_tarball>
  381. git tag -u <keyid> tor-0.2.x.y-status
  382. git push origin tag tor-0.2.x.y-status
  383. 8) scp the tarball and its sig to the website in the dist/ directory
  384. (i.e. /srv/www-master.torproject.org/htdocs/dist/ on vescum). Edit
  385. "include/versions.wmi" and "Makefile" to note the new version. From your
  386. website checkout, run ./publish to build and publish the website.
  387. 9) Email Erinn and weasel (cc'ing tor-assistants) that a new tarball
  388. is up. This step should probably change to mailing more packagers.
  389. 10) Add the version number to Trac. To do this, go to Trac, log in,
  390. select "Admin" near the top of the screen, then select "Versions" from
  391. the menu on the left. At the right, there will be an "Add version"
  392. box. By convention, we enter the version in the form "Tor:
  393. 0.2.2.23-alpha" (or whatever the version is), and we select the date as
  394. the date in the ChangeLog.
  395. 11) Forward-port the ChangeLog.
  396. 12) Update the topic in #tor to reflect the new version.
  397. 12) Wait up to a day or two (for a development release), or until most
  398. packages are up (for a stable release), and mail the release blurb and
  399. changelog to tor-talk or tor-announce.
  400. (We might be moving to faster announcements, but don't announce until
  401. the website is at least updated.)