shell_lk.c 文件参考

浏览源代码.

结构体
struct	Logger

枚举
enum	MODULE_FLAG {   MODULE0 = 0 , MODULE1 = 1 , MODULE2 = 2 , MODULE3 = 3 ,   MODULE4 = 4 }

函数
VOID	OsLkDefaultFunc (INT32 level, const CHAR *func, INT32 line, const CHAR *fmt, va_list ap)
	内核打印函数,在LOS_LkPrint中回调 更多...
STATIC INLINE INT32	OsLkTraceLvGet (VOID)
const CHAR *	OsLkCurLogLvGet (VOID)
VOID	OsLkTraceLvSet (INT32 level)
VOID	OsLkModuleLvSet (INT32 level)
INT32	OsLkModuleLvGet (VOID)
VOID	OsLkLogFileSet (const CHAR *str)
FILE *	OsLogFpGet (VOID)
INT32	CmdLog (INT32 argc, const CHAR **argv)
	log命令用于修改&查询日志配置,即选择打印哪种日志? 该命令依赖于LOSCFG_SHELL_LK，使用时通过menuconfig在配置项中开启"Enable Shell lk"： Debug —> Enable a Debug Version —> Enable Shell —> Enable Shell lK。 log level命令用于配置日志的打印等级，包括6个等级 TRACE_EMG = 0, TRACE_COMMON = 1, TRACE_ERROR = 2, TRACE_WARN = 3, TRACE_INFO = 4, TRACE_DEBUG = 5 若level不在有效范围内，会打印提示信息。 若log level命令不加[levelNum]参数，则默认查看当前打印等级，并且提示使用方法。 输入log level 4 更多...
STATIC INLINE VOID	OsLogCycleRecord (INT32 level)
	日志循环记录 更多...
VOID	LOS_LkPrint (INT32 level, const CHAR *func, INT32 line, const CHAR *fmt,...)
	打印 更多...
VOID	LOS_LkRegHook (LK_FUNC hook)
	设置回调函数 更多...
UINT32	OsLkLoggerInit (VOID)
	内核日志初始化 更多...
	SHELLCMD_ENTRY (log_shellcmd, CMD_TYPE_EX, "log", 1,(CmdCallBackFunc) CmdLog)
	LOS_MODULE_INIT (OsLkLoggerInit, LOS_INIT_LEVEL_EARLIEST)
	日志模块初始化 更多...

变量
STATIC INT32	g_tracelevel
	日志等级 更多...
STATIC INT32	g_modulelevel
	模块等级 更多...
STATIC Logger	g_logger = { 0 }
LK_FUNC	g_osLkHook = (LK_FUNC)OsLkDefaultFunc

枚举类型说明

MODULE_FLAG

enum MODULE_FLAG

枚举值
MODULE0
MODULE1
MODULE2
MODULE3
MODULE4

在文件 shell_lk.c 第 48 行定义.

             {//模块等级
    MODULE0 = 0,
    MODULE1 = 1,
    MODULE2 = 2,
    MODULE3 = 3,
    MODULE4 = 4,
} MODULE_FLAG;

函数说明

CmdLog()

INT32 CmdLog	(	INT32	argc,
		const CHAR **	argv
	)

log命令用于修改&查询日志配置,即选择打印哪种日志? 该命令依赖于LOSCFG_SHELL_LK，使用时通过menuconfig在配置项中开启"Enable Shell lk"： Debug —> Enable a Debug Version —> Enable Shell —> Enable Shell lK。 log level命令用于配置日志的打印等级，包括6个等级 TRACE_EMG = 0, TRACE_COMMON = 1, TRACE_ERROR = 2, TRACE_WARN = 3, TRACE_INFO = 4, TRACE_DEBUG = 5 若level不在有效范围内，会打印提示信息。 若log level命令不加[levelNum]参数，则默认查看当前打印等级，并且提示使用方法。 输入log level 4

在文件 shell_lk.c 第 141 行定义.

{
    size_t level;
    size_t module;
    CHAR *p = NULL;
 
    if ((argc != 2) || (argv == NULL)) { /* 2:count of parameter */
        PRINTK("Usage: log level <num>\n");
        PRINTK("Usage: log module <num>\n");
        PRINTK("Usage: log path <PATH>\n");
        return -1;
    }
 
    if (!strncmp(argv[0], "level", strlen(argv[0]) + 1)) {
        level = strtoul(argv[1], &p, 0);
        if ((*p != 0) || (level > LOS_TRACE_LEVEL) || (level < LOS_EMG_LEVEL)) {
            PRINTK("current log level %s\n", OsLkCurLogLvGet());
            PRINTK("log %s [num] can access as 0:EMG 1:COMMON 2:ERROR 3:WARN 4:INFO 5:DEBUG\n", argv[0]);
        } else {
            OsLkTraceLvSet(level);
            PRINTK("Set current log level %s\n", OsLkCurLogLvGet());
        }
    } else if (!strncmp(argv[0], "module", strlen(argv[0]) + 1)) {
        module = strtoul(argv[1], &p, 0);
        if ((*p != 0) || (module > MODULE4) || (module < MODULE0)) {
            PRINTK("log %s can't access %s\n", argv[0], argv[1]);
            PRINTK("not support yet\n");
            return -1;
        } else {
            OsLkModuleLvSet(module);
            PRINTK("not support yet\n");
        }
    } else if (!strncmp(argv[0], "path", strlen(argv[0]) + 1)) {
        OsLkLogFileSet(argv[1]);
        PRINTK("not support yet\n");
    } else {
        PRINTK("Usage: log level <num>\n");
        PRINTK("Usage: log module <num>\n");
        PRINTK("Usage: log path <PATH>\n");
        return -1;
    }
 
    return 0;
}

