linux0.11内核完全剖析 - vsprintf.c

声明：

参考《linux内核完全剖析基于linux0.11》--赵炯    节选

vsprintf.c 程序

1.功能描述
        主要包括 vsprintf() 函数，用于对参数产生格式化的输出。由于该函数是 C 函数库中的标准函数，基

本没有涉及内核工作原理，因此可以跳过。直接阅读代码后对该函数的使用说明。

2.代码注释

linux/kernel/vsprintf.c 程序

/*
* linux/kernel/vsprintf.c
*
* (C) 1991 Linus Torvalds
*/

/* vsprintf.c -- Lars Wirzenius & Linus Torvalds. */
/*
* Wirzenius wrote this portably, Torvalds fucked it up :-)
*/
// Lars Wirzenius 是 Linus 的好友，在 Helsinki 大学时曾同处一间办公室。在 1991 年夏季开发 Linux
// 时，Linus 当时对 C 语言还不是很熟悉，还不会使用可变参数列表函数功能。因此 Lars Wirzenius
// 就为他编写了这段用于内核显示信息的代码。他后来(1998 年)承认在这段代码中有一个 bug，直到
// 1994 年才有人发现，并予以纠正。这个 bug 是在使用*作为输出域宽度时，忘记递增指针跳过这个星
// 号了。在本代码中这个 bug 还仍然存在（130 行）。 他的个人主页是 http://liw.iki.fi/liw/ 
#include <stdarg.h> // 标准参数头文件。以宏的形式定义变量参数列表。主要说明了-个
// 类型(va_list)和三个宏(va_start, va_arg 和 va_end)，用于
// vsprintf、vprintf、vfprintf 函数。
#include <string.h> // 字符串头文件。主要定义了一些有关字符串操作的嵌入函数。

/* we use this so that we can do without the ctype library */
/* 我们使用下面的定义，这样我们就可以不使用 ctype 库了 */
#define is_digit(c) ((c) >=  '' && (c) <=  '9' ) // 判断字符是否数字字符。

// 该函数将字符数字串转换成整数。输入是数字串指针的指针，返回是结果数值。另外指针将前移。
static int skip_atoi(const char **s)
{
int i=0;

while (is_digit(**s))
i = i*10 + *((*s)++) -  '';
return i;
}

// 这里定义转换类型的各种符号常数。
#define ZEROPAD 1 			/* pad with zero */ /* 填充零 */
#define SIGN 2 				/* unsigned/signed long */ /* 无符号/符号长整数 */
#define PLUS 4 				/* show plus */ /* 显示加 */
#define SPACE 8 			/* space if plus */ /* 如是加，则置空格 */
#define LEFT 16 			/* left justified */ /* 左调整 */
#define SPECIAL 32 			/* 0x */ /* 0x */
#define SMALL 64 			/* use 'abcdef' instead of 'ABCDEF' */ /* 使用小写字母 */

// 除操作。输入：n 为被除数，base 为除数；结果：n 为商，函数返回值为余数。
// 有关嵌入汇编的信息。
#define do_div(n,base) ({ \
int __res; \
__asm__( "divl %4" : "=a" (n), "=d" (__res): "" (n), "1" (0), "r" (base)); \
__res; })

