2011년 10월 4일 화요일

GCC에서 printf류 함수 인자 타입 검사

format (archetype, string-index, first-to-check)
The format attribute specifies that a function takes printf, scanf, or strftime style arguments which should be type-checked against a format string. For example, the declaration:

extern int
my_printf (void *my_object, const char *my_format, ...)
__attribute__ ((format (printf, 2, 3)));


causes the compiler to check the arguments in calls to my_printf for consistency with the printf style format string argument my_format.

The parameter archetype determines how the format string is interpreted, and should be either printf, scanf, or strftime. The parameter string-index specifies which argument is the format string argument (starting from 1), while first-to-check is the number of the first argument to check against the format string. For functions where the arguments are not available to be checked (such as vprintf), specify the third parameter as zero. In this case the compiler only checks the format string for consistency.

In the example above, the format string (my_format) is the second argument of the function my_print, and the arguments to check start with the third argument, so the correct parameters for the format attribute are 2 and 3.

The format attribute allows you to identify your own functions which take format strings as arguments, so that GNU CC can check the calls to these functions for errors. The compiler always checks formats for the ANSI library functions printf, fprintf, sprintf, scanf, fscanf, sscanf, strftime, vprintf, vfprintf and vsprintf whenever such warnings are requested (using `-Wformat'), so there is no need to modify the header file `stdio.h'.

출처: http://gcc.gnu.org/onlinedocs/gcc-2.95.3/gcc_4.html

printf류 함수를 만들어서 사용할 때, 종종 변수 개수가 많아지면 헷갈려 정확한 인자를 넣지 않아 문제가 발생할 수 있다. 이를 위해 GCC는 -Wformat(또는 -Wall) 옵션을 사용하면, printf류 함수 안에 포맷스트링과 인자 타입과 개수를 검사하여 문제가 있을 경우 경고문구를 뿌려준다. C 기본 함수는 모두 이 검사 기능이 켜져 있지만, 커스텀 함수일 경우 위와 같이 __attribute__((format, (...))) 확장기능을 사용하여 컴파일러에게 알려줄 수 있다.

함수 선언부 뒤에 "__attribute__((format,(타입,포맷스트링인자위치,가변변수시작위치)))" 형태를 붙인다. 타입은 printf/scanf 두 가지 종류가 있으며, 각 위치는 '1'부터 시작한다. 단, static이 아닌 class의 method는 '2'부터 시작한다.