ioctl（）函式學習【綜合貼】

阿新 • • 發佈：2019-02-12

目錄：

6、linux系統檔案

說明：本文為上述文章的綜合，但有些地方根據自己的理解做了編輯更改。雖有些許原創，但可忽略不計。本文只為學習更方便，不保留版權。

標頭檔案： #include<sys/ioctl.h>

功能: 控制I/O裝置，提供了一種獲得裝置資訊和向裝置傳送控制引數的手段。用於向裝置發控制和配置命令，有些命令需要控制引數，這些資料是不能用read / write 讀寫的,稱為Out-of-band資料。也就是說,read / write 讀寫的資料是in-band資料,是I/O操作的主體，而ioctl命令傳送的是控制資訊,其中的資料是輔助的資料。

用法: int ioctl(int handle, unsigned long cmd,[int *argdx, int argcx]);

返回值：成功為0，出錯為-1

實際上在我的linux系統（redhat9,linux2.4核心和升級到的linux2.6）中，有三處ioctl.h標頭檔案：

/usr/include/asm/ioctl.h:這個檔案定義了關於ioctl要用到的許多至關重要的巨集定義，在後邊要講到。

/usr/include/linux/ioctl.h:包含的上一個檔案

/usr/include/sys/ioctl.h:除了包含了好幾個檔案外，就是一個ioctl的extern宣告，形式如下：externint ioctl(int __fd, unsigned long int __request, ...)。這個檔案就是提供給了使用者空間一個ioctl控制函式。由於這些點而凸現於 Unix 系統呼叫列表, 這些點常常表示函式有數目不定的引數. 在實際系統中, 但是, 一個系統呼叫不能真正有變數目的引數. 系統呼叫必須有一個很好定義的原型, 因為使用者程式可存取它們只能通過硬體的"門". 因此, 原型中的點不表示一個變數目的引數, 而是一個單個可選的引數, 傳統上標識為 char *argp. 這些點在那裡只是為了阻止在編譯時的型別檢查. 第 3 個引數的實際特點依賴所發出的特定的控制命令( 第 2 個引數 ). 一些命令不用引數, 一些用一個整數值, 以及一些使用指向其他資料的指標. 使用一個指標就可以傳遞任意資料到 ioctl 呼叫的方法; 裝置接著可與使用者空間交換任何數量的資料.

第二篇：核心空間的ioctl----用於驅動程式

函式形式：

int (*ioctl) (struct inode *, struct file *, unsigned int, unsigned long);

這是驅動程式裝置控制介面函式（ioctl函式）的核心原型定義，struct inode *和struct file*描述了操作的檔案，unsigned int 描述了ioctl命令號，這是一個重要的引數，我們稍後會對它做詳細介紹。最後一個引數是unsigned long資料型別，描述了ioctl命令可能帶有的引數，它可能是一個整數或指標資料。

ioctl命令號

ioctl

命令號是這個函式中最重要的引數，它描述的ioctl要處理的命令。Linux中使用一個32位的資料來編碼ioctl命令，它包含四個部分：dir：type：nr：size。

· dir：

代表資料傳輸的方向，佔2位，可以是_IOC_NONE（無資料傳輸，0U），_IOC_WRITE（向裝置寫資料，1U）或_IOC_READ（從裝置讀資料，2U）或他們的邏輯或組合，當然只有_IOC_WRITE和_IOC_READ的邏輯或才有意義。

· type：

描述了ioctl命令的型別，8位。每種裝置或系統都可以指定自己的一個型別號，ioctl用這個型別來表示ioctl命令所屬的裝置或驅動。一般用ASCII碼字元來表示，如 'a'。

· nr：

ioctl命令序號，一般8位。對於一個指定的裝置驅動，可以對它的ioctl命令做一個順序編碼，一般從零開始，這個編碼就是ioctl命令的序號。

· size：