// 将整数转换为指定进制的字符串。
// 输入：num-整数；base-进制；size-字符串长度；precision-数字长度(精度)；type-类型选项。
// 输出：str 字符串指针。
static char * number(char * str, int num, int base, int size, int precision
,int type)
{
char c, sign, tmp[36];
const char *digits= "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ" ;
int i;

// 如果类型 typ
e044
e 指出用小写字母，则定义小写字母集。
// 如果类型指出要左调整（靠左边界），则屏蔽类型中的填零标志。
// 如果进制基数小于 2 或大于 36，则退出处理，也即本程序只能处理基数在 2-32 之间的数。
if (type&SMALL) digits= "0123456789abcdefghijklmnopqrstuvwxyz" ;
if (type&LEFT) type &= ~ZEROPAD;
if (base<2 || base>36)
return 0;
// 如果类型指出要填零，则置字符变量 c='0'（也即''），否则 c 等于空格字符。
// 如果类型指出是带符号数并且数值 num 小于 0，则置符号变量 sign=负号，并使 num 取绝对值。
// 否则如果类型指出是加号，则置 sign=加号，否则若类型带空格标志则 sign=空格，否则置 0。
c = (type & ZEROPAD) ?  '' :  ' ' ;
if (type&SIGN && num<0) {
sign= '-' ;
num = -num;
} else
sign=(type&PLUS) ?  '+' : ((type&SPACE) ?  ' ' : 0);
// 若带符号，则宽度值减 1。若类型指出是特殊转换，则对于十六进制宽度再减少 2 位(用于 0x)，
// 对于八进制宽度减 1（用于八进制转换结果前放一个零）。
if (sign) size--;
if (type&SPECIAL)
if (base==16) size -= 2;
else if (base==8) size--;
// 如果数值 num 为 0，则临时字符串='0'；否则根据给定的基数将数值 num 转换成字符形式。
i=0;
if (num==0)
tmp[i++]= '' ;
else while (num!=0)
tmp[i++]=digits[do_div(num,base)];
// 若数值字符个数大于精度值，则精度值扩展为数字个数值。
// 宽度值 size 减去用于存放数值字符的个数。
if (i>precision) precision=i;
size -= precision;
// 从这里真正开始形成所需要的转换结果，并暂时放在字符串 str 中。
// 若类型中没有填零(ZEROPAD)和左靠齐（左调整）标志，则在 str 中首先
// 填放剩余宽度值指出的空格数。若需带符号位，则存入符号。
if (!(type&(ZEROPAD+LEFT)))
while(size-->0)
*str++ =  ' ' ;
if (sign)
*str++ = sign;
// 若类型指出是特殊转换，则对于八进制转换结果头一位放置一个'0'；而对于十六进制则存放'0x'。
if (type&SPECIAL)
if (base==8)
*str++ =  '' ;
else if (base==16) {
*str++ =  '' ;
*str++ = digits[33]; // 'X'或'x'
}
// 若类型中没有左调整（左靠齐）标志，则在剩余宽度中存放 c 字符（'0'或空格），见 51 行。
if (!(type&LEFT))
while(size-->0)
*str++ = c;
// 此时 i 存有数值 num 的数字个数。若数字个数小于精度值，则 str 中放入（精度值-i）个'0'。
while(i<precision--)
*str++ =  '' ;
// 将转数值换好的数字字符填入 str 中。共 i 个。
while(i-->0)
*str++ = tmp[i];
// 若宽度值仍大于零，则表示类型标志中有左靠齐标志标志。则在剩余宽度中放入空格。
while(size-->0)
*str++ =  ' ' ;
return str; // 返回转换好的字符串。
}
// 下面函数是送格式化输出到字符串中。
// 为了能在内核中使用格式化的输出，Linus 在内核实现了该 C 标准函数。
// 其中参数 fmt 是格式字符串；args 是个数变化的值；buf 是输出字符串缓冲区。
// 请参见本代码列表后的有关格式转换字符的介绍。
int vsprintf(char *buf, const char *fmt, va_list args)
{
int len;
int i;
char * str; // 用于存放转换过程中的字符串。
char *s;
int *ip;

int flags; /* flags to number() */
/* number()函数使用的标志 */
int field_width; /* width of output field */
/* 输出字段宽度*/
int precision; /* min. # of digits for integers; max
number of chars for from string */
/* min. 整数数字个数；max. 字符串中字符个数 */
int qualifier; /* 'h', 'l', or 'L' for integer fields */
/* 'h', 'l',或'L'用于整数字段 */
// 首先将字符指针指向 buf，然后扫描格式字符串，对各个格式转换指示进行相应的处理。
for (str=buf ; *fmt ; ++fmt) {
// 格式转换指示字符串均以'%'开始，这里从 fmt 格式字符串中扫描'%'，寻找格式转换字符串的开始。
// 不是格式指示的一般字符均被依次存入 str。
if (*fmt !=  '%' ) {
*str++ = *fmt;
continue;
}

// 下面取得格式指示字符串中的标志域，并将标志常量放入 flags 变量中。
/* process flags */
flags = 0;
repeat:
++fmt; /* this also skips first '%' */
switch (*fmt) {
case  '-' : flags |= LEFT; goto repeat; 		// 左靠齐调整。
case  '+' : flags |= PLUS; goto repeat; 		// 放加号。
case  ' ' : flags |= SPACE; goto repeat; 		// 放空格。
case  '#' : flags |= SPECIAL; goto repeat;	 	// 是特殊转换。
case  ''  : flags |= ZEROPAD; goto repeat; 	// 要填零(即'0')。
}

// 取当前参数字段宽度域值，放入 field_width 变量中。如果宽度域中是数值则直接取其为宽度值。
// 如果宽度域中是字符'*'，表示下一个参数指定宽度。因此调用 va_arg 取宽度值。若此时宽度值
// 小于 0，则该负数表示其带有标志域'-'标志（左靠齐），因此还需在标志变量中添入该标志，并
// 将字段宽度值取为其绝对值。
/* get field width */
field_width = -1;
if (is_digit(*fmt))
field_width = skip_atoi(&fmt);
else if (*fmt ==  '*' ) {
/* it's the next argument */ // 这里有个 bug，应插入++fmt;
field_width = va_arg(args, int);
if (field_width < 0) {
field_width = -field_width;
flags |= LEFT;
}
}

// 下面这段代码，取格式转换串的精度域，并放入 precision 变量中。精度域开始的标志是'.'。
// 其处理过程与上面宽度域的类似。如果精度域中是数值则直接取其为精度值。如果精度域中是
// 字符'*'，表示下一个参数指定精度。因此调用 va_arg 取精度值。若此时宽度值小于 0，则
// 将字段精度值取为其绝对值。
/* get the precision */
precision = -1;
if (*fmt ==  '.' ) {
++fmt;
if (is_digit(*fmt))
precision = skip_atoi(&fmt);
else if (*fmt ==  '*' ) {
/* it's the next argument */
precision = va_arg(args, int);
}
if (precision < 0)
precision = 0;
}

// 下面这段代码分析长度修饰符，并将其存入 qualifer 变量。（h,l,L 的含义参见列表后的说明）。
/* get the conversion qualifier */
qualifier = -1;
if (*fmt ==  'h' || *fmt ==  'l' || *fmt ==  'L' ) {
qualifier = *fmt;
++fmt;
}

// 下面分析转换指示符。
switch (*fmt) {
// 如果转换指示符是'c'，则表示对应参数应是字符。此时如果标志域表明不是左靠齐，则该字段前面
// 放入宽度域值-1 个空格字符，然后再放入参数字符。如果宽度域还大于 0，则表示为左靠齐，则在
// 参数字符后面添加宽度值-1 个空格字符。
case  'c' :
if (!(flags & LEFT))
while (--field_width > 0)
*str++ =  ' ' ;
*str++ = (unsigned char) va_arg(args, int);
while (--field_width > 0)
*str++ =  ' ' ;
break;

// 如果转换指示符是's'，则表示对应参数是字符串。首先取参数字符串的长度，若其超过了精度域值，
// 则扩展精度域=字符串长度。此时如果标志域表明不是左靠齐，则该字段前放入(宽度值-字符串长度)
// 个空格字符。然后再放入参数字符串。如果宽度域还大于 0，则表示为左靠齐，则在参数字符串后面
// 添加(宽度值-字符串长度)个空格字符。
case  's' :
s = va_arg(args, char *);
len = strlen(s);
if (precision < 0)
precision = len;
else if (len > precision)
len = precision;

if (!(flags & LEFT))
while (len < field_width--)
*str++ =  ' ' ;
for (i = 0; i < len; ++i)
*str++ = *s++;
while (len < field_width--)
*str++ =  ' ' ;
break;

// 如果格式转换符是'o'，表示需将对应的参数转换成八进制数的字符串。调用 number()函数处理。
case  'o' :
str = number(str, va_arg(args, unsigned long), 8,
field_width, precision, flags);
break;

// 如果格式转换符是'p'，表示对应参数的一个指针类型。此时若该参数没有设置宽度域，则默认宽度
// 为 8，并且需要添零。然后调用 number()函数进行处理。
case  'p' :
if (field_width == -1) {
field_width = 8;
flags |= ZEROPAD;
}
str = number(str,
(unsigned long) va_arg(args, void *), 16,
field_width, precision, flags);
break;

// 若格式转换指示是'x'或'X'，则表示对应参数需要打印成十六进制数输出。'x'表示用小写字母表示。
case  'x' :
flags |= SMALL;
case  'X' :
str = number(str, va_arg(args, unsigned long), 16,
field_width, precision, flags);
break;

// 如果格式转换字符是'd','i'或'u'，则表示对应参数是整数，'d', 'i'代表符号整数，因此需要加上
// 带符号标志。'u'代表无符号整数。
case  'd' :
case  'i' :
flags |= SIGN;
case  'u' :
str = number(str, va_arg(args, unsigned long), 10,
field_width, precision, flags);
break;

// 若格式转换指示符是'n'，则表示要把到目前为止转换输出的字符数保存到对应参数指针指定的位置中。
// 首先利用 va_arg()取得该参数指针，然后将已经转换好的字符数存入该指针所指的位置。
case  'n' :
ip = va_arg(args, int *);
*ip = (str - buf);
break;

// 若格式转换符不是'%'，则表示格式字符串有错，直接将一个'%'写入输出串中。
// 如果格式转换符的位置处还有字符，则也直接将该字符写入输出串中，并返回到 107 行继续处理
// 格式字符串。否则表示已经处理到格式字符串的结尾处，则退出循环。
default:
if (*fmt !=  '%' )
*str++ =  '%' ;
if (*fmt)
*str++ = *fmt;
else
--fmt;
break;
}
}
*str =  '\0' ; // 最后在转换好的字符串结尾处添上 null。
return str-buf; // 返回转换好的字符串长度值。
}

