Android-Logger-log.zip_android_android log

我们知道，在 Android 系统中，提供了一个轻量级的日志系统，这个日志系统

是以驱动程序的形式实现在内核空间的，而在用户空间分别提供了 Java 接口和

C/C++接口来使用这个日志系统，取决于你编写的是 Android 应用程序还是系统组

件。在前面的文章浅谈 Android 系统开发中 LOG 的使用中，已经简要地介绍了在

Android 应用程序开发中 Log 的使用方法，在这一篇文章中，我们将更进一步地分

析 Logger 驱动程序的源代码，使得我们对 Android 日志系统有一个深刻的认识。

既然 Android 日志系统是以驱动程序的形式实现在内核空间的，我们就需要获

取 Android 内核源代码来分析了，请参照前面在 Ubuntu 上下载、编译和安装 Android

最新源代码和在 Ubuntu 上下载、编译和安装 Android 最新内核源代码（Linux Kernel）

情景。

一. Logger 驱动程序的相关数据结构。

我们首先来看 logger.h 头文件的内容：

view plain

1. #ifndef _LINUX_LOGGER_H

2. #define _LINUX_LOGGER_H

3.

4. #include <linux/types.h>

5. #include <linux/ioctl.h>

6.

13. __s32 nsec; /* nanoseconds */

14. char msg[0]; /* the entry's payload */

15. };

16.

17. #define LOGGER_LOG_RADIO "log_radio" /* radio-related messages */

18. #define LOGGER_LOG_EVENTS "log_events" /* system/hardware events */

19. #define LOGGER_LOG_MAIN "log_main" /* everything else */

20.

21. #define LOGGER_ENTRY_MAX_LEN (4*1024)

22. #define LOGGER_ENTRY_MAX_PAYLOAD \

29. #define LOGGER_GET_NEXT_ENTRY_LEN _IO(__LOGGERIO, 3) /* next entry len */

30. #define LOGGER_FLUSH_LOG _IO(__LOGGERIO, 4) /* flush log */

31.

32. #endif /* _LINUX_LOGGER_H */

struct logger_entry 是一个用于描述一条 Log 记录的结构体。len 成员变量记录

了这条记录的有效负载的长度，有效负载指定的日志记录本身的长度，但是不包括

用于描述这个记录的 struct logger_entry 结构体。回忆一下我们调用 android.util.Log

接口来使用日志系统时，会指定日志的优先级别 Priority、Tag 字符串以及 Msg 字

符串，Priority + Tag + Msg 三者内容的长度加起来就是记录的有效负载长度了。

(LOGGER_ENTRY_MAX_LEN - sizeof(struct logger_entry))

从这两个宏可以看出，每条日志记录的有效负载长度加上结构体 logger_entry

的长度不能超过 4K 个字节。

logger.h 文件中还定义了其它宏，读者可以自己分析，在下面的分析中，碰到时，

我们也会详细解释。

再来看 logger.c 文件中，其它相关数据结构的定义：

view plain

1. /*

2. * struct logger_log - represents a specific log, such as 'main' or 'radio'

3. *

4. * This structure lives from module insertion until module removal, so it do

es

10. struct miscdevice misc; /* misc device representing the log */

11. wait_queue_head_t wq; /* wait queue for readers */

12. struct list_head readers; /* this log's readers */

13. struct mutex mutex; /* mutex protecting buffer */

14. size_t w_off; /* current write head offset */

15. size_t head; /* new readers start here */

16. size_t size; /* size of the log */

17. };

18.

19. /*

26. struct logger_log * log; /* associated log */

27. struct list_head list; /* entry in logger_log's list */

28. size_t r_off; /* current read head offset */

29. };

30.

31. /* logger_offset - returns index 'n' into the log via (optimized) modulus */

32. #define logger_offset(n) ((n) & (log->size - 1))

结构体 struct logger_log 就是真正用来保存日志的地方了。buffer 成员变量变

是用保存日志信息的内存缓冲区，它的大小由 size 成员变量确定。从 misc 成员变

量可以看出，logger 驱动程序使用的设备属于 misc 类型的设备，通过在 Android 模

拟器上执行 cat /proc/devices 命令（可参考在 Ubuntu 上下载、编译和安装 Android

最新内核源代码（Linux Kernel）一文），可以看出，misc 类型设备的主设备号是

10。关于主设备号的相关知识，可以参考 Android 学习启动篇一文中提到的 Linux

Driver Development 一书。wq 成员变量是一个等待队列，用于保存正在等待读取日

志的进程。readers 成员变量用来保存当前正在读取日志的进程，正在读取日志的

要读取的日志缓冲区。list 成员变量用来连接其它读者进程。r_off 成员变量表示当

前要读取的日志在缓冲区中的位置。

struct logger_log 结构体中用于保存日志信息的内存缓冲区 buffer 是一个循环

使用的环形缓冲区，缓冲区中保存的内容是以 struct logger_entry 为单位的，每个

单位的组成为：

struct logger_entry | priority | tag | msg

由于是内存缓冲区 buffer 是一个循环使用的环形缓冲区，给定一个偏移值，它

在 buffer 中的位置由下 logger_offset 来确定：

#define logger_offset(n) ((n) & (log->size - 1))

二. Logger 驱动程序模块的初始化过程分析。

4. * LONG_MAX minus LOGGER_ENTRY_MAX_LEN.

5. */

6. #define DEFINE_LOGGER_DEVICE(VAR, NAME, SIZE) \

7. static unsigned char _buf_ ## VAR[SIZE]; \

8. static struct logger_log VAR = { \

9. .buffer = _buf_ ## VAR, \

10. .misc = { \

11. .minor = MISC_DYNAMIC_MINOR, \

18. .mutex = __MUTEX_INITIALIZER(VAR .mutex), \

19. .w_off = 0, \

20. .head = 0, \

21. .size = SIZE, \

22. };

23.

24. DEFINE_LOGGER_DEVICE(log_main, LOGGER_LOG_MAIN, 64*1024)

25. DEFINE_LOGGER_DEVICE(log_events, LOGGER_LOG_EVENTS, 256*1024)

26. DEFINE_LOGGER_DEVICE(log_radio, LOGGER_LOG_RADIO, 64*1024)

分别是 log_main、log_events 和 log_radio，名称分别

LOGGER_LOG_MAIN、LOGGER_LOG_EVENTS 和 LOGGER_LOG_RADIO，

它们的次设备号为 MISC_DYNAMIC_MINOR，即为在注册时动态分配。在

logger.h 文件中，有这三个宏的定义：

#define LOGGER_LOG_RADIO "log_radio" /* radio-related messages */

1. static struct file_operations logger_fops = {

2. .owner = THIS_MODULE,

3. .read = logger_read,