ioctl命令的引數大小，一般14位。ioctl命令號的這個資料成員不是強制使用的，你可以不使用它，但是我們建議你指定這個資料成員，通過它我們可以檢查使用者空間資料的大小以避免錯誤的資料操作，也可以實現相容舊版本的ioctl命令。

我們可以自己來直接指定一個ioctl命令號，它可能僅僅是一個整數集，但Linux中的ioctl命令號都是有特定含義的，因此通常我們不推薦這麼做。其實Linux核心已經提供了相應的巨集來自動生成ioctl命令號：

_IO(type,nr)
_IOR(type,nr,size)
_IOW(type,nr,size)
_IOWR(type,nr,size)

巨集_IO用於無資料傳輸，巨集_IOR用於從裝置讀資料，巨集 _IOW用於向裝置寫資料，巨集_IOWR用於同時有讀寫資料的IOCTL命令。相對的，Linux核心也提供了相應的巨集來從ioctl命令號種解碼相應的域值：

_IOC_DIR(nr)
_IOC_TYPE(nr)
_IOC_NR(nr)
_IOC_SIZE(nr)

這些巨集都定義在<asm/ioctl.h>標頭檔案中（一般在<asm-generic.h>標頭檔案中）。一般在使用中，先指定各個IOCTL命令的順序編號（一般從0開始），然後根據使用的環境用這些巨集來自動生成IOCTL命令號，在後面的例子中你可以瞭解實際的使用場景。

ioctl返回值

ioctl函式的返回值是一個整數型別的值，如果命令執行成功，ioctl返回零，如果出現錯誤，ioctl函式應該返回一個負值。這個負值會作為errno值反饋給呼叫此ioctl的使用者空間程式。關於返回值的具體含義，請參考<linux/errno.h>和<asm/errno.h>標頭檔案。

ioctl引數

這裡有必要說明一下ioctl命令的引數，因為它很容易犯錯誤。如果ioctl命令引數僅僅是一個整數，那麼事情很簡單了，我們可以在ioctl函式中直接使用它。但如果它是一個指標資料，那麼使用上就要小心了。首先要說明這個引數是有使用者空間的程式傳遞過來的，因此這個指標指向的地址是使用者空間地址，在Linux中，使用者空間地址是一個虛擬地址，在核心空間是無法直接使用它的。為了解決在核心空間使用使用者空間地址的資料，Linux核心提供了以下函式，它們用於在核心空間訪問使用者空間的資料，定義在<asm/uaccess.h>標頭檔案中：

unsigned long __must_check copy_to_user(void __user *to,
const void *from, unsigned long n);
unsigned long __must_check copy_from_user(void *to,
const void __user *from, unsigned long n);

copy_from_user和copy_to_user一般用於複雜的或大資料交換，對於簡單的資料型別，如int或char，核心提供了簡單的巨集來實現這個功能：

#define get_user(x,ptr)
#define put_user(x,ptr)

其中，x是核心空間的簡單資料型別地址，ptr是使用者空間地址指標。
我們需要牢記：在核心中是無法直接訪問使用者空間地址資料的。因此凡是從使用者空間傳遞過來的指標資料，務必使用核心提供的函式來訪問它們。

這裡有必要再一次強調的是，在核心模組或驅動程式的編寫中，我們強烈建議你使用核心提供的介面來生成並操作ioctl命令號，這樣可以對命令號賦予特定的含義，使我們的程式更加的健壯；另一方面也可以提高程式的可移植性。舉例好了，是時候舉個例子了。我們將擴充套件我們的helloworld驅動新增ioctl函式。首先，我們新增一個頭檔案來定義ioctl介面需要用到的資料（hello.h）：

#ifndef _HELLO_H
#define _HELLO_H
#include <asm/ioctl.h>
#define MAXBUF 20
typedef struct _buf_data{
        int size;
        char data [MAXBUF];
}buf_data;

#define HELLO_IOCTL_NR_BASE             0
#define HELLO_IOCTL_NR_SET_DATA         (HELLO_IOCTL_NR_BASE + 1)
#define HELLO_IOCTL_NR_MAX              (HELLO_IOCTL_NR_GET_BUFF + 1)

