printf()를 만들어 보자

C언어를 배울 때 가장 먼저 사용하는 함수는 printf()일것이다.  또한 C프로그램에서 가장 많이 불리워지는 함수도 printf()일것이다.  그러나 이렇게 많이 사용하고 있는 printf() 함수가 실제로 어떻게 생겼는지 그 소스를 찾아본적은 거의 없을 것이다.

이번 글에서는 printf() 함수를 라이브러리에서 제공하는 것을 사용하지 않고 직접 만들어 보기로 하겠다.

printf() 함수의 소스 코드는 인터넷에서 검색하면 어렵지 않게 찾을 수 있을 것이다.  이 글에서는 BSD-lite 안에 들어 있는 코드를 참조하였다.

아직 C언어에 익숙하지 않은 프로그래머가 보기에는 소스코드가 다소 복잡하게 보일것이다.  따라서 이 코드를 바로 임베디드 시스템에 적용하기에 앞서 visual studio나 리눅스 환경에서 미리 검증한 후 실제 임베디드 보드에서 확인하는것이 좋다.

아래 코드는 visual studio에서 동작 확인을 위하여 만들어 본 코드이다.

main.c

직접 만들어 본 코드에 문제가 없음을 확인하였으면 실제 보드에서 동작 시켜 보도록 하겠다.

먼저 해야 할 일은 이제 더이상 컴파일러에 포함되어 있는 C라이브러리가 프로젝트 빌드시에 포함되지 않도록 하기 위하여 Makefile을 수정하여야 한다.

gccincdir := $(shell $(CC) -print-file-name=include) CFLAGS := -g -Os -ffunction-sections -fdata-sections -Wall -std=gnu99 CFLAGS += -fno-builtin -ffreestanding CFLAGS += -mthumb -mcpu=cortex-m3 CFLAGS += -Iinc -nostdinc -isystem $(gccincdir) LDFLAGS := -L $(shell dirname `$(CC) $(CFLAGS) -print-libgcc-file-name`) LDFLAGS += -nostdlib

6번줄에 있는 -nostdinc 옵션을 이용하여 라이브러리에서 제공하는 include 파일을 사용하지 않겠다는것을 알려 준다.  하지만, GCC 컴파일러에서 제공하는 헤더 파일은 사용하여야 하기 때문에 -isystem 옵션으로 GCC에서 제공하는 헤더파일을 include 시킨다.  GCC 헤더 파일의 위치는 1번줄에서 표현된 방법으로 그 디렉토리를 알 수 있다.

그리고, 링크시에 라이브러리에서 제공하는 코드가 포함되지 않도록 하기 위하여 9번 줄에서처럼 -nostdlib 옵션을 사용하였다.

컴파일과 링크 단계에서 -nostdinc와 -nostdlib 옵션을 주게 되면 더이상 라이브러리에서 제공하는 코드를 사용할 수 없게 되므로 프로그래머가 직접 해당 함수와 헤더 파일을 만들어야 한다.

원본 코드를 참조하여 만들어 본 printf() 함수의 코드는 다음과 같다.

