Skip to content

Files

Latest commit

 

History

History
1255 lines (936 loc) · 43.4 KB

logger_log.md

File metadata and controls

1255 lines (936 loc) · 43.4 KB

Logger日志

Android提供的Logger日志系统是基于内核中的Logger日志驱动程序实现的, 它会将日志记录保存在内核空间中。

Logger日志驱动程序在内部使用一个环形缓冲区来保存日志。 所以 当Logger日志驱动程序中的环形缓冲区满了之后, 新的日志就会覆盖旧的日志。

image-20200719180652875

Logger日志驱动程序根据日志的类型日志的输出量来进行分类, 日志的类型一共有四种, 它们分别是mainsystemradioevents

image-20200719181103329

在Logger日志驱动程序中, 这四种类型的日志分别通过/dev/log/main/dev/log/system/dev/log/radio/dev/log/events四个设备文件来进行访问 的

image-20200719181420876

类型为main的日志是应用程序级别的, 而类型为system的日志是系统级别的。

类型为radio的日志是与无线设备相关的, 因为数据量很大, 所以 把它们单独记录在一起, 也可以避免它们覆盖其他类型的日志。

类型为events的日志是专门用来诊断系统问题的, 应用程序开发者一般不使用该种类型的日志。

image-20200719181857429

Android系统在应用程序框架层中提供了android.util.Logandroid.util.Slogandroid.util.EventLog三个Java接口来往Logger日志驱动程序中写入日志, 它们写入的日志类型分别为mainsystemevents

image-20200719190216722

注意: 如果使用android.util.Logandroid.util.Slog接口写入的日志的标签值是以“RIL”开头 或 等于“HTC_RIL”、 “AT”、 “GSM”、 “STK”、 “CDMA”、 “PHONE”和“SMS”时, 它们就会被转换为radio类型的日志写入到Logger日志驱动程序中。

image-20200719190743669

对应者有 Android系统在运行时库层也提供了三组C/C++宏来往Logger日志驱动程序中写入日志。

其中, 宏LOGVLOGDLOGILOGWLOGE用来写入main类型的日志,

image-20200719191203480

SLOGVSLOGDSLOGISLOGWSLOGE用来写入system类型的日志,

image-20200719191307622

LOG_EVENT_INTLOG_EVENT_LONGLOG_EVENT_STRING用来写入events类型的日志。

image-20200719191427203

不管是Java日志写入接口还是C/C++日志写入接口, 它们都是通过运行时库层的日志库liblog来往Logger日志驱动程序中写入日志的。 另外,系统还提供了一个Logcat工具来读取和显示Logger日志驱动程序中的日志。

Logger日志系统框架 :

Logger日志格式

Logger日志一共划分为mainsystemradioevents四种类型

main、 system 和 radio 的日志格式 :

image-20200719192334248

priority : 日志优先级, 整数 ; tag : 日志标签, 字符串; msg : 日志内容, 字符串

日志优先级和日志标签可以作为在显示日志中的过滤字段。 日志优先级按照重要程度一般划分为VERBOSEDEBUGINFOWARNERRORFATAL六种。

image-20200719192556290

events的日志格式 :

image-20200719193309682

tag : 日志标签, 整数; msg : 日志内容, 二进制数据,它的内容格式是由日志写入者来决定的。

一般,日志内容是由一个或 多个值组成的, 每个值的前面都有一个字段来描述它的类型

events的日志内容的格式 :

image-20200719194813521

值的类型为整数(int)对应 1 、 长整数(long)2 、 字符串(string)3 或 列表(list) 4

events类型的日志标签是一个整数值, 在显示时不具有可读性,所以 Android系统用设备上的日志标签文件/system/etc/event-log-tags来描述这些标签值的含义。 这样,Logcat工具在显示events类型的日志时, 就可以把日志中的标签值转换为字符串

日志标签文件还用来描述events类型的日志内容的格式

日志标签文件格式 :

image-20200719195257831

tag number : 日志标签值, 它的取值范围为0~2147483648 = 2 * 2^30;

tag name : 日志标签值对应的字符串描述, 它是由字母[A-Z][a-z]、 数字[0-9] 或 下画线“_”组成的;

format for tag value : 描述组成日志内容的值格式

events的日志内容的值格式 :

events的日志内容的值格式

name : 日志内容值的名称;

data type : 日志内容值的数据类型, 它的取值范围为1~4, 分别表示整数(int) 、 长整数(long) 、 字符串(string) 和列表(list) ;

image-20200719200800560

data unit : 日志内容值的数据单位, 它的取值范围是1~6, 分别表示对象数量(numberof objects) 、 字节(Number of bytes) 、 毫秒数(Number of milliseconds) 、 分配额(Number of allocations) 、 标志(ID) 和 百分比(Percent)

image-20200719201122683

从Android模拟器上的日志标签文件/system/etc/event-log-tags中取出一行内容来说明类型为events的日志格式

image-20200718123314841

2722 : 日志标签值, battery_level : 描述日志标签值2722的含义。

日志标签值 == 2722的日志内容由三个值组成, 它们分别是level、 voltage和temperature,

level : 数据类型 : 整数 ; 单位 : 百分比

voltage : 数据类型 : 整数 ; 单位 : 对象数量

temperature : 数据类型 : 整数 ; 单位 : 对象数量

Logger日志驱动程序

Logger日志驱动程序实现在系统的内核空间中

目录结构 :

