Linux C 日志模块（附代码）给有用的人

测试积点老人

在产品研发的过程中，经常需要借助打印信息来帮助调试和后期维护。所以拥有一个完善的日志模块是至关重要的。

如下是从经手的项目中整理出来的日志模块及使用示例，以备后续项目开发时使用。（备注：Linux环境下）

log.c

1. #include <stdio.h>
   
2. #include <stdlib.h>
   
3. #include <sys/time.h>
   
4. #include <sys/types.h>
   
5. #include <sys/stat.h>
   
6. #include <unistd.h>
   
7. #include <string.h>
   
8. #include <time.h>
   
9. #include <ctype.h>
   
10. #include <pthread.h>
    
11. #include "log.h"
    
12. 
    
13. /*存储日志的文件名*/
    
14. 
    
15. static unsigned char g_ucLogFileName[MAX_LOG_FILE_NUM][STR_COMM_SIZE] = {{0}};
    
16. 
    
17. /*指明是g_ucLogFileName中的哪个文件*/
    
18. static unsigned char g_ucLogFileNo = 0;
    
19. 
    
20. /*输出日志位置标记,0-输出到终端,1-输出到日志文件*/
    
21. unsigned long g_ulPrintLogPlaceFlag = 0;
    
22. /*是否打印调试日志标记,0-不打印调试日志,1-打印调试日志*/
    
23. unsigned long g_ulPrintDebugLogFlag = 0;
    
24. 
    
25. /*日志文件大小*/
    
26. static unsigned long g_ulLogFileSize = 0;
    
27. 
    
28. /*日志文件句柄*/
    
29. static FILE* pFile = NULL;
    
30. 
    
31. /*日志存储互斥锁*/
    
32. static pthread_mutex_t g_stSaveLogMutexLock;
    
33. 
    
34. /*日志模块初始化标记*/
    
35. static unsigned long g_ulLogInitFlag = 0;
    
36. 
    
37. 
    
38. void LOG_SetPrintLogPlaceFlag(unsigned long flag)
    
39. {
    
40. g_ulPrintLogPlaceFlag = flag;
    
41. }
    
42. 
    
43. void LOG_SetPrintDebugLogFlag(unsigned long flag)
    
44. {
    
45. g_ulPrintDebugLogFlag = flag;
    
46. }
    
47. 
    
48. 
    
49. /*****************************************************************
    
50. ** 函数名: get_file_size
    
51. ** 输 入: char *path
    
52. ** 输 出:
    
53. ** 功能描述:获取指令文件大小
    
54. ** 返回值: long
    
55. ****************************************************************/
    
56. static long get_file_size(const char *path)
    
57. {
    
58. long filesize = -1;
    
59. struct stat statbuff;
    
60. 
    
61. if(stat(path, &statbuff) < 0){
    
62.      return filesize;
    
63. }
    
64. else{
    
65.      filesize = statbuff.st_size;
    
66. }
    
67. return filesize;
    
68. }
    
69. 
    
70. /*****************************************************************
    
71. ** 函数名: unsigned long LOG_PrintLogTime
    
72. ** 输 入:  unsigned long ulBufLen 存储时间的空间长度
    
73. ** 输 出:unsigned char *ucTime  存储时间
    
74. ** 功能描述:日志输出
    
75. ** 返回值:unsigned long
    
76. ****************************************************************/
    
77. unsigned long LOG_PrintLogTime(unsigned char *ucTime, unsigned long ulBufLen)
    
