Documentation: fix the explanation of Kconfig files
[linux-2.6.git] / Documentation / CodingStyle
1
2                 Linux kernel coding style
3
4 This is a short document describing the preferred coding style for the
5 linux kernel.  Coding style is very personal, and I won't _force_ my
6 views on anybody, but this is what goes for anything that I have to be
7 able to maintain, and I'd prefer it for most other things too.  Please
8 at least consider the points made here.
9
10 First off, I'd suggest printing out a copy of the GNU coding standards,
11 and NOT read it.  Burn them, it's a great symbolic gesture.
12
13 Anyway, here goes:
14
15
16                 Chapter 1: Indentation
17
18 Tabs are 8 characters, and thus indentations are also 8 characters.
19 There are heretic movements that try to make indentations 4 (or even 2!)
20 characters deep, and that is akin to trying to define the value of PI to
21 be 3.
22
23 Rationale: The whole idea behind indentation is to clearly define where
24 a block of control starts and ends.  Especially when you've been looking
25 at your screen for 20 straight hours, you'll find it a lot easier to see
26 how the indentation works if you have large indentations.
27
28 Now, some people will claim that having 8-character indentations makes
29 the code move too far to the right, and makes it hard to read on a
30 80-character terminal screen.  The answer to that is that if you need
31 more than 3 levels of indentation, you're screwed anyway, and should fix
32 your program.
33
34 In short, 8-char indents make things easier to read, and have the added
35 benefit of warning you when you're nesting your functions too deep.
36 Heed that warning.
37
38 The preferred way to ease multiple indentation levels in a switch statement is
39 to align the "switch" and its subordinate "case" labels in the same column
40 instead of "double-indenting" the "case" labels.  E.g.:
41
42         switch (suffix) {
43         case 'G':
44         case 'g':
45                 mem <<= 30;
46                 break;
47         case 'M':
48         case 'm':
49                 mem <<= 20;
50                 break;
51         case 'K':
52         case 'k':
53                 mem <<= 10;
54                 /* fall through */
55         default:
56                 break;
57         }
58
59
60 Don't put multiple statements on a single line unless you have
61 something to hide:
62
63         if (condition) do_this;
64           do_something_everytime;
65
66 Don't put multiple assignments on a single line either.  Kernel coding style
67 is super simple.  Avoid tricky expressions.
68
69 Outside of comments, documentation and except in Kconfig, spaces are never
70 used for indentation, and the above example is deliberately broken.
71
72 Get a decent editor and don't leave whitespace at the end of lines.
73
74
75                 Chapter 2: Breaking long lines and strings
76
77 Coding style is all about readability and maintainability using commonly
78 available tools.
79
80 The limit on the length of lines is 80 columns and this is a hard limit.
81
82 Statements longer than 80 columns will be broken into sensible chunks.
83 Descendants are always substantially shorter than the parent and are placed
84 substantially to the right. The same applies to function headers with a long
85 argument list. Long strings are as well broken into shorter strings.
86
87 void fun(int a, int b, int c)
88 {
89         if (condition)
90                 printk(KERN_WARNING "Warning this is a long printk with "
91                                                 "3 parameters a: %u b: %u "
92                                                 "c: %u \n", a, b, c);
93         else
94                 next_statement;
95 }
96
97                 Chapter 3: Placing Braces and Spaces
98
99 The other issue that always comes up in C styling is the placement of
100 braces.  Unlike the indent size, there are few technical reasons to
101 choose one placement strategy over the other, but the preferred way, as
102 shown to us by the prophets Kernighan and Ritchie, is to put the opening
103 brace last on the line, and put the closing brace first, thusly:
104
105         if (x is true) {
106                 we do y
107         }
108
109 This applies to all non-function statement blocks (if, switch, for,
110 while, do).  E.g.:
111
112         switch (action) {
113         case KOBJ_ADD:
114                 return "add";
115         case KOBJ_REMOVE:
116                 return "remove";
117         case KOBJ_CHANGE:
118                 return "change";
119         default:
120                 return NULL;
121         }
122
123 However, there is one special case, namely functions: they have the
124 opening brace at the beginning of the next line, thus:
125
126         int function(int x)
127         {
128                 body of function
129         }
130
131 Heretic people all over the world have claimed that this inconsistency
132 is ...  well ...  inconsistent, but all right-thinking people know that
133 (a) K&R are _right_ and (b) K&R are right.  Besides, functions are
134 special anyway (you can't nest them in C).
135
136 Note that the closing brace is empty on a line of its own, _except_ in
137 the cases where it is followed by a continuation of the same statement,
138 ie a "while" in a do-statement or an "else" in an if-statement, like
139 this:
140
141         do {
142                 body of do-loop
143         } while (condition);
144
145 and
146
147         if (x == y) {
148                 ..
149         } else if (x > y) {
150                 ...
151         } else {
152                 ....
153         }
154
155 Rationale: K&R.
156
157 Also, note that this brace-placement also minimizes the number of empty
158 (or almost empty) lines, without any loss of readability.  Thus, as the
159 supply of new-lines on your screen is not a renewable resource (think
160 25-line terminal screens here), you have more empty lines to put
161 comments on.
162
163 Do not unnecessarily use braces where a single statement will do.
164
165 if (condition)
166         action();
167
168 This does not apply if one branch of a conditional statement is a single
169 statement. Use braces in both branches.
170
171 if (condition) {
172         do_this();
173         do_that();
174 } else {
175         otherwise();
176 }
177
178                 3.1:  Spaces
179
180 Linux kernel style for use of spaces depends (mostly) on
181 function-versus-keyword usage.  Use a space after (most) keywords.  The
182 notable exceptions are sizeof, typeof, alignof, and __attribute__, which look
183 somewhat like functions (and are usually used with parentheses in Linux,
184 although they are not required in the language, as in: "sizeof info" after
185 "struct fileinfo info;" is declared).
186
187 So use a space after these keywords:
188         if, switch, case, for, do, while
189 but not with sizeof, typeof, alignof, or __attribute__.  E.g.,
190         s = sizeof(struct file);
191
192 Do not add spaces around (inside) parenthesized expressions.  This example is
193 *bad*:
194
195         s = sizeof( struct file );
196
197 When declaring pointer data or a function that returns a pointer type, the
198 preferred use of '*' is adjacent to the data name or function name and not
199 adjacent to the type name.  Examples:
200
201         char *linux_banner;
202         unsigned long long memparse(char *ptr, char **retptr);
203         char *match_strdup(substring_t *s);
204
205 Use one space around (on each side of) most binary and ternary operators,
206 such as any of these:
207
208         =  +  -  <  >  *  /  %  |  &  ^  <=  >=  ==  !=  ?  :
209
210 but no space after unary operators:
211         &  *  +  -  ~  !  sizeof  typeof  alignof  __attribute__  defined
212
213 no space before the postfix increment & decrement unary operators:
214         ++  --
215
216 no space after the prefix increment & decrement unary operators:
217         ++  --
218
219 and no space around the '.' and "->" structure member operators.
220
221
222                 Chapter 4: Naming
223
224 C is a Spartan language, and so should your naming be.  Unlike Modula-2
225 and Pascal programmers, C programmers do not use cute names like
226 ThisVariableIsATemporaryCounter.  A C programmer would call that
227 variable "tmp", which is much easier to write, and not the least more
228 difficult to understand.
229
230 HOWEVER, while mixed-case names are frowned upon, descriptive names for
231 global variables are a must.  To call a global function "foo" is a
232 shooting offense.
233
234 GLOBAL variables (to be used only if you _really_ need them) need to
235 have descriptive names, as do global functions.  If you have a function
236 that counts the number of active users, you should call that
237 "count_active_users()" or similar, you should _not_ call it "cntusr()".
238
239 Encoding the type of a function into the name (so-called Hungarian
240 notation) is brain damaged - the compiler knows the types anyway and can
241 check those, and it only confuses the programmer.  No wonder MicroSoft
242 makes buggy programs.
243
244 LOCAL variable names should be short, and to the point.  If you have
245 some random integer loop counter, it should probably be called "i".
246 Calling it "loop_counter" is non-productive, if there is no chance of it
247 being mis-understood.  Similarly, "tmp" can be just about any type of
248 variable that is used to hold a temporary value.
249
250 If you are afraid to mix up your local variable names, you have another
251 problem, which is called the function-growth-hormone-imbalance syndrome.
252 See chapter 6 (Functions).
253
254
255                 Chapter 5: Typedefs
256
257 Please don't use things like "vps_t".
258
259 It's a _mistake_ to use typedef for structures and pointers. When you see a
260
261         vps_t a;
262
263 in the source, what does it mean?
264
265 In contrast, if it says
266
267         struct virtual_container *a;
268
269 you can actually tell what "a" is.
270
271 Lots of people think that typedefs "help readability". Not so. They are
272 useful only for:
273
274  (a) totally opaque objects (where the typedef is actively used to _hide_
275      what the object is).
276
277      Example: "pte_t" etc. opaque objects that you can only access using
278      the proper accessor functions.
279
280      NOTE! Opaqueness and "accessor functions" are not good in themselves.
281      The reason we have them for things like pte_t etc. is that there
282      really is absolutely _zero_ portably accessible information there.
283
284  (b) Clear integer types, where the abstraction _helps_ avoid confusion
285      whether it is "int" or "long".
286
287      u8/u16/u32 are perfectly fine typedefs, although they fit into
288      category (d) better than here.
289
290      NOTE! Again - there needs to be a _reason_ for this. If something is
291      "unsigned long", then there's no reason to do
292
293         typedef unsigned long myflags_t;
294
295      but if there is a clear reason for why it under certain circumstances
296      might be an "unsigned int" and under other configurations might be
297      "unsigned long", then by all means go ahead and use a typedef.
298
299  (c) when you use sparse to literally create a _new_ type for
300      type-checking.
301
302  (d) New types which are identical to standard C99 types, in certain
303      exceptional circumstances.
304
305      Although it would only take a short amount of time for the eyes and
306      brain to become accustomed to the standard types like 'uint32_t',
307      some people object to their use anyway.
308
309      Therefore, the Linux-specific 'u8/u16/u32/u64' types and their
310      signed equivalents which are identical to standard types are
311      permitted -- although they are not mandatory in new code of your
312      own.
313
314      When editing existing code which already uses one or the other set
315      of types, you should conform to the existing choices in that code.
316
317  (e) Types safe for use in userspace.
318
319      In certain structures which are visible to userspace, we cannot
320      require C99 types and cannot use the 'u32' form above. Thus, we
321      use __u32 and similar types in all structures which are shared
322      with userspace.
323
324 Maybe there are other cases too, but the rule should basically be to NEVER
325 EVER use a typedef unless you can clearly match one of those rules.
326
327 In general, a pointer, or a struct that has elements that can reasonably
328 be directly accessed should _never_ be a typedef.
329
330
331                 Chapter 6: Functions
332
333 Functions should be short and sweet, and do just one thing.  They should
334 fit on one or two screenfuls of text (the ISO/ANSI screen size is 80x24,
335 as we all know), and do one thing and do that well.
336
337 The maximum length of a function is inversely proportional to the
338 complexity and indentation level of that function.  So, if you have a
339 conceptually simple function that is just one long (but simple)
340 case-statement, where you have to do lots of small things for a lot of
341 different cases, it's OK to have a longer function.
342
343 However, if you have a complex function, and you suspect that a
344 less-than-gifted first-year high-school student might not even
345 understand what the function is all about, you should adhere to the
346 maximum limits all the more closely.  Use helper functions with
347 descriptive names (you can ask the compiler to in-line them if you think
348 it's performance-critical, and it will probably do a better job of it
349 than you would have done).
350
351 Another measure of the function is the number of local variables.  They
352 shouldn't exceed 5-10, or you're doing something wrong.  Re-think the
353 function, and split it into smaller pieces.  A human brain can
354 generally easily keep track of about 7 different things, anything more
355 and it gets confused.  You know you're brilliant, but maybe you'd like
356 to understand what you did 2 weeks from now.
357
358 In source files, separate functions with one blank line.  If the function is
359 exported, the EXPORT* macro for it should follow immediately after the closing
360 function brace line.  E.g.:
361
362 int system_is_up(void)
363 {
364         return system_state == SYSTEM_RUNNING;
365 }
366 EXPORT_SYMBOL(system_is_up);
367
368 In function prototypes, include parameter names with their data types.
369 Although this is not required by the C language, it is preferred in Linux
370 because it is a simple way to add valuable information for the reader.
371
372
373                 Chapter 7: Centralized exiting of functions
374
375 Albeit deprecated by some people, the equivalent of the goto statement is
376 used frequently by compilers in form of the unconditional jump instruction.
377
378 The goto statement comes in handy when a function exits from multiple
379 locations and some common work such as cleanup has to be done.
380
381 The rationale is:
382
383 - unconditional statements are easier to understand and follow
384 - nesting is reduced
385 - errors by not updating individual exit points when making
386     modifications are prevented
387 - saves the compiler work to optimize redundant code away ;)
388
389 int fun(int a)
390 {
391         int result = 0;
392         char *buffer = kmalloc(SIZE);
393
394         if (buffer == NULL)
395                 return -ENOMEM;
396
397         if (condition1) {
398                 while (loop1) {
399                         ...
400                 }
401                 result = 1;
402                 goto out;
403         }
404         ...
405 out:
406         kfree(buffer);
407         return result;
408 }
409
410                 Chapter 8: Commenting
411
412 Comments are good, but there is also a danger of over-commenting.  NEVER
413 try to explain HOW your code works in a comment: it's much better to
414 write the code so that the _working_ is obvious, and it's a waste of
415 time to explain badly written code.
416
417 Generally, you want your comments to tell WHAT your code does, not HOW.
418 Also, try to avoid putting comments inside a function body: if the
419 function is so complex that you need to separately comment parts of it,
420 you should probably go back to chapter 6 for a while.  You can make
421 small comments to note or warn about something particularly clever (or
422 ugly), but try to avoid excess.  Instead, put the comments at the head
423 of the function, telling people what it does, and possibly WHY it does
424 it.
425
426 When commenting the kernel API functions, please use the kernel-doc format.
427 See the files Documentation/kernel-doc-nano-HOWTO.txt and scripts/kernel-doc
428 for details.
429
430 Linux style for comments is the C89 "/* ... */" style.
431 Don't use C99-style "// ..." comments.
432
433 The preferred style for long (multi-line) comments is:
434
435         /*
436          * This is the preferred style for multi-line
437          * comments in the Linux kernel source code.
438          * Please use it consistently.
439          *
440          * Description:  A column of asterisks on the left side,
441          * with beginning and ending almost-blank lines.
442          */
443
444 It's also important to comment data, whether they are basic types or derived
445 types.  To this end, use just one data declaration per line (no commas for
446 multiple data declarations).  This leaves you room for a small comment on each
447 item, explaining its use.
448
449
450                 Chapter 9: You've made a mess of it
451
452 That's OK, we all do.  You've probably been told by your long-time Unix
453 user helper that "GNU emacs" automatically formats the C sources for
454 you, and you've noticed that yes, it does do that, but the defaults it
455 uses are less than desirable (in fact, they are worse than random
456 typing - an infinite number of monkeys typing into GNU emacs would never
457 make a good program).
458
459 So, you can either get rid of GNU emacs, or change it to use saner
460 values.  To do the latter, you can stick the following in your .emacs file:
461
462 (defun linux-c-mode ()
463   "C mode with adjusted defaults for use with the Linux kernel."
464   (interactive)
465   (c-mode)
466   (c-set-style "K&R")
467   (setq tab-width 8)
468   (setq indent-tabs-mode t)
469   (setq c-basic-offset 8))
470
471 This will define the M-x linux-c-mode command.  When hacking on a
472 module, if you put the string -*- linux-c -*- somewhere on the first
473 two lines, this mode will be automatically invoked. Also, you may want
474 to add
475
476 (setq auto-mode-alist (cons '("/usr/src/linux.*/.*\\.[ch]$" . linux-c-mode)
477                         auto-mode-alist))
478
479 to your .emacs file if you want to have linux-c-mode switched on
480 automagically when you edit source files under /usr/src/linux.
481
482 But even if you fail in getting emacs to do sane formatting, not
483 everything is lost: use "indent".
484
485 Now, again, GNU indent has the same brain-dead settings that GNU emacs
486 has, which is why you need to give it a few command line options.
487 However, that's not too bad, because even the makers of GNU indent
488 recognize the authority of K&R (the GNU people aren't evil, they are
489 just severely misguided in this matter), so you just give indent the
490 options "-kr -i8" (stands for "K&R, 8 character indents"), or use
491 "scripts/Lindent", which indents in the latest style.
492
493 "indent" has a lot of options, and especially when it comes to comment
494 re-formatting you may want to take a look at the man page.  But
495 remember: "indent" is not a fix for bad programming.
496
497
498                 Chapter 10: Kconfig configuration files
499
500 For all of the Kconfig* configuration files throughout the source tree,
501 the indentation is somewhat different.  Lines under a "config" definition
502 are indented with one tab, while help text is indented an additional two
503 spaces.  Example:
504
505 config AUDIT
506         bool "Auditing support"
507         depends on NET
508         help
509           Enable auditing infrastructure that can be used with another
510           kernel subsystem, such as SELinux (which requires this for
511           logging of avc messages output).  Does not do system-call
512           auditing without CONFIG_AUDITSYSCALL.
513
514 Features that might still be considered unstable should be defined as
515 dependent on "EXPERIMENTAL":
516
517 config SLUB
518         depends on EXPERIMENTAL && !ARCH_USES_SLAB_PAGE_STRUCT
519         bool "SLUB (Unqueued Allocator)"
520         ...
521
522 while seriously dangerous features (such as write support for certain
523 filesystems) should advertise this prominently in their prompt string:
524
525 config ADFS_FS_RW
526         bool "ADFS write support (DANGEROUS)"
527         depends on ADFS_FS
528         ...
529
530 For full documentation on the configuration files, see the file
531 Documentation/kbuild/kconfig-language.txt.
532
533
534                 Chapter 11: Data structures
535
536 Data structures that have visibility outside the single-threaded
537 environment they are created and destroyed in should always have
538 reference counts.  In the kernel, garbage collection doesn't exist (and
539 outside the kernel garbage collection is slow and inefficient), which
540 means that you absolutely _have_ to reference count all your uses.
541
542 Reference counting means that you can avoid locking, and allows multiple
543 users to have access to the data structure in parallel - and not having
544 to worry about the structure suddenly going away from under them just
545 because they slept or did something else for a while.
546
547 Note that locking is _not_ a replacement for reference counting.
548 Locking is used to keep data structures coherent, while reference
549 counting is a memory management technique.  Usually both are needed, and
550 they are not to be confused with each other.
551
552 Many data structures can indeed have two levels of reference counting,
553 when there are users of different "classes".  The subclass count counts
554 the number of subclass users, and decrements the global count just once
555 when the subclass count goes to zero.
556
557 Examples of this kind of "multi-level-reference-counting" can be found in
558 memory management ("struct mm_struct": mm_users and mm_count), and in
559 filesystem code ("struct super_block": s_count and s_active).
560
561 Remember: if another thread can find your data structure, and you don't
562 have a reference count on it, you almost certainly have a bug.
563
564
565                 Chapter 12: Macros, Enums and RTL
566
567 Names of macros defining constants and labels in enums are capitalized.
568
569 #define CONSTANT 0x12345
570
571 Enums are preferred when defining several related constants.
572
573 CAPITALIZED macro names are appreciated but macros resembling functions
574 may be named in lower case.
575
576 Generally, inline functions are preferable to macros resembling functions.
577
578 Macros with multiple statements should be enclosed in a do - while block:
579
580 #define macrofun(a, b, c)                       \
581         do {                                    \
582                 if (a == 5)                     \
583                         do_this(b, c);          \
584         } while (0)
585
586 Things to avoid when using macros:
587
588 1) macros that affect control flow:
589
590 #define FOO(x)                                  \
591         do {                                    \
592                 if (blah(x) < 0)                \
593                         return -EBUGGERED;      \
594         } while(0)
595
596 is a _very_ bad idea.  It looks like a function call but exits the "calling"
597 function; don't break the internal parsers of those who will read the code.
598
599 2) macros that depend on having a local variable with a magic name:
600
601 #define FOO(val) bar(index, val)
602
603 might look like a good thing, but it's confusing as hell when one reads the
604 code and it's prone to breakage from seemingly innocent changes.
605
606 3) macros with arguments that are used as l-values: FOO(x) = y; will
607 bite you if somebody e.g. turns FOO into an inline function.
608
609 4) forgetting about precedence: macros defining constants using expressions
610 must enclose the expression in parentheses. Beware of similar issues with
611 macros using parameters.
612
613 #define CONSTANT 0x4000
614 #define CONSTEXP (CONSTANT | 3)
615
616 The cpp manual deals with macros exhaustively. The gcc internals manual also
617 covers RTL which is used frequently with assembly language in the kernel.
618
619
620                 Chapter 13: Printing kernel messages
621
622 Kernel developers like to be seen as literate. Do mind the spelling
623 of kernel messages to make a good impression. Do not use crippled
624 words like "dont" and use "do not" or "don't" instead.
625
626 Kernel messages do not have to be terminated with a period.
627
628 Printing numbers in parentheses (%d) adds no value and should be avoided.
629
630
631                 Chapter 14: Allocating memory
632
633 The kernel provides the following general purpose memory allocators:
634 kmalloc(), kzalloc(), kcalloc(), and vmalloc().  Please refer to the API
635 documentation for further information about them.
636
637 The preferred form for passing a size of a struct is the following:
638
639         p = kmalloc(sizeof(*p), ...);
640
641 The alternative form where struct name is spelled out hurts readability and
642 introduces an opportunity for a bug when the pointer variable type is changed
643 but the corresponding sizeof that is passed to a memory allocator is not.
644
645 Casting the return value which is a void pointer is redundant. The conversion
646 from void pointer to any other pointer type is guaranteed by the C programming
647 language.
648
649
650                 Chapter 15: The inline disease
651
652 There appears to be a common misperception that gcc has a magic "make me
653 faster" speedup option called "inline". While the use of inlines can be
654 appropriate (for example as a means of replacing macros, see Chapter 12), it
655 very often is not. Abundant use of the inline keyword leads to a much bigger
656 kernel, which in turn slows the system as a whole down, due to a bigger
657 icache footprint for the CPU and simply because there is less memory
658 available for the pagecache. Just think about it; a pagecache miss causes a
659 disk seek, which easily takes 5 miliseconds. There are a LOT of cpu cycles
660 that can go into these 5 miliseconds.
661
662 A reasonable rule of thumb is to not put inline at functions that have more
663 than 3 lines of code in them. An exception to this rule are the cases where
664 a parameter is known to be a compiletime constant, and as a result of this
665 constantness you *know* the compiler will be able to optimize most of your
666 function away at compile time. For a good example of this later case, see
667 the kmalloc() inline function.
668
669 Often people argue that adding inline to functions that are static and used
670 only once is always a win since there is no space tradeoff. While this is
671 technically correct, gcc is capable of inlining these automatically without
672 help, and the maintenance issue of removing the inline when a second user
673 appears outweighs the potential value of the hint that tells gcc to do
674 something it would have done anyway.
675
676
677                 Chapter 16: Function return values and names
678
679 Functions can return values of many different kinds, and one of the
680 most common is a value indicating whether the function succeeded or
681 failed.  Such a value can be represented as an error-code integer
682 (-Exxx = failure, 0 = success) or a "succeeded" boolean (0 = failure,
683 non-zero = success).
684
685 Mixing up these two sorts of representations is a fertile source of
686 difficult-to-find bugs.  If the C language included a strong distinction
687 between integers and booleans then the compiler would find these mistakes
688 for us... but it doesn't.  To help prevent such bugs, always follow this
689 convention:
690
691         If the name of a function is an action or an imperative command,
692         the function should return an error-code integer.  If the name
693         is a predicate, the function should return a "succeeded" boolean.
694
695 For example, "add work" is a command, and the add_work() function returns 0
696 for success or -EBUSY for failure.  In the same way, "PCI device present" is
697 a predicate, and the pci_dev_present() function returns 1 if it succeeds in
698 finding a matching device or 0 if it doesn't.
699
700 All EXPORTed functions must respect this convention, and so should all
701 public functions.  Private (static) functions need not, but it is
702 recommended that they do.
703
704 Functions whose return value is the actual result of a computation, rather
705 than an indication of whether the computation succeeded, are not subject to
706 this rule.  Generally they indicate failure by returning some out-of-range
707 result.  Typical examples would be functions that return pointers; they use
708 NULL or the ERR_PTR mechanism to report failure.
709
710
711                 Chapter 17:  Don't re-invent the kernel macros
712
713 The header file include/linux/kernel.h contains a number of macros that
714 you should use, rather than explicitly coding some variant of them yourself.
715 For example, if you need to calculate the length of an array, take advantage
716 of the macro
717
718   #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
719
720 Similarly, if you need to calculate the size of some structure member, use
721
722   #define FIELD_SIZEOF(t, f) (sizeof(((t*)0)->f))
723
724 There are also min() and max() macros that do strict type checking if you
725 need them.  Feel free to peruse that header file to see what else is already
726 defined that you shouldn't reproduce in your code.
727
728
729
730                 Appendix I: References
731
732 The C Programming Language, Second Edition
733 by Brian W. Kernighan and Dennis M. Ritchie.
734 Prentice Hall, Inc., 1988.
735 ISBN 0-13-110362-8 (paperback), 0-13-110370-9 (hardback).
736 URL: http://cm.bell-labs.com/cm/cs/cbook/
737
738 The Practice of Programming
739 by Brian W. Kernighan and Rob Pike.
740 Addison-Wesley, Inc., 1999.
741 ISBN 0-201-61586-X.
742 URL: http://cm.bell-labs.com/cm/cs/tpop/
743
744 GNU manuals - where in compliance with K&R and this text - for cpp, gcc,
745 gcc internals and indent, all available from http://www.gnu.org/manual/
746
747 WG14 is the international standardization working group for the programming
748 language C, URL: http://www.open-std.org/JTC1/SC22/WG14/
749
750 Kernel CodingStyle, by greg@kroah.com at OLS 2002:
751 http://www.kroah.com/linux/talks/ols_2002_kernel_codingstyle_talk/html/
752
753 --
754 Last updated on 2006-December-06.