Documentation/sysfs的中文翻譯

Documentation/filesystems/sysfs.txt 的中文翻譯

如果想評論或更新本文的内容，請直接聯系原文檔的維護者。如果你使用英文

交流有困難的話，也可以向中文版維護者求助。如果本翻譯更新不及時或者翻

譯存在問題，請聯系中文版維護者。

英文版維護者： Patrick Mochel [email protected]

Mike Murphy [email protected]

中文版維護者：傅炜 Fu Wei [email protected]

中文版翻譯者：傅炜 Fu Wei tekkamanninj[email protected]

中文版校譯者：傅炜 Fu Wei [email protected]

以下為正文

sysfs - 用于導出核心對象(kobject)的檔案系統

Patrick Mochel [email protected]

Mike Murphy [email protected]

修訂: 16 August 2011

原始版本: 10 January 2003

sysfs 簡介:

~~~~~~

sysfs 是一個最初基于 ramfs 且位于記憶體的檔案系統。它提供導出核心

資料結構及其屬性，以及它們之間的關聯到使用者空間的方法。

sysfs 始終與 kobject 的底層結構緊密相關。請閱讀

Documentation/kobject.txt 文檔以獲得更多關于 kobject 接口的

資訊。

使用 sysfs

~~~~~~~

隻要核心配置中定義了 CONFIG_SYSFS ，sysfs 總是被編譯進核心。你可

通過以下指令挂載它:

mount -t sysfs sysfs /sys

建立目錄

~~~~

任何 kobject 在系統中注冊，就會有一個目錄在 sysfs 中被建立。這個

目錄是作為該 kobject 的父對象所在目錄的子目錄建立的，以準确地傳遞

核心的對象層次到使用者空間。sysfs 中的頂層目錄代表着核心對象層次的

共同祖先；例如：某些對象屬于某個子系統。

Sysfs 在與其目錄關聯的

kernfs_node

對象中内部儲存一個指向實作

目錄的 kobject 的指針。以前，這個 kobject 指針被 sysfs 直接用于

kobject 檔案打開和關閉的引用計數。而現在的 sysfs 實作中，kobject

引用計數隻能通過

sysfs_schedule_callback()

函數直接修改。

屬性

~~~~

kobject 的屬性可在檔案系統中以普通檔案的形式導出。Sysfs 為屬性定義

了面向檔案 I/O 操作的方法，以提供對核心屬性的讀寫。

屬性應為 ASCII 碼文本檔案。以一個檔案隻存儲一個屬性值為宜。但一個

檔案隻包含一個屬性值可能影響效率，是以一個包含相同資料類型的屬性值

數組也被廣泛地接受。

混合類型、表達多行資料以及一些怪異的資料格式會遭到強烈反對。這樣做是

很丢臉的,而且其代碼會在未通知作者的情況下被重寫。

一個簡單的屬性結構定義如下:

struct attribute {
    char                    * name;
    struct module       *owner;
    umode_t                 mode;
};


int sysfs_create_file(struct kobject * kobj, const struct attribute * attr);
void sysfs_remove_file(struct kobject * kobj, const struct attribute * attr);

一個單獨的屬性結構并不包含讀寫其屬性值的方法。子系統最好為增删特定

對象類型的屬性定義自己的屬性結構體和封裝函數。

例如:驅動程式模型定義的

device_attribute

結構體如下:

struct device_attribute {
struct attribute    attr;
ssize_t (*show)(struct device *dev, struct device_attribute *attr,
        char *buf);
ssize_t (*store)(struct device *dev, struct device_attribute *attr,
         const char *buf, size_t count);
};

int device_create_file(struct device *, const struct device_attribute *);
void device_remove_file(struct device *, const struct device_attribute *);

為了定義裝置屬性，同時定義了一下輔助宏:

#define DEVICE_ATTR(_name, _mode, _show, _store) \
struct device_attribute dev_attr_##_name = __ATTR(_name, _mode, _show, _store)

例如:聲明

static DEVICE_ATTR(foo, S_IWUSR | S_IRUGO, show_foo, store_foo);

等同于如下代碼：

static struct device_attribute dev_attr_foo = {
   .attr    = {
    .name = "foo",
    .mode = S_IWUSR | S_IRUGO,
    .show = show_foo,
    .store = store_foo,
    },
};

子系統特有的回調函數

~~~~~~~~~~~~~~~

當一個子系統定義一個新的屬性類型時，必須實作一系列的 sysfs 操作，

