los_printf.c 文件参考

浏览源代码.

函数
const CHAR *	OsLogLvGet (INT32 level)
STATIC VOID	ErrorMsg (VOID)
STATIC VOID	UartOutput (const CHAR *str, UINT32 len, BOOL isLock)
	串口输出,打印消息的本质就是向串口输出buf 更多...
STATIC VOID	ConsoleOutput (const CHAR *str, UINT32 len)
	控制台输出 更多...
VOID	OutputControl (const CHAR *str, UINT32 len, OutputType type)
STATIC VOID	OsVprintfFree (CHAR *buf, UINT32 bufLen)
VOID	OsVprintf (const CHAR *fmt, va_list ap, OutputType type)
	printf由 print 和 format 两个单词构成,格式化输出函数, 一般用于向标准输出设备按规定格式输出信息 更多...
VOID	UartVprintf (const CHAR *fmt, va_list ap)
	串口方式输入printf内容 更多...
	__attribute__ ((noinline))
	attribute((noinline)) 意思是告诉编译器 这是非内联函数 更多...
VOID	LkDprintf (const CHAR *fmt, va_list ap)
	LK 注者的理解是 log kernel(内核日志) 更多...
VOID	DmesgPrintf (const CHAR *fmt, va_list ap)
VOID	PrintExcInfo (const CHAR *fmt,...)
	打印异常信息 更多...
VOID	LOS_LkPrint (INT32 level, const CHAR *func, INT32 line, const CHAR *fmt,...)
	print log. 更多...

变量
const CHAR *	g_logString []

函数说明

__attribute__()

__attribute__

(

(noinline)

)

attribute((noinline)) 意思是告诉编译器 这是非内联函数

异常信息的输出

可变参数,输出到控制台

在文件 los_printf.c 第 194 行定义.

{
    va_list ap;
    va_start(ap, fmt);
    OsVprintf(fmt, ap, UART_OUTPUT);
    va_end(ap);
}

函数调用图:

ConsoleOutput()

STATIC VOID ConsoleOutput	(	const CHAR *	str,
		UINT32	len
	)

控制台输出

在文件 los_printf.c 第 90 行定义.

{
    ssize_t written = 0;
    ssize_t cnt;
    ssize_t toWrite = len;//每次写入的数量
    
    for (;;) {
        cnt = write(STDOUT_FILENO, str + written, (size_t)toWrite);//向控制台写入数据,STDOUT_FILENO = 1
        if ((cnt < 0) || ((cnt == 0) && ((!OsPreemptable()) || (OS_INT_ACTIVE))) || (toWrite == cnt)) {
            break;
        }
        written += cnt; //已写入数量增加
        toWrite -= cnt; //要写入数量减少
    }
}

函数调用图:

这是这个函数的调用关系图:

DmesgPrintf()

VOID DmesgPrintf	(	const CHAR *	fmt,
		va_list	ap
	)

在文件 los_printf.c 第 228 行定义.

{
    OsVprintf(fmt, ap, CONSOLE_OUTPUT);
}

函数调用图:

这是这个函数的调用关系图:

ErrorMsg()

STATIC VOID ErrorMsg

(

VOID

)

在文件 los_printf.c 第 69 行定义.

{
    const CHAR *p = "Output illegal string! vsnprintf_s failed!\n";
    UartPuts(p, (UINT32)strlen(p), UART_WITH_LOCK);
}

函数调用图:

这是这个函数的调用关系图:

LkDprintf()

VOID LkDprintf	(	const CHAR *	fmt,
		va_list	ap
	)

LK 注者的理解是 log kernel(内核日志)

在文件 los_printf.c 第 217 行定义.

{
    OsVprintf(fmt, ap, CONSOLE_OUTPUT);
#ifdef LOSCFG_SAVE_EXCINFO
    if (OsGetSystemStatus() == OS_SYSTEM_EXC_CURR_CPU) {
        WriteExcBufVa(fmt, ap);
    }
#endif
}

函数调用图:

这是这个函数的调用关系图:

OsLogLvGet()

const CHAR * OsLogLvGet

(

INT32

level

)

在文件 los_printf.c 第 64 行定义.

{
    return g_logString[level];
}

这是这个函数的调用关系图:

OsVprintf()

VOID OsVprintf	(	const CHAR *	fmt,
		va_list	ap,
		OutputType	type
	)

printf由 print 和 format 两个单词构成,格式化输出函数, 一般用于向标准输出设备按规定格式输出信息

在文件 los_printf.c 第 138 行定义.