函数调用图:

LOS_MODULE_INIT()

LOS_MODULE_INIT	(	OsLkLoggerInit	,
		LOS_INIT_LEVEL_EARLIEST
	)

日志模块初始化

OsLkCurLogLvGet()

const CHAR * OsLkCurLogLvGet

(

VOID

)

在文件 shell_lk.c 第 78 行定义.

{
    return OsLogLvGet(g_tracelevel);
}

函数调用图:

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

OsLkDefaultFunc()

VOID OsLkDefaultFunc	(	INT32	level,
		const CHAR *	func,
		INT32	line,
		const CHAR *	fmt,
		va_list	ap
	)

内核打印函数,在LOS_LkPrint中回调

在文件 shell_lk.c 第 199 行定义.

{
    if (level > OsLkTraceLvGet()) {
#ifdef LOSCFG_SHELL_DMESG
        if ((UINT32)level <= OsDmesgLvGet()) {
            OsLogCycleRecord(level);
            DmesgPrintf(fmt, ap);
        }
#endif
        return;
    }
    if ((level != LOS_COMMON_LEVEL) && ((level > LOS_EMG_LEVEL) && (level <= LOS_TRACE_LEVEL))) {
        dprintf("[%s][%s:%s]", OsLogLvGet(level),
                ((OsCurrProcessGet() == NULL) ? "NULL" : OsCurrProcessGet()->processName),
                ((OsCurrTaskGet() == NULL) ? "NULL" : OsCurrTaskGet()->taskName));
    }
    LkDprintf(fmt, ap);
}

函数调用图:

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

OsLkLogFileSet()

VOID OsLkLogFileSet

(

const CHAR *

str

)

在文件 shell_lk.c 第 102 行定义.

{
    FILE *fp = NULL;
    FILE *oldfp = g_logger.fp;
 
    if (str == NULL) {
        return;
    }
    fp = fopen(str, "w+");
    if (fp == NULL) {
        printf("Error can't open the %s file\n",str);
        return;
    }
 
    g_logger.fp = fp;
    if (oldfp != NULL) {
        fclose(oldfp);
    }
}

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

OsLkLoggerInit()

UINT32 OsLkLoggerInit

(

VOID

)

内核日志初始化

在文件 shell_lk.c 第 233 行定义.

{
    (VOID)memset_s(&g_logger, sizeof(Logger), 0, sizeof(Logger));
    OsLkTraceLvSet(TRACE_DEFAULT);
    LOS_LkRegHook(OsLkDefaultFunc);//注册钩子函数,将在 LOS_LkPrint中回调钩子
#ifdef LOSCFG_SHELL_DMESG
    (VOID)LOS_DmesgLvSet(TRACE_DEFAULT);
#endif
    return LOS_OK;
}

函数调用图:

OsLkModuleLvGet()

INT32 OsLkModuleLvGet

(

VOID

)

在文件 shell_lk.c 第 97 行定义.

{
    return g_modulelevel;
}

OsLkModuleLvSet()

VOID OsLkModuleLvSet

(

INT32

level

)

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

{
    g_modulelevel = level;
    g_logger.module_level = level;
    return;
}

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

OsLkTraceLvGet()

STATIC INLINE INT32 OsLkTraceLvGet

(

VOID

)

在文件 shell_lk.c 第 73 行定义.

{
    return g_tracelevel;
}

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

OsLkTraceLvSet()

VOID OsLkTraceLvSet

(

INT32

level

)

在文件 shell_lk.c 第 83 行定义.

{
    g_tracelevel = level;
    g_logger.trace_level = level;
    return;
}

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

OsLogCycleRecord()

STATIC INLINE VOID OsLogCycleRecord

(

INT32

level

)

日志循环记录

在文件 shell_lk.c 第 188 行定义.

{
    UINT32 tmpLen;
    if (level != LOS_COMMON_LEVEL && (level > LOS_EMG_LEVEL && level <= LOS_TRACE_LEVEL)) {
        tmpLen = strlen(OsLogLvGet(level));
        const CHAR* tmpPtr = OsLogLvGet(level);
        (VOID)OsLogRecordStr(tmpPtr, tmpLen);
    }
}

函数调用图:

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

OsLogFpGet()

FILE * OsLogFpGet

(

VOID

)

在文件 shell_lk.c 第 122 行定义.

{
    return g_logger.fp;
}

SHELLCMD_ENTRY()

SHELLCMD_ENTRY	(	log_shellcmd	,
		CMD_TYPE_EX	,
		"log"	,
		1	,
		(CmdCallBackFunc)	CmdLog
	)

变量说明

g_logger

STATIC Logger g_logger = { 0 }

在文件 shell_lk.c 第 67 行定义.

g_modulelevel

STATIC INT32 g_modulelevel

模块等级

在文件 shell_lk.c 第 65 行定义.

g_osLkHook

LK_FUNC g_osLkHook = (LK_FUNC)OsLkDefaultFunc

在文件 shell_lk.c 第 71 行定义.

g_tracelevel

STATIC INT32 g_tracelevel

日志等级

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