Linux源码下生成并安装内核文档

最近想使用man命令查看Linux内核函数的帮助信息，无奈有如下提示： 
xinu@slam:~$ man printk 
No manual entry for printk 
而在Linux内核源码下，我们执行make help命令后，输出的提示内容有关于内核文档的如下信息： Documentation targets: Linux kernel internal documentation in different formats: 
htmldocs - HTML 
pdfdocs - PDF 
psdocs - Postscript 
xmldocs - XML DocBook 
mandocs - man pages 
installmandocs - install man pages generated by mandocs 
cleandocs - clean all generated DocBook files 
总共可以生成HTML、PDF、Postscript、XML和man文档这5种格式，其中man文档可以安装到系统里，然后使用man命令来查看相关Linux内核函数（Linux内核API函数）的帮助信息。 
由于我们终究要生成man文档，故而进行如下操作： 
cd ~/linux-3.13.6 make mandocs 
此时会有如下错误提示： 
xinu@slam:~/linux-3.13.6$ make mandocs 
HOSTCC scripts/docproc DOCPROC 
Documentation/DocBook/z8530book.xml 
** You need to install xmlto 
**make[1]: ** [Documentation/DocBook/z8530book.9] 
Error 1 make: ** [mandocs] Error 2 
于是使用如下命令安装xmlto： 
sudo apt-get install xmlto 
安装好后再执行上面的make mandocs命令继续生成Linux内核API帮助文档，生成的文档会放在Kernel源码的Documentation/DocBook目录下。
生成好后，再使用如下命令安装： 
sudo make installmandocs 
执行该命令时会有如下输出： 
xinu@slam:~/linux-3.13.6$ sudo make installmandocs 
[sudo] password for xinu: 
GEN /home/xinu/linux-3.13.6/Documentation/DocBook//v4l2.xml 
mkdir -p /usr/local/man/man9/ 
install Documentation/DocBook/man/.9.gz /usr/local/man/man9/ 
从提示可以看出其实际上是将所有.9.gz文件安装到/usr/local/man/man9目录里，那我们可以只编译一遍，然后将这些*.9.gz文件复制到其他机器再执行上面最后一行命令进行安装即可，这样可以省下编译生成文档的1个来小时时间（视机器配置而言）。 
至此，我们就可以使用类似man printk语句来查看内核函数的帮助信息了。

评论

发表评论

此博客中的热门博文

I/O映射之I/O端口

图片
对于外设，操作系统会采用端口映射和内存映射两种方式来对其进行控制，其中端口映射就是操作系统规定好一段地址给指定换上设，其与外设的寄存器按顺序一一对应上。 在Linux内核源码include/asm-generic/io.h头文件里有如下我们对I/O port进行操作的函数： static inline u8 inb(unsigned long addr) { return readb(addr + PCI_IOBASE); } static inline u16 inw(unsigned long addr) { return readw(addr + PCI_IOBASE); } static inline u32 inl(unsigned long addr) { return readl(addr + PCI_IOBASE); } static inline void outb(u8 b, unsigned long addr) { writeb(b, addr + PCI_IOBASE); } static inline void outw(u16 b, unsigned long addr) { writew(b, addr + PCI_IOBASE); } static inline void outl(u32 b, unsigned long addr) { writel(b, addr + PCI_IOBASE); } #define inb_p(addr) inb(addr) #define inw_p(addr) inw(addr) #define inl_p(addr) inl(addr) #define outb_p(x, addr) outb((x), (addr)) #define outw_p(x, addr) outw((x), (addr)) #define outl_p(x, addr) outl((x), (addr)) 分别对应对端口进行读取或写入字节、字、双字大小数据的操作。 该头文件中还有其他的操作函数及宏定义，请自行深入了解。 我们可通过读取/proc/ioports文件来了解Linux里I/O端口的映射
阅读全文

通过Netlink检测网线插拔

  最近有个需求需要检测RJ45网卡的网线有没有接上，而最近正在了解Netlink相关资料，刚好也看下通过Netlink可以进行检测，故在此做下粗略笔记：   1.首先要创建一个Netlink Socket，在用户层使用如下参数来调用socket()函数：    fd = socket(AF_NETLINK, SOCK_RAW, NETLINK_ROUTE);    上面这个函数第一个参数必须是AF_NETLINK或PF_NETLINK，这两个标志在Linux下是一样的，第二个参数可以是SOCK_RAW或SOCK_DGRAM（对应用到TCP或UDP协议），而最后一个参数NETLINK_ROUTE为“路由守护进程”，用于接收来自内核的路由通知事件。   2.将上面创建的Socket绑定    addr.nl_family = AF_NETLINK;    addr.nl_groups = RTNLGRP_LINK; //指定接收路由多播组消息    bind(fd, (struct sockaddr*)&addr, sizeof(addr));    上面将创建的socket与相应的协议族和组进行绑定，接下来通过读fd这个socket来获得相应的消息数据struct nlmsghdr，再对该结构体数据进行判断来获得网线是接上或是拔掉，相应的源码如下： #include <sys/types.h>  #include <sys/socket.h>  #include <asm/types.h>  #include <linux/netlink.h>  #include <linux/rtnetlink.h>  #include <stdlib.h>  #include <stdio.h>  #include <sys/ioctl.h>  #include <linux/if.h>  #include <string.h>  #define BUFLEN 20480  int main(int argc, char *argv[])  {      int fd, retval;      char buf[BUFLEN] = {0};
阅读全文

使用seq_file

在《使用procfs》一文的源码示例中有说到proc文件系统每次读取的数据只能是1个页，如果超过则需多次读取，这样的话会增加读取次数，增多系统调用次数，影响了整体的效率，故而才有seq file序列文件的出现，该项功能使得内核对于大文件的读取更加容易。 对于seq file，其结构体定义在include/linux/seq_file.h文件中，内容如下： struct seq_file { char *buf; size_t size; size_t from; size_t count; size_t pad_until; loff_t index; loff_t read_pos; u64 version; struct mutex lock; const struct seq_operations *op; int poll_event; #ifdef CONFIG_USER_NS struct user_namespace *user_ns; #endif void *private; }; 这里不详细说明该结构体，仅供感受下。 对于seq_file，相应的文件操作需要实现seq_operations结构体的成员，该结构体在同一头文件中有如下定义： struct seq_operations { void * (*start) (struct seq_file *m, loff_t *pos); void (*stop) (struct seq_file *m, void *v); void * (*next) (struct seq_file *m, void *v, loff_t *pos); int (*show) (struct seq_file *m, void *v); }; 实现该结构体成员后，需要使用seq_open打开，让文件与该seq_operations关联起来，最终这个open函数要作为file_oper
阅读全文