~/Android/kernel/goldfish
    drivers
        staging
            android
                logger.h # 源文件
                logger.c

基础数据结构

Logger日志驱动程序主要使用到了logger_entrylogger_log , logger_reader三个结构体

struct logger_entry :

// kernel\goldfish\drivers\staging\android\logger.h

// 描述一个日志记录
struct logger_entry 
{
/* 实际的日志记录的有效负载长度 */
    __u16        len;    /* length of the payload */
    /* 将成员变量pid的地址值对齐到4字节边界的 */
    __u16        __pad;    /* no matter what, we get 2 bytes of padding */
    /* 写入该日志记录的进程的TGID  线程组ID */
    __s32        pid;    /* generating process's pid */
    /* 写入该日志记录的进程的PID 进程ID */
    __s32        tid;    /* generating process's tid */
    /* 写入该日志记录的时间 用标准基准时间(Epoch)来描述*/
    __s32        sec;    /* seconds since Epoch */
    /* 写入该日志记录的时间 */
    __s32        nsec;    /* nanoseconds */
    /* 实际写入的日志记录内容,长度是可变的,len决定 */
    char        msg[0];    /* the entry's payload */
};

//每一个日志记录的最大长度 == 4K
#define LOGGER_ENTRY_MAX_LEN        (4*1024)

// 有效负载长度最大 == 4K - 结构体logger_entry的大小
#define LOGGER_ENTRY_MAX_PAYLOAD    \
    (LOGGER_ENTRY_MAX_LEN - sizeof(struct logger_entry))

struct logger_log :

// kernel\goldfish\drivers\staging\android\logger.c
// 描述一个日志缓冲区
struct logger_log 
{
    //指向一个内核缓冲区, 用来保存日志记录, 它是循环使用的
    unsigned char *        buffer;    /* the ring buffer itself */
    // 描述一个日志设备
    struct miscdevice    misc;    /* misc device representing the log */
    // 等待队列,用来记录那些正在等待读取新的日志记录的进程, 每一个进程都使用一个结构体logger_reader来描述
    wait_queue_head_t    wq;    /* wait queue for readers */
    // 列表, 用来记录那些正在读取日志记录的进程
    struct list_head    readers; /* this log's readers */
    // 互斥量, 用来保护日志缓冲区的并发访问
    struct mutex        mutex;    /* mutex protecting buffer */
    // 下一条要写入的日志记录在日志缓冲区中的位置
    size_t            w_off;    /* current write head offset */
    // 当一个新的进程读取日志时,会从日志缓冲区中的什么位置开始读取
    size_t            head;    /* new readers start here */
    // 大小
    size_t            size;    /* size of the log */
};

struct logger_reader :

// 描述一个正在读取某一个日志缓冲区的日志记录的进程
struct logger_reader 
{
    // 指向要读取的日志缓冲区结构体
    struct logger_log *    log;    /* associated log */
    // 一个列表项, 用来连接所有读取同一种类型日志记录的进程
    struct list_head    list;    /* entry in logger_log's list */
    // 当前进程要读取的下一条日志记录在日 志缓冲区中的位置
    size_t            r_off;    /* current read head offset */
};

日志设备的初始化过程

日志设备的初始化过程是在Logger日志驱动程序的入口函数logger_init中进行的。

// kernel\goldfish\drivers\staging\android\logger.c

#define DEFINE_LOGGER_DEVICE(VAR, NAME, SIZE) \
// 将各自的日志记录保存在一个静态分配的unsigned char数组
// 大小由SIZE决定
static unsigned char _buf_ ## VAR[SIZE]; \
static struct logger_log VAR = { \
    .buffer = _buf_ ## VAR, \
    .misc = { \
        .minor = MISC_DYNAMIC_MINOR, \
        .name = NAME, \
        .fops = &logger_fops, \
        .parent = NULL, \
    }, \
    // 等待队列
    .wq = __WAIT_QUEUE_HEAD_INITIALIZER(VAR .wq), \
    // 队列
    .readers = LIST_HEAD_INIT(VAR .readers), \
    // 互斥量
    .mutex = __MUTEX_INITIALIZER(VAR .mutex), \
    .w_off = 0, \
    .head = 0, \
    .size = SIZE, \
};

// 宏DEFINE_LOGGER_DEVICE来定义的
// 传入参数分别为变量名、 设备文件名,分配的日志缓冲区的大小
// system和 main 的日志记录保存在同一个日志缓冲区 log_main 中 大小为64K
// events的日志记录保存在日志缓冲区 log_events 大小为256K
// radio的日志记录保存在日志缓冲区 log_radio 大小为64K
DEFINE_LOGGER_DEVICE(log_main, LOGGER_LOG_MAIN, 64*1024)
DEFINE_LOGGER_DEVICE(log_events, LOGGER_LOG_EVENTS, 256*1024)
DEFINE_LOGGER_DEVICE(log_radio, LOGGER_LOG_RADIO, 64*1024)
// kernel\goldfish\drivers\staging\android\logger.h

#define LOGGER_LOG_RADIO    "log_radio"    /* radio-related messages */
#define LOGGER_LOG_EVENTS    "log_events"    /* system/hardware events */
#define LOGGER_LOG_MAIN        "log_main"    /* everything else */

Logger日志驱动程序初始化完成之后, 我们就可以在/dev/log目录下看到三个日志设备文件maineventsradio

三个日志设备对应的文件操作函数表均为logger_fops :

// kernel\goldfish\drivers\staging\android\logger.c