78. {
    
79.     struct tm* pstTmSec;
    
80.     struct timeval stTmMsec;
    
81. 
    
82. if(NULL == ucTime)
    
83. {
    
84.   return -1;
    
85. }
    
86. gettimeofday(&stTmMsec, NULL);
    
87. pstTmSec = localtime(&stTmMsec.tv_sec);
    
88. snprintf((char *)ucTime, ulBufLen - 1, "%04d-%02d-%02d %02d:%02d:%02d %03ldms",
    
89.             pstTmSec->tm_year + 1900, pstTmSec->tm_mon + 1, pstTmSec->tm_mday, pstTmSec->tm_hour,
    
90.             pstTmSec->tm_min, pstTmSec->tm_sec, stTmMsec.tv_usec / 1000);
    
91. 
    
92. return 0;
    
93. }
    
94. 
    
95. /*****************************************************************
    
96. ** 函数名:  unsigned char *LOG_LogTypeToStr
    
97. ** 输 入:   unsigned char ucType  日志类型
    
98.    unsigned long ulBufLen 存储日志类型字符串空间的长度
    
99. ** 输 出:unsigned char *pucTypeString 根据日志类型将其转换成相应的字符串
    
100. ** 功能描述:根据日志类型转换成相应的字符串
     
101. ** 返回值:unsigned long
     
102. ****************************************************************/
     
103. unsigned long LOG_LogTypeToStr(unsigned char ucType, unsigned char *pucTypeString, unsigned long ulBufLen)
     
104. {
     
105. if(NULL == pucTypeString)
     
106. {
     
107.   return -1;
     
108. }
     
109. /*防止发生越界*/
     
110. ulBufLen -= 1;
     
111. 
     
112. switch(ucType)
     
113. {
     
114.   case LOG_DEBUG:
     
115.   {
     
116.    strncpy((char *)pucTypeString, "DEBUG", ulBufLen);
     
117.    break;
     
118.   }
     
119.   case LOG_ERROR:
     
120.   {
     
121.    strncpy((char *)pucTypeString, "ERROR", ulBufLen);
     
122.    break;
     
123.   }
     
124.   case LOG_WARNING:
     
125.   {
     
126.    strncpy((char *)pucTypeString, "WARNING", ulBufLen);
     
127.    break;
     
128.   }
     
129.   case LOG_ACTION:
     
130.   {
     
131.    strncpy((char *)pucTypeString, "ACTION", ulBufLen);
     
132.    break;
     
133.   }
     
134.   case LOG_SYSTEM:
     
135.   {
     
136.    strncpy((char *)pucTypeString, "SYSTEM", ulBufLen);
     
137.    break;
     
138.   }
     
139.   default:
     
140.   {
     
141.    strncpy((char *)pucTypeString, "UNKNOWN", ulBufLen);
     
142.    break;
     
143.   }
     
144. }
     
145. return 0;
     
146. }
     
147. 
     
148. /*****************************************************************
     
149. ** 函数名: unsigned long LOG_OpenLogFile
     
150. ** 输 入:  void
     
151. ** 输 出:void
     
152. ** 功能描述:打开日志文件
     
153. ** 返回值:unsigned long
     
154. ****************************************************************/
     
155. unsigned long LOG_OpenLogFile(void)
     
156. {
     
157. char *path = (char*)g_ucLogFileName[g_ucLogFileNo];
     
158. char *flag = NULL;
     
159. int len = 0;
     
160. 
     
161. /*判断文件是否已经打开*/
     
162. if(NULL != pFile)
     
163. {
     
164.   LOG_PRINT("[ACTION] file opened!");
     
165.   return 0;
     
166. }
     
167. /*判断文件名是否有定义*/
     
168. if(NULL == path)
     
169. {
     
170.   LOG_PRINT("[ERROR] file name is NULL.");
     
171.   return -1;
     
172. }
     
173. 
     
174. /*判断文件是否存在*/
     
175. if (!access(path, 0))
     
176. {
     
177.   /*获取文件大小*/
     
178.   if (0 > (len = get_file_size(path)))
     
179.   {
     
180.    LOG_PRINT("[ERROR] get file size failed!");
     
181.    return -1;
     
182.   }
     
183. }
     
184. flag = (len > 0 && len < g_ulLogFileSize) ? "a" : "w";
     
185. 
     
186. /*打开文件*/
     
187. pFile = fopen(path, flag);
     
188. if(NULL == pFile)
     
189. {
     
190.   LOG_PRINT("[ERROR] open file failed!");
     
191.   return -1;
     
192. }
     
193. LOG_PRINT("[DEBUG] open file name = %s", path);
     
194. return 0;
     
195. }
     
