12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601 |
- /*
- * Copyright (c) 2006-2024 RT-Thread Development Team
- *
- * SPDX-License-Identifier: Apache-2.0
- *
- * Change Logs:
- * Date Author Notes
- * 2018-08-25 armink the first version
- */
- #include <stdarg.h>
- #include "ulog.h"
- #include "rthw.h"
- #ifdef ULOG_USING_SYSLOG
- #include <syslog.h>
- #endif
- #ifdef ULOG_TIME_USING_TIMESTAMP
- #include <sys/time.h>
- #endif
- #ifdef ULOG_USING_ASYNC_OUTPUT
- #include <rtdevice.h>
- #endif
- #ifdef RT_USING_ULOG
- /* the number which is max stored line logs */
- #ifndef ULOG_ASYNC_OUTPUT_STORE_LINES
- #define ULOG_ASYNC_OUTPUT_STORE_LINES (ULOG_ASYNC_OUTPUT_BUF_SIZE * 3 / 2 / 80)
- #endif
- #ifdef ULOG_USING_COLOR
- /**
- * CSI(Control Sequence Introducer/Initiator) sign
- * more information on https://en.wikipedia.org/wiki/ANSI_escape_code
- */
- #define CSI_START "\033["
- #define CSI_END "\033[0m"
- /* output log front color */
- #define F_BLACK "30m"
- #define F_RED "31m"
- #define F_GREEN "32m"
- #define F_YELLOW "33m"
- #define F_BLUE "34m"
- #define F_MAGENTA "35m"
- #define F_CYAN "36m"
- #define F_WHITE "37m"
- /* output log default color definition */
- #ifndef ULOG_COLOR_DEBUG
- #define ULOG_COLOR_DEBUG RT_NULL
- #endif
- #ifndef ULOG_COLOR_INFO
- #define ULOG_COLOR_INFO (F_GREEN)
- #endif
- #ifndef ULOG_COLOR_WARN
- #define ULOG_COLOR_WARN (F_YELLOW)
- #endif
- #ifndef ULOG_COLOR_ERROR
- #define ULOG_COLOR_ERROR (F_RED)
- #endif
- #ifndef ULOG_COLOR_ASSERT
- #define ULOG_COLOR_ASSERT (F_MAGENTA)
- #endif
- #endif /* ULOG_USING_COLOR */
- #if ULOG_LINE_BUF_SIZE < 80
- #error "the log line buffer size must more than 80"
- #endif
- struct rt_ulog
- {
- rt_bool_t init_ok;
- rt_bool_t output_lock_enabled;
- struct rt_mutex output_locker;
- /* all backends */
- rt_slist_t backend_list;
- /* the thread log's line buffer */
- char log_buf_th[ULOG_LINE_BUF_SIZE + 1];
- #ifdef ULOG_USING_ISR_LOG
- /* the ISR log's line buffer */
- rt_base_t output_locker_isr_lvl;
- char log_buf_isr[ULOG_LINE_BUF_SIZE + 1];
- #endif /* ULOG_USING_ISR_LOG */
- #ifdef ULOG_USING_ASYNC_OUTPUT
- rt_bool_t async_enabled;
- rt_rbb_t async_rbb;
- /* ringbuffer for log_raw function only */
- struct rt_ringbuffer *async_rb;
- rt_thread_t async_th;
- struct rt_semaphore async_notice;
- #endif
- #ifdef ULOG_USING_FILTER
- struct
- {
- /* all tag's level filter */
- rt_slist_t tag_lvl_list;
- /* global filter level, tag and keyword */
- rt_uint32_t level;
- char tag[ULOG_FILTER_TAG_MAX_LEN + 1];
- char keyword[ULOG_FILTER_KW_MAX_LEN + 1];
- } filter;
- #endif /* ULOG_USING_FILTER */
- };
- #ifdef ULOG_OUTPUT_LEVEL
- /* level output info */
- static const char * const level_output_info[] =
- {
- "A/",
- RT_NULL,
- RT_NULL,
- "E/",
- "W/",
- RT_NULL,
- "I/",
- "D/",
- };
- #endif /* ULOG_OUTPUT_LEVEL */
- #ifdef ULOG_USING_COLOR
- /* color output info */
- static const char * const color_output_info[] =
- {
- ULOG_COLOR_ASSERT,
- RT_NULL,
- RT_NULL,
- ULOG_COLOR_ERROR,
- ULOG_COLOR_WARN,
- RT_NULL,
- ULOG_COLOR_INFO,
- ULOG_COLOR_DEBUG,
- };
- #endif /* ULOG_USING_COLOR */
- /* ulog local object */
- static struct rt_ulog ulog = { 0 };
- static RT_DEFINE_SPINLOCK(_spinlock);
- rt_size_t ulog_strcpy(rt_size_t cur_len, char *dst, const char *src)
- {
- const char *src_old = src;
- RT_ASSERT(dst);
- RT_ASSERT(src);
- while (*src != 0)
- {
- /* make sure destination has enough space */
- if (cur_len++ < ULOG_LINE_BUF_SIZE)
- {
- *dst++ = *src++;
- }
- else
- {
- break;
- }
- }
- return src - src_old;
- }
- rt_size_t ulog_ultoa(char *s, unsigned long int n)
- {
- rt_size_t i = 0, j = 0, len = 0;
- char swap;
- do
- {
- s[len++] = n % 10 + '0';
- } while (n /= 10);
- s[len] = '\0';
- /* reverse string */
- for (i = 0, j = len - 1; i < j; ++i, --j)
- {
- swap = s[i];
- s[i] = s[j];
- s[j] = swap;
- }
- return len;
- }
- static void output_unlock(void)
- {
- /* earlier stage */
- if (ulog.output_lock_enabled == RT_FALSE)
- {
- return;
- }
- /* If the scheduler is started and in thread context */
- if (rt_scheduler_is_available())
- {
- rt_mutex_release(&ulog.output_locker);
- }
- else
- {
- #ifdef ULOG_USING_ISR_LOG
- rt_spin_unlock_irqrestore(&_spinlock, ulog.output_locker_isr_lvl);
- #endif
- }
- }
- static void output_lock(void)
- {
- /* earlier stage */
- if (ulog.output_lock_enabled == RT_FALSE)
- {
- return;
- }
- /* If the scheduler is started and in thread context */
- if (rt_scheduler_is_available())
- {
- rt_mutex_take(&ulog.output_locker, RT_WAITING_FOREVER);
- }
- else
- {
- #ifdef ULOG_USING_ISR_LOG
- ulog.output_locker_isr_lvl = rt_spin_lock_irqsave(&_spinlock);
- #endif
- }
- }
- void ulog_output_lock_enabled(rt_bool_t enabled)
- {
- ulog.output_lock_enabled = enabled;
- }
- static char *get_log_buf(void)
- {
- /* is in thread context */
- if (rt_interrupt_get_nest() == 0)
- {
- return ulog.log_buf_th;
- }
- else
- {
- #ifdef ULOG_USING_ISR_LOG
- return ulog.log_buf_isr;
- #else
- rt_kprintf("Error: Current mode not supported run in ISR. Please enable ULOG_USING_ISR_LOG.\n");
- return RT_NULL;
- #endif
- }
- }
- rt_weak rt_size_t ulog_head_formater(char *log_buf, rt_uint32_t level, const char *tag)
- {
- /* the caller has locker, so it can use static variable for reduce stack usage */
- static rt_size_t log_len;
- RT_ASSERT(log_buf);
- RT_ASSERT(level <= LOG_LVL_DBG);
- RT_ASSERT(tag);
- log_len = 0;
- #ifdef ULOG_USING_COLOR
- /* add CSI start sign and color info */
- if (color_output_info[level])
- {
- log_len += ulog_strcpy(log_len, log_buf + log_len, CSI_START);
- log_len += ulog_strcpy(log_len, log_buf + log_len, color_output_info[level]);
- }
- #endif /* ULOG_USING_COLOR */
- log_buf[log_len] = '\0';
- #ifdef ULOG_OUTPUT_TIME
- /* add time info */
- {
- #ifdef ULOG_TIME_USING_TIMESTAMP
- static struct timeval now;
- static struct tm *tm, tm_tmp;
- static rt_bool_t check_usec_support = RT_FALSE, usec_is_support = RT_FALSE;
- time_t t = (time_t)0;
- if (gettimeofday(&now, RT_NULL) >= 0)
- {
- t = now.tv_sec;
- }
- tm = localtime_r(&t, &tm_tmp);
- /* show the time format MM-DD HH:MM:SS */
- rt_snprintf(log_buf + log_len, ULOG_LINE_BUF_SIZE - log_len, "%02d-%02d %02d:%02d:%02d", tm->tm_mon + 1,
- tm->tm_mday, tm->tm_hour, tm->tm_min, tm->tm_sec);
- /* check the microseconds support when kernel is startup */
- if (t > 0 && !check_usec_support && rt_thread_self() != RT_NULL)
- {
- long old_usec = now.tv_usec;
- /* delay some time for wait microseconds changed */
- rt_thread_mdelay(10);
- gettimeofday(&now, RT_NULL);
- check_usec_support = RT_TRUE;
- /* the microseconds is not equal between two gettimeofday calls */
- if (now.tv_usec != old_usec)
- usec_is_support = RT_TRUE;
- }
- if (usec_is_support)
- {
- /* show the millisecond */
- log_len += rt_strlen(log_buf + log_len);
- rt_snprintf(log_buf + log_len, ULOG_LINE_BUF_SIZE - log_len, ".%03d", now.tv_usec / 1000);
- }
- #else
- static rt_size_t tick_len = 0;
- log_buf[log_len] = '[';
- tick_len = ulog_ultoa(log_buf + log_len + 1, rt_tick_get());
- log_buf[log_len + 1 + tick_len] = ']';
- log_buf[log_len + 1 + tick_len + 1] = '\0';
- #endif /* ULOG_TIME_USING_TIMESTAMP */
- log_len += rt_strlen(log_buf + log_len);
- }
- #endif /* ULOG_OUTPUT_TIME */
- #ifdef ULOG_OUTPUT_LEVEL
- #ifdef ULOG_OUTPUT_TIME
- log_len += ulog_strcpy(log_len, log_buf + log_len, " ");
- #endif
- /* add level info */
- log_len += ulog_strcpy(log_len, log_buf + log_len, level_output_info[level]);
- #endif /* ULOG_OUTPUT_LEVEL */
- #ifdef ULOG_OUTPUT_TAG
- #if !defined(ULOG_OUTPUT_LEVEL) && defined(ULOG_OUTPUT_TIME)
- log_len += ulog_strcpy(log_len, log_buf + log_len, " ");
- #endif
- /* add tag info */
- log_len += ulog_strcpy(log_len, log_buf + log_len, tag);
- #endif /* ULOG_OUTPUT_TAG */
- #ifdef ULOG_OUTPUT_THREAD_NAME
- /* add thread info */
- {
- #if defined(ULOG_OUTPUT_TIME) || defined(ULOG_OUTPUT_LEVEL) || defined(ULOG_OUTPUT_TAG)
- log_len += ulog_strcpy(log_len, log_buf + log_len, " ");
- #endif
- /* is not in interrupt context */
- if (rt_interrupt_get_nest() == 0)
- {
- rt_size_t name_len = 0;
- const char *thread_name = "N/A";
- if (rt_thread_self())
- {
- thread_name = rt_thread_self()->parent.name;
- }
- name_len = rt_strnlen(thread_name, RT_NAME_MAX);
- rt_strncpy(log_buf + log_len, thread_name, name_len);
- log_len += name_len;
- }
- else
- {
- log_len += ulog_strcpy(log_len, log_buf + log_len, "ISR");
- }
- }
- #endif /* ULOG_OUTPUT_THREAD_NAME */
- log_len += ulog_strcpy(log_len, log_buf + log_len, ": ");
- return log_len;
- }
- rt_weak rt_size_t ulog_tail_formater(char *log_buf, rt_size_t log_len, rt_bool_t newline, rt_uint32_t level)
- {
- /* the caller has locker, so it can use static variable for reduce stack usage */
- static rt_size_t newline_len;
- RT_ASSERT(log_buf);
- newline_len = rt_strlen(ULOG_NEWLINE_SIGN);
- /* overflow check and reserve some space for CSI end sign, newline sign and string end sign */
- #ifdef ULOG_USING_COLOR
- if (log_len + (sizeof(CSI_END) - 1) + newline_len + sizeof((char)'\0') > ULOG_LINE_BUF_SIZE)
- {
- /* using max length */
- log_len = ULOG_LINE_BUF_SIZE;
- /* reserve some space for CSI end sign */
- log_len -= (sizeof(CSI_END) - 1);
- #else
- if (log_len + newline_len + sizeof((char)'\0') > ULOG_LINE_BUF_SIZE)
- {
- /* using max length */
- log_len = ULOG_LINE_BUF_SIZE;
- #endif /* ULOG_USING_COLOR */
- /* reserve some space for newline sign */
- log_len -= newline_len;
- /* reserve some space for string end sign */
- log_len -= sizeof((char)'\0');
- }
- /* package newline sign */
- if (newline)
- {
- log_len += ulog_strcpy(log_len, log_buf + log_len, ULOG_NEWLINE_SIGN);
- }
- #ifdef ULOG_USING_COLOR
- /* add CSI end sign */
- if (color_output_info[level])
- {
- log_len += ulog_strcpy(log_len, log_buf + log_len, CSI_END);
- }
- #endif /* ULOG_USING_COLOR */
- /* add string end sign */
- log_buf[log_len] = '\0';
- return log_len;
- }
- rt_weak rt_size_t ulog_formater(char *log_buf, rt_uint32_t level, const char *tag, rt_bool_t newline,
- const char *format, va_list args)
- {
- /* the caller has locker, so it can use static variable for reduce stack usage */
- static rt_size_t log_len;
- static int fmt_result;
- RT_ASSERT(log_buf);
- RT_ASSERT(format);
- /* log head */
- log_len = ulog_head_formater(log_buf, level, tag);
- /* log content */
- fmt_result = rt_vsnprintf(log_buf + log_len, ULOG_LINE_BUF_SIZE - log_len, format, args);
- /* calculate log length */
- if ((log_len + fmt_result <= ULOG_LINE_BUF_SIZE) && (fmt_result > -1))
- {
- log_len += fmt_result;
- }
- else
- {
- /* using max length */
- log_len = ULOG_LINE_BUF_SIZE;
- }
- /* log tail */
- return ulog_tail_formater(log_buf, log_len, newline, level);
- }
- 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)
- {
- #define __is_print(ch) ((unsigned int)((ch) - ' ') < 127u - ' ')
- /* the caller has locker, so it can use static variable for reduce stack usage */
- static rt_size_t log_len, j;
- static int fmt_result;
- char dump_string[8];
- RT_ASSERT(log_buf);
- RT_ASSERT(buf);
- /* log head */
- log_len = ulog_head_formater(log_buf, LOG_LVL_DBG, tag);
- /* log content */
- fmt_result = rt_snprintf(log_buf + log_len, ULOG_LINE_BUF_SIZE, "%04X-%04X: ", addr, addr + size);
- /* calculate log length */
- if ((fmt_result > -1) && (fmt_result <= ULOG_LINE_BUF_SIZE))
- {
- log_len += fmt_result;
- }
- else
- {
- log_len = ULOG_LINE_BUF_SIZE;
- }
- /* dump hex */
- for (j = 0; j < width; j++)
- {
- if (j < size)
- {
- rt_snprintf(dump_string, sizeof(dump_string), "%02X ", buf[j]);
- }
- else
- {
- rt_strncpy(dump_string, " ", sizeof(dump_string));
- }
- log_len += ulog_strcpy(log_len, log_buf + log_len, dump_string);
- if ((j + 1) % 8 == 0)
- {
- log_len += ulog_strcpy(log_len, log_buf + log_len, " ");
- }
- }
- log_len += ulog_strcpy(log_len, log_buf + log_len, " ");
- /* dump char for hex */
- for (j = 0; j < size; j++)
- {
- rt_snprintf(dump_string, sizeof(dump_string), "%c", __is_print(buf[j]) ? buf[j] : '.');
- log_len += ulog_strcpy(log_len, log_buf + log_len, dump_string);
- }
- /* log tail */
- return ulog_tail_formater(log_buf, log_len, RT_TRUE, LOG_LVL_DBG);
- }
- 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)
- {
- rt_slist_t *node;
- ulog_backend_t backend;
- if (!ulog.init_ok)
- return;
- /* if there is no backend */
- if (!rt_slist_first(&ulog.backend_list))
- {
- rt_kputs(log);
- return;
- }
- /* output for all backends */
- for (node = rt_slist_first(&ulog.backend_list); node; node = rt_slist_next(node))
- {
- backend = rt_slist_entry(node, struct ulog_backend, list);
- if (backend->out_level < level)
- {
- continue;
- }
- #if !defined(ULOG_USING_COLOR) || defined(ULOG_USING_SYSLOG)
- backend->output(backend, level, tag, is_raw, log, len);
- #else
- if (backend->filter && backend->filter(backend, level, tag, is_raw, log, len) == RT_FALSE)
- {
- /* backend's filter is not match, so skip output */
- continue;
- }
- if (backend->support_color || is_raw)
- {
- backend->output(backend, level, tag, is_raw, log, len);
- }
- else
- {
- /* recalculate the log start address and log size when backend not supported color */
- rt_size_t color_info_len = 0, output_len = len;
- const char *output_log = log;
- if (color_output_info[level] != RT_NULL)
- color_info_len = rt_strlen(color_output_info[level]);
- if (color_info_len)
- {
- rt_size_t color_hdr_len = rt_strlen(CSI_START) + color_info_len;
- output_log += color_hdr_len;
- output_len -= (color_hdr_len + (sizeof(CSI_END) - 1));
- }
- backend->output(backend, level, tag, is_raw, output_log, output_len);
- }
- #endif /* !defined(ULOG_USING_COLOR) || defined(ULOG_USING_SYSLOG) */
- }
- }
- 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)
- {
- #ifdef ULOG_USING_ASYNC_OUTPUT
- rt_size_t log_buf_size = log_len + sizeof((char)'\0');
- if (ulog.async_enabled)
- {
- if (is_raw == RT_FALSE)
- {
- rt_rbb_blk_t log_blk;
- ulog_frame_t log_frame;
- /* allocate log frame */
- log_blk = rt_rbb_blk_alloc(ulog.async_rbb, RT_ALIGN(sizeof(struct ulog_frame) + log_buf_size, RT_ALIGN_SIZE));
- if (log_blk)
- {
- /* package the log frame */
- log_frame = (ulog_frame_t) log_blk->buf;
- log_frame->magic = ULOG_FRAME_MAGIC;
- log_frame->is_raw = is_raw;
- log_frame->level = level;
- log_frame->log_len = log_len;
- log_frame->tag = tag;
- log_frame->log = (const char *)log_blk->buf + sizeof(struct ulog_frame);
- /* copy log data */
- rt_strncpy((char *)(log_blk->buf + sizeof(struct ulog_frame)), log_buf, log_buf_size);
- /* put the block */
- rt_rbb_blk_put(log_blk);
- /* send a notice */
- rt_sem_release(&ulog.async_notice);
- }
- else
- {
- static rt_bool_t already_output = RT_FALSE;
- if (already_output == RT_FALSE)
- {
- rt_kprintf("Warning: There is no enough buffer for saving async log,"
- " please increase the ULOG_ASYNC_OUTPUT_BUF_SIZE option.\n");
- already_output = RT_TRUE;
- }
- }
- }
- else if (ulog.async_rb)
- {
- /* log_buf_size contain the tail \0, which will lead discard follow char, so only put log_buf_size -1 */
- rt_ringbuffer_put(ulog.async_rb, (const rt_uint8_t *)log_buf, (rt_uint16_t)log_buf_size - 1);
- /* send a notice */
- rt_sem_release(&ulog.async_notice);
- }
- return;
- }
- #endif /* ULOG_USING_ASYNC_OUTPUT */
- /* is in thread context */
- if (rt_interrupt_get_nest() == 0)
- {
- /* output to all backends */
- ulog_output_to_all_backend(level, tag, is_raw, log_buf, log_len);
- }
- else
- {
- #ifdef ULOG_BACKEND_USING_CONSOLE
- /* We can't ensure that all backends support ISR context output.
- * So only using rt_kprintf when context is ISR */
- extern void ulog_console_backend_output(struct ulog_backend *backend, rt_uint32_t level, const char *tag,
- rt_bool_t is_raw, const char *log, rt_size_t len);
- ulog_console_backend_output(RT_NULL, level, tag, is_raw, log_buf, log_len);
- #endif /* ULOG_BACKEND_USING_CONSOLE */
- }
- }
- /**
- * output the log by variable argument list
- *
- * @param level level
- * @param tag tag
- * @param newline has_newline
- * @param hex_buf != RT_NULL: enable hex log mode, data buffer
- * @param hex_size hex data buffer size
- * @param hex_width hex log width
- * @param hex_addr hex data address
- * @param format output format
- * @param args variable argument list
- */
- 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,
- rt_size_t hex_width, rt_base_t hex_addr, const char *format, va_list args)
- {
- static rt_bool_t ulog_voutput_recursion = RT_FALSE;
- char *log_buf = RT_NULL;
- static rt_size_t log_len = 0;
- RT_ASSERT(tag);
- RT_ASSERT((format && !hex_buf) || (!format && hex_buf));
- #ifndef ULOG_USING_SYSLOG
- RT_ASSERT(level <= LOG_LVL_DBG);
- #else
- RT_ASSERT(LOG_PRI(level) <= LOG_DEBUG);
- #endif /* ULOG_USING_SYSLOG */
- if (!ulog.init_ok)
- {
- return;
- }
- #ifdef ULOG_USING_FILTER
- /* level filter */
- #ifndef ULOG_USING_SYSLOG
- if (level > ulog.filter.level || level > ulog_tag_lvl_filter_get(tag))
- {
- return;
- }
- #else
- if (((LOG_MASK(LOG_PRI(level)) & ulog.filter.level) == 0)
- || ((LOG_MASK(LOG_PRI(level)) & ulog_tag_lvl_filter_get(tag)) == 0))
- {
- return;
- }
- #endif /* ULOG_USING_SYSLOG */
- else if (!rt_strstr(tag, ulog.filter.tag))
- {
- /* tag filter */
- return;
- }
- #endif /* ULOG_USING_FILTER */
- /* get log buffer */
- log_buf = get_log_buf();
- /* lock output */
- output_lock();
- /* If there is a recursion, we use a simple way */
- if ((ulog_voutput_recursion == RT_TRUE) && (hex_buf == RT_NULL))
- {
- rt_kprintf(format, args);
- if (newline == RT_TRUE)
- {
- rt_kprintf(ULOG_NEWLINE_SIGN);
- }
- output_unlock();
- return;
- }
- ulog_voutput_recursion = RT_TRUE;
- if (hex_buf == RT_NULL)
- {
- #ifndef ULOG_USING_SYSLOG
- log_len = ulog_formater(log_buf, level, tag, newline, format, args);
- #else
- 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);
- log_len = syslog_formater(log_buf, level, tag, newline, format, args);
- #endif /* ULOG_USING_SYSLOG */
- }
- else
- {
- /* hex mode */
- log_len = ulog_hex_formater(log_buf, tag, hex_buf, hex_size, hex_width, hex_addr);
- }
- #ifdef ULOG_USING_FILTER
- /* keyword filter */
- if (ulog.filter.keyword[0] != '\0')
- {
- /* add string end sign */
- log_buf[log_len] = '\0';
- /* find the keyword */
- if (!rt_strstr(log_buf, ulog.filter.keyword))
- {
- ulog_voutput_recursion = RT_FALSE;
- /* unlock output */
- output_unlock();
- return;
- }
- }
- #endif /* ULOG_USING_FILTER */
- /* do log output */
- do_output(level, tag, RT_FALSE, log_buf, log_len);
- ulog_voutput_recursion = RT_FALSE;
- /* unlock output */
- output_unlock();
- }
- /**
- * output the log
- *
- * @param level level
- * @param tag tag
- * @param newline has newline
- * @param format output format
- * @param ... args
- */
- void ulog_output(rt_uint32_t level, const char *tag, rt_bool_t newline, const char *format, ...)
- {
- va_list args;
- /* args point to the first variable parameter */
- va_start(args, format);
- ulog_voutput(level, tag, newline, RT_NULL, 0, 0, 0, format, args);
- va_end(args);
- }
- /**
- * output RAW string format log
- *
- * @param format output format
- * @param ... args
- */
- void ulog_raw(const char *format, ...)
- {
- rt_size_t log_len = 0;
- char *log_buf = RT_NULL;
- va_list args;
- int fmt_result;
- RT_ASSERT(ulog.init_ok);
- #ifdef ULOG_USING_ASYNC_OUTPUT
- if (ulog.async_rb == RT_NULL)
- {
- ulog.async_rb = rt_ringbuffer_create(ULOG_ASYNC_OUTPUT_BUF_SIZE);
- }
- #endif
- /* get log buffer */
- log_buf = get_log_buf();
- /* lock output */
- output_lock();
- /* args point to the first variable parameter */
- va_start(args, format);
- fmt_result = rt_vsnprintf(log_buf, ULOG_LINE_BUF_SIZE, format, args);
- va_end(args);
- /* calculate log length
- * rt_vsnprintf would add \0 to the end, push \0 to ulog.async_rb will discard the follow char
- * if fmt_result = ULOG_LINE_BUF_SIZE, then the last char must be \0
- */
- if ((fmt_result > -1) && (fmt_result < ULOG_LINE_BUF_SIZE))
- {
- log_len = fmt_result;
- }
- else
- {
- log_len = ULOG_LINE_BUF_SIZE;
- }
- /* do log output */
- do_output(LOG_LVL_DBG, "", RT_TRUE, log_buf, log_len);
- /* unlock output */
- output_unlock();
- }
- /**
- * dump the hex format data to log
- *
- * @param tag name for hex object, it will show on log header
- * @param width hex number for every line, such as: 16, 32
- * @param buf hex buffer
- * @param size buffer size
- */
- void ulog_hexdump(const char *tag, rt_size_t width, const rt_uint8_t *buf, rt_size_t size, ...)
- {
- rt_size_t i, len;
- va_list args;
- va_start(args, size);
- for (i = 0; i < size; i += width, buf += width)
- {
- if (i + width > size)
- len = size - i;
- else
- len = width;
- ulog_voutput(LOG_LVL_DBG, tag, RT_TRUE, buf, len, width, i, RT_NULL, args);
- }
- va_end(args);
- }
- #ifdef ULOG_USING_FILTER
- /**
- * Set the filter's level by different backend.
- * The log on this backend which level is less than it will stop output.
- *
- * @param be_name backend name
- * @param level The filter level. When the level is LOG_FILTER_LVL_SILENT, the log enter silent mode.
- * When the level is LOG_FILTER_LVL_ALL, it will remove this tag's level filer.
- * Then all level log will resume output.
- *
- * @return 0 : success
- * -10: level is out of range
- */
- int ulog_be_lvl_filter_set(const char *be_name, rt_uint32_t level)
- {
- rt_slist_t *node = RT_NULL;
- ulog_backend_t backend;
- int result = RT_EOK;
- if (level > LOG_FILTER_LVL_ALL)
- return -RT_EINVAL;
- if (!ulog.init_ok)
- return result;
- for (node = rt_slist_first(&ulog.backend_list); node; node = rt_slist_next(node))
- {
- backend = rt_slist_entry(node, struct ulog_backend, list);
- if (rt_strncmp(backend->name, be_name, RT_NAME_MAX) == 0)
- {
- backend->out_level = level;
- }
- }
- return result;
- }
- /**
- * Set the filter's level by different tag.
- * The log on this tag which level is less than it will stop output.
- *
- * example:
- * // the example tag log enter silent mode
- * ulog_set_filter_lvl("example", LOG_FILTER_LVL_SILENT);
- * // the example tag log which level is less than INFO level will stop output
- * ulog_set_filter_lvl("example", LOG_LVL_INFO);
- * // remove example tag's level filter, all level log will resume output
- * ulog_set_filter_lvl("example", LOG_FILTER_LVL_ALL);
- *
- * @param tag log tag
- * @param level The filter level. When the level is LOG_FILTER_LVL_SILENT, the log enter silent mode.
- * When the level is LOG_FILTER_LVL_ALL, it will remove this tag's level filer.
- * Then all level log will resume output.
- *
- * @return 0 : success
- * -5 : no memory
- * -10: level is out of range
- */
- int ulog_tag_lvl_filter_set(const char *tag, rt_uint32_t level)
- {
- rt_slist_t *node;
- ulog_tag_lvl_filter_t tag_lvl = RT_NULL;
- int result = RT_EOK;
- if (level > LOG_FILTER_LVL_ALL)
- return -RT_EINVAL;
- if (!ulog.init_ok)
- return result;
- /* lock output */
- output_lock();
- /* find the tag in list */
- for (node = rt_slist_first(ulog_tag_lvl_list_get()); node; node = rt_slist_next(node))
- {
- tag_lvl = rt_slist_entry(node, struct ulog_tag_lvl_filter, list);
- if (!rt_strncmp(tag_lvl->tag, tag, ULOG_FILTER_TAG_MAX_LEN))
- {
- break;
- }
- else
- {
- tag_lvl = RT_NULL;
- }
- }
- /* find OK */
- if (tag_lvl)
- {
- if (level == LOG_FILTER_LVL_ALL)
- {
- /* remove current tag's level filter when input level is the lowest level */
- rt_slist_remove(ulog_tag_lvl_list_get(), &tag_lvl->list);
- rt_free(tag_lvl);
- }
- else
- {
- /* update level */
- tag_lvl->level = level;
- }
- }
- else
- {
- /* only add the new tag's level filer when level is not LOG_FILTER_LVL_ALL */
- if (level != LOG_FILTER_LVL_ALL)
- {
- /* new a tag's level filter */
- tag_lvl = (ulog_tag_lvl_filter_t)rt_malloc(sizeof(struct ulog_tag_lvl_filter));
- if (tag_lvl)
- {
- rt_memset(tag_lvl->tag, 0 , sizeof(tag_lvl->tag));
- rt_strncpy(tag_lvl->tag, tag, ULOG_FILTER_TAG_MAX_LEN);
- tag_lvl->level = level;
- rt_slist_append(ulog_tag_lvl_list_get(), &tag_lvl->list);
- }
- else
- {
- result = -RT_ENOMEM;
- }
- }
- }
- /* unlock output */
- output_unlock();
- return result;
- }
- /**
- * get the level on tag's level filer
- *
- * @param tag log tag
- *
- * @return It will return the lowest level when tag was not found.
- * Other level will return when tag was found.
- */
- rt_uint32_t ulog_tag_lvl_filter_get(const char *tag)
- {
- rt_slist_t *node;
- ulog_tag_lvl_filter_t tag_lvl = RT_NULL;
- rt_uint32_t level = LOG_FILTER_LVL_ALL;
- if (!ulog.init_ok)
- return level;
- /* lock output */
- output_lock();
- /* find the tag in list */
- for (node = rt_slist_first(ulog_tag_lvl_list_get()); node; node = rt_slist_next(node))
- {
- tag_lvl = rt_slist_entry(node, struct ulog_tag_lvl_filter, list);
- if (!rt_strncmp(tag_lvl->tag, tag, ULOG_FILTER_TAG_MAX_LEN))
- {
- level = tag_lvl->level;
- break;
- }
- }
- /* unlock output */
- output_unlock();
- return level;
- }
- /**
- * get the tag's level list on filter
- *
- * @return tag's level list
- */
- rt_slist_t *ulog_tag_lvl_list_get(void)
- {
- return &ulog.filter.tag_lvl_list;
- }
- /**
- * set log global filter level
- *
- * @param level log level: LOG_LVL_ASSERT, LOG_LVL_ERROR, LOG_LVL_WARNING, LOG_LVL_INFO, LOG_LVL_DBG
- * LOG_FILTER_LVL_SILENT: disable all log output, except assert level
- * LOG_FILTER_LVL_ALL: enable all log output
- */
- void ulog_global_filter_lvl_set(rt_uint32_t level)
- {
- RT_ASSERT(level <= LOG_FILTER_LVL_ALL);
- ulog.filter.level = level;
- }
- /**
- * get log global filter level
- *
- * @return log level: LOG_LVL_ASSERT, LOG_LVL_ERROR, LOG_LVL_WARNING, LOG_LVL_INFO, LOG_LVL_DBG
- * LOG_FILTER_LVL_SILENT: disable all log output, except assert level
- * LOG_FILTER_LVL_ALL: enable all log output
- */
- rt_uint32_t ulog_global_filter_lvl_get(void)
- {
- return ulog.filter.level;
- }
- /**
- * set log global filter tag
- *
- * @param tag tag
- */
- void ulog_global_filter_tag_set(const char *tag)
- {
- RT_ASSERT(tag);
- rt_strncpy(ulog.filter.tag, tag, ULOG_FILTER_TAG_MAX_LEN);
- }
- /**
- * get log global filter tag
- *
- * @return tag
- */
- const char *ulog_global_filter_tag_get(void)
- {
- return ulog.filter.tag;
- }
- /**
- * set log global filter keyword
- *
- * @param keyword keyword
- */
- void ulog_global_filter_kw_set(const char *keyword)
- {
- RT_ASSERT(keyword);
- rt_strncpy(ulog.filter.keyword, keyword, ULOG_FILTER_KW_MAX_LEN);
- }
- /**
- * get log global filter keyword
- *
- * @return keyword
- */
- const char *ulog_global_filter_kw_get(void)
- {
- return ulog.filter.keyword;
- }
- #ifdef RT_USING_FINSH
- #include <finsh.h>
- static void _print_lvl_info(void)
- {
- #ifndef ULOG_USING_SYSLOG
- rt_kprintf("Assert : 0\n");
- rt_kprintf("Error : 3\n");
- rt_kprintf("Warning : 4\n");
- rt_kprintf("Info : 6\n");
- rt_kprintf("Debug : 7\n");
- #else
- rt_kprintf("EMERG : 1 (1 << 0)\n");
- rt_kprintf("ALERT : 2 (1 << 1)\n");
- rt_kprintf("CRIT : 4 (1 << 2)\n");
- rt_kprintf("ERR : 8 (1 << 3)\n");
- rt_kprintf("WARNING : 16 (1 << 4)\n");
- rt_kprintf("NOTICE : 32 (1 << 5)\n");
- rt_kprintf("INFO : 64 (1 << 6)\n");
- rt_kprintf("DEBUG : 128 (1 << 7)\n");
- #endif /* ULOG_USING_SYSLOG */
- }
- static void ulog_be_lvl(uint8_t argc, char **argv)
- {
- if (argc > 2)
- {
- if ((atoi(argv[2]) <= LOG_FILTER_LVL_ALL) && (atoi(argv[2]) >= 0))
- {
- ulog_be_lvl_filter_set(argv[1], atoi(argv[2]));
- }
- else
- {
- rt_kprintf("Please input correct level (0-%d).\n", LOG_FILTER_LVL_ALL);
- }
- }
- else
- {
- rt_kprintf("Please input: ulog_be_lvl <be_name> <level>.\n");
- _print_lvl_info();
- }
- }
- MSH_CMD_EXPORT(ulog_be_lvl, Set ulog filter level by different backend.);
- static void ulog_tag_lvl(uint8_t argc, char **argv)
- {
- if (argc > 2)
- {
- if ((atoi(argv[2]) <= LOG_FILTER_LVL_ALL) && (atoi(argv[2]) >= 0))
- {
- ulog_tag_lvl_filter_set(argv[1], atoi(argv[2]));
- }
- else
- {
- rt_kprintf("Please input correct level (0-%d).\n", LOG_FILTER_LVL_ALL);
- }
- }
- else
- {
- rt_kprintf("Please input: ulog_tag_lvl <tag> <level>.\n");
- _print_lvl_info();
- }
- }
- MSH_CMD_EXPORT(ulog_tag_lvl, Set ulog filter level by different tag.);
- static void ulog_lvl(uint8_t argc, char **argv)
- {
- if (argc > 1)
- {
- if ((atoi(argv[1]) <= LOG_FILTER_LVL_ALL) && (atoi(argv[1]) >= 0))
- {
- ulog_global_filter_lvl_set(atoi(argv[1]));
- }
- else
- {
- rt_kprintf("Please input correct level (0-%d).\n", LOG_FILTER_LVL_ALL);
- }
- }
- else
- {
- rt_kprintf("Please input: ulog_lvl <level>.\n");
- _print_lvl_info();
- }
- }
- MSH_CMD_EXPORT(ulog_lvl, Set ulog global filter level.);
- static void ulog_tag(uint8_t argc, char **argv)
- {
- if (argc > 1)
- {
- if (rt_strlen(argv[1]) <= ULOG_FILTER_TAG_MAX_LEN)
- {
- ulog_global_filter_tag_set(argv[1]);
- }
- else
- {
- rt_kprintf("The tag length is too long. Max is %d.\n", ULOG_FILTER_TAG_MAX_LEN);
- }
- }
- else
- {
- ulog_global_filter_tag_set("");
- }
- }
- MSH_CMD_EXPORT(ulog_tag, Set ulog global filter tag);
- static void ulog_kw(uint8_t argc, char **argv)
- {
- if (argc > 1)
- {
- if (rt_strlen(argv[1]) <= ULOG_FILTER_KW_MAX_LEN)
- {
- ulog_global_filter_kw_set(argv[1]);
- }
- else
- {
- rt_kprintf("The keyword length is too long. Max is %d.\n", ULOG_FILTER_KW_MAX_LEN);
- }
- }
- else
- {
- ulog_global_filter_kw_set("");
- }
- }
- MSH_CMD_EXPORT(ulog_kw, Set ulog global filter keyword);
- static void ulog_filter(uint8_t argc, char **argv)
- {
- #ifndef ULOG_USING_SYSLOG
- const char *lvl_name[] = { "Assert ", "Error ", "Error ", "Error ", "Warning", "Info ", "Info ", "Debug " };
- #endif
- const char *tag = ulog_global_filter_tag_get(), *kw = ulog_global_filter_kw_get();
- rt_slist_t *node;
- ulog_tag_lvl_filter_t tag_lvl = RT_NULL;
- rt_kprintf("--------------------------------------\n");
- rt_kprintf("ulog global filter:\n");
- #ifndef ULOG_USING_SYSLOG
- rt_kprintf("level : %s\n", lvl_name[ulog_global_filter_lvl_get()]);
- #else
- rt_kprintf("level : %d\n", ulog_global_filter_lvl_get());
- #endif
- rt_kprintf("tag : %s\n", rt_strlen(tag) == 0 ? "NULL" : tag);
- rt_kprintf("keyword : %s\n", rt_strlen(kw) == 0 ? "NULL" : kw);
- rt_kprintf("--------------------------------------\n");
- rt_kprintf("ulog tag's level filter:\n");
- if (rt_slist_isempty(ulog_tag_lvl_list_get()))
- {
- rt_kprintf("settings not found\n");
- }
- else
- {
- /* lock output */
- output_lock();
- /* show the tag level list */
- for (node = rt_slist_first(ulog_tag_lvl_list_get()); node; node = rt_slist_next(node))
- {
- tag_lvl = rt_slist_entry(node, struct ulog_tag_lvl_filter, list);
- rt_kprintf("%-*.*s: ", ULOG_FILTER_TAG_MAX_LEN, ULOG_FILTER_TAG_MAX_LEN, tag_lvl->tag);
- #ifndef ULOG_USING_SYSLOG
- rt_kprintf("%s\n", lvl_name[tag_lvl->level]);
- #else
- rt_kprintf("%d\n", tag_lvl->level);
- #endif
- }
- /* unlock output */
- output_unlock();
- }
- }
- MSH_CMD_EXPORT(ulog_filter, Show ulog filter settings);
- #endif /* RT_USING_FINSH */
- #endif /* ULOG_USING_FILTER */
- /**
- * @brief register the backend device into the ulog.
- *
- * @param backend Backend device handle, a pointer to a "struct ulog_backend" obj.
- * @param name Backend device name.
- * @param support_color Whether it supports color logs.
- * @return rt_err_t - return 0 on success.
- *
- * @note - This function is used to register the backend device into the ulog,
- * ensuring that the function members in the backend device structure are set before registration.
- * - about struct ulog_backend:
- * 1. The name and support_color properties can be passed in through the ulog_backend_register() function.
- * 2. output is the back-end specific output function, and all backends must implement the interface.
- * 3. init/deinit is optional, init is called at register, and deinit is called at unregister or ulog_deinit.
- * 4. flush is also optional, and some internal output cached backends need to implement this interface.
- * For example, some file systems with RAM cache. The flush of the backend is usually called by
- * ulog_flush in the case of an exception such as assertion or hardfault.
- */
- rt_err_t ulog_backend_register(ulog_backend_t backend, const char *name, rt_bool_t support_color)
- {
- rt_base_t level;
- RT_ASSERT(backend);
- RT_ASSERT(name);
- RT_ASSERT(ulog.init_ok);
- RT_ASSERT(backend->output);
- if (backend->init)
- {
- backend->init(backend);
- }
- backend->support_color = support_color;
- backend->out_level = LOG_FILTER_LVL_ALL;
- rt_strncpy(backend->name, name, RT_NAME_MAX - 1);
- level = rt_spin_lock_irqsave(&_spinlock);
- rt_slist_append(&ulog.backend_list, &backend->list);
- rt_spin_unlock_irqrestore(&_spinlock, level);
- return RT_EOK;
- }
- /**
- * @brief unregister a backend device that has already been registered.
- *
- * @param backend Backend device handle
- * @return rt_err_t - return 0 on success.
- * @note deinit function will be called at unregister.
- */
- rt_err_t ulog_backend_unregister(ulog_backend_t backend)
- {
- rt_base_t level;
- RT_ASSERT(backend);
- RT_ASSERT(ulog.init_ok);
- if (backend->deinit)
- {
- backend->deinit(backend);
- }
- level = rt_spin_lock_irqsave(&_spinlock);
- rt_slist_remove(&ulog.backend_list, &backend->list);
- rt_spin_unlock_irqrestore(&_spinlock, level);
- return RT_EOK;
- }
- rt_err_t ulog_backend_set_filter(ulog_backend_t backend, ulog_backend_filter_t filter)
- {
- rt_base_t level;
- RT_ASSERT(backend);
- level = rt_spin_lock_irqsave(&_spinlock);
- backend->filter = filter;
- rt_spin_unlock_irqrestore(&_spinlock, level);
- return RT_EOK;
- }
- ulog_backend_t ulog_backend_find(const char *name)
- {
- rt_base_t level;
- rt_slist_t *node;
- ulog_backend_t backend;
- RT_ASSERT(ulog.init_ok);
- level = rt_spin_lock_irqsave(&_spinlock);
- for (node = rt_slist_first(&ulog.backend_list); node; node = rt_slist_next(node))
- {
- backend = rt_slist_entry(node, struct ulog_backend, list);
- if (rt_strncmp(backend->name, name, RT_NAME_MAX) == 0)
- {
- rt_spin_unlock_irqrestore(&_spinlock, level);
- return backend;
- }
- }
- rt_spin_unlock_irqrestore(&_spinlock, level);
- return RT_NULL;
- }
- #ifdef ULOG_USING_ASYNC_OUTPUT
- /**
- * asynchronous output logs to all backends
- *
- * @note you must call this function when ULOG_ASYNC_OUTPUT_BY_THREAD is disable
- */
- void ulog_async_output(void)
- {
- rt_rbb_blk_t log_blk;
- ulog_frame_t log_frame;
- if (!ulog.async_enabled)
- {
- return;
- }
- while ((log_blk = rt_rbb_blk_get(ulog.async_rbb)) != RT_NULL)
- {
- log_frame = (ulog_frame_t) log_blk->buf;
- if (log_frame->magic == ULOG_FRAME_MAGIC)
- {
- /* output to all backends */
- ulog_output_to_all_backend(log_frame->level, log_frame->tag, log_frame->is_raw, log_frame->log,
- log_frame->log_len);
- }
- rt_rbb_blk_free(ulog.async_rbb, log_blk);
- }
- /* output the log_raw format log */
- if (ulog.async_rb)
- {
- rt_size_t log_len = rt_ringbuffer_data_len(ulog.async_rb);
- char *log = rt_malloc(log_len + 1);
- if (log)
- {
- rt_size_t len = rt_ringbuffer_get(ulog.async_rb, (rt_uint8_t *)log, (rt_uint16_t)log_len);
- log[log_len] = '\0';
- ulog_output_to_all_backend(LOG_LVL_DBG, "", RT_TRUE, log, len);
- rt_free(log);
- }
- }
- }
- /**
- * enable or disable asynchronous output mode
- * the log will be output directly when mode is disabled
- *
- * @param enabled RT_TRUE: enabled, RT_FALSE: disabled
- */
- void ulog_async_output_enabled(rt_bool_t enabled)
- {
- ulog.async_enabled = enabled;
- }
- /**
- * waiting for get asynchronous output log
- *
- * @param time the waiting time
- *
- * @return the operation status, RT_EOK on successful
- */
- rt_err_t ulog_async_waiting_log(rt_int32_t time)
- {
- rt_sem_control(&ulog.async_notice, RT_IPC_CMD_RESET, RT_NULL);
- return rt_sem_take(&ulog.async_notice, time);
- }
- static void async_output_thread_entry(void *param)
- {
- ulog_async_output();
- while (1)
- {
- ulog_async_waiting_log(RT_WAITING_FOREVER);
- while (1)
- {
- ulog_async_output();
- /* If there is no log output for a certain period of time,
- * refresh the log buffer
- */
- if (ulog_async_waiting_log(RT_TICK_PER_SECOND * 2) == RT_EOK)
- {
- continue;
- }
- else
- {
- ulog_flush();
- break;
- }
- }
- }
- }
- #endif /* ULOG_USING_ASYNC_OUTPUT */
- /**
- * flush all backends's log
- */
- void ulog_flush(void)
- {
- rt_slist_t *node;
- ulog_backend_t backend;
- if (!ulog.init_ok)
- return;
- #ifdef ULOG_USING_ASYNC_OUTPUT
- ulog_async_output();
- #endif
- /* flush all backends */
- for (node = rt_slist_first(&ulog.backend_list); node; node = rt_slist_next(node))
- {
- backend = rt_slist_entry(node, struct ulog_backend, list);
- if (backend->flush)
- {
- backend->flush(backend);
- }
- }
- }
- /**
- * @brief ulog initialization
- *
- * @return int return 0 on success, return -5 when failed of insufficient memory.
- *
- * @note This function must be called to complete ulog initialization before using ulog.
- * This function will also be called automatically if component auto-initialization is turned on.
- */
- int ulog_init(void)
- {
- if (ulog.init_ok)
- return 0;
- rt_mutex_init(&ulog.output_locker, "ulog", RT_IPC_FLAG_PRIO);
- ulog.output_lock_enabled = RT_TRUE;
- rt_slist_init(&ulog.backend_list);
- #ifdef ULOG_USING_FILTER
- rt_slist_init(ulog_tag_lvl_list_get());
- #endif
- #ifdef ULOG_USING_ASYNC_OUTPUT
- RT_ASSERT(ULOG_ASYNC_OUTPUT_STORE_LINES >= 2);
- ulog.async_enabled = RT_TRUE;
- /* async output ring block buffer */
- ulog.async_rbb = rt_rbb_create(RT_ALIGN(ULOG_ASYNC_OUTPUT_BUF_SIZE, RT_ALIGN_SIZE), ULOG_ASYNC_OUTPUT_STORE_LINES);
- if (ulog.async_rbb == RT_NULL)
- {
- rt_kprintf("Error: ulog init failed! No memory for async rbb.\n");
- rt_mutex_detach(&ulog.output_locker);
- return -RT_ENOMEM;
- }
- rt_sem_init(&ulog.async_notice, "ulog", 0, RT_IPC_FLAG_FIFO);
- #endif /* ULOG_USING_ASYNC_OUTPUT */
- #ifdef ULOG_USING_FILTER
- ulog_global_filter_lvl_set(LOG_FILTER_LVL_ALL);
- #endif
- ulog.init_ok = RT_TRUE;
- return 0;
- }
- INIT_BOARD_EXPORT(ulog_init);
- #ifdef ULOG_USING_ASYNC_OUTPUT
- int ulog_async_init(void)
- {
- if (ulog.async_th == RT_NULL)
- {
- /* async output thread */
- ulog.async_th = rt_thread_create("ulog_async", async_output_thread_entry, &ulog, ULOG_ASYNC_OUTPUT_THREAD_STACK,
- ULOG_ASYNC_OUTPUT_THREAD_PRIORITY, 20);
- if (ulog.async_th == RT_NULL)
- {
- rt_kprintf("Error: ulog init failed! No memory for async output thread.\n");
- return -RT_ENOMEM;
- }
- /* async output thread startup */
- rt_thread_startup(ulog.async_th);
- }
- return 0;
- }
- INIT_PREV_EXPORT(ulog_async_init);
- #endif /* ULOG_USING_ASYNC_OUTPUT */
- /**
- * @brief ulog deinitialization
- *
- * @note This deinit release resource can be executed when ulog is no longer used.
- */
- void ulog_deinit(void)
- {
- rt_slist_t *node;
- ulog_backend_t backend;
- if (!ulog.init_ok)
- return;
- /* deinit all backends */
- for (node = rt_slist_first(&ulog.backend_list); node; node = rt_slist_next(node))
- {
- backend = rt_slist_entry(node, struct ulog_backend, list);
- if (backend->deinit)
- {
- backend->deinit(backend);
- }
- }
- #ifdef ULOG_USING_FILTER
- /* deinit tag's level filter */
- {
- ulog_tag_lvl_filter_t tag_lvl;
- for (node = rt_slist_first(ulog_tag_lvl_list_get()); node; node = rt_slist_next(node))
- {
- tag_lvl = rt_slist_entry(node, struct ulog_tag_lvl_filter, list);
- rt_free(tag_lvl);
- }
- }
- #endif /* ULOG_USING_FILTER */
- rt_mutex_detach(&ulog.output_locker);
- #ifdef ULOG_USING_ASYNC_OUTPUT
- rt_rbb_destroy(ulog.async_rbb);
- rt_thread_delete(ulog.async_th);
- if (ulog.async_rb)
- rt_ringbuffer_destroy(ulog.async_rb);
- #endif
- ulog.init_ok = RT_FALSE;
- }
- #endif /* RT_USING_ULOG */
|