{
    INT32 len;
    const CHAR *errMsgMalloc = "OsVprintf, malloc failed!\n";//内存分配失败的错误日志,注意这是在打印函数里分配内存失败的情况
    const CHAR *errMsgLen = "OsVprintf, length overflow!\n";//所以要直接向串口发送字符串,不能再调用 printK(...)打印日志了.
    CHAR aBuf[SIZEBUF] = {0};
    CHAR *bBuf = NULL;
    UINT32 bufLen = SIZEBUF;
    UINT32 systemStatus;
 
    bBuf = aBuf;
    len = vsnprintf_s(bBuf, bufLen, bufLen - 1, fmt, ap);//C语言库函数之一，属于可变参数。用于向字符串中打印数据、数据格式用户自定义。
    if ((len == -1) && (*bBuf == '\0')) {//直接碰到字符串结束符或长度异常
        /* parameter is illegal or some features in fmt dont support */ //参数非法或fmt中的某些功能不支持
        ErrorMsg();
        return;
    }
 
    while (len == -1) {//处理((len == -1) && (*bBuf != '\0'))的情况
        /* bBuf is not enough */
        OsVprintfFree(bBuf, bufLen);
 
        bufLen = bufLen << 1;
        if ((INT32)bufLen <= 0) {//异常情况下 向串口发送
            UartPuts(errMsgLen, (UINT32)strlen(errMsgLen), UART_WITH_LOCK);
            return;
        }
        bBuf = (CHAR *)LOS_MemAlloc(m_aucSysMem0, bufLen);
        if (bBuf == NULL) {//分配内存失败,直接向串口发送错误信息
            UartPuts(errMsgMalloc, (UINT32)strlen(errMsgMalloc), UART_WITH_LOCK);
            return;
        }
        len = vsnprintf_s(bBuf, bufLen, bufLen - 1, fmt, ap);//将ap按格式输出到buf中
        if (*bBuf == '\0') {//字符串结束符
            /* parameter is illegal or some features in fmt dont support */
            (VOID)LOS_MemFree(m_aucSysMem0, bBuf);
            ErrorMsg();
            return;
        }
    }
    *(bBuf + len) = '\0';
 
    systemStatus = OsGetSystemStatus();//获取系统的状态
    if ((systemStatus == OS_SYSTEM_NORMAL) || (systemStatus == OS_SYSTEM_EXC_OTHER_CPU)) {//当前CPU正常或其他CPU出现异常时
        OutputControl(bBuf, len, type);//输出到终端
    } else if (systemStatus == OS_SYSTEM_EXC_CURR_CPU) {//当前CPU出现异常
        OutputControl(bBuf, len, EXC_OUTPUT);//串口以无锁的方式输出
    }
    OsVprintfFree(bBuf, bufLen);
}

函数调用图:

这是这个函数的调用关系图:

OsVprintfFree()

STATIC VOID OsVprintfFree	(	CHAR *	buf,
		UINT32	bufLen
	)

在文件 los_printf.c 第 130 行定义.

{
    if (bufLen != SIZEBUF) {
        (VOID)LOS_MemFree(m_aucSysMem0, buf);
    }
}

函数调用图:

这是这个函数的调用关系图:

OutputControl()

VOID OutputControl	(	const CHAR *	str,
		UINT32	len,
		OutputType	type
	)

在文件 los_printf.c 第 107 行定义.

{
    switch (type) {//输出类型
        case CONSOLE_OUTPUT://控制台输出
#ifdef LOSCFG_PLATFORM_CONSOLE
            if (ConsoleEnable() == TRUE) {//POSIX 定义了 STDIN_FILENO、STDOUT_FILENO 和 STDERR_FILENO 来代替 0、1、2 
                ConsoleOutput(str, len);//输出到控制台
                break;
            }
#endif
            /* fall-through */ //落空的情况下,会接着向串口打印数据
        case UART_OUTPUT:   //串口输出
            UartOutput(str, len, UART_WITH_LOCK);//向串口发送数据
            break;
        case EXC_OUTPUT:    //异常输出
            UartPuts(str, len, UART_WITH_LOCK);
            break;
        default:
            break;
    }
    return;
}

函数调用图:

这是这个函数的调用关系图:

PrintExcInfo()

VOID PrintExcInfo	(	const CHAR *	fmt,
			...
	)

打印异常信息

在文件 los_printf.c 第 263 行定义.

{
    va_list ap;
    va_start(ap, fmt);
    /* uart output without print-spinlock */
    OsVprintf(fmt, ap, EXC_OUTPUT);//异常信息打印主体函数
#ifdef LOSCFG_SAVE_EXCINFO
    WriteExcBufVa(fmt, ap);
#endif
    va_end(ap);
}

函数调用图:

这是这个函数的调用关系图:

UartOutput()

STATIC VOID UartOutput	(	const CHAR *	str,
		UINT32	len,
		BOOL	isLock
	)

串口输出,打印消息的本质就是向串口输出buf

在文件 los_printf.c 第 75 行定义.

{
#ifdef LOSCFG_SHELL_DMESG //是否打开了 dmesg开关,打开了会写到文件中 var/log/dmesg 文件中
    if (!OsCheckUartLock()) {//是否被锁
        UartPuts(str, len, isLock);//直接写串口
    }
    if (isLock != UART_WITHOUT_LOCK) {
        (VOID)OsLogMemcpyRecord(str, len);//写入dmesg缓存区
    }
#else
    UartPuts(str, len, isLock);//没有打开dmesg开关时,直接写串口 
#endif
}

函数调用图:

这是这个函数的调用关系图:

UartVprintf()

VOID UartVprintf	(	const CHAR *	fmt,
		va_list	ap
	)

串口方式输入printf内容

在文件 los_printf.c 第 189 行定义.

{
    OsVprintf(fmt, ap, UART_OUTPUT);
}

函数调用图:

变量说明

g_logString

const CHAR* g_logString[]

初始值:

= {
    "EMG",      
    "COMMON",   
    "ERR",      
    "WARN",     
    "INFO",     
    "DEBUG",    
    "TRACE"     
}

在文件 los_printf.c 第 54 行定义.