ulog.c 42 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593
  1. /*
  2. * Copyright (c) 2006-2022, RT-Thread Development Team
  3. *
  4. * SPDX-License-Identifier: Apache-2.0
  5. *
  6. * Change Logs:
  7. * Date Author Notes
  8. * 2018-08-25 armink the first version
  9. */
  10. #include <stdarg.h>
  11. #include "ulog.h"
  12. #include "rthw.h"
  13. #ifdef ULOG_USING_SYSLOG
  14. #include <syslog.h>
  15. #endif
  16. #ifdef ULOG_TIME_USING_TIMESTAMP
  17. #include <sys/time.h>
  18. #endif
  19. #ifdef ULOG_USING_ASYNC_OUTPUT
  20. #include <rtdevice.h>
  21. #endif
  22. #ifdef RT_USING_ULOG
  23. /* the number which is max stored line logs */
  24. #ifndef ULOG_ASYNC_OUTPUT_STORE_LINES
  25. #define ULOG_ASYNC_OUTPUT_STORE_LINES (ULOG_ASYNC_OUTPUT_BUF_SIZE * 3 / 2 / 80)
  26. #endif
  27. #ifdef ULOG_USING_COLOR
  28. /**
  29. * CSI(Control Sequence Introducer/Initiator) sign
  30. * more information on https://en.wikipedia.org/wiki/ANSI_escape_code
  31. */
  32. #define CSI_START "\033["
  33. #define CSI_END "\033[0m"
  34. /* output log front color */
  35. #define F_BLACK "30m"
  36. #define F_RED "31m"
  37. #define F_GREEN "32m"
  38. #define F_YELLOW "33m"
  39. #define F_BLUE "34m"
  40. #define F_MAGENTA "35m"
  41. #define F_CYAN "36m"
  42. #define F_WHITE "37m"
  43. /* output log default color definition */
  44. #ifndef ULOG_COLOR_DEBUG
  45. #define ULOG_COLOR_DEBUG RT_NULL
  46. #endif
  47. #ifndef ULOG_COLOR_INFO
  48. #define ULOG_COLOR_INFO (F_GREEN)
  49. #endif
  50. #ifndef ULOG_COLOR_WARN
  51. #define ULOG_COLOR_WARN (F_YELLOW)
  52. #endif
  53. #ifndef ULOG_COLOR_ERROR
  54. #define ULOG_COLOR_ERROR (F_RED)
  55. #endif
  56. #ifndef ULOG_COLOR_ASSERT
  57. #define ULOG_COLOR_ASSERT (F_MAGENTA)
  58. #endif
  59. #endif /* ULOG_USING_COLOR */
  60. #if ULOG_LINE_BUF_SIZE < 80
  61. #error "the log line buffer size must more than 80"
  62. #endif
  63. struct rt_ulog
  64. {
  65. rt_bool_t init_ok;
  66. rt_bool_t output_lock_enabled;
  67. struct rt_mutex output_locker;
  68. /* all backends */
  69. rt_slist_t backend_list;
  70. /* the thread log's line buffer */
  71. char log_buf_th[ULOG_LINE_BUF_SIZE + 1];
  72. #ifdef ULOG_USING_ISR_LOG
  73. /* the ISR log's line buffer */
  74. rt_base_t output_locker_isr_lvl;
  75. char log_buf_isr[ULOG_LINE_BUF_SIZE + 1];
  76. #endif /* ULOG_USING_ISR_LOG */
  77. #ifdef ULOG_USING_ASYNC_OUTPUT
  78. rt_bool_t async_enabled;
  79. rt_rbb_t async_rbb;
  80. /* ringbuffer for log_raw function only */
  81. struct rt_ringbuffer *async_rb;
  82. rt_thread_t async_th;
  83. struct rt_semaphore async_notice;
  84. #endif
  85. #ifdef ULOG_USING_FILTER
  86. struct
  87. {
  88. /* all tag's level filter */
  89. rt_slist_t tag_lvl_list;
  90. /* global filter level, tag and keyword */
  91. rt_uint32_t level;
  92. char tag[ULOG_FILTER_TAG_MAX_LEN + 1];
  93. char keyword[ULOG_FILTER_KW_MAX_LEN + 1];
  94. } filter;
  95. #endif /* ULOG_USING_FILTER */
  96. };
  97. /* level output info */
  98. static const char * const level_output_info[] =
  99. {
  100. "A/",
  101. RT_NULL,
  102. RT_NULL,
  103. "E/",
  104. "W/",
  105. RT_NULL,
  106. "I/",
  107. "D/",
  108. };
  109. #ifdef ULOG_USING_COLOR
  110. /* color output info */
  111. static const char * const color_output_info[] =
  112. {
  113. ULOG_COLOR_ASSERT,
  114. RT_NULL,
  115. RT_NULL,
  116. ULOG_COLOR_ERROR,
  117. ULOG_COLOR_WARN,
  118. RT_NULL,
  119. ULOG_COLOR_INFO,
  120. ULOG_COLOR_DEBUG,
  121. };
  122. #endif /* ULOG_USING_COLOR */
  123. /* ulog local object */
  124. static struct rt_ulog ulog = { 0 };
  125. rt_size_t ulog_strcpy(rt_size_t cur_len, char *dst, const char *src)
  126. {
  127. const char *src_old = src;
  128. RT_ASSERT(dst);
  129. RT_ASSERT(src);
  130. while (*src != 0)
  131. {
  132. /* make sure destination has enough space */
  133. if (cur_len++ < ULOG_LINE_BUF_SIZE)
  134. {
  135. *dst++ = *src++;
  136. }
  137. else
  138. {
  139. break;
  140. }
  141. }
  142. return src - src_old;
  143. }
  144. rt_size_t ulog_ultoa(char *s, unsigned long int n)
  145. {
  146. rt_size_t i = 0, j = 0, len = 0;
  147. char swap;
  148. do
  149. {
  150. s[len++] = n % 10 + '0';
  151. } while (n /= 10);
  152. s[len] = '\0';
  153. /* reverse string */
  154. for (i = 0, j = len - 1; i < j; ++i, --j)
  155. {
  156. swap = s[i];
  157. s[i] = s[j];
  158. s[j] = swap;
  159. }
  160. return len;
  161. }
  162. static void output_unlock(void)
  163. {
  164. /* earlier stage */
  165. if (ulog.output_lock_enabled == RT_FALSE)
  166. {
  167. return;
  168. }
  169. /* If the scheduler is started and in thread context */
  170. if (rt_interrupt_get_nest() == 0 && rt_thread_self() != RT_NULL)
  171. {
  172. rt_mutex_release(&ulog.output_locker);
  173. }
  174. else
  175. {
  176. #ifdef ULOG_USING_ISR_LOG
  177. rt_hw_interrupt_enable(ulog.output_locker_isr_lvl);
  178. #endif
  179. }
  180. }
  181. static void output_lock(void)
  182. {
  183. /* earlier stage */
  184. if (ulog.output_lock_enabled == RT_FALSE)
  185. {
  186. return;
  187. }
  188. /* If the scheduler is started and in thread context */
  189. if (rt_interrupt_get_nest() == 0 && rt_thread_self() != RT_NULL)
  190. {
  191. rt_mutex_take(&ulog.output_locker, RT_WAITING_FOREVER);
  192. }
  193. else
  194. {
  195. #ifdef ULOG_USING_ISR_LOG
  196. ulog.output_locker_isr_lvl = rt_hw_interrupt_disable();
  197. #endif
  198. }
  199. }
  200. void ulog_output_lock_enabled(rt_bool_t enabled)
  201. {
  202. ulog.output_lock_enabled = enabled;
  203. }
  204. static char *get_log_buf(void)
  205. {
  206. /* is in thread context */
  207. if (rt_interrupt_get_nest() == 0)
  208. {
  209. return ulog.log_buf_th;
  210. }
  211. else
  212. {
  213. #ifdef ULOG_USING_ISR_LOG
  214. return ulog.log_buf_isr;
  215. #else
  216. rt_kprintf("Error: Current mode not supported run in ISR. Please enable ULOG_USING_ISR_LOG.\n");
  217. return RT_NULL;
  218. #endif
  219. }
  220. }
  221. RT_WEAK rt_size_t ulog_formater(char *log_buf, rt_uint32_t level, const char *tag, rt_bool_t newline,
  222. const char *format, va_list args)
  223. {
  224. /* the caller has locker, so it can use static variable for reduce stack usage */
  225. static rt_size_t log_len, newline_len;
  226. static int fmt_result;
  227. RT_ASSERT(log_buf);
  228. RT_ASSERT(level <= LOG_LVL_DBG);
  229. RT_ASSERT(tag);
  230. RT_ASSERT(format);
  231. log_len = 0;
  232. newline_len = rt_strlen(ULOG_NEWLINE_SIGN);
  233. #ifdef ULOG_USING_COLOR
  234. /* add CSI start sign and color info */
  235. if (color_output_info[level])
  236. {
  237. log_len += ulog_strcpy(log_len, log_buf + log_len, CSI_START);
  238. log_len += ulog_strcpy(log_len, log_buf + log_len, color_output_info[level]);
  239. }
  240. #endif /* ULOG_USING_COLOR */
  241. log_buf[log_len] = '\0';
  242. #ifdef ULOG_OUTPUT_TIME
  243. /* add time info */
  244. {
  245. #ifdef ULOG_TIME_USING_TIMESTAMP
  246. static struct timeval now;
  247. static struct tm *tm, tm_tmp;
  248. static rt_bool_t check_usec_support = RT_FALSE, usec_is_support = RT_FALSE;
  249. time_t t = (time_t)0;
  250. if (gettimeofday(&now, RT_NULL) >= 0)
  251. {
  252. t = now.tv_sec;
  253. }
  254. tm = localtime_r(&t, &tm_tmp);
  255. /* show the time format MM-DD HH:MM:SS */
  256. rt_snprintf(log_buf + log_len, ULOG_LINE_BUF_SIZE - log_len, "%02d-%02d %02d:%02d:%02d", tm->tm_mon + 1,
  257. tm->tm_mday, tm->tm_hour, tm->tm_min, tm->tm_sec);
  258. /* check the microseconds support when kernel is startup */
  259. if (t > 0 && !check_usec_support && rt_thread_self() != RT_NULL)
  260. {
  261. long old_usec = now.tv_usec;
  262. /* delay some time for wait microseconds changed */
  263. rt_thread_mdelay(10);
  264. gettimeofday(&now, RT_NULL);
  265. check_usec_support = RT_TRUE;
  266. /* the microseconds is not equal between two gettimeofday calls */
  267. if (now.tv_usec != old_usec)
  268. usec_is_support = RT_TRUE;
  269. }
  270. if (usec_is_support)
  271. {
  272. /* show the millisecond */
  273. log_len += rt_strlen(log_buf + log_len);
  274. rt_snprintf(log_buf + log_len, ULOG_LINE_BUF_SIZE - log_len, ".%03d", now.tv_usec / 1000);
  275. }
  276. #else
  277. static rt_size_t tick_len = 0;
  278. log_buf[log_len] = '[';
  279. tick_len = ulog_ultoa(log_buf + log_len + 1, rt_tick_get());
  280. log_buf[log_len + 1 + tick_len] = ']';
  281. log_buf[log_len + 1 + tick_len + 1] = '\0';
  282. #endif /* ULOG_TIME_USING_TIMESTAMP */
  283. log_len += rt_strlen(log_buf + log_len);
  284. }
  285. #endif /* ULOG_OUTPUT_TIME */
  286. #ifdef ULOG_OUTPUT_LEVEL
  287. #ifdef ULOG_OUTPUT_TIME
  288. log_len += ulog_strcpy(log_len, log_buf + log_len, " ");
  289. #endif
  290. /* add level info */
  291. log_len += ulog_strcpy(log_len, log_buf + log_len, level_output_info[level]);
  292. #endif /* ULOG_OUTPUT_LEVEL */
  293. #ifdef ULOG_OUTPUT_TAG
  294. #if !defined(ULOG_OUTPUT_LEVEL) && defined(ULOG_OUTPUT_TIME)
  295. log_len += ulog_strcpy(log_len, log_buf + log_len, " ");
  296. #endif
  297. /* add tag info */
  298. log_len += ulog_strcpy(log_len, log_buf + log_len, tag);
  299. #endif /* ULOG_OUTPUT_TAG */
  300. #ifdef ULOG_OUTPUT_THREAD_NAME
  301. /* add thread info */
  302. {
  303. #if defined(ULOG_OUTPUT_TIME) || defined(ULOG_OUTPUT_LEVEL) || defined(ULOG_OUTPUT_TAG)
  304. log_len += ulog_strcpy(log_len, log_buf + log_len, " ");
  305. #endif
  306. /* is not in interrupt context */
  307. if (rt_interrupt_get_nest() == 0)
  308. {
  309. rt_size_t name_len = 0;
  310. const char *thread_name = "N/A";
  311. if (rt_thread_self())
  312. {
  313. thread_name = rt_thread_self()->name;
  314. }
  315. name_len = rt_strnlen(thread_name, RT_NAME_MAX);
  316. rt_strncpy(log_buf + log_len, thread_name, name_len);
  317. log_len += name_len;
  318. }
  319. else
  320. {
  321. log_len += ulog_strcpy(log_len, log_buf + log_len, "ISR");
  322. }
  323. }
  324. #endif /* ULOG_OUTPUT_THREAD_NAME */
  325. log_len += ulog_strcpy(log_len, log_buf + log_len, ": ");
  326. fmt_result = rt_vsnprintf(log_buf + log_len, ULOG_LINE_BUF_SIZE - log_len, format, args);
  327. /* calculate log length */
  328. if ((log_len + fmt_result <= ULOG_LINE_BUF_SIZE) && (fmt_result > -1))
  329. {
  330. log_len += fmt_result;
  331. }
  332. else
  333. {
  334. /* using max length */
  335. log_len = ULOG_LINE_BUF_SIZE;
  336. }
  337. /* overflow check and reserve some space for CSI end sign, newline sign and string end sign */
  338. #ifdef ULOG_USING_COLOR
  339. if (log_len + (sizeof(CSI_END) - 1) + newline_len + sizeof((char)'\0') > ULOG_LINE_BUF_SIZE)
  340. {
  341. /* using max length */
  342. log_len = ULOG_LINE_BUF_SIZE;
  343. /* reserve some space for CSI end sign */
  344. log_len -= (sizeof(CSI_END) - 1);
  345. #else
  346. if (log_len + newline_len + sizeof((char)'\0') > ULOG_LINE_BUF_SIZE)
  347. {
  348. /* using max length */
  349. log_len = ULOG_LINE_BUF_SIZE;
  350. #endif /* ULOG_USING_COLOR */
  351. /* reserve some space for newline sign */
  352. log_len -= newline_len;
  353. /* reserve some space for string end sign */
  354. log_len -= sizeof((char)'\0');
  355. }
  356. /* package newline sign */
  357. if (newline)
  358. {
  359. log_len += ulog_strcpy(log_len, log_buf + log_len, ULOG_NEWLINE_SIGN);
  360. }
  361. #ifdef ULOG_USING_COLOR
  362. /* add CSI end sign */
  363. if (color_output_info[level])
  364. {
  365. log_len += ulog_strcpy(log_len, log_buf + log_len, CSI_END);
  366. }
  367. #endif /* ULOG_USING_COLOR */
  368. /* add string end sign */
  369. log_buf[log_len] = '\0';
  370. return log_len;
  371. }
  372. static void ulog_output_to_all_backend(rt_uint32_t level, const char *tag, rt_bool_t is_raw, const char *log, rt_size_t len)
  373. {
  374. rt_slist_t *node;
  375. ulog_backend_t backend;
  376. if (!ulog.init_ok)
  377. return;
  378. /* if there is no backend */
  379. if (!rt_slist_first(&ulog.backend_list))
  380. {
  381. rt_kputs(log);
  382. return;
  383. }
  384. /* output for all backends */
  385. for (node = rt_slist_first(&ulog.backend_list); node; node = rt_slist_next(node))
  386. {
  387. backend = rt_slist_entry(node, struct ulog_backend, list);
  388. if (backend->out_level < level)
  389. {
  390. continue;
  391. }
  392. #if !defined(ULOG_USING_COLOR) || defined(ULOG_USING_SYSLOG)
  393. backend->output(backend, level, tag, is_raw, log, len);
  394. #else
  395. if (backend->filter && backend->filter(backend, level, tag, is_raw, log, len) == RT_FALSE)
  396. {
  397. /* backend's filter is not match, so skip output */
  398. continue;
  399. }
  400. if (backend->support_color || is_raw)
  401. {
  402. backend->output(backend, level, tag, is_raw, log, len);
  403. }
  404. else
  405. {
  406. /* recalculate the log start address and log size when backend not supported color */
  407. rt_size_t color_info_len = 0, output_len = len;
  408. const char *output_log = log;
  409. if (color_output_info[level] != RT_NULL)
  410. color_info_len = rt_strlen(color_output_info[level]);
  411. if (color_info_len)
  412. {
  413. rt_size_t color_hdr_len = rt_strlen(CSI_START) + color_info_len;
  414. output_log += color_hdr_len;
  415. output_len -= (color_hdr_len + (sizeof(CSI_END) - 1));
  416. }
  417. backend->output(backend, level, tag, is_raw, output_log, output_len);
  418. }
  419. #endif /* !defined(ULOG_USING_COLOR) || defined(ULOG_USING_SYSLOG) */
  420. }
  421. }
  422. static void do_output(rt_uint32_t level, const char *tag, rt_bool_t is_raw, const char *log_buf, rt_size_t log_len)
  423. {
  424. #ifdef ULOG_USING_ASYNC_OUTPUT
  425. rt_size_t log_buf_size = log_len + sizeof((char)'\0');
  426. if (is_raw == RT_FALSE)
  427. {
  428. rt_rbb_blk_t log_blk;
  429. ulog_frame_t log_frame;
  430. /* allocate log frame */
  431. log_blk = rt_rbb_blk_alloc(ulog.async_rbb, RT_ALIGN(sizeof(struct ulog_frame) + log_buf_size, RT_ALIGN_SIZE));
  432. if (log_blk)
  433. {
  434. /* package the log frame */
  435. log_frame = (ulog_frame_t) log_blk->buf;
  436. log_frame->magic = ULOG_FRAME_MAGIC;
  437. log_frame->is_raw = is_raw;
  438. log_frame->level = level;
  439. log_frame->log_len = log_len;
  440. log_frame->tag = tag;
  441. log_frame->log = (const char *)log_blk->buf + sizeof(struct ulog_frame);
  442. /* copy log data */
  443. rt_strncpy((char *)(log_blk->buf + sizeof(struct ulog_frame)), log_buf, log_buf_size);
  444. /* put the block */
  445. rt_rbb_blk_put(log_blk);
  446. /* send a notice */
  447. rt_sem_release(&ulog.async_notice);
  448. }
  449. else
  450. {
  451. static rt_bool_t already_output = RT_FALSE;
  452. if (already_output == RT_FALSE)
  453. {
  454. rt_kprintf("Warning: There is no enough buffer for saving async log,"
  455. " please increase the ULOG_ASYNC_OUTPUT_BUF_SIZE option.\n");
  456. already_output = RT_TRUE;
  457. }
  458. }
  459. }
  460. else if (ulog.async_rb)
  461. {
  462. rt_ringbuffer_put(ulog.async_rb, (const rt_uint8_t *)log_buf, log_buf_size);
  463. /* send a notice */
  464. rt_sem_release(&ulog.async_notice);
  465. }
  466. #else
  467. /* is in thread context */
  468. if (rt_interrupt_get_nest() == 0)
  469. {
  470. /* output to all backends */
  471. ulog_output_to_all_backend(level, tag, is_raw, log_buf, log_len);
  472. }
  473. else
  474. {
  475. #ifdef ULOG_BACKEND_USING_CONSOLE
  476. /* We can't ensure that all backends support ISR context output.
  477. * So only using rt_kprintf when context is ISR */
  478. extern void ulog_console_backend_output(struct ulog_backend *backend, rt_uint32_t level, const char *tag,
  479. rt_bool_t is_raw, const char *log, rt_size_t len);
  480. ulog_console_backend_output(RT_NULL, level, tag, is_raw, log_buf, log_len);
  481. #endif /* ULOG_BACKEND_USING_CONSOLE */
  482. }
  483. #endif /* ULOG_USING_ASYNC_OUTPUT */
  484. }
  485. /**
  486. * output the log by variable argument list
  487. *
  488. * @param level level
  489. * @param tag tag
  490. * @param newline has_newline
  491. * @param format output format
  492. * @param args variable argument list
  493. */
  494. void ulog_voutput(rt_uint32_t level, const char *tag, rt_bool_t newline, const char *format, va_list args)
  495. {
  496. static rt_bool_t ulog_voutput_recursion = RT_FALSE;
  497. char *log_buf = RT_NULL;
  498. rt_size_t log_len = 0;
  499. RT_ASSERT(tag);
  500. RT_ASSERT(format);
  501. #ifndef ULOG_USING_SYSLOG
  502. RT_ASSERT(level <= LOG_LVL_DBG);
  503. #else
  504. RT_ASSERT(LOG_PRI(level) <= LOG_DEBUG);
  505. #endif /* ULOG_USING_SYSLOG */
  506. if (!ulog.init_ok)
  507. {
  508. return;
  509. }
  510. #ifdef ULOG_USING_FILTER
  511. /* level filter */
  512. #ifndef ULOG_USING_SYSLOG
  513. if (level > ulog.filter.level || level > ulog_tag_lvl_filter_get(tag))
  514. {
  515. return;
  516. }
  517. #else
  518. if (((LOG_MASK(LOG_PRI(level)) & ulog.filter.level) == 0)
  519. || ((LOG_MASK(LOG_PRI(level)) & ulog_tag_lvl_filter_get(tag)) == 0))
  520. {
  521. return;
  522. }
  523. #endif /* ULOG_USING_SYSLOG */
  524. else if (!rt_strstr(tag, ulog.filter.tag))
  525. {
  526. /* tag filter */
  527. return;
  528. }
  529. #endif /* ULOG_USING_FILTER */
  530. /* get log buffer */
  531. log_buf = get_log_buf();
  532. /* lock output */
  533. output_lock();
  534. /* If there is a recursion, we use a simple way */
  535. if (ulog_voutput_recursion == RT_TRUE)
  536. {
  537. rt_kprintf(format, args);
  538. if(newline == RT_TRUE)
  539. {
  540. rt_kprintf(ULOG_NEWLINE_SIGN);
  541. }
  542. output_unlock();
  543. return;
  544. }
  545. ulog_voutput_recursion = RT_TRUE;
  546. #ifndef ULOG_USING_SYSLOG
  547. log_len = ulog_formater(log_buf, level, tag, newline, format, args);
  548. #else
  549. extern rt_size_t syslog_formater(char *log_buf, rt_uint8_t level, const char *tag, rt_bool_t newline, const char *format, va_list args);
  550. log_len = syslog_formater(log_buf, level, tag, newline, format, args);
  551. #endif /* ULOG_USING_SYSLOG */
  552. #ifdef ULOG_USING_FILTER
  553. /* keyword filter */
  554. if (ulog.filter.keyword[0] != '\0')
  555. {
  556. /* add string end sign */
  557. log_buf[log_len] = '\0';
  558. /* find the keyword */
  559. if (!rt_strstr(log_buf, ulog.filter.keyword))
  560. {
  561. ulog_voutput_recursion = RT_FALSE;
  562. /* unlock output */
  563. output_unlock();
  564. return;
  565. }
  566. }
  567. #endif /* ULOG_USING_FILTER */
  568. /* do log output */
  569. do_output(level, tag, RT_FALSE, log_buf, log_len);
  570. ulog_voutput_recursion = RT_FALSE;
  571. /* unlock output */
  572. output_unlock();
  573. }
  574. /**
  575. * output the log
  576. *
  577. * @param level level
  578. * @param tag tag
  579. * @param newline has newline
  580. * @param format output format
  581. * @param ... args
  582. */
  583. void ulog_output(rt_uint32_t level, const char *tag, rt_bool_t newline, const char *format, ...)
  584. {
  585. va_list args;
  586. /* args point to the first variable parameter */
  587. va_start(args, format);
  588. ulog_voutput(level, tag, newline, format, args);
  589. va_end(args);
  590. }
  591. /**
  592. * output RAW string format log
  593. *
  594. * @param format output format
  595. * @param ... args
  596. */
  597. void ulog_raw(const char *format, ...)
  598. {
  599. rt_size_t log_len = 0;
  600. char *log_buf = RT_NULL;
  601. va_list args;
  602. int fmt_result;
  603. RT_ASSERT(ulog.init_ok);
  604. #ifdef ULOG_USING_ASYNC_OUTPUT
  605. if (ulog.async_rb == RT_NULL)
  606. {
  607. ulog.async_rb = rt_ringbuffer_create(ULOG_ASYNC_OUTPUT_BUF_SIZE);
  608. }
  609. #endif
  610. /* get log buffer */
  611. log_buf = get_log_buf();
  612. /* lock output */
  613. output_lock();
  614. /* args point to the first variable parameter */
  615. va_start(args, format);
  616. fmt_result = rt_vsnprintf(log_buf, ULOG_LINE_BUF_SIZE, format, args);
  617. va_end(args);
  618. /* calculate log length */
  619. if ((fmt_result > -1) && (fmt_result <= ULOG_LINE_BUF_SIZE))
  620. {
  621. log_len = fmt_result;
  622. }
  623. else
  624. {
  625. log_len = ULOG_LINE_BUF_SIZE;
  626. }
  627. /* do log output */
  628. do_output(LOG_LVL_DBG, "", RT_TRUE, log_buf, log_len);
  629. /* unlock output */
  630. output_unlock();
  631. }
  632. /**
  633. * dump the hex format data to log
  634. *
  635. * @param tag name for hex object, it will show on log header
  636. * @param width hex number for every line, such as: 16, 32
  637. * @param buf hex buffer
  638. * @param size buffer size
  639. */
  640. void ulog_hexdump(const char *tag, rt_size_t width, rt_uint8_t *buf, rt_size_t size)
  641. {
  642. #define __is_print(ch) ((unsigned int)((ch) - ' ') < 127u - ' ')
  643. rt_size_t i, j;
  644. rt_size_t log_len = 0, name_len = rt_strlen(tag);
  645. #ifdef ULOG_OUTPUT_TIME
  646. rt_size_t time_head_len = 0;
  647. #endif
  648. char *log_buf = RT_NULL, dump_string[8];
  649. int fmt_result;
  650. RT_ASSERT(ulog.init_ok);
  651. #ifdef ULOG_USING_FILTER
  652. /* level filter */
  653. #ifndef ULOG_USING_SYSLOG
  654. if (LOG_LVL_DBG > ulog.filter.level || LOG_LVL_DBG > ulog_tag_lvl_filter_get(tag))
  655. {
  656. return;
  657. }
  658. #else
  659. if ((LOG_MASK(LOG_DEBUG) & ulog.filter.level) == 0)
  660. {
  661. return;
  662. }
  663. #endif /* ULOG_USING_SYSLOG */
  664. else if (!rt_strstr(tag, ulog.filter.tag))
  665. {
  666. /* tag filter */
  667. return;
  668. }
  669. #endif /* ULOG_USING_FILTER */
  670. #ifdef ULOG_USING_ASYNC_OUTPUT
  671. if (ulog.async_rb == RT_NULL)
  672. {
  673. ulog.async_rb = rt_ringbuffer_create(ULOG_ASYNC_OUTPUT_BUF_SIZE);
  674. }
  675. #endif
  676. /* get log buffer */
  677. log_buf = get_log_buf();
  678. /* lock output */
  679. output_lock();
  680. for (i = 0, log_len = 0; i < size; i += width)
  681. {
  682. /* package header */
  683. if (i == 0)
  684. {
  685. #ifdef ULOG_OUTPUT_TIME
  686. /* add time info */
  687. #ifdef ULOG_TIME_USING_TIMESTAMP
  688. static time_t now;
  689. static struct tm *tm, tm_tmp;
  690. now = time(RT_NULL);
  691. tm = gmtime_r(&now, &tm_tmp);
  692. #ifdef RT_USING_SOFT_RTC
  693. rt_snprintf(log_buf + log_len, ULOG_LINE_BUF_SIZE - log_len, "%02d-%02d %02d:%02d:%02d.%03d ", tm->tm_mon + 1,
  694. tm->tm_mday, tm->tm_hour, tm->tm_min, tm->tm_sec, rt_tick_get() % 1000);
  695. #else
  696. rt_snprintf(log_buf + log_len, ULOG_LINE_BUF_SIZE - log_len, "%02d-%02d %02d:%02d:%02d ", tm->tm_mon + 1,
  697. tm->tm_mday, tm->tm_hour, tm->tm_min, tm->tm_sec);
  698. #endif /* RT_USING_SOFT_RTC */
  699. #else
  700. static rt_size_t tick_len = 0;
  701. log_buf[log_len] = '[';
  702. tick_len = ulog_ultoa(log_buf + log_len + 1, rt_tick_get());
  703. log_buf[log_len + 1 + tick_len] = ']';
  704. log_buf[log_len + 2 + tick_len] = ' ';
  705. log_buf[log_len + 3 + tick_len] = '\0';
  706. #endif /* ULOG_TIME_USING_TIMESTAMP */
  707. time_head_len = rt_strlen(log_buf + log_len);
  708. log_len += time_head_len;
  709. #endif /* ULOG_OUTPUT_TIME */
  710. log_len += ulog_strcpy(log_len, log_buf + log_len, "D/HEX ");
  711. log_len += ulog_strcpy(log_len, log_buf + log_len, tag);
  712. log_len += ulog_strcpy(log_len, log_buf + log_len, ": ");
  713. }
  714. else
  715. {
  716. log_len = 6 + name_len + 2;
  717. #ifdef ULOG_OUTPUT_TIME
  718. log_len += time_head_len;
  719. #endif
  720. rt_memset(log_buf, ' ', log_len);
  721. }
  722. fmt_result = rt_snprintf(log_buf + log_len, ULOG_LINE_BUF_SIZE, "%04X-%04X: ", i, i + width - 1);
  723. /* calculate log length */
  724. if ((fmt_result > -1) && (fmt_result <= ULOG_LINE_BUF_SIZE))
  725. {
  726. log_len += fmt_result;
  727. }
  728. else
  729. {
  730. log_len = ULOG_LINE_BUF_SIZE;
  731. }
  732. /* dump hex */
  733. for (j = 0; j < width; j++)
  734. {
  735. if (i + j < size)
  736. {
  737. rt_snprintf(dump_string, sizeof(dump_string), "%02X ", buf[i + j]);
  738. }
  739. else
  740. {
  741. rt_strncpy(dump_string, " ", sizeof(dump_string));
  742. }
  743. log_len += ulog_strcpy(log_len, log_buf + log_len, dump_string);
  744. if ((j + 1) % 8 == 0)
  745. {
  746. log_len += ulog_strcpy(log_len, log_buf + log_len, " ");
  747. }
  748. }
  749. log_len += ulog_strcpy(log_len, log_buf + log_len, " ");
  750. /* dump char for hex */
  751. for (j = 0; j < width; j++)
  752. {
  753. if (i + j < size)
  754. {
  755. rt_snprintf(dump_string, sizeof(dump_string), "%c", __is_print(buf[i + j]) ? buf[i + j] : '.');
  756. log_len += ulog_strcpy(log_len, log_buf + log_len, dump_string);
  757. }
  758. }
  759. /* overflow check and reserve some space for newline sign */
  760. if (log_len + rt_strlen(ULOG_NEWLINE_SIGN) > ULOG_LINE_BUF_SIZE)
  761. {
  762. log_len = ULOG_LINE_BUF_SIZE - rt_strlen(ULOG_NEWLINE_SIGN);
  763. }
  764. /* package newline sign */
  765. log_len += ulog_strcpy(log_len, log_buf + log_len, ULOG_NEWLINE_SIGN);
  766. /*add string end sign*/
  767. log_buf[log_len] = '\0';
  768. /* do log output */
  769. do_output(LOG_LVL_DBG, RT_NULL, RT_TRUE, log_buf, log_len);
  770. }
  771. /* unlock output */
  772. output_unlock();
  773. }
  774. #ifdef ULOG_USING_FILTER
  775. /**
  776. * Set the filter's level by different backend.
  777. * The log on this backend which level is less than it will stop output.
  778. *
  779. * @param be_name backend name
  780. * @param level The filter level. When the level is LOG_FILTER_LVL_SILENT, the log enter silent mode.
  781. * When the level is LOG_FILTER_LVL_ALL, it will remove this tag's level filer.
  782. * Then all level log will resume output.
  783. *
  784. * @return 0 : success
  785. * -10: level is out of range
  786. */
  787. int ulog_be_lvl_filter_set(const char *be_name, rt_uint32_t level)
  788. {
  789. rt_slist_t *node = RT_NULL;
  790. ulog_backend_t backend;
  791. int result = RT_EOK;
  792. if (level > LOG_FILTER_LVL_ALL)
  793. return -RT_EINVAL;
  794. if (!ulog.init_ok)
  795. return result;
  796. for (node = rt_slist_first(&ulog.backend_list); node; node = rt_slist_next(node))
  797. {
  798. backend = rt_slist_entry(node, struct ulog_backend, list);
  799. if (rt_strncmp(backend->name, be_name, RT_NAME_MAX) == 0)
  800. {
  801. backend->out_level = level;
  802. }
  803. }
  804. return result;
  805. }
  806. /**
  807. * Set the filter's level by different tag.
  808. * The log on this tag which level is less than it will stop output.
  809. *
  810. * example:
  811. * // the example tag log enter silent mode
  812. * ulog_set_filter_lvl("example", LOG_FILTER_LVL_SILENT);
  813. * // the example tag log which level is less than INFO level will stop output
  814. * ulog_set_filter_lvl("example", LOG_LVL_INFO);
  815. * // remove example tag's level filter, all level log will resume output
  816. * ulog_set_filter_lvl("example", LOG_FILTER_LVL_ALL);
  817. *
  818. * @param tag log tag
  819. * @param level The filter level. When the level is LOG_FILTER_LVL_SILENT, the log enter silent mode.
  820. * When the level is LOG_FILTER_LVL_ALL, it will remove this tag's level filer.
  821. * Then all level log will resume output.
  822. *
  823. * @return 0 : success
  824. * -5 : no memory
  825. * -10: level is out of range
  826. */
  827. int ulog_tag_lvl_filter_set(const char *tag, rt_uint32_t level)
  828. {
  829. rt_slist_t *node;
  830. ulog_tag_lvl_filter_t tag_lvl = RT_NULL;
  831. int result = RT_EOK;
  832. if (level > LOG_FILTER_LVL_ALL)
  833. return -RT_EINVAL;
  834. if (!ulog.init_ok)
  835. return result;
  836. /* lock output */
  837. output_lock();
  838. /* find the tag in list */
  839. for (node = rt_slist_first(ulog_tag_lvl_list_get()); node; node = rt_slist_next(node))
  840. {
  841. tag_lvl = rt_slist_entry(node, struct ulog_tag_lvl_filter, list);
  842. if (!rt_strncmp(tag_lvl->tag, tag, ULOG_FILTER_TAG_MAX_LEN))
  843. {
  844. break;
  845. }
  846. else
  847. {
  848. tag_lvl = RT_NULL;
  849. }
  850. }
  851. /* find OK */
  852. if (tag_lvl)
  853. {
  854. if (level == LOG_FILTER_LVL_ALL)
  855. {
  856. /* remove current tag's level filter when input level is the lowest level */
  857. rt_slist_remove(ulog_tag_lvl_list_get(), &tag_lvl->list);
  858. rt_free(tag_lvl);
  859. }
  860. else
  861. {
  862. /* update level */
  863. tag_lvl->level = level;
  864. }
  865. }
  866. else
  867. {
  868. /* only add the new tag's level filer when level is not LOG_FILTER_LVL_ALL */
  869. if (level != LOG_FILTER_LVL_ALL)
  870. {
  871. /* new a tag's level filter */
  872. tag_lvl = (ulog_tag_lvl_filter_t)rt_malloc(sizeof(struct ulog_tag_lvl_filter));
  873. if (tag_lvl)
  874. {
  875. rt_memset(tag_lvl->tag, 0 , sizeof(tag_lvl->tag));
  876. rt_strncpy(tag_lvl->tag, tag, ULOG_FILTER_TAG_MAX_LEN);
  877. tag_lvl->level = level;
  878. rt_slist_append(ulog_tag_lvl_list_get(), &tag_lvl->list);
  879. }
  880. else
  881. {
  882. result = -RT_ENOMEM;
  883. }
  884. }
  885. }
  886. /* unlock output */
  887. output_unlock();
  888. return result;
  889. }
  890. /**
  891. * get the level on tag's level filer
  892. *
  893. * @param tag log tag
  894. *
  895. * @return It will return the lowest level when tag was not found.
  896. * Other level will return when tag was found.
  897. */
  898. rt_uint32_t ulog_tag_lvl_filter_get(const char *tag)
  899. {
  900. rt_slist_t *node;
  901. ulog_tag_lvl_filter_t tag_lvl = RT_NULL;
  902. rt_uint32_t level = LOG_FILTER_LVL_ALL;
  903. if (!ulog.init_ok)
  904. return level;
  905. /* lock output */
  906. output_lock();
  907. /* find the tag in list */
  908. for (node = rt_slist_first(ulog_tag_lvl_list_get()); node; node = rt_slist_next(node))
  909. {
  910. tag_lvl = rt_slist_entry(node, struct ulog_tag_lvl_filter, list);
  911. if (!rt_strncmp(tag_lvl->tag, tag, ULOG_FILTER_TAG_MAX_LEN))
  912. {
  913. level = tag_lvl->level;
  914. break;
  915. }
  916. }
  917. /* unlock output */
  918. output_unlock();
  919. return level;
  920. }
  921. /**
  922. * get the tag's level list on filter
  923. *
  924. * @return tag's level list
  925. */
  926. rt_slist_t *ulog_tag_lvl_list_get(void)
  927. {
  928. return &ulog.filter.tag_lvl_list;
  929. }
  930. /**
  931. * set log global filter level
  932. *
  933. * @param level log level: LOG_LVL_ASSERT, LOG_LVL_ERROR, LOG_LVL_WARNING, LOG_LVL_INFO, LOG_LVL_DBG
  934. * LOG_FILTER_LVL_SILENT: disable all log output, except assert level
  935. * LOG_FILTER_LVL_ALL: enable all log output
  936. */
  937. void ulog_global_filter_lvl_set(rt_uint32_t level)
  938. {
  939. RT_ASSERT(level <= LOG_FILTER_LVL_ALL);
  940. ulog.filter.level = level;
  941. }
  942. /**
  943. * get log global filter level
  944. *
  945. * @return log level: LOG_LVL_ASSERT, LOG_LVL_ERROR, LOG_LVL_WARNING, LOG_LVL_INFO, LOG_LVL_DBG
  946. * LOG_FILTER_LVL_SILENT: disable all log output, except assert level
  947. * LOG_FILTER_LVL_ALL: enable all log output
  948. */
  949. rt_uint32_t ulog_global_filter_lvl_get(void)
  950. {
  951. return ulog.filter.level;
  952. }
  953. /**
  954. * set log global filter tag
  955. *
  956. * @param tag tag
  957. */
  958. void ulog_global_filter_tag_set(const char *tag)
  959. {
  960. RT_ASSERT(tag);
  961. rt_strncpy(ulog.filter.tag, tag, ULOG_FILTER_TAG_MAX_LEN);
  962. }
  963. /**
  964. * get log global filter tag
  965. *
  966. * @return tag
  967. */
  968. const char *ulog_global_filter_tag_get(void)
  969. {
  970. return ulog.filter.tag;
  971. }
  972. /**
  973. * set log global filter keyword
  974. *
  975. * @param keyword keyword
  976. */
  977. void ulog_global_filter_kw_set(const char *keyword)
  978. {
  979. RT_ASSERT(keyword);
  980. rt_strncpy(ulog.filter.keyword, keyword, ULOG_FILTER_KW_MAX_LEN);
  981. }
  982. /**
  983. * get log global filter keyword
  984. *
  985. * @return keyword
  986. */
  987. const char *ulog_global_filter_kw_get(void)
  988. {
  989. return ulog.filter.keyword;
  990. }
  991. #ifdef RT_USING_FINSH
  992. #include <finsh.h>
  993. static void _print_lvl_info(void)
  994. {
  995. #ifndef ULOG_USING_SYSLOG
  996. rt_kprintf("Assert : 0\n");
  997. rt_kprintf("Error : 3\n");
  998. rt_kprintf("Warning : 4\n");
  999. rt_kprintf("Info : 6\n");
  1000. rt_kprintf("Debug : 7\n");
  1001. #else
  1002. rt_kprintf("EMERG : 1 (1 << 0)\n");
  1003. rt_kprintf("ALERT : 2 (1 << 1)\n");
  1004. rt_kprintf("CRIT : 4 (1 << 2)\n");
  1005. rt_kprintf("ERR : 8 (1 << 3)\n");
  1006. rt_kprintf("WARNING : 16 (1 << 4)\n");
  1007. rt_kprintf("NOTICE : 32 (1 << 5)\n");
  1008. rt_kprintf("INFO : 64 (1 << 6)\n");
  1009. rt_kprintf("DEBUG : 128 (1 << 7)\n");
  1010. #endif /* ULOG_USING_SYSLOG */
  1011. }
  1012. static void ulog_be_lvl(uint8_t argc, char **argv)
  1013. {
  1014. if (argc > 2)
  1015. {
  1016. if ((atoi(argv[2]) <= LOG_FILTER_LVL_ALL) && (atoi(argv[2]) >= 0))
  1017. {
  1018. ulog_be_lvl_filter_set(argv[1], atoi(argv[2]));
  1019. }
  1020. else
  1021. {
  1022. rt_kprintf("Please input correct level (0-%d).\n", LOG_FILTER_LVL_ALL);
  1023. }
  1024. }
  1025. else
  1026. {
  1027. rt_kprintf("Please input: ulog_be_lvl <be_name> <level>.\n");
  1028. _print_lvl_info();
  1029. }
  1030. }
  1031. MSH_CMD_EXPORT(ulog_be_lvl, Set ulog filter level by different backend.);
  1032. static void ulog_tag_lvl(uint8_t argc, char **argv)
  1033. {
  1034. if (argc > 2)
  1035. {
  1036. if ((atoi(argv[2]) <= LOG_FILTER_LVL_ALL) && (atoi(argv[2]) >= 0))
  1037. {
  1038. ulog_tag_lvl_filter_set(argv[1], atoi(argv[2]));
  1039. }
  1040. else
  1041. {
  1042. rt_kprintf("Please input correct level (0-%d).\n", LOG_FILTER_LVL_ALL);
  1043. }
  1044. }
  1045. else
  1046. {
  1047. rt_kprintf("Please input: ulog_tag_lvl <tag> <level>.\n");
  1048. _print_lvl_info();
  1049. }
  1050. }
  1051. MSH_CMD_EXPORT(ulog_tag_lvl, Set ulog filter level by different tag.);
  1052. static void ulog_lvl(uint8_t argc, char **argv)
  1053. {
  1054. if (argc > 1)
  1055. {
  1056. if ((atoi(argv[1]) <= LOG_FILTER_LVL_ALL) && (atoi(argv[1]) >= 0))
  1057. {
  1058. ulog_global_filter_lvl_set(atoi(argv[1]));
  1059. }
  1060. else
  1061. {
  1062. rt_kprintf("Please input correct level (0-%d).\n", LOG_FILTER_LVL_ALL);
  1063. }
  1064. }
  1065. else
  1066. {
  1067. rt_kprintf("Please input: ulog_lvl <level>.\n");
  1068. _print_lvl_info();
  1069. }
  1070. }
  1071. MSH_CMD_EXPORT(ulog_lvl, Set ulog global filter level.);
  1072. static void ulog_tag(uint8_t argc, char **argv)
  1073. {
  1074. if (argc > 1)
  1075. {
  1076. if (rt_strlen(argv[1]) <= ULOG_FILTER_TAG_MAX_LEN)
  1077. {
  1078. ulog_global_filter_tag_set(argv[1]);
  1079. }
  1080. else
  1081. {
  1082. rt_kprintf("The tag length is too long. Max is %d.\n", ULOG_FILTER_TAG_MAX_LEN);
  1083. }
  1084. }
  1085. else
  1086. {
  1087. ulog_global_filter_tag_set("");
  1088. }
  1089. }
  1090. MSH_CMD_EXPORT(ulog_tag, Set ulog global filter tag);
  1091. static void ulog_kw(uint8_t argc, char **argv)
  1092. {
  1093. if (argc > 1)
  1094. {
  1095. if (rt_strlen(argv[1]) <= ULOG_FILTER_KW_MAX_LEN)
  1096. {
  1097. ulog_global_filter_kw_set(argv[1]);
  1098. }
  1099. else
  1100. {
  1101. rt_kprintf("The keyword length is too long. Max is %d.\n", ULOG_FILTER_KW_MAX_LEN);
  1102. }
  1103. }
  1104. else
  1105. {
  1106. ulog_global_filter_kw_set("");
  1107. }
  1108. }
  1109. MSH_CMD_EXPORT(ulog_kw, Set ulog global filter keyword);
  1110. static void ulog_filter(uint8_t argc, char **argv)
  1111. {
  1112. #ifndef ULOG_USING_SYSLOG
  1113. const char *lvl_name[] = { "Assert ", "Error ", "Error ", "Error ", "Warning", "Info ", "Info ", "Debug " };
  1114. #endif
  1115. const char *tag = ulog_global_filter_tag_get(), *kw = ulog_global_filter_kw_get();
  1116. rt_slist_t *node;
  1117. ulog_tag_lvl_filter_t tag_lvl = RT_NULL;
  1118. rt_kprintf("--------------------------------------\n");
  1119. rt_kprintf("ulog global filter:\n");
  1120. #ifndef ULOG_USING_SYSLOG
  1121. rt_kprintf("level : %s\n", lvl_name[ulog_global_filter_lvl_get()]);
  1122. #else
  1123. rt_kprintf("level : %d\n", ulog_global_filter_lvl_get());
  1124. #endif
  1125. rt_kprintf("tag : %s\n", rt_strlen(tag) == 0 ? "NULL" : tag);
  1126. rt_kprintf("keyword : %s\n", rt_strlen(kw) == 0 ? "NULL" : kw);
  1127. rt_kprintf("--------------------------------------\n");
  1128. rt_kprintf("ulog tag's level filter:\n");
  1129. if (rt_slist_isempty(ulog_tag_lvl_list_get()))
  1130. {
  1131. rt_kprintf("settings not found\n");
  1132. }
  1133. else
  1134. {
  1135. /* lock output */
  1136. output_lock();
  1137. /* show the tag level list */
  1138. for (node = rt_slist_first(ulog_tag_lvl_list_get()); node; node = rt_slist_next(node))
  1139. {
  1140. tag_lvl = rt_slist_entry(node, struct ulog_tag_lvl_filter, list);
  1141. rt_kprintf("%-*.s: ", ULOG_FILTER_TAG_MAX_LEN, tag_lvl->tag);
  1142. #ifndef ULOG_USING_SYSLOG
  1143. rt_kprintf("%s\n", lvl_name[tag_lvl->level]);
  1144. #else
  1145. rt_kprintf("%d\n", tag_lvl->level);
  1146. #endif
  1147. }
  1148. /* unlock output */
  1149. output_unlock();
  1150. }
  1151. }
  1152. MSH_CMD_EXPORT(ulog_filter, Show ulog filter settings);
  1153. #endif /* RT_USING_FINSH */
  1154. #endif /* ULOG_USING_FILTER */
  1155. rt_err_t ulog_backend_register(ulog_backend_t backend, const char *name, rt_bool_t support_color)
  1156. {
  1157. rt_base_t level;
  1158. RT_ASSERT(backend);
  1159. RT_ASSERT(name);
  1160. RT_ASSERT(ulog.init_ok);
  1161. RT_ASSERT(backend->output);
  1162. if (backend->init)
  1163. {
  1164. backend->init(backend);
  1165. }
  1166. backend->support_color = support_color;
  1167. backend->out_level = LOG_FILTER_LVL_ALL;
  1168. rt_strncpy(backend->name, name, RT_NAME_MAX);
  1169. level = rt_hw_interrupt_disable();
  1170. rt_slist_append(&ulog.backend_list, &backend->list);
  1171. rt_hw_interrupt_enable(level);
  1172. return RT_EOK;
  1173. }
  1174. rt_err_t ulog_backend_unregister(ulog_backend_t backend)
  1175. {
  1176. rt_base_t level;
  1177. RT_ASSERT(backend);
  1178. RT_ASSERT(ulog.init_ok);
  1179. if (backend->deinit)
  1180. {
  1181. backend->deinit(backend);
  1182. }
  1183. level = rt_hw_interrupt_disable();
  1184. rt_slist_remove(&ulog.backend_list, &backend->list);
  1185. rt_hw_interrupt_enable(level);
  1186. return RT_EOK;
  1187. }
  1188. rt_err_t ulog_backend_set_filter(ulog_backend_t backend, ulog_backend_filter_t filter)
  1189. {
  1190. rt_base_t level;
  1191. RT_ASSERT(backend);
  1192. level = rt_hw_interrupt_disable();
  1193. backend->filter = filter;
  1194. rt_hw_interrupt_enable(level);
  1195. return RT_EOK;
  1196. }
  1197. ulog_backend_t ulog_backend_find(const char *name)
  1198. {
  1199. rt_base_t level;
  1200. rt_slist_t *node;
  1201. ulog_backend_t backend;
  1202. RT_ASSERT(ulog.init_ok);
  1203. level = rt_hw_interrupt_disable();
  1204. for (node = rt_slist_first(&ulog.backend_list); node; node = rt_slist_next(node))
  1205. {
  1206. backend = rt_slist_entry(node, struct ulog_backend, list);
  1207. if (rt_strncmp(backend->name, name, RT_NAME_MAX) == 0)
  1208. {
  1209. rt_hw_interrupt_enable(level);
  1210. return backend;
  1211. }
  1212. }
  1213. rt_hw_interrupt_enable(level);
  1214. return RT_NULL;
  1215. }
  1216. #ifdef ULOG_USING_ASYNC_OUTPUT
  1217. /**
  1218. * asynchronous output logs to all backends
  1219. *
  1220. * @note you must call this function when ULOG_ASYNC_OUTPUT_BY_THREAD is disable
  1221. */
  1222. void ulog_async_output(void)
  1223. {
  1224. rt_rbb_blk_t log_blk;
  1225. ulog_frame_t log_frame;
  1226. if (!ulog.async_enabled)
  1227. {
  1228. return;
  1229. }
  1230. while ((log_blk = rt_rbb_blk_get(ulog.async_rbb)) != RT_NULL)
  1231. {
  1232. log_frame = (ulog_frame_t) log_blk->buf;
  1233. if (log_frame->magic == ULOG_FRAME_MAGIC)
  1234. {
  1235. /* output to all backends */
  1236. ulog_output_to_all_backend(log_frame->level, log_frame->tag, log_frame->is_raw, log_frame->log,
  1237. log_frame->log_len);
  1238. }
  1239. rt_rbb_blk_free(ulog.async_rbb, log_blk);
  1240. }
  1241. /* output the log_raw format log */
  1242. if (ulog.async_rb)
  1243. {
  1244. rt_size_t log_len = rt_ringbuffer_data_len(ulog.async_rb);
  1245. char *log = rt_malloc(log_len + 1);
  1246. if (log)
  1247. {
  1248. rt_size_t len = rt_ringbuffer_get(ulog.async_rb, (rt_uint8_t *)log, log_len);
  1249. log[log_len] = '\0';
  1250. ulog_output_to_all_backend(LOG_LVL_DBG, "", RT_TRUE, log, len);
  1251. rt_free(log);
  1252. }
  1253. }
  1254. }
  1255. /**
  1256. * enable or disable asynchronous output mode
  1257. * the log will be output directly when mode is disabled
  1258. *
  1259. * @param enabled RT_TRUE: enabled, RT_FALSE: disabled
  1260. */
  1261. void ulog_async_output_enabled(rt_bool_t enabled)
  1262. {
  1263. ulog.async_enabled = enabled;
  1264. }
  1265. /**
  1266. * waiting for get asynchronous output log
  1267. *
  1268. * @param time the waiting time
  1269. *
  1270. * @return the operation status, RT_EOK on successful
  1271. */
  1272. rt_err_t ulog_async_waiting_log(rt_int32_t time)
  1273. {
  1274. rt_sem_control(&ulog.async_notice, RT_IPC_CMD_RESET, RT_NULL);
  1275. return rt_sem_take(&ulog.async_notice, time);
  1276. }
  1277. static void async_output_thread_entry(void *param)
  1278. {
  1279. ulog_async_output();
  1280. while (1)
  1281. {
  1282. ulog_async_waiting_log(RT_WAITING_FOREVER);
  1283. while (1)
  1284. {
  1285. ulog_async_output();
  1286. /* If there is no log output for a certain period of time,
  1287. * refresh the log buffer
  1288. */
  1289. if (ulog_async_waiting_log(RT_TICK_PER_SECOND * 2) == RT_EOK)
  1290. {
  1291. continue;
  1292. }
  1293. else
  1294. {
  1295. ulog_flush();
  1296. break;
  1297. }
  1298. }
  1299. }
  1300. }
  1301. #endif /* ULOG_USING_ASYNC_OUTPUT */
  1302. /**
  1303. * flush all backends's log
  1304. */
  1305. void ulog_flush(void)
  1306. {
  1307. rt_slist_t *node;
  1308. ulog_backend_t backend;
  1309. if (!ulog.init_ok)
  1310. return;
  1311. #ifdef ULOG_USING_ASYNC_OUTPUT
  1312. ulog_async_output();
  1313. #endif
  1314. /* flush all backends */
  1315. for (node = rt_slist_first(&ulog.backend_list); node; node = rt_slist_next(node))
  1316. {
  1317. backend = rt_slist_entry(node, struct ulog_backend, list);
  1318. if (backend->flush)
  1319. {
  1320. backend->flush(backend);
  1321. }
  1322. }
  1323. }
  1324. int ulog_init(void)
  1325. {
  1326. if (ulog.init_ok)
  1327. return 0;
  1328. rt_mutex_init(&ulog.output_locker, "ulog", RT_IPC_FLAG_PRIO);
  1329. ulog.output_lock_enabled = RT_TRUE;
  1330. rt_slist_init(&ulog.backend_list);
  1331. #ifdef ULOG_USING_FILTER
  1332. rt_slist_init(ulog_tag_lvl_list_get());
  1333. #endif
  1334. #ifdef ULOG_USING_ASYNC_OUTPUT
  1335. RT_ASSERT(ULOG_ASYNC_OUTPUT_STORE_LINES >= 2);
  1336. ulog.async_enabled = RT_TRUE;
  1337. /* async output ring block buffer */
  1338. ulog.async_rbb = rt_rbb_create(RT_ALIGN(ULOG_ASYNC_OUTPUT_BUF_SIZE, RT_ALIGN_SIZE), ULOG_ASYNC_OUTPUT_STORE_LINES);
  1339. if (ulog.async_rbb == RT_NULL)
  1340. {
  1341. rt_kprintf("Error: ulog init failed! No memory for async rbb.\n");
  1342. rt_mutex_detach(&ulog.output_locker);
  1343. return -RT_ENOMEM;
  1344. }
  1345. rt_sem_init(&ulog.async_notice, "ulog", 0, RT_IPC_FLAG_FIFO);
  1346. #endif /* ULOG_USING_ASYNC_OUTPUT */
  1347. #ifdef ULOG_USING_FILTER
  1348. ulog_global_filter_lvl_set(LOG_FILTER_LVL_ALL);
  1349. #endif
  1350. ulog.init_ok = RT_TRUE;
  1351. return 0;
  1352. }
  1353. INIT_BOARD_EXPORT(ulog_init);
  1354. #ifdef ULOG_USING_ASYNC_OUTPUT
  1355. int ulog_async_init(void)
  1356. {
  1357. if (ulog.async_th == RT_NULL)
  1358. {
  1359. /* async output thread */
  1360. ulog.async_th = rt_thread_create("ulog_async", async_output_thread_entry, &ulog, ULOG_ASYNC_OUTPUT_THREAD_STACK,
  1361. ULOG_ASYNC_OUTPUT_THREAD_PRIORITY, 20);
  1362. if (ulog.async_th == RT_NULL)
  1363. {
  1364. rt_kprintf("Error: ulog init failed! No memory for async output thread.\n");
  1365. return -RT_ENOMEM;
  1366. }
  1367. /* async output thread startup */
  1368. rt_thread_startup(ulog.async_th);
  1369. }
  1370. return 0;
  1371. }
  1372. INIT_PREV_EXPORT(ulog_async_init);
  1373. #endif /* ULOG_USING_ASYNC_OUTPUT */
  1374. void ulog_deinit(void)
  1375. {
  1376. rt_slist_t *node;
  1377. ulog_backend_t backend;
  1378. if (!ulog.init_ok)
  1379. return;
  1380. /* deinit all backends */
  1381. for (node = rt_slist_first(&ulog.backend_list); node; node = rt_slist_next(node))
  1382. {
  1383. backend = rt_slist_entry(node, struct ulog_backend, list);
  1384. if (backend->deinit)
  1385. {
  1386. backend->deinit(backend);
  1387. }
  1388. }
  1389. #ifdef ULOG_USING_FILTER
  1390. /* deinit tag's level filter */
  1391. {
  1392. ulog_tag_lvl_filter_t tag_lvl;
  1393. for (node = rt_slist_first(ulog_tag_lvl_list_get()); node; node = rt_slist_next(node))
  1394. {
  1395. tag_lvl = rt_slist_entry(node, struct ulog_tag_lvl_filter, list);
  1396. rt_free(tag_lvl);
  1397. }
  1398. }
  1399. #endif /* ULOG_USING_FILTER */
  1400. rt_mutex_detach(&ulog.output_locker);
  1401. #ifdef ULOG_USING_ASYNC_OUTPUT
  1402. rt_rbb_destroy(ulog.async_rbb);
  1403. rt_thread_delete(ulog.async_th);
  1404. if (ulog.async_rb)
  1405. rt_ringbuffer_destroy(ulog.async_rb);
  1406. #endif
  1407. ulog.init_ok = RT_FALSE;
  1408. }
  1409. #endif /* RT_USING_ULOG */