以幫助讀寫調用實作屬性所有者的顯示和儲存方法。

struct sysfs_ops {
    ssize_t (*show)(struct kobject *, struct attribute *, char *);
    ssize_t (*store)(struct kobject *, struct attribute *, const char *, size_t);
};

[子系統應已經定義了一個

struct kobj_type

結構體作為這個類型的

描述符，并在此儲存

sysfs_ops

的指針。更多的資訊參見 kobject 的

文檔]

sysfs 會為這個類型調用适當的方法。當一個檔案被讀寫時，這個方法會

将一般的kobject 和 attribute 結構體指針轉換為适當的指針類型後

調用相關聯的函數。

示例:

#define to_dev(obj) container_of(obj, struct device, kobj)
#define to_dev_attr(_attr) container_of(_attr, struct device_attribute, attr)

static ssize_t dev_attr_show(struct kobject *kobj, struct attribute *attr,
                         char *buf)
{
    struct device_attribute *dev_attr = to_dev_attr(attr);
    struct device *dev = to_dev(kobj);
    ssize_t ret = -EIO;

    if (dev_attr->show)
            ret = dev_attr->show(dev, dev_attr, buf);
    if (ret >= (ssize_t)PAGE_SIZE) {
            print_symbol("dev_attr_show: %s returned bad count\n",
                            (unsigned long)dev_attr->show);
    }
    return ret;
}

讀寫屬性資料

~~~~~~~~

在聲明屬性時，必須指定 show() 或 store() 方法，以實作屬性的

讀或寫。這些方法的類型應該和以下的裝置屬性定義一樣簡單。

ssize_t (*show)(struct device *dev, struct device_attribute *attr, char *buf);
ssize_t (*store)(struct device *dev, struct device_attribute *attr,
             const char *buf, size_t count);

也就是說,他們應隻以一個處理對象、一個屬性和一個緩沖指針作為參數。

sysfs 會配置設定一個大小為 (PAGE_SIZE) 的緩沖區并傳遞給這個方法。

Sysfs 将會為每次讀寫操作調用一次這個方法。這使得這些方法在執行時

會出現以下的行為:

在讀方面（read(2)），show() 方法應該填充整個緩沖區。回想屬性

應隻導出了一個屬性值或是一個同類型屬性值的數組，是以這個代價将

不會不太高。

這使得使用者空間可以局部地讀和任意的向前搜尋整個檔案。如果使用者空間

向後搜尋到零或使用‘0’偏移執行一個pread(2)操作，show()方法将

再次被調用，以重新填充緩存。
在寫方面（write(2)），sysfs 希望在第一次寫操作時得到整個緩沖區。

之後 Sysfs 傳遞整個緩沖區給 store() 方法。

當要寫 sysfs 檔案時，使用者空間程序應首先讀取整個檔案，修該想要

改變的值，然後回寫整個緩沖區。

在讀寫屬性值時，屬性方法的執行應操作相同的緩沖區。

注記:

寫操作導緻的 show() 方法重載，會忽略目前檔案位置。
緩沖區應總是 PAGE_SIZE 大小。對于i386，這個值為4096。
show() 方法應該傳回寫入緩沖區的位元組數，也就是 snprintf()的

傳回值。
show() 應始終使用 snprintf()。
store() 應傳回緩沖區的已用位元組數。如果整個緩存都已填滿，隻需傳回

count 參數。
show() 或 store() 可以傳回錯誤值。當得到一個非法值，必須傳回一個

錯誤值。
一個傳遞給方法的對象将會通過 sysfs 調用對象内嵌的引用計數固定在

記憶體中。盡管如此，對象代表的實體實體(如裝置)可能已不存在。如有必要，

應該實作一個檢測機制。

一個簡單的(未經實驗證明的)裝置屬性實作如下：

static ssize_t show_name(struct device *dev, struct device_attribute *attr,
                     char *buf)
{
return scnprintf(buf, PAGE_SIZE, "%s\n", dev->name);
}

static ssize_t store_name(struct device *dev, struct device_attribute *attr,
                      const char *buf, size_t count)
{
    snprintf(dev->name, sizeof(dev->name), "%.*s",
             (int)min(count, sizeof(dev->name) - 1), buf);
return count;
}

s tatic DEVICE_ATTR(name, S_IRUGO, show_name, store_name);

（注意：真正的實作不允許使用者空間設定裝置名。）

頂層目錄布局

~~~~~~~~

sysfs 目錄的安排顯示了核心資料結構之間的關系。

