AFSLore/CodeArchitecture.mdwn

   1 -- [[StevenJenkins]] - 08 Jun 2007
   2
   3 This is an entry point into the code architecture. As always, the source for your release is the authoritative reference, but this wiki is designed to help navigate the source and point out relevant documentation.
   4
   5 -- Starting Point --
   6
   7 - <http://www.openafs.org/cgi-bin/cvsweb.cgi/openafs/doc/pdf/> Early architectural documents. Out of date, but still important. You should especially read the Architectural Overview document (archov-doc.pdf)
   8 - <http://www.eyrie.org/~eagle/tmp/openafs/1/rxgen.html> for more rxgen documentation
   9 - To understand the source layout, consult src/SOURCE-MAP -- this is a good place to go after reading the Architectural Overview
  10 - Need to document the build environment issues -- README, README.DEVEL, README.CVS
  11 - src/BUILDNOTES (at least in the 1.4 tree) is not very helpful
  12
  13 -- Source Browsing --
  14
  15 - Getting the source, preferably via CVS
  16
  17 README.CVS has the following line:
  18
  19 Do not use the CVS tree unless you know what you're doing.
  20
  21 This document helps you learn what you're doing.
  22
  23 - cvs co, regen.sh (&amp; when to run regen.sh)
  24
  25 ----
  26
  27 In the source itself ---
  28
  29 - **find | grep** is very helpful. For example, to find all the RX packages (ie, so that you can start to identify the various namespaces of components), you can do:
  30
  31     find . -name \*.xg -exec grep -H "^package" {} \; | grep -v 'example' | grep -v 'bulktest' | \
  32       sed -e 's|^./src/||' | sed -e 's/package/ /' | awk '{printf "%10s   %s\n", $2, $1}'
  33
  34 which results in:
  35
  36         VOTE_   ubik/ubik_int.xg:
  37          DISK_   ubik/ubik_int.xg:
  38        SAMPLE_   ubik/utst_int.xg:
  39            VL_   vlserver/vldbint.xg:
  40        UPDATE_   update/update.xg:
  41          TEST_   rxgk/test.xg:
  42          RXGK_   rxgk/rxgk_proto.xg:
  43       RXAFSCB_   fsint/afscbint.xg:
  44         RXAFS_   fsint/afsint.xg:
  45       RXSTATS_   rxstat/rxstat.xg:
  46            PR_   ptserver/ptint.xg:
  47          BOZO_   bozo/bosint.xg:
  48         BUMON_   bubasics/backmon.xg:
  49            TC_   bubasics/butc.xg:
  50            BC_   bubasics/bumon.xg:
  51           ADK_   dauth/adkint.xg:
  52        RMTSYS_   sys/rmtsys.xg:
  53         AFSVol   volser/volint.xg:
  54
  55 In other words, if something starts with BOZO\_, you know that it is generated by rxgen, and the interface is defined in `bozo/bosint.xg`.
  56
  57 In addition to the package name, also note that only rxstat uses an M prefix; all others use S.
  58
  59 - cscope: a source code browser, linked to your editor. Setup is simple: cd to your source tree and run:
  60
  61     find . -name \*.[ch] > namelist
  62     cscope -R -b
  63
  64 Then run
  65
  66     cscope -d
  67
  68 to start. The interface is simple. I tend to use it for finding things, but not necessarily for editing. When I'm studying the source, trying to understand how components link together, or bug-hunting, I tend to live inside `cscope`.
  69
  70 - doxygen: what it is, how to set up, how to use, how to make even more useful (ie, src code changes)
  71
  72 - gdb: examples of using (primarily b, bt)