static struct file_operations logger_fops = {
    .owner = THIS_MODULE,
    .read = logger_read,
    .aio_write = logger_aio_write,
    .poll = logger_poll,
    .unlocked_ioctl = logger_ioctl,
    .compat_ioctl = logger_ioctl,
    .open = logger_open,
    .release = logger_release,
};

日志设备打开、 读取和写入函数openreadaio_write的定义, 它们分别被设置为logger_openlogger_readlogger_aio_write函数

每一个硬件设备都有自己的主设备号从设备号。 因为日志设备的类型为misc, 所以这类型的设备都是一样的主设备号, 因此, 在定义这些日志设备时, 就不需要指定它们的主设备号了, 等到注册这些日志设备时, 会统一指定。

从宏DEFINE_LOGGER_DEVICE的定义可以看出, 这些日志设备的从设备号被设置为MISC_DYNAMIC_MINOR, 表示由系统动态分配

// kernel\goldfish\include\linux\miscdevice.h
#define MISC_DYNAMIC_MINOR    255

logger_init日志设备的初始化过程 :

// kernel\goldfish\drivers\staging\android\logger.c

static int __init logger_init(void)
{
    int ret;
    // 将三个日志设备注册到系统

    ret = init_log(&log_main);
    if (unlikely(ret))
        goto out;

    ret = init_log(&log_events);
    if (unlikely(ret))
        goto out;

    ret = init_log(&log_radio);
    if (unlikely(ret))
        goto out;

out:
    return ret;
}

init_log来实现 :

// kernel\goldfish\drivers\staging\android\logger.c

static int __init init_log(struct logger_log *log)
{
    int ret;

    //将相应的日志设备注册到系统
    ret = misc_register(&log->misc);
    if (unlikely(ret)) {
        printk(KERN_ERR "logger: failed to register misc "
               "device for log '%s'!\n", log->misc.name);
        return ret;
    }

    printk(KERN_INFO "logger: created %luK log '%s'\n",
           (unsigned long) log->size >> 10, log->misc.name);

    return 0;
}

misc_register实现 :

// kernel\goldfish\drivers\char\misc.c

int misc_register(struct miscdevice * misc)
{
    struct miscdevice *c;
    dev_t dev;
    int err = 0;
    // 系统中所有的misc设备都保存在一个misc_list列表

    INIT_LIST_HEAD(&misc->list);

    mutex_lock(&misc_mtx);

    // 检查所要注册的misc设备的从设备号是否已经被注册
    list_for_each_entry(c, &misc_list, list) 
    {
        if (c->minor == misc->minor) 
        {
            // 注册失败,因为同一类型设备的从设备号是不能相同的

            mutex_unlock(&misc_mtx);
            return -EBUSY;
        }
    }

    // 从设备号是动态分配的 == MISC_DYNAMIC_MINOR
    if (misc->minor == MISC_DYNAMIC_MINOR) 
    {
        // 分配的misc从设备号一共有64个

        int i = DYNAMIC_MINORS;

        while (--i >= 0)
        {
            // 从设备号的使用情况记录在数组misc_minors
            // 从设备号已经被分配了,那么它在数组misc_minors中所对应的位== 1,否则 == 0
            // i >> 3, 然后取出从设备号i的低三位 == i & 7
            if ( (misc_minors[i>>3] & (1 << (i & 7))) == 0)
            {
                // 没有被分配
                break;
            }
        }

        if (i < 0) 
        {
            // 注册失败

            mutex_unlock(&misc_mtx);
            return -EBUSY;
        }
        // 将它分配给当前正在注册的日志设备
        misc->minor = i;
    }

    if (misc->minor < DYNAMIC_MINORS)
    {
        // 在数组misc_minors中记录该从设备号已经被分配
        misc_minors[misc->minor >> 3] |= 1 << (misc->minor & 7);
    }

    // 使用 主设备号MISC_MAJOR和 得到的从设备号 , 创建一个设备号对象dev
    dev = MKDEV(MISC_MAJOR, misc->minor);

    // 将日志设备misc注册到系统
    // misc->name 指定日志设备的名称,就是 它在设备系统目录/dev中对应的文件名称
    misc->this_device = device_create(misc_class, misc->parent, dev, NULL,
                      "%s", misc->name);

    if (IS_ERR(misc->this_device)) {
        err = PTR_ERR(misc->this_device);
        goto out;
    }

    /*
     * Add it to the front, so that later devices can "override"
     * earlier defaults
     */
    // 将它添加到misc设备列表misc_list中, 表示日志设备注册成功
    list_add(&misc->list, &misc_list);
 out:
    mutex_unlock(&misc_mtx);

    return err;
}
// kernel\goldfish\drivers\char\misc.c

#define DYNAMIC_MINORS 64 /* like dynamic majors */
// 类型为unsigned char , 每一个元素可以管理8个从设备号,
// 64个从设备号就需要8个元素,所以 数组misc_minors的大小为8
static unsigned char misc_minors[DYNAMIC_MINORS / 8];
// kernel\goldfish\include\linux\major.h
// misc设备的主设备号
#define MISC_MAJOR        10

Android系统使用一种uevent机制来管理系统的设备文件。当Logger日志驱动程序注册一个日志设备时, 内核就会发出一个uevent事件, 这个uevent最终由init进程中的handle_device_event函数来处理

// system\core\init\devices.c