頂層 sysfs 目錄如下:

block/
bus/
class/
dev/
devices/
firmware/
net/
fs/

devices/ 包含了一個裝置樹的檔案系統表示。他直接映射了内部的核心

裝置樹，反映了裝置的層次結構。

bus/ 包含了核心中各種總線類型的平面目錄布局。每個總線目錄包含兩個

子目錄:

devices/
drivers/

devices/ 包含了系統中出現的每個裝置的符号連結，他們指向 root/ 下的

裝置目錄。

drivers/ 包含了每個已為特定總線上的裝置而挂載的驅動程式的目錄(這裡

假定驅動沒有跨越多個總線類型)。

fs/ 包含了一個為檔案系統設立的目錄。現在每個想要導出屬性的檔案系統必須

在 fs/ 下建立自己的層次結構(參見Documentation/filesystems/fuse.txt)。

dev/ 包含兩個子目錄： char/ 和 block/。在這兩個子目錄中，有以

: 格式命名的符号連結。這些符号連結指向 sysfs 目錄

中相應的裝置。/sys/dev 提供一個通過一個 stat(2) 操作結果，查找

裝置 sysfs 接口快捷的方法。

更多有關 driver-model 的特性資訊可以在 Documentation/driver-model/

中找到。

TODO: 完成這一節。

目前接口

~~~~

以下的接口層普遍存在于目前的sysfs中:

- 裝置 (include/linux/device.h)

結構體:

struct device_attribute {
struct attribute    attr;
ssize_t (*show)(struct device *dev, struct device_attribute *attr,
        char *buf);
ssize_t (*store)(struct device *dev, struct device_attribute *attr,
         const char *buf, size_t count);
};

聲明:

DEVICE_ATTR(_name, _mode, _show, _store);

增/删屬性:

int device_create_file(struct device *dev, const struct device_attribute * attr);
void device_remove_file(struct device *dev, const struct device_attribute * attr);

- 總線驅動程式 (include/linux/device.h)

結構體:

struct bus_attribute {
    struct attribute        attr;
    ssize_t (*show)(struct bus_type *, char * buf);
    ssize_t (*store)(struct bus_type *, const char * buf, size_t count);
};

聲明:

BUS_ATTR(_name, _mode, _show, _store)

增/删屬性:

int bus_create_file(struct bus_type *, struct bus_attribute *);
void bus_remove_file(struct bus_type *, struct bus_attribute *);

- 裝置驅動程式 (include/linux/device.h)

結構體:

struct driver_attribute {
    struct attribute        attr;
    ssize_t (*show)(struct device_driver *, char * buf);
    ssize_t (*store)(struct device_driver *, const char * buf,
                     size_t count);
};

聲明:

DRIVER_ATTR(_name, _mode, _show, _store)

增/删屬性：

int driver_create_file(struct device_driver *, const struct driver_attribute *);
void driver_remove_file(struct device_driver *, const struct driver_attribute *);

文檔

~~~~

sysfs 目錄結構以及其中包含的屬性定義了一個核心與使用者空間之間的 ABI。

對于任何 ABI，其自身的穩定和适當的文檔是非常重要的。所有新的 sysfs

屬性必須在 Documentation/ABI 中有文檔。詳見 Documentation/ABI/README。

Documentation/sysfs的中文翻譯

以下為正文

- 裝置 (include/linux/device.h)

- 總線驅動程式 (include/linux/device.h)

- 裝置驅動程式 (include/linux/device.h)

繼續閱讀

C語言：初學者必定看懂的注釋！！！猴子吃桃問題。猴子第一天摘下若幹個桃子，每天都吃了前一天剩下的一半零一個，到第10天早上想再吃的時候，就剩下一個桃子. 求第一天共摘多少個桃子。

Ubuntu14.04 LTS下安裝mongodb

[轉]九大排序算法——C語言實作及詳解

while 循環、do- while 循環和 for 循環之間的那點事C語言自學之三種循環比較

httpd服務的部署、啟動、配置和簡單優化一、部署二、啟動三、配置檔案

配置網頁内容通路

手動安裝Intel network I217-LM網卡的Linux驅動

禁止ubuntu系統彈出報錯界面

Ubuntu Linux下Apache的配置檔案

結構體：typedef與struct的差別

samba伺服器的功能

【Linux】UDP廣播封包接收速率問題

Linux裝置模型（中）之上層容器

PowerPC平台 Linux移植三

hdu7108哈希