196. 
     
197. /*****************************************************************
     
198. ** 函数名: LOG_PrintLog
     
199. ** 输 入:  unsigned char *ucLogInfo  需要打印或者存储的日志信息
     
200.    unsigned char ucType 日志类型
     
201. ** 输 出:void
     
202. ** 功能描述:日志输出
     
203. ** 返回值:unsigned long
     
204. ****************************************************************/
     
205. unsigned long LOG_PrintLog(unsigned char ucType, unsigned char *pucLogInfo)
     
206. {
     
207. unsigned long ulResult = 0;
     
208. unsigned long ulFileLen = 0;
     
209. unsigned char ucTime[STR_COMM_SIZE] = {0};
     
210. unsigned char ucLogTypeStr[STR_COMM_SIZE] = {0};
     
211. unsigned char ucLogInfo[STR_MAX_SIZE] = {0};
     
212. 
     
213. if(NULL == pucLogInfo)
     
214. {
     
215.   return -1;
     
216. }
     
217. 
     
218. /*将日志类型转换成字符串*/
     
219. ulResult = LOG_LogTypeToStr(ucType, ucLogTypeStr, sizeof(ucLogTypeStr));
     
220. /*获取生成日志的时间*/
     
221. ulResult += LOG_PrintLogTime(ucTime, sizeof(ucTime));
     
222. if(0 != ulResult)
     
223. {
     
224.   return -1;
     
225. }
     
226. snprintf((char *)ucLogInfo, sizeof(ucLogInfo) - 1, "[%s] [%s] %s", ucTime, ucLogTypeStr, pucLogInfo);
     
227. /*判断是否打印调试日志*/
     
228. if(PRINT_LOG_TO_TERM == g_ulPrintLogPlaceFlag)
     
229. {
     
230.   printf("%s", ucLogInfo);
     
231.   return 0;
     
232. }
     
233. /*加锁保护文件操作*/
     
234. pthread_mutex_lock(&g_stSaveLogMutexLock);
     
235. /*打开日志文件*/
     
236. (void)LOG_OpenLogFile();
     
237. if(NULL != pFile)
     
238. {
     
239.   fputs((char *)ucLogInfo, pFile);
     
240.   ulFileLen = ftell(pFile);
     
241.   LOG_PRINT("file len = %ld", ulFileLen);
     
242.   if(ulFileLen >= g_ulLogFileSize)
     
243.   {
     
244.    fclose(pFile);
     
245.    pFile = NULL;
     
246.    g_ucLogFileNo = (g_ucLogFileNo + 1) % MAX_LOG_FILE_NUM;
     
247.   }
     
248. }
     
249. pthread_mutex_unlock(&g_stSaveLogMutexLock);
     
250. return 0;
     
251. }
     
252. 
     
253. /*****************************************************************
     
254. ** 函数名: LOG_Init
     
255. ** 输 入:  const unsigned char* ucLogFileName  用来保存日志的文件名
     
256.    unsigned long ulFileSize 存储日志的文件大小
     
257. ** 输 出:void
     
258. ** 功能描述:日志打印初始化
     
259. ** 返回值:unsigned long
     
260. ****************************************************************/
     
261. unsigned long LOG_Init(const unsigned char* ucLogFileName, unsigned long ulFileSize)
     
