ulog.c 43 KB

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