Kernel Normal Form

From Embedded Xinu
Revision as of 21:27, 21 February 2008 by Michael (talk | contribs) (Rewrote the XINU style guide.)
Jump to navigation Jump to search

This page specifies the preferred style for kernel source files in the XINU operating system source tree. It also provides a guide for preferred userland code style. Many style rules will not be explicitly stated, but rather implicit through examples in this guide. Be careful to check the example before assuming that this guide is silent on an issue.


 * @file
 * @provides style, guide
 * This is the opening comment block for a file.
 * $Id$

The copyright header should be a single-line comment that immediately follows the opening comment block.

/* Embedded XINU, Copyright (C) 2007, 2008.  All rights reserved. */
 * Immensely important comments look like this.
/* Typical single-line comments look like this. */
 * Multi-line comments that should appear in the autogenerated documentation
 * should look like this.
/** Single-line comments to appear in documentation look like this. */
/**< or they look like this. */

The first form of single-line comments goes above the code that it pertains to, whereas the second form will appear on the same line as the code it describes.

An automatic script (Doxygen) will collect comments that begin with the ** and parse them into the documentation for this project. In the opening comment block there is a line containing $Id$, if that file has the subversion property svn:keywords "Id" set, it will be filled out with the name of the file, the last revision that file was updated, the date and time of the last update, and the user who last modified the file.


As a precaution against multiple definitions every include file should protect itself against redefining its material.

#ifndef _INCLUDE_H_
#define _INCLUDE_H_
#endif /* _INCLUDE_H_ */

After the opening comment block and copyright of a file, include one blank line and begin including non-local header files. Typically these should be ordered from most important (kernel-level) to least important (user-level).

#include <kernel.h>
#include <device.h>
#include <memory.h>
#include <string.h>

Now, if there are local header files include a blank line and then continue including files.

#include "local.h"

Macro definitions should typically be in ALL CAPS, unless it goes against a standard. If a macro is being used in lieu of a function the macro should be defined in ALL CAPS. If the macro consumes multiple lines, align the backslashes one space to the right of the longest line. Any final statement-terminating semicolon should not appear in the macro, rather it will be supplied by the invocation on the macro to allow easier parsing of the code by humans and editors alike.

#define MACRO(x, y)      \
    (x) = (x) + 5 * (y); \
    (x) /= 3

When using conditional directives such as #if or #ifdef, it is recommended to place a comment following the matching #else or #endif to make the reader have an easier time discerning where conditionally compiled code begins and ends.

#ifdef MIPS
/* MIPS specific code goes here. */
#else /* not MIPS */
/* generic code goes here. */
#endif /* MIPS */

Structs and Typedefs

Structures should have logically named members with a comment describing what each member is for. Structures do not have to have a typedef, but if they do have one it should be inline with the structure definition.

typedef struct dentry
    ushort  major; /**< major device number          */
    ushort  minor; /**< minor device number          */
    void   *csr;   /**< control and status registers */
} device;


All functions must be prototyped somewhere. Global functions should have a prototype in a system header file, local functions can be prototyped at the top of its respective source file (or in a local header file). If the function is local it should use the local type from stddef.h, which will declare it as static and not pollute the namespace.

Prototypes should not have a variable name associated with the type. For example:

void foo(int, int *);

With multiple prototypes lined up, after the type declarations there should be at least one space before an * and the function names should line up.

extern devcall  freemem(void *);
extern void    *getmem(ulong);

When creating a function it should be preceeded by document comment describing what it does, the parameters it takes, and what it will return, if applicable. The return type, function name, and parameters should be on the same line unless that line is over 75 characters wide. In that case the remaining parameters should be aligned with the first parameter on the line above.

 * The main function of the program will parse the input for the arguments passed.
 * @param argc   number of arguments passed to function
 * @param argv   array of char *s containing passed arguments
 * @param func   pointer to function that takes two int parameters
 * @param offset offset into char * array to read
 * @param length length to read at offset
 * @return 0 on successful completion, non-0 if unsuccessful.
int foo(int argc, char **argv, devcall (*func)(int, int), int offset,
        int length)
    /* well written code. */