#include <stdarg.h> #include <stdint.h> #include <stddef.h> #include <limits.h> #include <stdio.h> #include <string.h> #define UART_BUF_SIZE 256 char uart_buf[UART_BUF_SIZE]; #define to_digit(c) ((c) - '0') #define is_digit(c) ((unsigned)to_digit(c) <= 9) #define to_char(n) ((n) + '0') #define BUF 68 #define ALT 0X001 #define HEXPREFIX 0X002 #define LADJUST 0X004 #define LONGDBL 0X008 #define LONGINT 0X010 #define QUADINT 0X020 #define SHORTINT 0X040 #define ZEROPAD 0X080 #define FPT 0X100 static char *__ultoa(register uint32_t val, char *endp, int base, int octzero, char *xdigs) { register char *cp = endp; register int32_t sval; switch (base) { case 8: do { *--cp = to_char(val & 7); val >>= 3; } while(val); if (octzero && *cp != '0') *--cp = '0'; break; case 10: if (val < 10) { *--cp = to_char(val); return cp; } if (val > LONG_MAX) { *--cp = to_char(val % 10); sval = val / 10; } else sval = val; do { *--cp = to_char(sval % 10); sval /= 10; } while(sval != 0); break; case 16: do { *--cp = xdigs[val & 15]; val >>= 4; } while(val); break; default: break; } return cp; } static char *__uqtoa(register uint64_t val, char *endp, int base, int octzero, char *xdigs) { register char *cp = endp; register int64_t sval; if (val <= ULONG_MAX) return __ultoa((uint32_t)val, endp, base, octzero, xdigs); switch (base) { case 8: do { *--cp = to_char(val & 7); val >>= 3; } while(val); if (octzero && *cp != '0') *--cp = '0'; break; case 10: if (val < 10) { *--cp = to_char(val % 10); return cp; } if (val > QUAD_MAX) { *--cp = to_char(val % 10); sval = val / 10; } else sval = val; do { *--cp = to_char(sval % 10); sval /= 10; } while(sval != 0); break; case 16: do { *--cp = xdigs[val & 15]; val >>= 4; } while(val); break; default: break; } return cp; } int vprintf(char *strbuf, const char *format, va_list ap) { register char *fmt; register char *cp; register char ch; register int n; register int flags; char sign; int ret; int width; int prec; int dprec = 0; int size; int fieldsz; int realsz; int base; char *xdigs = NULL; uint32_t ulval = 0; uint64_t uqval = 0; char buf[BUF]; char ox[2]; #define PADSIZE 16 static char blanks[PADSIZE] = {' ',' ',' ',' ',' ',' ',' ',' ',' ',' ',' ',' ',' ',' ',' ',' '}; static char zeroes[PADSIZE] = {'0','0','0','0','0','0','0','0','0','0','0','0','0','0','0','0'}; #define PRINT(ptr, len) \ do { \ int i; \ for (i=0; i<len; i++) \ *strbuf++ = ptr[i]; \ }while(0) #define PAD(howmany, with) \ do { \ if ((n = (howmany)) > 0) { \ while (n > PADSIZE) { \ PRINT(with, PADSIZE); \ n -= PADSIZE; \ } \ PRINT(with, n); \ } \ }while(0) #define SARG() \ (flags & LONGINT ? va_arg(ap, long) : \ flags & SHORTINT ? (long)(short)va_arg(ap, int) : \ (long)va_arg(ap, int)) #define UARG() \ (flags & LONGINT ? va_arg(ap, uint32_t) : \ flags & SHORTINT ? (uint32_t)(uint16_t)va_arg(ap, int) : \ (uint32_t)va_arg(ap, uint32_t)) fmt = (char *)format; ret = 0; while (1) { for (cp = fmt; (ch = *fmt) != '\0' && ch != '%'; fmt++); if ((n = fmt - cp) != 0) { PRINT(cp, n); ret += n; } if (ch == '\0') goto done; fmt++; flags = 0; width = 0; prec = -1; sign = '\0'; rflag: ch = *fmt++; reswitch: switch (ch) { case ' ': if (!sign) sign = ' '; goto rflag; case '#': flags |= ALT; goto rflag; case '*': if ((width = va_arg(ap, int)) >= 0) goto rflag; width = -width; case '-': flags |= LADJUST; goto rflag; case '+': sign = '+'; goto rflag; case '.': if ((ch = *fmt++) == '*') { n = va_arg(ap, int); prec = n < 0 ? -1 : n; goto rflag; } n = 0; while (is_digit(ch)) { n = 10 * n + to_digit(ch); ch = *fmt++; } prec = n < 0 ? -1 : n; goto reswitch; case '0': flags |= ZEROPAD; goto rflag; case '1' ... '9': n = 0; do { n = 10 * n + to_digit(ch); ch = *fmt++; } while(is_digit(ch)); width = n; goto reswitch; case 'h': flags |= SHORTINT; goto rflag; case 'l': if (*fmt == 'l') { fmt++; flags |= QUADINT; } else flags |= LONGINT; goto rflag; case 'q': flags |= QUADINT; goto rflag; case 'c': *(cp = buf) = va_arg(ap, int); size = 1; sign = '\0'; break; case 'D': flags |= LONGINT; case 'd': case 'i': if (flags & QUADINT) { uqval = va_arg(ap, int64_t); if ((int64_t)uqval < 0) { uqval = -uqval; sign = '-'; } } else { ulval = SARG(); if ((long)ulval < 0) { ulval = -ulval; sign = '-'; } } base = 10; goto number; case 'O': flags |= LONGINT; case 'o': if (flags & QUADINT) uqval = va_arg(ap, uint64_t); else ulval = UARG(); base = 8; goto nosign; case 'p': ulval = (uint32_t)va_arg(ap, void *); base = 16; xdigs = "0123456789abcdef"; flags = (flags & ~QUADINT) | HEXPREFIX; ch = 'x'; goto nosign; case 's': if ((cp = va_arg(ap, char *)) == NULL) cp = "(null)"; if (prec >= 0) { char *p = memchr(cp, 0, prec); if (p != NULL) { size = p - cp; if (size > prec) size = prec; } else size = prec; } else size = strlen(cp); sign = '\0'; break; case 'U': flags |= LONGINT; case 'u': if (flags & QUADINT) uqval = va_arg(ap, uint64_t); else ulval = UARG(); base = 10; goto nosign; case 'X': xdigs = "0123456789ABCDEF"; goto hex; case 'x': xdigs = "0123456789abcdef"; hex: if (flags & QUADINT) uqval = va_arg(ap, uint64_t); else ulval = UARG(); base = 16; if (flags & ALT && (flags & QUADINT ? uqval != 0 : ulval != 0)) flags |= HEXPREFIX; nosign: sign = '\0'; number: if ((dprec = prec) >= 0) flags &= ~ZEROPAD; cp = buf + BUF; if (flags & QUADINT) { if (uqval != 0 || prec != 0) cp = __uqtoa(uqval, cp, base, flags & ALT, xdigs); } else { if (ulval != 0 || prec != 0) cp = __ultoa(ulval, cp, base, flags & ALT, xdigs); } size = buf + BUF - cp; break; default: if (ch == '\0') goto done; cp = buf; *cp = ch; size = 1; sign = '\0'; break; } fieldsz = size; if (sign) fieldsz++; else if (flags & HEXPREFIX) fieldsz += 2; realsz = dprec > fieldsz ? dprec : fieldsz; if ((flags & (LADJUST | ZEROPAD)) == 0) PAD(width - realsz, blanks); if (sign) { *strbuf++ = sign; } else if (flags & HEXPREFIX) { ox[0] = '0'; ox[1] = ch; PRINT(ox, 2); } if ((flags & (LADJUST | ZEROPAD)) == ZEROPAD) PAD(width - realsz, zeroes); PAD(dprec - fieldsz, zeroes); PRINT(cp, size); if (flags & LADJUST) PAD(width - realsz, blanks); ret += width > realsz ? width : realsz; } done: *strbuf = '\0'; return ret; } int printf(const char *format, ...) { int rc; va_list ap; va_start(ap, format); rc = vprintf(uart_buf, format, ap); va_end(ap); puts(uart_buf); return rc; } void putc(char ch) { extern void uart_putc(char ch); uart_putc(ch); if (ch == '\n') uart_putc('\r'); } void puts(const char *str) { while(*str) putc(*str++); }