3. 其他信息
        int vsprintf(char *buf, const char *fmt, va_list args)

        vsprintf() 函数是 printf() 系列函数之一。这些函数都产生格式化的输出：接受确定输出格式的格式字符串 fmt ，用格式字符串对个数变化的参数进行格式化，产生格式化的输出。

        printf 直接把输出送到标准输出句柄 stdout 。 cprintf 把输出送到控制台。 fprintf 把输出送到文件句柄。printf 前带 'v' 字符的 ( 例如 vfprintf) 表示参数是从 va_arg 数组的 va_list args 中接受。 printf 前面带 's' 字符则表示把输出送到以 null 结尾的字符串 buf 中（此时用户应确保 buf 有足够的空间存放字符串）。下面详细说明格式字符串的使用方法。

1.  格式字符串

         printf 系列函数中的格式字符串用于控制函数转换方式、格式化和输出其参数。对于每个格式，必须有对应的参数，参数过多将被忽略。格式字符串中含有两类成份，一种是将被直接复制到输出中的简单字符；另一种是用于对对应参数进行格式化的转换指示字符串。

2.  格式指示字符串

        格式指示串的形式如下：

                %[flags][width][.prec][|h|l|L][type]

        每一个转换指示串均需要以百分号 (%) 开始。其中
                [flags]     是可选择的标志字符序列；
                [width]    是可选择的的宽度指示符；
                [.prec]    是可选择的精度 (precision) 指示符；
                [h|l|L]     是可选择的输入长度修饰符；
                [type]     是转换类型字符 ( 或称为转换指示符 ) 。

        flags 控制输出对齐方式、数值符号、小数点、尾零、二进制、八进制或十六进制等，参见上面列表27-33 行的注释。标志字符及其含义如下：
                #   表示需要将相应参数转换为“特殊形式”。对于八进制 (o) ，则转换后的字符串的首位必须是一个零。对于十六进制 (x 或 X) ，则转换后的字符串需以 '0x' 或 '0X' 开头。对于 e,E,f,F,g 以及 G ，则即使没有小数位，转换结果也将总是有一个小数点。对于 g 或 G ，后拖的零也不会删除。
                0   转换结果应该是附零的。对于 d,i,o,u,x,X,e,E,f,g 和 G ，转换结果的左边将用零填空而不是用空格。如果同时出现 0 和 - 标志，则 0 标志将被忽略。对于数值转换，如果给出了精度域， 0 标志也被忽略。
                -   转换后的结果在相应字段边界内将作左调整（靠左）。（默认是作右调整 -- 靠右）。 n 转换例外，转换结果将在右面填空格。
                 ' '   表示带符号转换产生的一个正数结果前应该留一个空格。
                +    表示在一个符号转换结果之前总需要放置一个符号（ + 或 - ）。对于默认情况，只有负数使用负号。

        width 指定了输出字符串宽度，即指定了字段的最小宽度值。如果被转换的结果要比指定的宽度小，则在其左边（或者右边，如果给出了左调整标志）需要填充空格或零（由 flags 标志确定）的个数等。除了使用数值来指定宽度域以外，也可以使用 '*' 来指出字段的宽度由下一个整型参数给出。当转换值宽度大于 width 指定的宽度时，在任何情况下小宽度值都不会截断结果。字段宽度会扩充以包含完整结果。

        precision 是说明输出数字起码的个数。对于 d,I,o,u,x 和 X 转换，精度值指出了起码出现数字的个数。对于 e,E,f 和 F ，该值指出在小数点之后出现的数字的个数。对于 g 或 G ，指出最大有效数字个数。对于s 或 S 转换，精度值说明输出字符串的最大字数。
       
        长度修饰指示符说明了整型数转换后的输出类型形式。下面叙述中‘整型数转换’代表 d,i,o,u,x 或X 转换。
                hh  说明后面的整型数转换对应于一个带符号字符或无符号字符参数。
                h    说明后面的整型数转换对应于一个带符号整数或无符号短整数参数。
                l     说明后面的整型数转换对应于一个长整数或无符号长整数参数。
                ll    说明后面的整型数转换对应于一个长长整数或无符号长长整数参数。
                L    说明 e,E,f,F,g 或 G 转换结果对应于一个长双精度参数。

        type 是说明接受的输入参数类型和输出的格式。各个转换指示符的含义如下：
                d,I 整数型参数将被转换为带符号整数。如果有精度 (precision) 的话，则给出了需要输出的最少数字个数。如果被转换的值数字个数较少，就会在其左边添零。默认的精度值是 1 。
                o,u,x,X  会将无符号的整数转换为无符号八进制 (o) 、无符号十进制 (u) 或者是无符号十六进制 (x 或X) 表示方式输出。 x 表示要使用小写字母（ abcdef ）来表示十六进制数， X 表示用大写字母（ ABCDEF ）表示十六进制数。如果存在精度域的话，说明需要输出的最少数字个数。如果被转换的值数字个数较少，就会在其左边添零。默认的精度值是
