Một vài macro hữu dụng trong C
Thấy mọi người đang thảo luận về Macro trong C. Macro có rất nhiều cách sử dụng “ảo diệu”. Nhưng bài này chỉ nói về một số macro hữu dụng cho cho việc thêm log cho code C/C++.
Có bao giờ bạn debug một code C/C++ bằng một loạt các lệnh printf không?
Rồi đến khi fix xong ta lại đi xóa đóng code rác đó vì nếu không xóa đi, khách hàng có thể hỏi :”Dòng đó để làm gì, tại sao lại in ra trị ở đây?”
Có khi nào log của của trình C/C++ nào khiến bạn quá khó để theo dõi vì chúng chẳng được canh lề gì cả. Hoặc có in ra log đấy nhưng quên không in ra thông tin về dòng nào ?
Hoặc bạn đã in quá nhiều log phải tắt một số log đi.
Dưới đây là một số macro dùng cho việc in log, vì cách gọi giống hệt cách gọi các hàm trong C/C++ nên dù có log thì code vẫn không quá khó nhìn.
Link tham khảo:
- http://stackoverflow.com/questions/1644868/c-define-macro-for-debug-printing
- http://c.learncodethehardway.org/book/ex20.html
Ta sẽ có một file chứa vài macro sẽ nói đến ở đây:
debug_macro.h
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 | #ifndef __debug_macro__ #define __debug_macro__ #include <stdio.h> #include <string.h> #include <stdarg.h> // // Khi không cần in ra log nữa ta đơn giản định nghĩa macro NDEBUG (tức là No Debug) bằng dòng bên dưới. // Khi biên dich, các đoạn mã trống do {} while(0); sẽ bị xóa hết do tối ưu. // Vì thế hầu như không ảnh hưởng đến code chính. //#define NDEBUG (1) #ifdef NDEBUG #define log_debug(fmt, ...) do {} while (0) #define log_err(fmt, ...) do {} while (0) #define log_warn(fmt, ...) do {} while (0) #define log_info(fmt, ...) do {} while (0) #else // NDEBUG // // Dành cho việc in ra log debug // #define log_debug(fmt, ...) do { fprintf(stderr, "[DEBUG] %10s:%10d:%15s(): " fmt, __FILE__, __LINE__, __func__,## __VA_ARGS__); } while (0) // // Dành cho việc in ra log lỗi // #define log_err(fmt, ...) do { fprintf(stderr, "[ERROR] %10s:%10d:%15s(): " fmt, __FILE__, __LINE__, __func__,## __VA_ARGS__); } while (0) // // Dành cho việc in ra log lỗi // #define log_warn(fmt, ...) do { fprintf(stderr, "[WARN] %10s:%10d:%15s(): " fmt, __FILE__, __LINE__, __func__, ##__VA_ARGS__); } while (0) // // Dành cho việc in ra các thông tin khác. // #define log_info(fmt, ...) do { fprintf(stderr, "[INFO] %10s:%10d:%15s(): " fmt, __FILE__, __LINE__, __func__, ##__VA_ARGS__); } while (0) #endif //NDEBUG #endif // __debug_macro__ |
Các sử dụng mấy macro trên khá đơn giản, vì hàm trên được khai báo sử dụng với tham số thay đổi được.
Nên ta sử dụng giống hệt với các hàm printf mà ta vẫn biết.
Ví dụ
1 2 3 4 5 | log_debug("Đây là log debug n"); //.... log_err"Đây là log lỗi n"); //... log_info"Đây là log info n"); |
Môt ví dụ sử dụng
Định viết lại “Hello World” kinh điển nhưng thấy nó cũ quá. Và mình thấy giờ thấy đề bài sau chắc cũng sắp thành kinh điển rồi.
Yêu cầu : Viết chương trình mô tả luồng công việc của một programmer.
Mã giả:
- Vận công nghĩ keyword
- Tìm kiếm keyword trên google
- Xem link 1, xem có code sample không? Nếu có đến step 4, nếu không xem link tiếp theo.
- Chạy thử code sample, nếu chạy đúng, thì kết thúc, nếu chạy sai thì trở về step 3 xem link tiếp.
- Xem hết link mà không có kết quả, thì quay lại step 1 nghĩ từ khóa khác.
Các file source code cho chương trình trên như sau:
resultLinks.txt
1 2 3 4 5 | "www.lx.com", "www.facebook.com", "www.stackoverflow.com", "www.segmentfault.com", "www.kipalog.com" |
program.c
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 | #include <stdio.h> #include <stdarg.h> #include"debug_macro.h"// #define MAX_LINK_LENGTH (100) #define MAX_NUM_LINK (20) #define N_DUMMY_LINKS (5) #define N_DUMMY_RESULT_SITE (2) // // Dummy danh sách links kết quả tìm kiếm từ google // const char* DUMMY_RESULT_LINKS[] = { #include"resultLinks.txt" }; // // Dummy những site có sample source // const char* DUMMY_HAS_SOURCE_CODE_SITE[]= { "www.stackoverflow.com", "www.kipalog.com" }; // // Hàm tìm kiếm từ khóa trên google, trả về kết quả là danh sách link // void search_google(char* keyword, char result[MAX_NUM_LINK][MAX_LINK_LENGTH], int *nResults) { int i = 0; log_debug("Search google : (keyword=%s) START n", keyword); for (i = 0; i < N_DUMMY_LINKS; i++) { strcpy(result[i], DUMMY_RESULT_LINKS[i]); } *nResults = N_DUMMY_LINKS; log_debug("Search google : (nResults=%d) END n", *nResults); } // // Hàm chạy source sample từ một link đưa vào từ tham số // int runSource(char* link) { int retVal = 1; //log_debug("Run source in (link=%s) START n",link); if (strstr(link, "www.kipalog.com") != NULL) { log_debug("OK, It works!!!!n"); retVal = 1; } else { log_err("Hmm, Bad source (link=%s) n",link); retVal = 0; } //log_debug("Run source in (link=%s) END n",link); return retVal; } // // Hàm kiểm tra một link có chưa sample source hay không. // int hasSampleSource(char* link) { int i = 0; int retVal = 0; //log_debug("Check source (link=%s) START n",link); for (i = 0; i < N_DUMMY_RESULT_SITE; i++) { if (strstr(link, DUMMY_HAS_SOURCE_CODE_SITE[i]) != NULL) { retVal = 1; break; } } //log_debug("Check source (link=%s) END n",link); return retVal; } // // Hàm start-up // int main(int argc, char* argv[]) { char *keyword; char results[MAX_NUM_LINK][MAX_LINK_LENGTH]; int nResults; int i = 0; // Kiểm tra tham số if (2 != argc) { log_err("Invalid parameter, usage: %s <keyword>n",argv[0]); return 0; } // Lấy keyword keyword = argv[1]; // Tìm google search_google(&keyword[0], results, &nResults); if (nResults > 0)// Nếu có kết quả { // Duyệt từng link kết quả for (i = 0; i < nResults; i++) { log_debug("Try (link=%s) n",results[i]); if (hasSampleSource(results[i]))// Kiểm tra xem có sample source hay không { // Chạy thử source sample runSource(results[i]); } else { log_err("No source in link :%sn", results[i]); } } } else{ log_err("Keyword is so difficult (keyword=%s) n", keyword); } return 0; } |
Build xong và chạy.
Kết quả sau khi thực hiện sẽ như thế này:
1 2 3 4 5 6 7 8 9 10 11 12 13 | oedev@OECrossDev:~/Code/Kipalog$ ./program hello [DEBUG] program.c: 26: search_google(): Search google : (keyword=hello) START [DEBUG] program.c: 33: search_google(): Search google : (nResults=5) END [DEBUG] program.c: 95: main(): Try (link=www.lx.com) [ERROR] program.c: 102: main(): No source in link :www.lx.com [DEBUG] program.c: 95: main(): Try (link=www.facebook.com) [ERROR] program.c: 102: main(): No source in link :www.facebook.com [DEBUG] program.c: 95: main(): Try (link=www.stackoverflow.com) [ERROR] program.c: 48: runSource(): Hmm, Bad source (link=www.stackoverflow.com) [DEBUG] program.c: 95: main(): Try (link=www.segmentfault.com) [ERROR] program.c: 102: main(): No source in link :www.segmentfault.com [DEBUG] program.c: 95: main(): Try (link=www.kipalog.com) [DEBUG] program.c: 43: runSource(): OK, It works!!!! |
Ta thấy log được hiển thị theo các TAG, các thông tin debug cũng được in ra.
Ta có thể dùng các tool view log để phân tích những file log dài một cách dễ dàng hơn. Ví dụ glogg chẳng hạn, ta gán màu cho từng loại TAG (ERROR, DEBUG) thì việc phân tích log sẽ trở nên dễ hiểu hơn.
Tắt việc hiển thị log
Đơn giản ta comment out lại một dòng ở file debug_macro.h, sẽ không có gì hiện ra nữa.
Thêm thông tin vào nội dung log
Log ở trên chứa các thông tin về tên file, hàm, dòng code cũng tương đối đủ để trace lỗi.
Nhưng trong một số trường hợp, nhất là với các ứng dụng nhiều thread chẳng hạn, ta muốn thêm giá trị về thời gian nữa.
Ta có thể tùy biết các macro ở trong file debug_macro.h, có nhiều cách tùy múc đích của việc in log:
Đây là một cách trong đó:
debug_macro.h
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 | #ifndef __debug_macro__ #define __debug_macro__ #include <stdio.h> #include <string.h> #include <stdarg.h> #include <time.h>// Cần cho việc lấy time // // Hàm hiển thị log có thêm nhãn thời gian // void time_printf(const char *fmt, ... ) { // Tính thời gian hiện tại time_t rawtime; struct tm * timeinfo; time ( &rawtime ); timeinfo = localtime ( &rawtime ); fprintf (stderr, "[%d-%d-%d_%d:%d:%d] ", timeinfo->tm_year + 1900,timeinfo->tm_mon + 1, timeinfo->tm_mday, timeinfo->tm_hour, timeinfo->tm_min, timeinfo->tm_sec); // Hiển thị log như cũ va_list args; va_start(args, fmt); vfprintf(stderr, fmt, args); va_end(args); } #ifdef NDEBUG #define log_debug(fmt, ...) do {} while (0) #define log_err(fmt, ...) do {} while (0) #define log_warn(fmt, ...) do {} while (0) #define log_info(fmt, ...) do {} while (0) #else // NDEBUG #define log_debug(fmt, ...) do { time_printf("[DEBUG] %10s:%10d:%15s(): " fmt, __FILE__, __LINE__, __func__, ##__VA_ARGS__); } while (0) #define log_err(fmt, ...) do { time_printf("[ERROR] %10s:%10d:%15s(): " fmt, __FILE__, __LINE__, __func__,## __VA_ARGS__); } while (0) #define log_warn(fmt, ...) do { time_printf("[WARN] %10s:%10d:%15s(): " fmt, __FILE__, __LINE__, __func__, ##__VA_ARGS__); } while (0) #define log_info(fmt, ...) do { time_printf("[INFO] %10s:%10d:%15s(): " fmt, __FILE__, __LINE__, __func__, ##__VA_ARGS__); } while (0) #endif //NDEBUG #endif // __debug_macro__ |
Kết quả chạy sẽ như sau:
1 2 3 4 5 6 7 8 9 10 11 12 13 | oedev@OECrossDev:~/Code/Kipalog$ ./program hello [2015-9-1_23:20:58] [DEBUG] program.c: 35: search_google(): Search google : (keyword=hello) START [2015-9-1_23:20:58] [DEBUG] program.c: 43: search_google(): Search google : (nResults=5) END [2015-9-1_23:20:58] [DEBUG] program.c: 118: main(): Try (link=www.lx.com) [2015-9-1_23:20:58] [ERROR] program.c: 126: main(): No source in link :www.lx.com [2015-9-1_23:20:58] [DEBUG] program.c: 118: main(): Try (link=www.facebook.com) [2015-9-1_23:20:58] [ERROR] program.c: 126: main(): No source in link :www.facebook.com [2015-9-1_23:20:58] [DEBUG] program.c: 118: main(): Try (link=www.stackoverflow.com) [2015-9-1_23:20:58] [ERROR] program.c: 61: runSource(): Hmm, Bad source (link=www.stackoverflow.com) [2015-9-1_23:20:58] [DEBUG] program.c: 118: main(): Try (link=www.segmentfault.com) [2015-9-1_23:20:58] [ERROR] program.c: 126: main(): No source in link :www.segmentfault.com [2015-9-1_23:20:58] [DEBUG] program.c: 118: main(): Try (link=www.kipalog.com) [2015-9-1_23:20:58] [DEBUG] program.c: 56: runSource(): OK, It works!!!! |
Trong file mới, thay vì gọi các hàm fprintf thì ta gọi đến một hàm khác là time_printf để in log và có cả thơi gian nữa.
Trên đây là tất cả những gì mình có nhớ được. Mình cũng từng thấy người ta tùy biến việc xuất log theo một số cách khác phức tạp hơn như theo level (cái này giống thư viện log4j, log4net của Apache Team).
Trong một số thiết bị nhúng, nơi mà stdin không phải bàn phím, stdout không phải màn hình.
Khi ấy có thể, người ta phải viết code cho hàm *fprintf để xuất log ra đâu đó như serial chẳng hạn, etc.
Phùng Văn Tú
ITZone via Kipalog