一、_IO, _IOR, _IOW, _IOWR 宏的用法與解析
在驅動程式裡， ioctl() 函數上傳送的變量 cmd 是應用程式用于差別裝置驅動程式請求處理内容的值。cmd除了可差別數字外，還包含有助于處理的幾種相應資訊。 cmd的大小為 32位，共分 4 個域：
bit31~bit30 2位為 “差別讀寫” 區，作用是區分是讀取指令還是寫入指令。
bit29~bit15 14位為 "資料大小" 區，表示 ioctl() 中的 arg 變量傳送的記憶體大小。
bit20~bit08 8位為 “魔數"(也稱為"幻數")區，這個值用以與其它裝置驅動程式的 ioctl 指令進行差別。
bit07~bit00 8位為 "差別序号" 區，是區分指令的指令順序序号。
像指令碼中的 “區分讀寫區” 裡的值可能是 _IOC_NONE （0值）表示無資料傳輸，_IOC_READ (讀)， _IOC_WRITE (寫) ， _IOC_READ|_IOC_WRITE (雙向)。
核心定義了 _IO() , _IOR() , IOW() 和 _IOWR() 這 4 個宏來輔助生成上面的 cmd 。下面分析 _IO() 的實作，其它的類似。
在 asm-generic/ioctl.h 裡可以看到 _IO() 的定義：
#define _IO(type,nr) _IOC(_IOC_NONE,(type),(nr),0)
再看 _IOC() 的定義：
#define _IOC(dir,type,nr,size) \
(((dir) << _IOC_DIRSHIFT) | \
((type) << _IOC_TYPESHIFT) | \
((nr) << _IOC_NRSHIFT) | \
((size) << _IOC_SIZESHIFT))
可見，_IO() 的最後結果由 _IOC() 中的 4 個參數移位組合而成。
再看 _IOC_DIRSHIT 的定義：
#define _IOC_DIRSHIFT (_IOC_SIZESHIFT+_IOC_SIZEBITS)_IOC_SIZESHIFT 的定義：
#define _IOC_SIZESHIFT (_IOC_TYPESHIFT+_IOC_TYPEBITS)_IOC_TYPESHIF 的定義：
#define _IOC_TYPESHIFT (_IOC_NRSHIFT+_IOC_NRBITS)_IOC_NRSHIFT 的定義：
#define _IOC_NRSHIFT 0_IOC_NRBITS 的定義：
#define _IOC_NRBITS 8_IOC_TYPEBITS 的定義：
#define _IOC_TYPEBITS 8由上面的定義，往上推得到：
_IOC_TYPESHIFT = 8
_IOC_SIZESHIFT = 16
_IOC_DIRSHIFT = 30
是以，(dir) << _IOC_DIRSHIFT) 表是 dir 往左移 30 位，即移到 bit31~bit30 兩位上，得到方向(讀寫)的屬性；
(size) << _IOC_SIZESHIFT) 位左移 16 位得到“資料大小”區；
(type) << _IOC_TYPESHIFT) 左移 8位得到"魔數區" ；
(nr) << _IOC_NRSHIFT) 左移 0 位( bit7~bit0) 。
這樣，就得到了 _IO() 的宏值。
這幾個宏的使用格式為：
_IO (魔數， 基數);
_IOR (魔數， 基數， 變量型)
_IOW (魔數， 基數， 變量型)
_IOWR (魔數， 基數，變量型 )
魔數 (magic number)
魔數範圍為 0~255 。通常，用英文字元 "A" ~ "Z" 或者 "a" ~ "z" 來表示。裝置驅動程式從傳遞進來的指令擷取魔數，然後與自身處理的魔數想比較，如果相同則處理，不同則不處理。魔數是拒絕誤使用的初步輔助狀态。裝置驅動程式可以通過 _IOC_TYPE (cmd) 來擷取魔數。不同的裝置驅動程式最好設定不同的魔數，但并不是要求絕對，也是可以使用其他裝置驅動程式已用過的魔數。
基(序列号)數
基數用于差別各種指令。通常，從 0開始遞增，相同裝置驅動程式上可以重複使用該值。例如，讀取和寫入指令中使用了相同的基數，裝置驅動程式也能分辨出來，原因在于裝置驅動程式區分指令時使用 switch ，且直接使用指令變量 cmd值。建立指令的宏生成的值由多個域組合而成，是以即使是相同的基數，也會判斷為不同的指令。裝置驅動程式想要從指令中擷取該基數，就使用下面的宏：
_IOC_NR (cmd)
通常，switch 中的 case 值使用的是指令的本身。
變量型
變量型使用 arg 變量指定傳送的資料大小，但是不直接代入輸入，而是代入變量或者是變量的類型，原因是在使用宏建立指令，已經包含了 sizeof() 編譯指令。比如 _IOR() 宏的定義是：
#define _IOR(type,nr,size) _IOC(_IOC_READ,(type),(nr),(_IOC_TYPECHECK(size)))
而 _IOC_TYPECHECK() 的定義正是：
#define _IOC_TYPECHECK(t) (sizeof(t))
裝置驅動程式想要從傳送的指令擷取相應的值，就要使用下列宏函數：
_IOC_SIZE(cmd)
_IO 宏
該宏函數沒有可傳送的變量，隻是用于傳送指令。例如如下約定：
#define TEST_DRV_RESET _IO ('Q', 0)
此時，省略由應用程式傳送的 arg 變量或者代入 0 。在應用程式中使用該宏時，比如：
ioctl (dev, TEST_DEV_RESET, 0) 或者 ioctl (dev, TEST_DRV_RESET) 。
這是因為變量的有效因素是可變因素。隻作為指令使用時，沒有必要判斷出裝置上資料的輸出或輸入。是以，裝置驅動程式沒有必要執行裝置檔案大開選項的相關處理。
_IOR 宏
該函數用于建立從裝置讀取資料的指令，例如可如下約定：
#define TEST_DEV_READ _IRQ('Q', 1, int)
這說明應用程式從裝置讀取資料的大小為 int 。下面宏用于判斷傳送到裝置驅動程式的 cmd 指令的讀寫狀态：
_IOC_DIR (cmd)
運作該宏時，傳回值的類型如下：
_IOC_NONE : 無屬性
_IOC_READ : 可讀屬性
_IOC_WRITE : 可寫屬性
_IOC_READ | _IOC_WRITE : 可讀，可寫屬性
使用該指令時，應用程式的 ioctl() 的 arg 變量值指定裝置驅動程式上讀取資料時的緩存(結構體)位址。
_IOW 宏
用于建立裝置上寫入資料的指令，其餘内容與 _IOR 相同。通常，使用該指令時，ioctl() 的 arg 變量值指定裝置驅動程式上寫入資料時的緩存(結構體)位址。
_IOWR 宏
用于建立裝置上讀寫資料的指令。其餘内容與 _IOR 相同。通常，使用該指令時，ioctl() 的 arg 變量值指定裝置驅動程式上寫入或讀取資料時的緩存 (結構體) 位址。
_IOR() , _IOW(), IORW() 的定義：
#define _IOW(type,nr,size) _IOC(_IOC_WRITE,(type),(nr),(_IOC_TYPECHECK(size)))
#define _IOWR(type,nr,size) _IOC(_IOC_READ|_IOC_WRITE,(type),(nr),(_IOC_TYPECHECK(size)))
二、下面來實際動手寫個測試例子
1.server.c
#include <linux/module.h>
#include <linux/highmem.h>
#include <asm/uaccess.h> //copy_to_user copy_from_user
#define MODULE_NAME "hepeng"
#define HEPENG_TEST 0x0 //request code
#define HEPENG_TEST_OK 0 //reply code
#define HEPENG_TEST_UNKNOWN_OPTION -1 //reply code
#define HEPENG_TEST_UNKNOWN_DEV -2 //reply code
#define TEST_IOC_MAGIC 'k' //device type
struct COMMAND_STRU_T
{
short op;
short error;
};//Params transfers between server and client
int hepeng_cmd(struct COMMAND_STRU_T *cmd)
switch (cmd->op)
{
case HEPENG_TEST:
printk("hepeng_cmd: this is a test\n");
cmd->error = HEPENG_TEST_OK;
break;
default:
printk("hepeng_cmd: error option\n");
cmd->error = HEPENG_TEST_UNKNOWN_OPTION;
return -1;
}
return 0;
}
int hepeng_ioctl(struct inode *inode, struct file *file, unsigned int opt, unsigned long arg)
int ret_val;
struct COMMAND_STRU_T *cmd = (struct COMMAND_STRU_T*)
kmalloc(sizeof(struct COMMAND_STRU_T), GFP_KERNEL);
if (!cmd)
printk("hepeng_ioctl: failed to allocate spcmd\n");
goto ioctl_error1;
if (copy_from_user (cmd, (long *)arg, sizeof(struct COMMAND_STRU_T)))
{
printk("hepeng_ioctl: failed to copy from user\n");
goto ioctl_error2;
}
if(_IOC_TYPE(opt) != TEST_IOC_MAGIC)
cmd->error = HEPENG_TEST_UNKNOWN_DEV;
printk("hepeng_ioctl:unknown device type\n");
if(copy_to_user ((long *)arg, cmd, sizeof(struct COMMAND_STRU_T)))
printk("hepeng_ioctl: failed to copy to user\n");
ret_val = hepeng_cmd(cmd);
if (copy_to_user ((long *)arg, cmd, sizeof(struct COMMAND_STRU_T)))
printk("hepeng_ioctl: failed to copy to user\n");
kfree(cmd);
return 0;
ioctl_error2:
ioctl_error1:
return -1;
int sp_major; //global variable
int test_init(void)
struct file_operations module_params =
owner:THIS_MODULE,
ioctl:hepeng_ioctl,
};//disorder assignment
sp_major = register_chrdev(0, MODULE_NAME, &module_params);//register a character device
if (sp_major < 0)
printk(MODULE_NAME "failed to initialize\n");
return -1;
printk(MODULE_NAME ":initialize ok\n");
void test_clean(void)
printk(MODULE_NAME ":quit module\n");
unregister_chrdev(sp_major, MODULE_NAME);//unregister a character device
module_init(test_init);//load module
module_exit(test_clean);//quit module
MODULE_DESCRIPTION("Only A Test");
MODULE_AUTHOR("He Peng");
MODULE_LICENSE("GPL v2");
該子產品由test_init函數開始，設定了file_operations的成員owner,ioctl，而ioctl指向hepeng_ioctl函數，即注冊ioctl函數，如果該子產品加載成功，收到用戶端的ioctl函數，那麼就會由hepeng_ioctl來處理。test_init調用了register_chrdev函數來注冊字元型裝置，注冊字元裝置是為了能和/dev/XXX的裝置聯系的前提。子產品退出會調用test_clean函數。TEST_IOC_MAGIC即魔數，用戶端需要用該魔數來ioctl
2.Makefile
MODULE_NAME:=hepeng
$(MODULE_NAME)-objs := server.o
obj-m:=$(MODULE_NAME).o
KDIR := /usr/src/kernels/2.6.18-164.el5-x86_64 #usual path: /lib/modules/(kernel name)/build
PWD := $(shell pwd)
default:
$(MAKE) -C $(KDIR) M=$(PWD) modules
clean:
rm -rf *.o *~ core .depend .*.cmd *.ko *.mod.c .tmp_versions Module.symvers
distclean:
rm -rf *.o *~ core .depend .*.cmd *.mod.c .tmp_versions Module.symvers
3.make 編譯
編譯後，目前目錄下生成一些檔案，如hepeng.ko等，用/sbin/modinfo hepeng.ko檢視結果如下：
filename: hepeng.ko
license: GPL v2
author: He peng
description: Only A Test
srcversion: A66C3C701909D1C32559F94
depends:
vermagic: 2.6.18-164.el5 SMP mod_unload gcc-4.1
4.手工加載子產品
insmod hepeng.ko
tail -f /var/log/messages 可以看見如下資訊：
Jun 14 23:52:41 localhost kernel: hepeng:initialize ok
如果不是，則檢查linux系統運作的kernel版本與server.c編譯用的kernel版本是否一緻
5.生成字元裝置檔案
隻有生成字元裝置檔案才能給用戶端調用
cat /proc/devices | grep hepeng，可以看到如下資訊：
253 hepeng
生成字元設定檔案：mknod /dev/hepeng c 253 0
成功後生成/dev/hepeng檔案，即字元裝置，可以被用戶端open來打開。這個檔案可以用于應用程式與kernel程式互動
6.client.c
#include <iostream>
#include <unistd.h>
#include <cstdio>
#include <sys/ioctl.h>
#include <linux/types.h>
#include <fcntl.h>
using namespace std;
#define HEPENG_TEST 0
#define TEST_IOC_MAGIC 'k' //device command type
#define IOCTL_HEPENGCMD _IOWR ( TEST_IOC_MAGIC, 2, struct COMMAND_STRU_T)
};
int main()
int fd = open("/dev/hepeng", O_RDWR);
if(fd < 0)
cout << "error open" << endl;
return -1;
COMMAND_STRU_T cmd;
cmd.op = HEPENG_TEST;
if( ioctl(fd, IOCTL_HEPENGCMD, (void*)&cmd) < 0 )
cout << "error ioctl" << endl;
cout << "cmd.error:" << cmd.error << endl;
cout << "cmd.error:" << cmd.error << endl;
close(fd);
g++ client.c -o client
7.使用client測試驅動是否正常
sudo ./client
輸入：cmd.error:0
檢視/var/log/messages
hepeng_cmd: this is a test
![C經典書籍筆記——C陷阱與缺陷②(文法陷阱之優先級)一、錯誤案列 二、優先級規律[圖]](data:image/gif;base64,R0lGODlhAQABAIAAAP///wAAACwAAAAAAQABAAACAkQBADs=)