#define HELLO_IOCTL_SET_DATA            _IOR('h', HELLO_IOCTL_NR_SET_DATA, buf_data*)

#endif

然後為我們的驅動程式新增ioctl介面hello_ioctl，並實現這個函式：

static int hello_ioctl (struct inode *inode, struct file *filp,
                           unsigned int cmd, unsigned long arg)
{
    int cmd_nr;
    int err;
    buf_data buff;

    err = 0;
    cmd_nr = _IOC_NR (cmd);
    switch (cmd_nr){
        case HELLO_IOCTL_NR_SET_DATA:
            if (copy_from_user(&buff, (unsigned char *)arg, sizeof(buf_data)))
            {
                err = -ENOMEM;
                goto error;
            }
            memset(hello_buf, 0, sizeof(hello_buf));
            memcpy(hello_buf, buff.data, buff.size);
            break;
        default:
            printk("hello_ioctl: Unknown ioctl command (%d)/n", cmd);
            break;
    }

error:
    return err;
}

static struct file_operations hello_fops = {
        .read = hello_read,
        .write = hello_write,
        .open = hello_open,
        .ioctl = hello_ioctl,
        .release = hello_release,
};

這個例子儘管很簡單，但已經足夠了。到這裡你可以寫出一個標準的Linux驅動程式了。不過這裡還有個問題，那就是我們不得不從/proc/devices檔案裡讀取裝置號然後手動建立裝置節點。我們是否可以讓系統自動的建立這個裝置節點檔案呢？當然可以。不過在那之前，我們必須深入瞭解Linux的裝置驅動模型。

第三篇：標頭檔案ioctl.h----關於ioctl的巨集定義

在編寫ioctl程式碼之前，需要選擇對應不同命令的編號。為了防止對錯誤的裝置使用正確的命令，命令號應該在系統範圍內唯一，這種錯誤匹配並不是不會發生，程式可能發現自己正在試圖對FIFO和audio等這類非序列裝置輸入流修改波特率，如果每一個ioctl命令都是唯一的，應用程式進行這種操作時就會得到一個EINVAL錯誤，而不是無意間成功地完成了意想不到的操作。

要按Linux核心的約定方法為驅動程式選擇ioctl編號，應該首先看看include/asm/ioctl.h和這兩個檔案。標頭檔案定義了要使用的位欄位：型別（幻數）、序數、傳送方向以及引數大小等。ioctl-number.txt檔案中羅列了核心所使用的幻數，選擇自己的幻數要避免和核心衝突。以下是對include/asm/ioctl.h中定義的巨集的註釋：

#define_IOC_NRBITS 8 //序數（number）欄位的字位寬度，8bits

#define_IOC_TYPEBITS 8 //幻數（type）欄位的字位寬度，8bits

#define _IOC_SIZEBITS 14 //大小（size）欄位的字位寬度，14bits

#define_IOC_DIRBITS 2 //方向（direction）欄位的字位寬度，2bits

#define_IOC_NRMASK ((1 << _IOC_NRBITS)-1) //序數字段的掩碼，0x000000FF

#define _IOC_TYPEMASK ((1 << _IOC_TYPEBITS)-1) //幻數字段的掩碼，0x000000FF

#define _IOC_SIZEMASK ((1 << _IOC_SIZEBITS)-1) //大小欄位的掩碼，0x00003FFF

#define_IOC_DIRMASK ((1 << _IOC_DIRBITS)-1) //方向欄位的掩碼，0x00000003

#define _IOC_NRSHIFT 0 //序數字段在整個欄位中的位移，0

#define _IOC_TYPESHIFT (_IOC_NRSHIFT+_IOC_NRBITS) //幻數字段的位移，8

#define_IOC_SIZESHIFT (_IOC_TYPESHIFT+_IOC_TYPEBITS) //大小欄位的位移，16

#define _IOC_DIRSHIFT (_IOC_SIZESHIFT+_IOC_SIZEBITS) //方向欄位的位移，30