262. {
     
263. unsigned int i = 0;
     
264. /*判断参数的合法性*/
     
265. if((NULL == ucLogFileName) || !(ulFileSize > 0))
     
266. {
     
267.   return -1;
     
268. }
     
269. /*判断是否将日志输出到日志文件*/
     
270. if((PRINT_LOG_TO_FILE != g_ulPrintLogPlaceFlag) || (0 != g_ulLogInitFlag))
     
271. {
     
272.   printf("g_ulPrintLogPlaceFlag = %ld g_ulLogInitFlag = %ld\n",g_ulPrintLogPlaceFlag,g_ulLogInitFlag);
     
273.   LOG_PRINT("print log to termination!!");
     
274.   return 0;
     
275. }
     
276. 
     
277. /*记录日志模块已经被初始化(防止改模块被重复初始化)*/
     
278. g_ulLogInitFlag = 1;
     
279. 
     
280. /*生成存储日志的文件名*/
     
281. for(i = 0; i < NUMBER(g_ucLogFileName); i++)
     
282. {
     
283.   snprintf((char *)g_ucLogFileName[i], sizeof(g_ucLogFileName[i]) - 1, "%s_%02d", ucLogFileName, i);
     
284.   LOG_PRINT("Log File: %s", g_ucLogFileName[i]);
     
285.   printf("Log File: %s\n", g_ucLogFileName[i]);
     
286. }
     
287. /*设置日志文件大小*/
     
288. g_ulLogFileSize = ulFileSize;
     
289. pthread_mutex_init(&g_stSaveLogMutexLock, NULL);
     
290. 
     
291. return 0;
     
292. }
     
293. 
     
294. /*****************************************************************
     
295. ** 函数名: LOG_Destroy
     
296. ** 输 入:  void
     
297. ** 输 出:void
     
298. ** 功能描述:日志打印资源释放
     
299. ** 返回值:unsigned long
     
300. ****************************************************************/
     
301. void LOG_Destroy(void)
     
302. {
     
303. if(pFile != NULL)
     
304. {
     
305.   fclose(pFile);
     
306.   pFile = NULL;
     
307. }
     
308. pthread_mutex_destroy(&g_stSaveLogMutexLock);
     
309. return;
     
310. }
     

复制代码

测试积点老人

log.h

1. #ifndef _LOG_H_
   
2. #define _LOG_H_
   
3. #include <string.h>
   
4. 
   
5. /*通用字符串存储大小定义*/
   
6. #define STR_COMM_SIZE 128
   
7. #define STR_MAX_SIZE 1024
   
8. 
   
9. #define MAX_LOG_FILE_NUM    (3)
   
10. 
    
11. #define NUMBER(type) sizeof(type)/sizeof(type[0])
    
12. 
    
13. #define __FILENAME__ (strrchr(__FILE__, '/') ? (strrchr(__FILE__, '/') + 1) : __FILE__)
    
14. 
    
15. /*日志类型*/
    
16. enum
    
17. {
    
18.     LOG_DEBUG = 0,/*调试日志*/
    
19.     LOG_ERROR,/*错误日志*/
    
20.     LOG_WARNING,/*告警日志*/
    
21.     LOG_ACTION,/*运行日志*/
    
22.     LOG_SYSTEM,/*系统日志*/
    
23.     BUTTOM
    
24. };
    
25. 
    
26. /*将日志输出到终端*/
    
27. #define PRINT_LOG_TO_TERM (0)
    
28. /*将日志输出到文件中*/
    
29. #define PRINT_LOG_TO_FILE (1)
    
30. 
    
31. /*调试日志宏定义*/
    
32. #define DEBUG_PRINT 0
    
33. #define LOG_PRINT(fmt, ...) do{\
    
34. if(DEBUG_PRINT)\
    
35. {\
    
36.   printf(fmt"  [line:%d] [%s]\n", ##__VA_ARGS__, __LINE__, __FUNCTION__);\
    
37. }\
    
38. }while(0);
    
39. 
    
40. /*错误日志打印(在日志打印模块还未启动时使用)*/
    
