linux设备模型之kset/kobj/ktype分析
1. 概述
今天來聊一下Linux設(shè)備模型的基石:kset/kobject/ktype。
sysfs文件系統(tǒng)提供了一種用戶與內(nèi)核數(shù)據(jù)結(jié)構(gòu)進行交互的方式,可以通過mount -t sysfs sysfs /sys來進行掛載;
Linux設(shè)備模型中,設(shè)備、驅(qū)動、總線組織成拓撲結(jié)構(gòu),通過sysfs文件系統(tǒng)以目錄結(jié)構(gòu)進行展示與管理;
Linux設(shè)備模型中,總線負責(zé)設(shè)備和驅(qū)動的匹配,設(shè)備與驅(qū)動都掛在某一個總線上,當(dāng)它們進行注冊時由總線負責(zé)去完成匹配,進而回調(diào)驅(qū)動的probe函數(shù);
SoC系統(tǒng)中有spi, i2c, pci等實體總線用于外設(shè)的連接,而針對集成在SoC中的外設(shè)控制器,Linux內(nèi)核提供一種虛擬總線platform用于這些外設(shè)控制器的連接,此外platform總線也可用于沒有實體總線的外設(shè);
在/sys目錄下,bus用于存放各類總線,其中總線中會存放掛載在該總線上的驅(qū)動和設(shè)備,比如serial8250,devices存放了系統(tǒng)中的設(shè)備信息,class是針對不同的設(shè)備進行分類;
上邊這些功能的實現(xiàn),離不開kobject/kset/ktype機制的支撐,開始旅程吧。
2. 數(shù)據(jù)結(jié)構(gòu)
2.1 kobject
kobject代表內(nèi)核對象,結(jié)構(gòu)體本身不單獨使用,而是嵌套在其他高層結(jié)構(gòu)中,用于組織成拓撲關(guān)系;
sysfs文件系統(tǒng)中一個目錄對應(yīng)一個kobject;
看看結(jié)構(gòu)體吧:
struct?kobject?{const?char??*name;??????????????????/*?名字,對應(yīng)sysfs下的一個目錄?*/struct?list_head?entry;???????????????/*?kobject中插入的?list_head結(jié)構(gòu),用于構(gòu)造雙向鏈表?*/struct?kobject??*parent;????????????/*?指向當(dāng)前kobject父對象的指針,體現(xiàn)在sys中就是包含當(dāng)前kobject對象的目錄對象?*/struct?kset??*kset;????????????????????/*?當(dāng)前kobject對象所屬的集合?*/struct?kobj_type?*ktype;????????????/*?當(dāng)前kobject對象的類型?*/struct?kernfs_node?*sd;??????????????/*?VFS文件系統(tǒng)的目錄項,是設(shè)備和文件之間的橋梁,sysfs中的符號鏈接是通過kernfs_node內(nèi)的聯(lián)合體實現(xiàn)的?*/struct?kref??kref;?????????????????????/*?kobject的引用計數(shù),當(dāng)計數(shù)為0時,回調(diào)之前注冊的release方法釋放該對象?*/ #ifdef?CONFIG_DEBUG_KOBJECT_RELEASEstruct?delayed_work?release; #endifunsigned?int?state_initialized:1;????????????????/*?初始化標(biāo)志位,初始化時被置位?*/unsigned?int?state_in_sysfs:1;??????????????????/*?kobject在sysfs中的狀態(tài),在目錄中創(chuàng)建則為1,否則為0?*/unsigned?int?state_add_uevent_sent:1;??????/*?添加設(shè)備的uevent事件是否發(fā)送標(biāo)志,添加設(shè)備時向用戶空間發(fā)送uevent事件,請求新增設(shè)備?*/unsigned?int?state_remove_uevent_sent:1;??/*?刪除設(shè)備的uevent事件是否發(fā)送標(biāo)志,刪除設(shè)備時向用戶空間發(fā)送uevent事件,請求卸載設(shè)備?*/unsigned?int?uevent_suppress:1;??????????????/*?是否忽略上報(不上報uevent)?*/ };2.2 kset
kset是包含多個kobject的集合;
如果需要在sysfs的目錄中包含多個子目錄,那需要將它定義成一個kset;
kset結(jié)構(gòu)體中包含struct kobject字段,可以使用該字段鏈接到更上一層的結(jié)構(gòu),用于構(gòu)建更復(fù)雜的拓撲結(jié)構(gòu);
sysfs中的設(shè)備組織結(jié)構(gòu)很大程度上根據(jù)kset組織的,/sys/bus目錄就是一個kset對象,在Linux設(shè)備模型中,注冊設(shè)備或驅(qū)動時就將kobject添加到對應(yīng)的kset中;
2.3 ktype
kobj_type用于表征kobject的類型,指定了刪除kobject時要調(diào)用的函數(shù),kobject結(jié)構(gòu)體中有struct kref字段用于對kobject進行引用計數(shù),當(dāng)計數(shù)值為0時,就會調(diào)用kobj_type中的release函數(shù)對kobject進行釋放,這個就有點類似于C++中的智能指針了;
kobj_type指定了通過sysfs顯示或修改有關(guān)kobject的信息時要處理的操作,實際是調(diào)用show/store函數(shù);
可以看一下kobject創(chuàng)建的時候,與ktype的關(guān)系,這樣理解起來更順:
kobject在創(chuàng)建的時候,默認設(shè)置kobj_type的值為dynamic_kobj_ktype,通常kobject會嵌入在其他結(jié)構(gòu)中來使用,因此它的初始化跟特定的結(jié)構(gòu)相關(guān),典型的比如struct device和struct device_driver;
在/sys文件系統(tǒng)中,通過echo/cat的操作,最終會調(diào)用到show/store函數(shù),而這兩個函數(shù)的具體實現(xiàn)可以放置到驅(qū)動程序中;
2.4 結(jié)構(gòu)關(guān)系
為了更形象的說明這幾個結(jié)構(gòu)體的關(guān)系,再來一張圖:
kset既是kobject的集合,本身又是一個kobject,進而可以添加到其他的集合中,從而就可以構(gòu)建成復(fù)雜的拓撲結(jié)構(gòu),滿足/sys文件夾下的文件組織需求;
如果只看kset/kobject的數(shù)據(jù)結(jié)構(gòu)組織,可能還是會迷惑,它怎么跟Linux的設(shè)備模型相關(guān)?這時就不得不提到Linux內(nèi)核中一個很精妙的存在container_of,它可以通過成員變量的地址來獲取所在結(jié)構(gòu)的地址信息。前文提到過kobject/kset結(jié)構(gòu)本身不會單獨使用,通常都是會嵌套在其他結(jié)構(gòu)中,既然kobjcet/kset能組織成拓撲結(jié)構(gòu),那么包含它們的結(jié)構(gòu)同樣可以構(gòu)建這個關(guān)系,因為可以通過container_of就可以找到結(jié)構(gòu)體的首地址。
結(jié)構(gòu)體A、B、C、D、E同樣可以構(gòu)建拓撲結(jié)構(gòu)關(guān)系;
struct device和struct device_driver結(jié)構(gòu)體中都包含了struct kobject,而struct bus_type結(jié)構(gòu)體中包含了struct kset結(jié)構(gòu),這個也就對應(yīng)到前文提到的設(shè)備和驅(qū)動都添加到總線上,由總線來負責(zé)匹配;
3. 流程分析
kobject/kset的相關(guān)代碼比較簡單,畢竟它只是作為一個結(jié)構(gòu)體嵌入其他high-level的結(jié)構(gòu)中,充當(dāng)紐帶的作用。不過,我還是簡單的上一張圖吧:
完成的工作基本就是分配結(jié)構(gòu)體,初始化各個結(jié)構(gòu)體字段,構(gòu)建拓撲關(guān)系(主要是添加到kset的list中,parent的指向等)等,看懂了結(jié)構(gòu)體的組織,這部分的代碼理解起來就很輕松了;
4. 示例
先上一個原理圖:
4.1 代碼
#include?<linux/kernel.h> #include?<linux/module.h> #include?<linux/slab.h> #include?<linux/kobject.h>//自定義一個結(jié)構(gòu),包含了struct?kobject子結(jié)構(gòu) struct?test_kobj?{int?value;struct?kobject?kobj; };//自定義個屬性結(jié)構(gòu)體,包含了struct?attribute結(jié)構(gòu) struct?test_kobj_attribute?{struct?attribute?attr;ssize_t?(*show)(struct?test_kobj?*obj,?struct?test_kobj_attribute?*attr,?char?*buf);ssize_t?(*store)(struct?test_kobj?*obj,?struct?test_kobj_attribute?*attr,?const?char?*buf,?size_t?count); };//聲明一個全局結(jié)構(gòu)用于測試 struct?test_kobj?*obj;//用于初始化sysfs_ops中的函數(shù)指針 static?ssize_t?test_kobj_attr_show(struct?kobject?*kobj,?struct?attribute?*attr,?char?*buf) {struct?test_kobj_attribute?*test_kobj_attr;ssize_t?ret?=?-EIO;test_kobj_attr?=?container_of(attr,?struct?test_kobj_attribute,?attr);//回調(diào)到具體的實現(xiàn)函數(shù)if?(test_kobj_attr->show)ret?=?test_kobj_attr->show(container_of(kobj,?struct?test_kobj,?kobj),?test_kobj_attr,?buf);return?ret; }//用于初始化sysfs_ops中的函數(shù)指針 static?ssize_t?test_kobj_attr_store(struct?kobject?*kobj,?struct?attribute?*attr,?const?char?*buf,?size_t?count) {struct?test_kobj_attribute?*test_kobj_attr;ssize_t?ret?=?-EIO;test_kobj_attr?=?container_of(attr,?struct?test_kobj_attribute,?attr);//回調(diào)到具體的實現(xiàn)函數(shù)if?(test_kobj_attr->store)ret?=?test_kobj_attr->store(container_of(kobj,?struct?test_kobj,?kobj),?test_kobj_attr,?buf,?count);return?ret; }//用于初始化kobj_ktype const?struct?sysfs_ops?test_kobj_sysfs_ops?=?{.show?=?test_kobj_attr_show,.store?=?test_kobj_attr_store, };//用于初始化kobj_ktype,最終用于釋放kobject void?obj_release(struct?kobject?*kobj) {struct?test_kobj?*obj?=?container_of(kobj,?struct?test_kobj,?kobj);printk(KERN_INFO?"test?kobject?release?%s\n",?kobject_name(&obj->kobj));kfree(obj); }//定義kobj_ktype,用于指定kobject的類型,初始化的時候使用 static?struct?kobj_type?test_kobj_ktype?=?{.release?=?obj_release,.sysfs_ops?=?&test_kobj_sysfs_ops, };//show函數(shù)的具體實現(xiàn) ssize_t?name_show(struct?test_kobj?*obj,?struct?test_kobj_attribute?*attr,?char?*buffer) {return?sprintf(buffer,?"%s\n",?kobject_name(&obj->kobj)); }//show函數(shù)的具體實現(xiàn) ssize_t?value_show(struct?test_kobj?*obj,?struct?test_kobj_attribute?*attr,?char?*buffer) {return?sprintf(buffer,?"%d\n",?obj->value); }//store函數(shù)的具體實現(xiàn) ssize_t?value_store(struct?test_kobj?*obj,?struct?test_kobj_attribute?*attr,?const?char?*buffer,?size_t?size) {sscanf(buffer,?"%d",?&obj->value);return?size; }//定義屬性,最終注冊進sysfs系統(tǒng) struct?test_kobj_attribute?name_attribute?=?__ATTR(name,?0664,?name_show,?NULL); struct?test_kobj_attribute?value_attribute?=?__ATTR(value,?0664,?value_show,?value_store); struct?attribute?*test_kobj_attrs[]?=?{&name_attribute.attr,&value_attribute.attr,NULL, };//定義組 struct?attribute_group?test_kobj_group?=?{.name?=?"test_kobj_group",.attrs?=?test_kobj_attrs, };//模塊初始化函數(shù) static?int?__init?test_kobj_init(void) {int?retval;printk(KERN_INFO?"test_kobj_init\n");obj?=?kmalloc(sizeof(struct?test_kobj),?GFP_KERNEL);if?(!obj)?{return?-ENOMEM;}obj->value?=?1;memset(&obj->kobj,?0,?sizeof(struct?kobject));//添加進sysfs系統(tǒng)kobject_init_and_add(&obj->kobj,?&test_kobj_ktype,?NULL,?"test_kobj");//在sys文件夾下創(chuàng)建文件retval?=?sysfs_create_files(&obj->kobj,?(const?struct?attribute?**)test_kobj_attrs);if?(retval)?{kobject_put(&obj->kobj);return?retval;}//在sys文件夾下創(chuàng)建groupretval?=?sysfs_create_group(&obj->kobj,?&test_kobj_group);if?(retval)?{kobject_put(&obj->kobj);return?retval;}return?0; }//模塊清理函數(shù) static?void?__exit?test_kobj_exit(void) {printk(KERN_INFO?"test_kobj_exit\n");kobject_del(&obj->kobj);kobject_put(&obj->kobj);return; }module_init(test_kobj_init); module_exit(test_kobj_exit);MODULE_AUTHOR("LoyenWang"); MODULE_LICENSE("GPL");4.2 Makefile
ifneq??($(KERNELRELEASE),) obj-m:=test_kobject.o else KERDIR?:=?/lib/modules/$(shell?uname?-r)/build PWD:=$(shell?pwd) all:make?-C?$(KERDIR)?M=$(PWD)?modules clean:rm?-f?*.ko?*.o?*.symvers?*.cmd?*.cmd.o?modules.*?*.mod.c endifMakefile沒有太多好說的,注意Tab的使用,否則容易出錯;
4.3 測試結(jié)果
在/sys目錄下創(chuàng)建了test_kobj文件夾,在該文件夾下除了name和value外,還有一個test_kobj_group的子文件夾;
可以通過cat/echo的操作,來操作name和value,分別會調(diào)用到底層的xxx_show和xxx_store函數(shù);
對著代碼看這個圖,一目了然;
草草收場,洗洗睡了。
如果覺得對你有幫助,那就點個在看吧。
參考
https://lwn.net/Articles/263200/
推薦閱讀:
? ??專輯|Linux文章匯總
? ??專輯|程序人生
? ??專輯|C語言
嵌入式Linux
微信掃描二維碼,關(guān)注我的公眾號?
總結(jié)
以上是生活随笔為你收集整理的linux设备模型之kset/kobj/ktype分析的全部內(nèi)容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: 后端图形验证码base64编码字符串及前
- 下一篇: Linux 内核通知链和例程代码