AFSLore/CodingStyle.mdwn

   1 # <a name="OpenAFS Coding Style"></a> [[OpenAFS]] Coding Style
   2
   3 This document is an attempt to codify a coding style for [[OpenAFS]]. It's currently the opinions of the author, however. Not all of this is current practice for the tree. If you would like information about our style, as currently used, see README.DEVEL
   4
   5 **Note for commentors**: Please feel free to update this guide with your views. However, if you disagree with the content, rather than deleting it, please add your suggested ammendments alongside - that way we can hopefully produce a consensus document.
   6
   7 ## <a name="Comments"></a> Comments
   8
   9 C++ style comments ( ones beginning //) should be avoided in cross-platform C code
  10
  11 Single line comments:
  12
  13     /* This is a one line comment about something or other */
  14
  15 Mutli line comments should be structured as
  16
  17     /*
  18      * A multi line comment, which should be written as real sentences,
  19      * and continue to have a leading star if they span multiple lines
  20      */
  21
  22 Where comments are documenting the behaviour of a piece of code, they should be written in Doxygen. We have adopted the Qt format of that style.
  23
  24     /*!
  25      * A function to compute the cost of everything
  26      *
  27      * \param currency The currency to perform the calculation in
  28      * \param fudge A fudge factor to apply
  29      */
  30
  31 Many more options are possible for doxygen. See their documentation for details.
  32
  33 ## <a name="Include files"></a> Include files
  34
  35 All C files should start by including
  36
  37     #include <afsconfig.h>
  38     #include <afs/param.h>
  39
  40 Following this, all of the necessary system includes should be listed. The following headers may be included without guards
  41
  42 - ctype.h
  43 - errno.h
  44 - stdarg.h
  45 - stddef.h
  46 - stdio.h
  47 - stdlib.h
  48 - string.h
  49 - sys/types.h
  50 - sys/stat.h
  51 - time.h
  52 - fcntl.h
  53
  54 The following headers may be included for all Unix platforms, but must be protected by #ifndef AFS\_NT40\_ENV
  55
  56 - syslog.h
  57 - sys/param.h
  58 - sys/time.h
  59 - sys/file.h
  60 - sys/ioctl.h
  61 - sys/socket.h
  62 - sys/uio.h
  63 - netinet/in.h
  64 - arpa/inet.h
  65 - netdb.h
  66 - unistd.h
  67
  68 netinet/in.h should be included before arpa/inet.h
  69
  70 All other system headers should be protected, either by autoconf checks, or by the relevant platform definitions
  71
  72 Next, should come all of the AFS headers from the src/include/ directoy. Do not reference headers which occur within other packages by using relative paths - use only the public interfaces in src/include/. Public headers should be referenced using the &lt;&gt; notation.
  73
  74 Finally come the header files from this module, which should be referenced using " ".
  75
  76 ## <a name="Preprocessor directives"></a> Preprocessor directives
  77
  78 Where #if statements are nested, attempt to keep that nesting to a minimum. For example, do
  79
  80     #if defined(FOO)
  81     #elif defined(BAR)
  82     #elif defined(BLOB)
  83     #endif
  84
  85 not
  86
  87     #if defined(FOO)
  88     #else
  89     # if defined(BAR)
  90     # else
  91     #  if defined(BLOB)
  92     #  endif /* BLOB */
  93     # endif /* BAR */
  94     #endif /* FOO */
  95
  96 Where nested #ifs are unavoidable, please indent all preprocessor directives inside the #if or #ifdef by adding on space after the # and before the directive name per nesting level, and annotate #endifs to indicate the statement they refer to.
  97
  98 ## <a name="Functions"></a> Functions
  99
 100 Functions should be written with the type information on the first line, followed by the function name on the next, followed by the parameter list, in ANSI C format. Function names are typically StudlyCaps, but the code isn't currently consistent in this regard. Functions which are not being used outside of the source file they are in should be declared static, and prototyped at the start of that file.
 101
 102 For example:
 103
 104     static int
 105     ValueOfNothing(afs_int32 nothing) {  ... }
 106
 107 Prototypes for functions which are shared within a module should go into the a header file named _module_ \_internal.h
 108
 109 Prototypes for public functions should go either into _module_ \_prototypes.h_ or module_.h
 110
 111 Public functions should be prefixed with the name of the module they are in. For example
 112
 113     witty_CostOfEverything(...)
 114
 115 Prototypes should not have variable names included within them.
 116
 117 ## <a name="Headers"></a> Headers
 118
 119 Header files should be protected against multiple inclusion. Use
 120
 121     #ifndef AFS_SRC_MODULE_FILENAME_H
 122     #define AFS_SRC_MODULE_FILENAME_H
 123
 124     #endif
 125
 126 All routines should have a return type specified, void if nothing returned, and should have (void) if no arguments are taken.
 127
 128 Header files should not contain macros or other definitions unless they are used across multiple source files.
 129
 130 ## <a name="Formatting"></a> Formatting
 131
 132 - Indentation is in 4 character spaces, with 8 characters being replaced by a tab.
 133 - Always use spaces around operators (+, -, &gt;, &lt;, &amp;&amp;, || and so on)
 134 - Don't put a space between the function name and the opening parentheses of its arguments
 135 - Always put a space after, but not before a comma in an argument list
 136 - Always put a space after a conditional statement (if, while, for, etc) and the opening parentheses, and a space between the ) and the \{
 137 - Use braces where it aids readability.
 138 - Closing and opening braces go on the same line as the control statement
 139
 140     if (foo) {
 141     ...
 142     } else {
 143     ...
 144     }
 145
 146 - Code surrounded by brackets should have its continuation lines lined up with the relevant opening brace
 147
 148     value = CostOfEverything(ValueOfNothing(0),
 149                              fudge);
 150
 151 - Loops with an empty body should have their trailing semicolon on the following line, to make the empty body explicit, and suppress a compiler warning
 152
 153     for (...; ...; ...)
 154         ;
 155
 156 - Lines should be wrapped within 80 characters
 157
 158 ## <a name="Warnings"></a> Warnings
 159
 160 All new code must compile cleanly when configured with --enable-warnings
 161
 162 ## <a name="Build system"></a> Build system
 163
 164 - Do not use $&lt; for non-pattern rules in any cross-platform directory
 165 - Do not have build rules that build multiple targets
 166 - Ensure that make clean really does
 167 - Add new header files as dependencies for files that consume them
 168 - Test parallel makes after any build system changes
 169 - Test out-of-tree builds after any build system changes
 170
 171 ## <a name="Coding practices"></a> Coding practices
 172
 173 - Try to use inline functions, rather than casts, when converting from one type to another, except when removing const
 174 - Use inline functions, rather than macros wherever possible (as they preserve type checking)
 175 - Only use if (var) when var is a boolean. Use if (p != NULL) instead of if (p), and if (\*p!='\\0') rather than if (\*p)
 176 - Don't use unsafe string functions. No new code should be using strcpy, or strcat. Use strlcpy, strlcat, or afs\_snprintf() as appropriate.
 177 - if (!strcmp(foo,bar)) is really hard to read. Use if (strcmp(foo,bar) == 0) instead
 178 - Don't use strncpy unless you explicitly need the special strncpy semantics, and if you don't know what those are, never use it. Use strlcpy or memcpy instead.
 179 - Always use size\_t for sizes of objects, not int or unsigned long, even if they're small objects. Exception: wire protocol objects should instead use types with explicit sizes, such as afs\_int32.
 180 - Always use either size\_t or ptrdiff\_t for offsets into data structures or memory blocks, not int or long.
 181 - All new APIs that take buffers should also take the length of the buffer as an additional parameter.
 182 - Where possible, move assignments outside of conditionals. In general, write code = function(); if (code = 0) not if ((code = function()) = 0).
 183 - Don't write new functions which take arrays as arguments
 184
 185 ## <a name="Unix kernel module"></a> Unix kernel module
 186
 187 - The kernel module has a documented lock hierarchy in src/afs/DOC/afs\_rwlocks
 188 - All calls to obtain a write lock have a unique reference number. This must be unique across the cache manager (lock numbers that are in a particular OS directory may be shared, but only between OS directories), and src/afs/lock.h must be updated with the highest number in use
 189 - New locks should be registered in the list in afs\_callback.c, so their contents can be viewed via cmdebug
 190
 191 -- [[SimonWilkinson]] - 27 Jul 2009