41. #define LOG_ERR(fmt, ...) do{\
    
42. printf("[ERROR]  "fmt"  [line:%d] [%s]\n", ##__VA_ARGS__, __LINE__, __FUNCTION__);\
    
43. }while(0);
    
44. 
    
45. 
    
46. 
    
47. /*存储日志标记. 0-不存储日志, 1-存储日志*/
    
48. extern unsigned long g_ulPrintLogPlaceFlag;
    
49. 
    
50. /*是否打印调试日志标记,0-不打印调试日志,1-打印调试日志*/
    
51. extern unsigned long g_ulPrintDebugLogFlag;
    
52. 
    
53. unsigned long LOG_PrintLog(unsigned char ucType, unsigned char *pucLogInfo);
    
54. 
    
55. 
    
56. /*日志打印宏定义*/
    
57. #define LOG_INFO(type, fmt, ...) do{\
    
58. if(PRINT_LOG_TO_TERM == g_ulPrintLogPlaceFlag) \
    
59. { \
    
60.   if((0 == g_ulPrintDebugLogFlag) && (LOG_DEBUG == type)) \
    
61.   {\
    
62.    break;\
    
63.   }\
    
64.      unsigned char ucLogInfo[STR_MAX_SIZE] = {0}; \
    
65.   snprintf((char *)ucLogInfo, sizeof(ucLogInfo) - 1, fmt"  [%s] [line:%d] [%s]\n", ##__VA_ARGS__, __FILENAME__, __LINE__, __FUNCTION__); \
    
66.   LOG_PrintLog(type, ucLogInfo); \
    
67. } \
    
68. else \
    
69. { \
    
70.   unsigned char ucLogInfo[STR_MAX_SIZE] = {0}; \
    
71.   snprintf((char *)ucLogInfo, sizeof(ucLogInfo) - 1, fmt"  [%s] [line:%d] [%s]\n", ##__VA_ARGS__, __FILENAME__, __LINE__, __FUNCTION__); \
    
72.   LOG_PrintLog(type, ucLogInfo); \
    
73. } \
    
74. }while(0)
    
75. 
    
76. 
    
77. /*是否打印调试日志标记,0-不打印调试日志,1-打印调试日志*/
    
78. extern void LOG_SetPrintDebugLogFlag(unsigned long flag);
    
79. /*存储日志标记. 0-不存储日志, 1-存储日志*/
    
80. extern void LOG_SetPrintLogPlaceFlag(unsigned long flag);
    
81. 
    
82. extern unsigned long LOG_Init(const unsigned char* ucLogFileName, unsigned long ulFileSize);
    
83. extern void LOG_Destroy(void);
    
84. 
    
85. #endif //_LOG_H_
    

复制代码

main.c

1. #include <stdio.h>
   
2. #include "log.h"
   
3. 
   
4. int test_func1()
   
5. {
   
6. LOG_INFO(LOG_DEBUG, "%s", "hello world!!");
   
7. return 0;
   
8. }
   
9. 
   
10. int main(int argc, char *argv[])
    
11. {
    
12. LOG_SetPrintDebugLogFlag(1);//打印调试信息
    
13. //LOG_SetPrintLogPlaceFlag(1);//保存打印信息到文件
    
14. LOG_Init("info", 8000);
    
15. 
    
16. LOG_INFO(LOG_DEBUG, "%s", "Init log!!");
    
17. 
    
18. test_func1();
    
19. 
    
20. LOG_INFO(LOG_DEBUG, "%s", "Destroy log!!");
    
21. LOG_Destroy();
    
22. }
    

复制代码

执行结果：

由执行结果可以看出一条打印信息包含了时间、日志类型、内容、文件名、行号、函数名等信息，这样就能够方便快速的定位问题，其使用方法也与printf函数类似，简单方便。

其次该日志模块还支持将日志存至文件，可以自行定义文件的大小及个数，日志循环覆盖。