1 | /**
|
---|
2 | * @file cf_debug.h
|
---|
3 | * @author myusgun <myusgun@gmail.com>
|
---|
4 | * @version 0.1
|
---|
5 | *
|
---|
6 | * @remark
|
---|
7 | * 디버그 함수를 직접 호출하지 않고 정의된 매크로를 사용하면,
|
---|
8 | * Preprocessor에 _DEBUG가 정의되어 있는 경우에 만
|
---|
9 | * 디버그 코드가 동작하도록 할 수 있음 <br />
|
---|
10 | * 디버그 메시지는 stdout 및 stderr를 이용한 파일 포인터 출력을 지원하고,
|
---|
11 | * 환경에 적합하도록 사용자가 구성한 컨텍스트를 이용하여 사용할 수도 있음 <br />
|
---|
12 | * (단, 콜스택의 푸시/팝은 컨텍스트를 이용해야만 사용 가능)
|
---|
13 | */
|
---|
14 | #ifndef __CF_DEBUG_H__
|
---|
15 | #define __CF_DEBUG_H__
|
---|
16 |
|
---|
17 | #include "cf_base.h"
|
---|
18 |
|
---|
19 | #include <stdio.h>
|
---|
20 |
|
---|
21 | /** 잘못된 컨텍스트 오류 */
|
---|
22 | #define CF_ERROR_DEBUG_INVALID_CTX CF_ERROR_DEBUG - 1
|
---|
23 |
|
---|
24 | /** 디버그 메시지 출력을 위한 파일 포인터 설정 오류 */
|
---|
25 | #define CF_ERROR_DEBUG_SET_OUTPUT_FD CF_ERROR_DEBUG - 2
|
---|
26 |
|
---|
27 | /** 콜스택 푸시 오류 */
|
---|
28 | #define CF_ERROR_DEBUG_PUSH_CALLSTACK CF_ERROR_DEBUG - 3
|
---|
29 |
|
---|
30 | /** 콜스택 팝 오류 */
|
---|
31 | #define CF_ERROR_DEBUG_POP_CALLSTACK CF_ERROR_DEBUG - 4
|
---|
32 |
|
---|
33 | /** Windows 함수 이름 매크로 재정의 */
|
---|
34 | #ifdef _WIN32
|
---|
35 | # define __func__ __FUNCTION__
|
---|
36 | #endif
|
---|
37 |
|
---|
38 | #ifdef _DEBUG
|
---|
39 | /**
|
---|
40 | * 디버그 컨텍스트 생성
|
---|
41 | *
|
---|
42 | * @see CF_Debug_CreateCtx
|
---|
43 | */
|
---|
44 | # define CF_DEBUG_CREATE_CTX() \
|
---|
45 | CF_Debug_CreateCtx ()
|
---|
46 |
|
---|
47 | /**
|
---|
48 | * 디버그 컨텍스트 해제
|
---|
49 | *
|
---|
50 | * @param __ctx 디버그 컨텍스트
|
---|
51 | *
|
---|
52 | * @see CF_Debug_DestroyCtx
|
---|
53 | */
|
---|
54 | # define CF_DEBUG_DESTROY_CTX(__ctx) \
|
---|
55 | CF_Debug_DestroyCtx (__ctx)
|
---|
56 |
|
---|
57 | /**
|
---|
58 | * 디버그 메시지를 지정된 파일 포인터로 출력
|
---|
59 | *
|
---|
60 | * @param __fp 파일 포인터. 표준출력(stdout) 및 표준오류(stderr) 사용 가능
|
---|
61 | * @param __fmt 포맷 스트링
|
---|
62 | * @param ... 가변 인자
|
---|
63 | *
|
---|
64 | * @see CF_Debug_Print
|
---|
65 | */
|
---|
66 | # define CF_DEBUG_PRINT(__fp,__fmt,...) \
|
---|
67 | CF_Debug_Print (__fp,__FILE__,__func__,__LINE__,__fmt,##__VA_ARGS__)
|
---|
68 |
|
---|
69 | /**
|
---|
70 | * 바이너리 데이터를 디버그 메시지와 함께 지정된 파일 포인터로 출력
|
---|
71 | *
|
---|
72 | * @param __fp 파일 포인터. 표준출력(stdout) 및 표준오류(stderr) 사용 가능
|
---|
73 | * @param __bin 바이너리 데이터
|
---|
74 | * @param __len 바이너리 길이
|
---|
75 | * @param __fmt 포맷 스트링
|
---|
76 | * @param ... 가변 인자
|
---|
77 | *
|
---|
78 | * @see CF_Debug_PrintBin
|
---|
79 | */
|
---|
80 | # define CF_DEBUG_PRINT_BIN(__fp,__bin,__len,__fmt,...) \
|
---|
81 | CF_Debug_PrintBin (__fp,__FILE__,__func__,__LINE__,__bin,__len,__fmt,##__VA_ARGS__)
|
---|
82 |
|
---|
83 | /**
|
---|
84 | * 컨텍스트를 업데이트하고 디버그 메시지를 출력
|
---|
85 | *
|
---|
86 | * @param __ctx 디버그 컨텍스트
|
---|
87 | * @param __fmt 포맷 스트링
|
---|
88 | * @param ... 가변 인자
|
---|
89 | *
|
---|
90 | * @see CF_DEBUG_UPDATE_CTX, CF_Debug_Trace
|
---|
91 | */
|
---|
92 | # define CF_DEBUG_TRACE(__ctx,__fmt,...) \
|
---|
93 | CF_Debug_Trace (__ctx,__FILE__,__func__,__LINE__,__fmt,##__VA_ARGS__)
|
---|
94 |
|
---|
95 | /**
|
---|
96 | * 컨텍스트를 업데이트하고 바이너리 데이터를 디버그 메시지와 함께 출력
|
---|
97 | *
|
---|
98 | * @param __ctx 디버그 컨텍스트
|
---|
99 | * @param __bin 바이너리 데이터
|
---|
100 | * @param __len 바이너리 길이
|
---|
101 | * @param __fmt 포맷 스트링
|
---|
102 | * @param ... 가변 인자
|
---|
103 | *
|
---|
104 | * @see CF_DEBUG_UPDATE_CTX, CF_Debug_TraceBin
|
---|
105 | */
|
---|
106 | # define CF_DEBUG_TRACE_BIN(__ctx,__bin,__len,__fmt,...) \
|
---|
107 | CF_Debug_TraceBin (__ctx,__FILE__,__func__,__LINE__,__bin,__len,__fmt,##__VA_ARGS__)
|
---|
108 |
|
---|
109 | /**
|
---|
110 | * 컨텍스트에 콜스택 푸시
|
---|
111 | *
|
---|
112 | * @param __ctx 디버그 컨텍스트
|
---|
113 | *
|
---|
114 | * @see CF_Debug_CallStackPush
|
---|
115 | */
|
---|
116 | # define CF_DEBUG_CALLSTACK_PUSH(__ctx) \
|
---|
117 | CF_Debug_CallStackPush (__ctx,__FILE__,__func__,__LINE__)
|
---|
118 |
|
---|
119 | /**
|
---|
120 | * 컨텍스트에서 콜스택 팝
|
---|
121 | *
|
---|
122 | * @param __ctx 디버그 컨텍스트
|
---|
123 | * @param __callstack 콜스택 정보를 가져올 콜스택 데이터 구조체 포인터
|
---|
124 | *
|
---|
125 | * @see CF_Debug_CallStackPop, CF_Debug_CallStack
|
---|
126 | */
|
---|
127 | # define CF_DEBUG_CALLSTACK_POP(__ctx,__callstack) \
|
---|
128 | CF_Debug_CallStackPop (__ctx,__callstack)
|
---|
129 | #else // #ifdef _DEBUG
|
---|
130 | # define CF_DEBUG_CREATE_CTX() NULL
|
---|
131 | # define CF_DEBUG_DESTROY_CTX(__ctx)
|
---|
132 | # define CF_DEBUG_UPDATE_CTX(__ctx)
|
---|
133 | # define CF_DEBUG_PRINT(__fp,__fmt,...)
|
---|
134 | # define CF_DEBUG_PRINT_BIN(__fp,__bin,__len,__fmt,...)
|
---|
135 | # define CF_DEBUG_TRACE(__ctx,__fmt,...)
|
---|
136 | # define CF_DEBUG_TRACE_BIN(__ctx,__bin,__len,__fmt,...)
|
---|
137 | # define CF_DEBUG_CALLSTACK_PUSH(__ctx)
|
---|
138 | # define CF_DEBUG_CALLSTACK_POP(__ctx,__callstack) 1
|
---|
139 | #endif // #ifdef _DEBUG
|
---|
140 |
|
---|
141 | /** 디버그 컨텍스트 */
|
---|
142 | typedef void * CF_Debug_Ctx;
|
---|
143 |
|
---|
144 | /** 콜스택 데이터 */
|
---|
145 | typedef struct cf_debug_callStack {
|
---|
146 | char file[NAME_LENGTH + 1]; /**< 파일 이름 */
|
---|
147 | char function[NAME_LENGTH + 1]; /**< 함수 이름 */
|
---|
148 | int line; /**< 라인 넘버 */
|
---|
149 | } CF_Debug_CallStack;
|
---|
150 |
|
---|
151 | #ifdef __cplusplus
|
---|
152 | extern "C" {
|
---|
153 | #endif
|
---|
154 |
|
---|
155 | /**
|
---|
156 | * 디버그 컨텍스트를 생성
|
---|
157 | *
|
---|
158 | * @return 성공 시, CF_Debug_Ctx 형태의 컨텍스트; 실패 시, NULL
|
---|
159 | * @see CF_DEBUG_CREATE_CTX
|
---|
160 | */
|
---|
161 | CF_EXPORT CF_Debug_Ctx
|
---|
162 | CF_Debug_CreateCtx (void);
|
---|
163 |
|
---|
164 | /**
|
---|
165 | * 디버그 컨텍스트를 해제
|
---|
166 | *
|
---|
167 | * @return 성공 시, CF_OK; 실패 시, 오류 코드
|
---|
168 | *
|
---|
169 | * @param ctx 디버그 컨텍스트
|
---|
170 | *
|
---|
171 | * @see CF_DEBUG_DESTROY_CTX
|
---|
172 | */
|
---|
173 | CF_EXPORT int
|
---|
174 | CF_Debug_DestroyCtx (CF_Debug_Ctx ctx);
|
---|
175 |
|
---|
176 | /**
|
---|
177 | * 디버그 컨텍스트에 출력할 파일 디스크립터를 설정
|
---|
178 | *
|
---|
179 | * @return 성공 시, CF_OK; 실패 시, 오류 코드
|
---|
180 | *
|
---|
181 | * @param ctx 디버그 컨텍스트
|
---|
182 | * @param fd 파일 디스크립터
|
---|
183 | *
|
---|
184 | * @see CF_File_Open, CF_File_Create
|
---|
185 | */
|
---|
186 | CF_EXPORT int
|
---|
187 | CF_Debug_SetOutputFD (CF_Debug_Ctx ctx,
|
---|
188 | int fd);
|
---|
189 |
|
---|
190 | /**
|
---|
191 | * 디버그 메시지를 지정된 파일 포인터로 출력
|
---|
192 | *
|
---|
193 | * @return 성공 시, CF_OK; 실패 시, 오류 코드
|
---|
194 | *
|
---|
195 | * @param fp 파일 포인터. 표준출력(stdout) 및 표준오류(stderr) 사용 가능
|
---|
196 | * @param file 파일 경로
|
---|
197 | * @param func 함수 이름
|
---|
198 | * @param line 라인 넘버
|
---|
199 | * @param fmt 포맷 스트링
|
---|
200 | * @param ... 가변 인자
|
---|
201 | *
|
---|
202 | * @see CF_DEBUG_PRINT
|
---|
203 | */
|
---|
204 | CF_EXPORT int
|
---|
205 | CF_Debug_Print (FILE * fp,
|
---|
206 | const char * file,
|
---|
207 | const char * func,
|
---|
208 | const int line,
|
---|
209 | const char * fmt, ...);
|
---|
210 |
|
---|
211 | /**
|
---|
212 | * 바이너리 데이터를 디버그 메시지와 함께 지정된 파일 포인터로 출력
|
---|
213 | *
|
---|
214 | * @return CF_OK 반환
|
---|
215 | *
|
---|
216 | * @param fp 파일 포인터. 표준출력(stdout) 및 표준오류(stderr) 사용 가능
|
---|
217 | * @param file 파일 경로
|
---|
218 | * @param func 함수 이름
|
---|
219 | * @param line 라인 넘버
|
---|
220 | * @param bin 라인 넘버
|
---|
221 | * @param len 바이너리 길이
|
---|
222 | * @param fmt 포맷 스트링
|
---|
223 | * @param ... 가변 인자
|
---|
224 | *
|
---|
225 | * @see CF_DEBUG_PRINT_BIN
|
---|
226 | */
|
---|
227 | CF_EXPORT int
|
---|
228 | CF_Debug_PrintBin (FILE * fp,
|
---|
229 | const char * file,
|
---|
230 | const char * func,
|
---|
231 | const int line,
|
---|
232 | const unsigned char * bin,
|
---|
233 | const int len,
|
---|
234 | const char * fmt, ...);
|
---|
235 |
|
---|
236 | /**
|
---|
237 | * 컨텍스트를 업데이트하고 디버그 메시지를 출력
|
---|
238 | *
|
---|
239 | * @return CF_OK 반환
|
---|
240 | *
|
---|
241 | * @param ctx 디버그 컨텍스트
|
---|
242 | * @param fmt 포맷 스트링
|
---|
243 | * @param ... 가변 인자
|
---|
244 | *
|
---|
245 | * @see CF_DEBUG_UPDATE_CTX, CF_Debug_Trace
|
---|
246 | */
|
---|
247 | CF_EXPORT int
|
---|
248 | CF_Debug_Trace (CF_Debug_Ctx ctx,
|
---|
249 | const char * fmt, ...);
|
---|
250 |
|
---|
251 | /**
|
---|
252 | * 컨텍스트를 업데이트하고 바이너리 데이터를 디버그 메시지와 함께 출력
|
---|
253 | *
|
---|
254 | * @return 성공 시, CF_OK; 실패 시, 오류 코드
|
---|
255 | *
|
---|
256 | * @param ctx 디버그 컨텍스트
|
---|
257 | * @param bin 바이너리 데이터
|
---|
258 | * @param len 바이너리 길이
|
---|
259 | * @param fmt 포맷 스트링
|
---|
260 | * @param ... 가변 인자
|
---|
261 | *
|
---|
262 | * @see CF_DEBUG_UPDATE_CTX, CF_DEBUG_TRACE_BIN
|
---|
263 | */
|
---|
264 | CF_EXPORT int
|
---|
265 | CF_Debug_TraceBin (CF_Debug_Ctx ctx,
|
---|
266 | const unsigned char * bin,
|
---|
267 | const int len,
|
---|
268 | const char * fmt, ...);
|
---|
269 |
|
---|
270 | /**
|
---|
271 | * 컨텍스트에 콜스택 푸시
|
---|
272 | *
|
---|
273 | * @return 성공 시, CF_OK; 실패 시, 오류 코드
|
---|
274 | *
|
---|
275 | * @param ctx 디버그 컨텍스트
|
---|
276 | * @param file 파일 경로
|
---|
277 | * @param func 함수 이름
|
---|
278 | * @param line 라인 넘버
|
---|
279 | *
|
---|
280 | * @see CF_DEBUG_CALLSTACK_PUSH
|
---|
281 | */
|
---|
282 | CF_EXPORT int
|
---|
283 | CF_Debug_CallStackPush (CF_Debug_Ctx ctx,
|
---|
284 | const char * file,
|
---|
285 | const char * func,
|
---|
286 | const int line);
|
---|
287 |
|
---|
288 | /**
|
---|
289 | * 컨텍스트에서 콜스택 팝
|
---|
290 | *
|
---|
291 | * @return 성공 시, CF_OK; 실패 시, 오류 코드
|
---|
292 | *
|
---|
293 | * @param ctx 디버그 컨텍스트
|
---|
294 | * @param callstack 콜스택 정보를 가져올 콜스택 데이터 구조체 포인터
|
---|
295 | *
|
---|
296 | * @see CF_Debug_CallStackPop, CF_Debug_CallStack
|
---|
297 | */
|
---|
298 | CF_EXPORT int
|
---|
299 | CF_Debug_CallStackPop (CF_Debug_Ctx ctx,
|
---|
300 | CF_Debug_CallStack * callstack);
|
---|
301 |
|
---|
302 | #ifdef __cplusplus
|
---|
303 | }
|
---|
304 | #endif
|
---|
305 |
|
---|
306 | #endif // #ifndef __CF_DEBUG_H__
|
---|