* Direction bits.

#define_IOC_NONE 0U //沒有資料傳輸

#define _IOC_WRITE 1U //向裝置寫入資料，驅動程式必須從使用者空間讀入資料

#define_IOC_READ 2U //從裝置中讀取資料，驅動程式必須向用戶空間寫入資料

*_IOC 巨集將dir，type，nr，size四個引數組合成一個cmd引數，如下圖：

#define _IOC(dir,type,nr,size) \

(((dir) << _IOC_DIRSHIFT) | \

((type) << _IOC_TYPESHIFT) | \

((nr) << _IOC_NRSHIFT) | \

((size) << _IOC_SIZESHIFT))

* used to create numbers

//構造無引數的命令編號

#define _IO(type,nr) _IOC(_IOC_NONE,(type),(nr),0)

//構造從驅動程式中讀取資料的命令編號

#define _IOR(type,nr,size) _IOC(_IOC_READ,(type),(nr),sizeof(size))

//用於向驅動程式寫入資料命令

#define _IOW(type,nr,size) _IOC(_IOC_WRITE,(type),(nr),sizeof(size))

//用於雙向傳輸

#define _IOWR(type,nr,size) _IOC(_IOC_READ|_IOC_WRITE,(type),(nr),sizeof(size))

*used to decode ioctl numbers..

//從命令引數中解析出資料方向，即寫進還是讀出

#define _IOC_DIR(nr) (((nr) >> _IOC_DIRSHIFT) & _IOC_DIRMASK)

//從命令引數中解析出幻數type

#define _IOC_TYPE(nr) (((nr) >> _IOC_TYPESHIFT) & _IOC_TYPEMASK)

//從命令引數中解析出序數number

#define _IOC_NR(nr) (((nr) >> _IOC_NRSHIFT) & _IOC_NRMASK)

//從命令引數中解析出使用者資料大小

#define _IOC_SIZE(nr) (((nr) >> _IOC_SIZESHIFT) & _IOC_SIZEMASK)

/* ...and for the drivers/sound files... */

#define IOC_IN (_IOC_WRITE << _IOC_DIRSHIFT)

#define IOC_OUT (_IOC_READ << _IOC_DIRSHIFT)

#defineIOC_INOUT ((_IOC_WRITE|_IOC_READ) << _IOC_DIRSHIFT)

#define IOCSIZE_MASK (_IOC_SIZEMASK << _IOC_SIZESHIFT)

#define IOCSIZE_SHIFT (_IOC_SIZESHIFT)

我的理解：

假如我定義了一個命令MY_CMD:

#define MY_CMD_MAGIC0xdf //type欄位，由於欄位寬度為8 bits，所以不能大於0xff

#define MY_CMD _IOW(MY_CMD_MAGIC,0,unsignedint)

於是有命令MY_CMD各組成欄位（dir，size，type，nr）分別為：01(=_IOC_WRITE),00 0000 0000 0100(=sizeof(unsignedint)),1101 1111(=MY_CMD_MAGIC),0000 0000(=0)。用十六進位制表示即0x4004df00。這個32 bits的“整數“就是該命令的編號（LDD3原文是command number），也就是命令MY_CMD在系統中的“身份證號碼”了！

為什麼上面我用“身份證號碼”作比喻呢？眾所周知，一個國家裡所有公民的身份證號都是各不相同的。身份證編號有一定的規則：即把身份證號劃分成幾個欄位，各段位數可不等，每個欄位編碼都有它的實際意義，例如我們現在用的的身份證前N位（不記得具體是多少了）表示一個具體的省、市、等地區，不同地區的人該欄位肯定不同了;另外有個表示出生年月的欄位（據說以前整個號碼最後一位偶數表示男性，奇數表示女性，現在貌似沒這個規則了，此為題外話）。