static void handle_device_event(struct uevent *uevent)
{
    //...
   /* are we block or char? where should we live? */
    if(!strncmp(uevent->subsystem, "block", 5)) 
    {
        //...
    } 
    else 
    {
        //...
            else if (!strncmp(uevent->subsystem, "graphics", 8)) {
            base = "/dev/graphics/";
            mkdir(base, 0755);
        } 
        else if (!strncmp(uevent->subsystem, "oncrpc", 6)) {
            //...
        else if(!strncmp(uevent->subsystem, "misc", 4) &&
                    !strncmp(name, "log_", 4)) 
        {
            //新注册的设备类型为misc,并且设备名称是以“log_”开头的,就会在/dev目录中创建一个log目录
            base = "/dev/log/";
            mkdir(base, 0755);
            // // 将设备名称的前四个字符去掉, 即去掉前面的“log_”子字符串
            name += 4;
        } else
            base = "/dev/";
    }

    //...
}

日志设备文件的打开过程

Logger日志驱动程序读取或者写入日志记录之前, 首先要调用函数open来打开对应的日志设备文件

在Logger日志驱动程序中, 日志设备文件的打开函数定义为logger_open :

// kernel\goldfish\drivers\staging\android\logger.c

static int logger_open(struct inode *inode, struct file *file)
{
    struct logger_log *log;
    int ret;

    // 将相应的设备文件设置为不可随机访问, 就是 不可以用lseek来设置设备文件的当前读写位置, 
    //因为日志记录的读取或者写入都必须按顺序来进行。
    ret = nonseekable_open(inode, file);
    if (ret)
        return ret;

    // 根据从设备号获得要操作的日志缓冲区结构体。
    log = get_log_from_minor(MINOR(inode->i_rdev));
    if (!log)
        return -ENODEV;

    if (file->f_mode & FMODE_READ) 
    {
        // 以读模式打开日志设备的情况

        // 为当前进程创建一个logger_reader结构体reader
        struct logger_reader *reader;

        // 初始化
        reader = kmalloc(sizeof(struct logger_reader), GFP_KERNEL);
        if (!reader)
            return -ENOMEM;

        // 获得的日志缓冲区结构体log保存在结构体reader的成员变量log中
        reader->log = log;
        INIT_LIST_HEAD(&reader->list);

        mutex_lock(&log->mutex);

        // 该进程从log->head位置开始读取日志记录
        reader->r_off = log->head;
        list_add_tail(&reader->list, &log->readers);

        mutex_unlock(&log->mutex);

        // 把结构体reader保存在参数file的成员变量private_data中
        file->private_data = reader;
    } 
    else
    {
        // 以写模式打开日志设备的情况

        // 把前面获得的日志缓冲区结构体log保存在参数file的成员变量private_data中
        file->private_data = log;
    }

    return 0;
}
// kernel\goldfish\drivers\staging\android\logger.c

static struct logger_log * get_log_from_minor(int minor)
{
    if (log_main.misc.minor == minor)
        return &log_main;
    if (log_events.misc.minor == minor)
        return &log_events;
    if (log_radio.misc.minor == minor)
        return &log_radio;
    return NULL;
}

日志记录的读取过程

当进程调用read函数从日志设备读取日志记录时, Logger日志驱动程序中的函数 logger_read就会被调用从相应的日志缓冲区中读取日志记录

// kernel\goldfish\drivers\staging\android\logger.c
static ssize_t logger_read(struct file *file, 
                  char __user *buf,
                  size_t count, 
                  loff_t *pos)
{
    // 得到日志记录读取进程结构体reader
    struct logger_reader *reader = file->private_data;
    // 得到日志缓冲区结构体 log
    struct logger_log *log = reader->log;
    ssize_t ret;
    DEFINE_WAIT(wait);

start:
    while (1) 
    {
        // 循环 检查日志缓冲区结构体 log 中是否有日志记录可读取

        // 将等待队列项wait加入日志记录读取进程的等待队列log->wq中
        prepare_to_wait(&log->wq, &wait, TASK_INTERRUPTIBLE);

        mutex_lock(&log->mutex);

        // w_off用来描述下一条新写入的日志记录在日志缓冲区中的位置
        // r_off用来描述当前进程下一条要读取的日志记录在日志缓冲区中的位置

        // 两者相等时,说明日志缓冲区结构体log中没有新的日志记录可读
        ret = (log->w_off == reader->r_off);

        mutex_unlock(&log->mutex);

        // ret == false,日志缓冲区结构体log中有新的日志记录可读
        if (!ret)
        {
            // 跳出循环
            break;
        }

        // 当前进程是否 以非阻塞模式来打开日志设备文件
        if (file->f_flags & O_NONBLOCK) 
        {
            // 当前进程就不会因为日志缓冲区结构体log中没有日志记录可读而进入睡眠状态,
            //它直接返回到用户空间中
            ret = -EAGAIN;

            break;
        }

        // 检查当前进程是否有信号正在等待处理
        if (signal_pending(current)) 
        {
            // 不能使当前进程进入睡眠状态, 而必须要让它结束当前系统调用, 
            //以便它可以立即返回去处理那些待处理信号
            ret = -EINTR;

            break;
        }

        // 请求内核进行一次进程调度, 从而进入睡眠状态的
        schedule();
    }

    // 将等待队列项wait从日志记录读取进程的等待队列log->wq中移除
    finish_wait(&log->wq, &wait);
    if (ret)
        return ret;

    // 获取互斥量log->mutex时, 可能会失败。 
    // 在这种情况下, 当前进程就会进入睡眠状态, 直到成功获取互斥量log->mutex为止
    // 在当前进程的睡眠过程中, 日志缓冲区结构体log中的日志记录可能已经被其他进程访问过了,
    // 所以 log->w_off的值可能已经发生了变化
    mutex_lock(&log->mutex);

    /* is there still something to read or did we race? */
    // 重新判断日志缓冲区结构体 w_off 和日志读取进程结构体 r_off 是否相等
    if (unlikely(log->w_off == reader->r_off)) 
    {
        mutex_unlock(&log->mutex);
        goto start;
    }

    /* get the size of the next entry */
    // 得到下一条要读取的日志记录的长度
    ret = get_entry_len(log, reader->r_off);
    if (count < ret) 
    {
        ret = -EINVAL;
        goto out;
    }

    /* get exactly one entry from the log */
    // 执行真正的日志记录读取操作
    ret = do_read_log_to_user(log, reader, buf, ret);

out:
    mutex_unlock(&log->mutex);

    return ret;
}

get_entry_len :

日志记录结构体logger_entry : 每一条日志记录都是由两部分内容组成的, 其中一部分内容用来描述日志记录, 即结构体logger_entry本身所占据的内容; 另一部分内容是日志记录的有效负载, 即真正的日志记录内容。

由于结构体logger_entry的大小是固定的, 因此只要知道它的有效负载长度, 就可以得到一条日志记录的长度。

日志记录结构体logger_entry的有效负载长度记录在它的成员变量len中。 因为 成员变量len是日志记录结构体logger_entry的第一个成员变量, 因此, 它们的起始地址是相同的。

len的类型为__u16, 只要读取该结构体变量地址的前两个字节的内容就是日志记录的长度。

因为 日志缓冲区是循环使用的, 所以 一条日志记录的前两个字节的存储 分两种情况来考虑 :

第一种情况是该日志记录的前两个字节是连在一起的; 第二种情况就是前两个字节分别保存在日志缓冲区的首字节尾字节

// kernel\goldfish\drivers\staging\android\logger.c

static __u32 get_entry_len(struct logger_log *log, size_t off)
{
    __u16 val;

    // 将日志缓冲区结构体log的总长度size - 下一条要读取的日志记录的位置off
    switch (log->size - off) 
    {
        case 1:
            // 该日志记录的长度值分别保存在日志缓冲区的首尾字节中

            // 将它的前1个字节从日志缓冲区的首字节中读取出来,并将它的内容保存在变量vals
            memcpy(&val, log->buffer + off, 1);
            // 将它的后1个字节从日志缓冲区的尾字节中读取出来,并将它的内容保存在变量vals + 1
            memcpy(((char *) &val) + 1, log->buffer, 1);

            break;

        default:
            // 该日志记录的长度值保存在两个连在一起的字节中, 即保存在地址log->buffer+off中

            // 将日志记录的长度值读取出来, 并且保存在变量val中
            memcpy(&val, log->buffer + off, 2);
    }

    // 将变量val的值 + 结构体logger_entry的大小, 就得到下一条要读取的日志记录的总长度    
    return sizeof(struct logger_entry) + val;
}

do_read_log_to_user :

// kernel\goldfish\drivers\staging\android\logger.c
static ssize_t do_read_log_to_user(struct logger_log *log,
                   struct logger_reader *reader,
                   char __user *buf,
                   size_t count)
{
    size_t len;

    /*
     * We read from the log in two disjoint operations. First, we read from
     * the current read head offset up to 'count' bytes or to the end of
     * the log, whichever comes first.
     */
    // 计算第一次要读取的日志记录的长度
    len = min(count, log->size - reader->r_off);
    // 将这一部分的日志记录复制到用户空间缓冲区buf中
    if (copy_to_user(buf, log->buffer + reader->r_off, len))
        return -EFAULT;

    /*
     * Second, we read any remaining bytes, starting back at the head of
     * the log.
     */
    // 检查上一次是否已经将日志记录的内容读取完毕
    if (count != len)
    {
        // 未读取完毕

        // 继续将第二部分的日志记录复制到用户空间缓冲区buf中,就完成了一条日志记录的读取
        if (copy_to_user(buf + len, log->buffer, count - len))
            return -EFAULT;
    }

    // 当前进程从日志缓冲区结构体log中读取了一条日志记录之后,就要修改它的成员变量r_off的值,
    // 表示下次要读取的是日志缓冲区结构体log中的下一条日志记录

    // 将日志读取进程结构体reader的成员变量r_off的值 + 前面已经读取的日志记录的长度count ,
    // 然后再使用宏logger_offset来对计算结果进行调整
    reader->r_off = logger_offset(reader->r_off + count);

    return count;
}

由于日志缓冲区是循环使用的, 如果计算得到的下一条日志记录的位置大于日志缓冲区的长度, 那么就需要将它绕回到日志缓冲区的前面

// kernel\goldfish\drivers\staging\android\logger.c
#define logger_offset(n)    ((n) & (log->size - 1))

日志记录的写入过程

当进程调用函数write、 writev或者aio_write往日志设备写入日志记录时, Logger日志驱动程序中的函数logger_aio_write就会被调用来执行日志记录的写入操作

对于类型为mainsystemradio的日志记录来说, 它们的内容是由优先级(priority) 、 标签(tag) 和内容(msg) 三个字段组成的, 分别保存在iov[0]、 iov[1]和iov[2]中, nr_segs == 3。

对于类型为events的日志记录来说, 它们的内容只有标签内容两个字段, 分别保存在iov[0]和iov[1]中, nr_segs == 2。

在特殊情况下, 当类型为events的日志记录的内容只有一个值时, iov的大小 == 3, iov[0] : 日志标签, iov[1] : 日志记录的内容值类型, iov[2] : 日志记录的内容值。

无论要写入的是什么类型的日志记录, 它的总长度值都是保存在参数iocb的成员变量ki_left中的, 单位是字节。

/*
 * logger_aio_write - our write method, implementing support for write(),
 * writev(), and aio_write(). Writes are our fast path, and we try to optimize
 * them above all else.
 */
ssize_t logger_aio_write(struct kiocb *iocb, const struct iovec *iov,
             unsigned long nr_segs, loff_t ppos)
{
    struct logger_log *log = file_get_log(iocb->ki_filp);
    size_t orig = log->w_off;
    struct logger_entry header;
    struct timespec now;
    ssize_t ret = 0;

    now = current_kernel_time();

    header.pid = current->tgid;
    header.tid = current->pid;
    header.sec = now.tv_sec;
    header.nsec = now.tv_nsec;
    header.len = min_t(size_t, iocb->ki_left, LOGGER_ENTRY_MAX_PAYLOAD);

    /* null writes succeed, return zero */
    if (unlikely(!header.len))
        return 0;

    mutex_lock(&log->mutex);

    /*
     * Fix up any readers, pulling them forward to the first readable
     * entry after (what will be) the new write offset. We do this now
     * because if we partially fail, we can end up with clobbered log
     * entries that encroach on readable buffer.
     */
    fix_up_readers(log, sizeof(struct logger_entry) + header.len);

    do_write_log(log, &header, sizeof(struct logger_entry));

    while (nr_segs-- > 0) {
        size_t len;
        ssize_t nr;

        /* figure out how much of this vector we can keep */
        len = min_t(size_t, iov->iov_len, header.len - ret);

        /* write out this segment's payload */
        nr = do_write_log_from_user(log, iov->iov_base, len);
        if (unlikely(nr < 0)) {
            log->w_off = orig;
            mutex_unlock(&log->mutex);
            return nr;
        }

        iov++;
        ret += nr;
    }

    mutex_unlock(&log->mutex);

    /* wake up any blocked readers */
    wake_up_interruptible(&log->wq);

    return ret;
}

当进程以写模式打开日志设备时, Logger日志驱动程序会把对应的日志缓冲区结构体log保存在一个打开文件结构体file的成员变量private_data中。 参数iocb的成员变量ki_filp正好指向该打开文件结构体

运行时库层日志库

Android系统在运行时库层提供了一个用来和Logger日志驱动程序进行交互的日志库liblog

通过日志库liblog提供的接口, 应用程序就可以方便地往Logger日志驱动程序中写入日志记录。

位于运行时库层的C/C++日志写入接口和位于应用程序框架层的Java日志写入接口都是通过liblog库提供的日志写入接口来往Logger日志驱动程序中写入日志记录的.

liblog库的日志记录写入接口 :

liblog日志库的函数调用关系 :

liblog日志库的函数调用关系

根据写入的日志记录的类型不同, 这些函数可以划分为三个类别。

函数__android_log_assert__android_log_vprint__android_log_print用来写入类型为main的日志记录;

函数__android_log_btwrite__android_log_bwrite用来写入类型为events的日志记录;

函数__android_log_buf_print可以写入任意一种类型的日志记录。

注意, 在函数__android_log_write__android_log_buf_write中, 如果要写入的日志记录的标签以“ RIL ”开头或者等于“ HTC_RIL ”、 “ AT ”、 “ GSM ”、 “ STK ”、 “ CDMA ”、 “ PHONE ”或 “ SMS ”, 那么它们就会被认为是radio类型的日志记录。

无论写入的是什么类型的日志记录, 它们最终都是通过调用函数write_to_log写入到Logger日志驱动程序中的。

当函数write_to_log第一次被调用时, 实际上执行的是函数__write_to_log_init

函数__write_to_log_init执行的是一些日志库的初始化操作,

接着将函数指针write_to_log重定向到函数__write_to_log_kernel或者__write_to_log_null中, 这取决于是否成功地将日志设备文件打开

描述日志库liblog提供的日志记录写入函数的实现 :

write_to_log :

// system\core\liblog\logd_write.c

// 初始化日志库liblog
static int __write_to_log_init(log_id_t, struct iovec *vec, size_t nr);

// write_to_log在开始的时候被设置为函数__write_to_log_init
static int (*write_to_log)(log_id_t, struct iovec *vec, size_t nr) = __write_to_log_init;
// system\core\liblog\logd_write.c

static int log_fds[(int)LOG_ID_MAX] = { -1, -1, -1, -1 };

// 初始化日志库liblog
static int __write_to_log_init(log_id_t log_id, struct iovec *vec, size_t nr)
{
    //...
    // write_to_log指向的是自己
    if (write_to_log == __write_to_log_init) {

        // 打开系统中的日志设备文件,并把得到的文件描述符保存在全局数组log_fds中
        // 实际打开/dev/log/main /dev/log/radio  /dev/log/events  /dev/log/system 四个日志设备文件
        log_fds[LOG_ID_MAIN] = log_open("/dev/"LOGGER_LOG_MAIN, O_WRONLY);
        log_fds[LOG_ID_RADIO] = log_open("/dev/"LOGGER_LOG_RADIO, O_WRONLY);
        log_fds[LOG_ID_EVENTS] = log_open("/dev/"LOGGER_LOG_EVENTS, O_WRONLY);
        log_fds[LOG_ID_SYSTEM] = log_open("/dev/"LOGGER_LOG_SYSTEM, O_WRONLY);

        // 将函数指针write_to_log指向函数__write_to_log_kernel
        write_to_log = __write_to_log_kernel;

        // 判断/dev/log/main  /dev/log/radio  /dev/log/events三个日志设备文件是否都打开成功
        if (log_fds[LOG_ID_MAIN] < 0 || log_fds[LOG_ID_RADIO] < 0 ||
                log_fds[LOG_ID_EVENTS] < 0) 
        {
            log_close(log_fds[LOG_ID_MAIN]);
            log_close(log_fds[LOG_ID_RADIO]);
            log_close(log_fds[LOG_ID_EVENTS]);
            log_fds[LOG_ID_MAIN] = -1;
            log_fds[LOG_ID_RADIO] = -1;
            log_fds[LOG_ID_EVENTS] = -1;

            // 将函数指针write_to_log 指向 函数 __write_to_log_null
            write_to_log = __write_to_log_null;
        }

        // 判断日志设备文件/dev/log/system是否打开成功
        if (log_fds[LOG_ID_SYSTEM] < 0) 
        {
            // 不成功

            // 将类型为system和main的日志记录都写入到日志设备文件/dev/log/main中
            log_fds[LOG_ID_SYSTEM] = log_fds[LOG_ID_MAIN];
        }
    }
    //...
    return write_to_log(log_id, vec, nr);
}
// system\core\include\cutils\log.h

typedef enum {
    LOG_ID_MAIN = 0,
    LOG_ID_RADIO = 1,
    LOG_ID_EVENTS = 2,
    LOG_ID_SYSTEM = 3,

    LOG_ID_MAX
} log_id_t;
// system\core\include\cutils\logger.h

#define LOGGER_LOG_MAIN        "log/main"
#define LOGGER_LOG_RADIO    "log/radio"
#define LOGGER_LOG_EVENTS    "log/events"
#define LOGGER_LOG_SYSTEM    "log/system"
// system\core\liblog\logd_write.c

// 正式环境中编译日志库liblog时, 宏FAKE_LOG_DEVICE的值定义为0

#if FAKE_LOG_DEVICE
// This will be defined when building for the host.
#define log_open(pathname, flags) fakeLogOpen(pathname, flags)
#define log_writev(filedes, vector, count) fakeLogWritev(filedes, vector, count)
#define log_close(filedes) fakeLogClose(filedes)
#else
// log_open实际上指向的是打开文件操作函数open
#define log_open(pathname, flags) open(pathname, flags)

// 写文件操作函数writev
#define log_writev(filedes, vector, count) writev(filedes, vector, count)

// 关闭文件操作函数close
#define log_close(filedes) close(filedes)
#endif

__write_to_log_ker nel :

// system\core\liblog\logd_write.c

// 把日志记录写入到Logger日志驱动程序中
static int __write_to_log_kernel(log_id_t log_id, struct iovec *vec, size_t nr)
{
    ssize_t ret;
    int log_fd;

    if (/*(int)log_id >= 0 &&*/ (int)log_id < (int)LOG_ID_MAX) 
    {
        // 根据log_id在全局数组log_fds中找到对应的日志设备文件描述符
        log_fd = log_fds[(int)log_id];
    } 
    else 
    {
        return EBADF;
    }

    do 
    {
        // 把日志记录写入到Logger日志驱动程序中
        ret = log_writev(log_fd, vec, nr);

        // 返回值小于0, 并且错误码等于EINTR, 那就重新执行写入日志记录的操作

        // 这种情况一般出现在当前进程等待写入日志记录的过程中,刚好有新的信号需要处理,
        //内核就会返回一个EINTR错误码给调用者, 表示调用者需要再次执行相同的操作
    } while (ret < 0 && errno == EINTR);

    return ret;
}

__write_to_log_null :

// system\core\liblog\logd_write.c

static int __write_to_log_null(log_id_t log_fd, struct iovec *vec, size_t nr)
{
    // 一个空实现 
    //日志设备文件打开失败的情况下, 函数指针write_to_log才会指向该函数
    return -1;
}

__android_log_write :

// system\core\liblog\logd_write.c

int __android_log_write(int prio, const char *tag, const char *msg)
{
    struct iovec vec[3];

    // 在默认情况下,写入的日志记录的类型是 main
    log_id_t log_id = LOG_ID_MAIN;

    if (!tag)
        tag = "";

    /* XXX: This needs to go! */
    if (!strcmp(tag, "HTC_RIL") ||
        !strncmp(tag, "RIL", 3) || /* Any log tag with "RIL" as the prefix */
        !strcmp(tag, "AT") ||
        !strcmp(tag, "GSM") ||
        !strcmp(tag, "STK") ||
        !strcmp(tag, "CDMA") ||
        !strcmp(tag, "PHONE") ||
        !strcmp(tag, "SMS"))
            // 类型为radio的日志记录
            log_id = LOG_ID_RADIO;

    // 日志记录的优先级
    vec[0].iov_base   = (unsigned char *) &prio;
    vec[0].iov_len    = 1;

    // 标签
    vec[1].iov_base   = (void *) tag;
    vec[1].iov_len    = strlen(tag) + 1;

    //内容
    vec[2].iov_base   = (void *) msg;
    vec[2].iov_len    = strlen(msg) + 1;

    // 把紧跟在日志记录标签和内容后面的字符串结束符号‘\0'也写入到Logger日志驱动程序中, 
    //目的是为了以后从Logger日志驱动程序读取日志时,可以将日志记录的标签字段和内容字段解析出来

    // 写入到Logger日志驱动程序中
    return write_to_log(log_id, vec, 3);
}

__android_log_buf_write :

// system\core\liblog\logd_write.c

int __android_log_buf_write(int bufID, int prio, const char *tag, const char *msg)
{
    // 可以指定写入的日志记录的类型

    struct iovec vec[3];

    if (!tag)
        tag = "";

    /* XXX: This needs to go! */
    if (!strcmp(tag, "HTC_RIL") ||
        !strncmp(tag, "RIL", 3) || /* Any log tag with "RIL" as the prefix */
        !strcmp(tag, "AT") ||
        !strcmp(tag, "GSM") ||
        !strcmp(tag, "STK") ||
        !strcmp(tag, "CDMA") ||
        !strcmp(tag, "PHONE") ||
        !strcmp(tag, "SMS"))

            // radio的日志记录
            bufID = LOG_ID_RADIO;

    vec[0].iov_base   = (unsigned char *) &prio;
    vec[0].iov_len    = 1;
    vec[1].iov_base   = (void *) tag;
    vec[1].iov_len    = strlen(tag) + 1;
    vec[2].iov_base   = (void *) msg;
    vec[2].iov_len    = strlen(msg) + 1;

    // 把紧跟在日志记录标签和内容后面的字符串结束符号‘\0'也写入到Logger日志驱动程序中, 
    //目的是为了以后从Logger日志驱动程序读取日志时,可以将日志记录的标签字段和内容字段解析出来

    return write_to_log(bufID, vec, 3);
}

__android_log_vprint__android_log_print__android_log_assert :

// system\core\liblog\logd_write.c

int __android_log_vprint(int prio, const char *tag, const char *fmt, va_list ap)
{
    char buf[LOG_BUF_SIZE];

    // 使用格式化字符串来描述要写入的日志记录内容
    vsnprintf(buf, LOG_BUF_SIZE, fmt, ap);

    // 向Logger日志驱动程序中写入日志记录
    return __android_log_write(prio, tag, buf);
}

int __android_log_print(int prio, const char *tag, const char *fmt, ...)
{
    va_list ap;

    // // 使用格式化字符串来描述要写入的日志记录内容
    char buf[LOG_BUF_SIZE];

    va_start(ap, fmt);
    vsnprintf(buf, LOG_BUF_SIZE, fmt, ap);
    va_end(ap);

    // 向Logger日志驱动程序中写入日志记录
    return __android_log_write(prio, tag, buf);
}

void __android_log_assert(const char *cond, const char *tag,
              const char *fmt, ...)
{
    // 使用格式化字符串来描述要写入的日志记录内容
    char buf[LOG_BUF_SIZE];

    if (fmt) {
        va_list ap;
        va_start(ap, fmt);
        vsnprintf(buf, LOG_BUF_SIZE, fmt, ap);
        va_end(ap);
    } else {
        /* Msg not provided, log condition.  N.B. Do not use cond directly as
         * format string as it could contain spurious '%' syntax (e.g.
         * "%d" in "blocks%devs == 0").
         */
        if (cond)
            snprintf(buf, LOG_BUF_SIZE, "Assertion failed: %s", cond);
        else
            strcpy(buf, "Unspecified assertion failed");
    }

    // 向Logger日志驱动程序中写入日志记录
    __android_log_write(ANDROID_LOG_FATAL, tag, buf);

    __builtin_trap(); /* trap so we have a chance to debug the situation */
}

__android_log_buf_print :

// system\core\liblog\logd_write.c

int __android_log_buf_print(int bufID, int prio, const char *tag, const char *fmt, ...)
{
    va_list ap;
    char buf[LOG_BUF_SIZE];

    va_start(ap, fmt);

    // 格式化字符串来描述要写入的日志记录内容
    vsnprintf(buf, LOG_BUF_SIZE, fmt, ap);

    va_end(ap);

    // 向Logger日志驱动程序中写入日志记录 , 指定要写入的日志记录的类型
    return __android_log_buf_write(bufID, prio, tag, buf);
}

__android_log_bwrite__android_log_btwrite :

// system\core\liblog\logd_write.c

int __android_log_bwrite(int32_t tag, const void *payload, size_t len)
{
    struct iovec vec[2];

    // 名称
    vec[0].iov_base = &tag;
    vec[0].iov_len = sizeof(tag);

    // 单位
    vec[1].iov_base = (void*)payload;
    vec[1].iov_len = len;

    // 写入的日志记录的类型为events
    return write_to_log(LOG_ID_EVENTS, vec, 2);
}

int __android_log_btwrite(int32_t tag, char type, 
                  const void *payload, size_t len)
{
    struct iovec vec[3];

    // 名称
    vec[0].iov_base = &tag;
    vec[0].iov_len = sizeof(tag);

    // 定要写入的日志记录内容的值类型
    vec[1].iov_base = &type;
    vec[1].iov_len = sizeof(type);

    // 单位
    vec[2].iov_base = (void*)payload;
    vec[2].iov_len = len;

    // 写入的日志记录的类型为events
    return write_to_log(LOG_ID_EVENTS, vec, 3);
}