실제 코드를 보면 무척 복잡하다는 느낌이 들것이다.

int main(int argc, char *argv[]) { int count = 100; sysclock_init(BD_CLKSRC, BD_PLLMUL, BD_AHBPRE, BD_APB1PRE, BD_APB2PRE, BD_ADCPRE); rcc_apb2enable(RCC_APB2_IOPC); gpio_set_outmode(GPIO_PORT_C, GPIO_PIN13, GPIO_GEN_PUSHPULL, GPIO_OUT_2M); uart_init(); while (1) { delay(500); gpio_out_toggle(GPIO_PORT_C, GPIO_PIN13); printf("%10s = 0x%08X[%8d]\n", "Count", count, count); count--; } return 0; }

main()를 위와 같이 만들어서 제대로 동작되는지 확인해 본다.  15번 줄에 보여지는 코드가 제대로 표현되는지 실행하여 그 결과를 확인한다.

Count 값이 100에서부터 1씩 감소하여 0이 되고, 그 다음에 -1이 되는것을 확인할 수 있다.

프로젝트에서 사용된 코드들은 아래에 첨부 하였다.  

stdio2.zip

소스코드를 열어보면 알겠지만 그동안 라이브러리에서 제공하여 그냥 불러 썼던 코드들이 모두 들어 있다.  이번 프로젝트에서는 물론 printf() 함수를 사용하는데 필요한 코드만 들어있다.  다른 함수들이 필요하면 그 코드들도 직접 만들어야 한다.

그렇다면 C에서 제공하는 라이브러리를 그냥 쓰면 되지 굳이 이렇게 불편하게 직접 만들 필요까지 있을까?

그 이유는 다음과 같다.

첫째, 이미 앞의 글에서도 얘기 했다시피 라이브러리코드가 포함되면 프로젝트의 실행 파일 크기가 상당히 커지게 된다.  ROM이나 RAM 크기가 충분하면 문제될게 없겠지만 MCU와 같이 ROM과 RAM 크기가 불과 몇K바이트나 몇십K바이트일뿐인 경우에는 라이브러리가 포함됨으로써 전체적으로 커지게 되는 실행 파일의 크기에 민감해 질 수밖에 없다.  어떤 경우 불과 몇십바이트 크기가 아쉬울때가 있기 때문이다.  이런 경우 라이브러리를 사용하지 않고 직접 필요한 함수만 만들어 쓰게 되면 그 크기를 대폭 줄일수 있게 된다.

둘째, 라이브러리 내부를 알 수 없으므로 원하는 동작이 수행되지 않을때 그 원인을 찾기가 쉽지 않은 경우가 있다.  때로는 보드에 맞지 않게 동작되는 라이브러리 코드가 포함될 수 있기 때문이다.  프로그래머가 직접 라이브러리를 만들어 쓰게 되면 어느 정도는 디버깅이 가능할 수 있게 된다.

세번째 이유는 프로젝트와는 직접적인 관계는 없지만 라이브러리 코드를 직접 만들어 봄으로써 프로그래밍 능력이 높아지게 된다.  좋은 글을 쓰기 위해서는 좋은 책을 많이 읽어야 하는것처럼 좋은 프로그램을 짜기 위해서는 좋은 코드들을 많이 분석해 보아야 한다.  C 라이브러리 코드들은 거의 프로그램의 신들이 만들기 때문에 거의 예술에 가까운 코드들이다.  평소에 절대 사용하지 않는 프로그래밍 기법들을 볼 수 있고, 특히 #define을 이용한 매크로 코드들을 보면 감탄하지 않을 수 없다.

단순히 취미가 아닌 프로그래머를 직업으로 삼으려하는 초보 프로그래머가 있다면 틈틈히 라이브러리 코드를 공부하기 바란다.