類似地，我們要為系統裡所有的IOCTL命令編號。我們身份證用的是15（上一代是18位）位十進位制數編碼（最後一位可能是拉丁字母）;我們用32位二進制數為IOCTL命令編碼，把它劃分成4個欄位，每段也有它的實際意義。要保證每個命令編號為系統唯一，主要靠命令的type和nr欄位。我們稱type 欄位內容為magic number，即幻數，它表示命令的型別。

看到上段紅色這句話，我想可能有細心的人會問：“那麼命令到底有哪些型別呢？”老實說我也不知道正確答案。大概因為大家都知道基本資料型別有整形、浮點型、字元型...人的性格型別有外向型、內向型...這些我們常見的型別都是可以用文字來列舉描述的，所以潛意識就覺得有型別就應該有文字可描述吧。回到正題，我想每個magic number，就像上面的巨集定義中：#defineMY_CMD_MAGIC 0xdf，MY_CMD_MAGIC就是型別名了吧！不知道我的想法對不對？！反正大家知道一個magic number就對應唯一一種命令型別就是了。LDD原文中有一段：

type
The magic number. Just choose one number (after consulting ioctl-number.txt)
and use it throughout the driver. This field is eight bits wide(_IOC_TYPEBITS).

原文是說type的內容叫幻數（magic number），強調它是一個8位二進位制數（number）。因此不同type的命令就有不同的magic number，因此命令編碼自然就不同了。但如果兩個命令type相同，它們的magic number就相同，於是就不能僅靠type欄位區分了。於是nr欄位就起作用了：

number
The ordinal (sequential) number. It’s eight bits (_IOC_NRBITS) wide.

nr（number）即序號，一般地我們從0開始編號。由於nr欄位為8位二進位制數，所以nr的取值範圍為0~255。同一種type的命令每個nr值對應唯一一個命令。其他兩個欄位在這裡不作深究。值得一提的是LDD3裡這麼一段話：The header alsodefines macros that may be used in your driver to decode the num-bers:_IOC_DIR(nr), _IOC_TYPE(nr), _IOC_NR(nr), and _IOC_SIZE(nr). We won’t gointo any moredetail about these macros because the header file is clear, and samplecode is shownlater in this section.根據ioctl.h檔案的定義，很明顯_IOC_DIR(nr), _IOC_TYPE(nr),_IOC_NR(nr),_IOC_SIZE(nr)這幾個巨集裡面的引數就是一個IOCTL命令，即一個32位的二進位制數，而檔案中引數居然用nr表示！當然用nr表示不是邏輯上的錯誤。但是別忘了檔案中還有_IOW(type,nr,size)這樣的定義IOCTL命令的巨集，這其中的引數nr是 IOCTL命令編號中的一個nr欄位，一個8位的二進位制數！我想很多新人都會對此產生莫大的疑惑！所以我認為把_IOC_DIR(nr), _IOC_TYPE(nr),_IOC_NR(nr),_IOC_SIZE(nr)這幾個解碼巨集的引數改用cmd表示更恰當！但是，我知道這不是LDD3作者的錯，因為核心標頭檔案裡面也是這麼表示的。我想核心開發者不可能沒意識到這個問題。因此，我猜測這其中肯定有個歷史原因：大概以前版本的命令不管type是否一樣，nr欄位的值都是唯一的，於是僅靠nr欄位就可以解碼出一個IOCTL命令的其他欄位吧？！但即使這樣 _IOC_DIR(nr), _IOC_TYPE(nr),_IOC_NR(nr),_IOC_SIZE(nr)也沒必要保留這種寫法啊！到底誰可以告訴我真相？LDD3沒有對_IOC_DIR(nr), _IOC_TYPE(nr),_IOC_NR(nr),_IOC_SIZE(nr)裡面的nr作任何解釋，只是例項中有如下用法：if(_IOC_TYPE(cmd) != SCULL_IOC_MAGIC) return -ENOTTY;if (_IOC_NR(cmd)> SCULL_IOC_MAXNR) return -ENOTTY;可見那個nr引數完全就是我所說的32位的IOCTL命令編碼。靠，既然這樣好歹也對著個confusion作一下簡單的解釋啊！如果LDD3一書那“既不承認，也不否認”的曖昧態度讓我真讓我哭笑不得的話，那麼國內某書（具體哪本我就不說了）簡直令我抓狂，我摘書中的兩段話如下：_IO(type,nr):定義一個沒有資料傳輸的命令編號。type為幻數，nr為命令編號。......_IOC_DIR(nr): 獲得命令編號的命令傳輸方向（direction）。這個巨集的引數就是命令編號。