Languages keywords (such as if, while, for, switch) all have one space following their use. This helps differentiate keywords from function calls. Braces ({ and }) should always be used in control statements. If the control statement is a single-line, the braces can exist on the same line as the statement (and if it's really short the same line as the keyword!). The use of brackets in all cases helps minimize the risk of bugs occurring when adding new lines to a statement.

for (i = 0; i < length; i++)
    a = i + 1;
    b *= a;

if (NULL != value)
{ *value = new_value; }

while (TRUE) { /* Do nothing. */ }

Avoid declarations within new statement blocks when possible, certain versions of compilers may not recognize them for what they are.

Indentations are done through the tab (\t) character, allowing each coder their own preference for the size of a tab stop. This only applies to indentation at the beginning of lines, for spacing (such as aligning comments) use the space character. If a conditional statement wraps around place the operator at the beginning of the next line (lining up with first variable above).

while (count > 30 && TRUE == this_variable_is_true
       && NULL != value)
    /* Do something. */
if (foo)
    /* foo case. */
else if (bar)
    /* bar case. */
    /* else case. */

Switch statements should be formatted with each case lining up with the braces as follows:

switch (test)
case 0:
case 1:
    /* Process. */
    /* Normal case. */

There should be no spaces after function names. Commas should be followed by a space. Spaces are optional after parentheses and square braces. Typically there are only spaces with more complex statements. Code readability is king. Binary operators should be padded with a space on either side.

error = function(a1, a2);
if ( (OK != error) && (5 < error) )
{ exit(error); }

Unary operators do not requires a space. Use parentheses only when they are required to override precedence rules or to maintain readability with complicated statements. Other people may get more easily confused then you. Can you parse the following:

a = b->c[0] + ~d == (e || f) || g && h ? i : j >> 1;

Perhaps that statement would benefit with parentheses.


It is permissible to declare multiple variables on one line, but do not initialize variables until everything has been declared.

struct foo one, *two;
int        three, four, five;

five = 5;
four = four();

Type casts and sizeof should not be followed by a space. sizeof should always be written with parentheses.

a = (ushort)sizeof(struct memblock);

Committed code should never produce warnings.

Function names should use lowerCamelCase. Avoid unnecessary abbreviation in function names as reasonable.

To avoid machine type size issues, the int and other #define types are deprecated. Instead, all code should use: long, ulong, short, ushort, char, uchar.

Pointers which are used solely as references to memory locations should be declared of type void *.


It should be noted that since HTML does not allow the tab character, this example should reflect someone who has their tab stop set to 4 spaces. Use the \t character for indentation.

 * @file     exampleFile.c
 * @provides exampleFile, fileLoaded, getIO
 * While only an example this portion should contain general information
 * about the importance of this file.
 * $Id$
/* Embedded XINU, Copyright (C) 2007.  All rights reserved. */

#include <kernel.h>
#include <proc.h>
#include <queue.h>

/* End of file marker */
#define FILE_END 0x255          /**< Magic number to designate end-of-file */

 * Processor Registers
#define zero $0                 /**< hardwired zero                        */
#define a0   $4                 /**< first passed argument                 */
#define s0   $16                /**< callee saved                          */

extern ulong getData(int *register);
extern ulong data_register;

static ulong getIO();
local fileLoaded(ushort fd);

 * Load an example file into XINU.
 * @param fd      descriptor of file to load
 * @param timeout how long to wait before error.
 * @return OK for success, SYSERR for failure to load
devcall exampleFile(ushort fd, ulong timeout)
    ulong counter; /* number of cycles we've been waiting   */
    ulong data;    /* 64-bits for storing a section of data */

    for ( counter = 0; counter < timeout; counter++ )
        data = getIO();

        /* TODO: perform operation on data */

        /* We have finished reading the file */
        if ( loadXinu(fd) == OK )
        { return OK; }

    return SYSERR;

 * Search for the end of the file
 * @param fd file descriptor to finish reading
 * @return OK if complete, SYSERR if incomplete
local fileLoaded(ushort fd)
    /* check for end of file marker */
    if ( filetab[fd].buffer == FILE_END )
        /* other code if needed */
        return OK;
        /* other code if needed */
        return SYSERR;

 * Read data from the s0 register through an assembly function.
 * @return data from register s0
static ulong getIO()
    switch (data_register)
    case S0: case S1:
        return getData(s0);
    case A0: case A1: case A2: case A3:
        return getData(a0);
        return SYSERR;