1 。
                e,E 这两个转换字符用于经四舍五入将参数转换成 [-]d.ddde+dd 的形式。小数点之后的数字个数等于精度。如果没有精度域，就取默认值 6 。如果精度是 0 ，则没有小数出现。 E 表示用大写字母 E来表示指数。指数部分总是用 2 位数字表示。如果数值为
0 ，那么指数就是 00 。
                f,F 这两个转换字符用于经四舍五入将参数转换成 [-]ddd.ddd 的形式。小数点之后的数字个数等于精度。如果没有精度域，就取默认值 6 。如果精度是 0 ，则没有小数出现。如果有小数点，那么后面起码会有 1 位数字。
                g,G 这两个转换字符将参数转换为 f 或 e 的格式（如果是 G ，则是 F 或 E 格式）。精度值指定了整数的个数。如果没有精度域，则其默认值为 6 。如果精度为 0 ，则作为 1 来对待。如果转换时指数小于-4 或大于等于精度，则采用 e 格式。小数部分后拖的零将被删除。仅当起码有一位小数时才会出现小数点。
                c  参数将被转换成无符号字符并输出转换结果。
                s  要求输入为指向字符串的指针，并且该字符串要以 null 结尾。如果有精度域，则只输出精度所要求的字符个数，并且字符串无须以 null 结尾。
                p  以指针形式输出十六进制数。
                n  用于把到目前为止转换输出的字符个数保存到由对应输入指针指定的位置中。不对参数进行转换。
                %  输出一个百分号 % ，不进行转换。也即此时整个转换指示为 %% 。

与当前版本的区别
        由于该文件也属于库函数，所以从 1.2 版内核开始就直接使用库中的函数了。也即删除了该文件。