由於檔案不長，且其中的英文比較簡單這裡直接貼原檔案內容：

If youare adding new ioctl's to the kernel, you should use the _IO

macrosdefined in <linux/ioctl.h>:

_IO an ioctl with no parameters

_IOW an ioctl with write parameters (copy_from_user)

_IOR an ioctl with read parameters (copy_to_user)

_IOWR an ioctl with both write and read parameters.

'Write'and 'read' are from the user's point of view, just like the

systemcalls 'write' and 'read'. For example, aSET_FOO ioctl would

be _IOW,although the kernel would actually read data from user space;

a GET_FOOioctl would be _IOR, although the kernel would actually write

data touser space.

The firstargument to _IO, _IOW, _IOR, or _IOWR is an identifying letter

or numberfrom the table below. Because of thelarge number of drivers,

many driversshare a partial letter with other drivers.

If youare writing a driver for a new device and need a letter, pick an

unusedblock with enough room for expansion: 32 to 256 ioctl commands.

You canregister the block by patching this file and submitting the

patch toLinus Torvalds. Or you can e-mail me at<[email protected]> and

I'llregister one for you.

Thesecond argument to _IO, _IOW, _IOR, or _IOWR is a sequence number

todistinguish ioctls from each other. Thethird argument to _IOW,

_IOR, or_IOWR is the type of the data going into the kernel or coming

out ofthe kernel (e.g. 'int' or 'struct foo').

Somedevices use their major number as the identifier; this is OK, as

long asit is unique. Some devices are irregularand don't follow any

conventionat all.

Followingthis convention is good because:

(1)Keeping the ioctl's globally unique helps error checking:

if a program calls an ioctl on the wrongdevice, it will get an

error rather than some unexpectedbehaviour.

(2) The'strace' build procedure automatically finds ioctl numbers

defined with _IO, _IOW, _IOR, or _IOWR.

(3)'strace' can decode numbers back into useful names when the

numbers are unique.

(4)People looking for ioctls can grep for them more easily when

this convention is used to define the ioctlnumbers.

(5) Whenfollowing the convention, the driver code can use generic

code to copy the parameters between userand kernel space.

Thistable lists ioctls visible from user land for Linux/i386. It contains

mostdrivers up to 2.3.14, but I know I am missing some.

Code Seq# IncludeFile Comments

========================================================

0x00 00-1F linux/fs.h conflict!

0x00 00-1F scsi/scsi_ioctl.h conflict!

0x00 00-1F linux/fb.h conflict!

0x00 00-1F linux/wavefront.h conflict!

0x02 all linux/fd.h

0x03 all linux/hdreg.h

0x04 all linux/umsdos_fs.h

0x06 all linux/lp.h

0x09 all linux/md.h

0x12 all linux/fs.h

linux/blkpg.h

0x20 all drivers/cdrom/cm206.h

0x22 all scsi/sg.h

'1' 00-1F <linux/timepps.h> PPS kit from Ulrich Windl

<ftp://ftp.de.kernel.org/pub/linux/daemons/ntp/PPS/>

'6' 00-10 <asm-i386/processor.h> Intel IA32 microcode update driver

ioctl（）函式學習 【綜合貼】

第二篇：核心空間的ioctl----用於驅動程式

第三篇：標頭檔案ioctl.h----關於ioctl的巨集定義

第五篇：Ioctl-----核心空間與使用者空間的資料交換

相關推薦

ioctl（）函式學習【綜合貼】