2. 程式人生 > >linux 核心 - ioctl 函式詳解

linux 核心 - ioctl 函式詳解

阿新 • • 發佈：2018-11-04

1. 概念

ioctl 是裝置驅動程式中裝置控制介面函式，一個字元裝置驅動通常會實現裝置開啟、關閉、讀、寫等功能，在一些需要細分的情境下，如果需要擴充套件新的功能，通常以增設 ioctl() 命令的方式實現。

在檔案 I/O 中，ioctl 扮演著重要角色，本文將以驅動開發為側重點，從使用者空間到核心空間縱向分析 ioctl 函式。

image

2. 使用者空間 ioctl

#include <sys/ioctl.h> 

int ioctl(int fd, int cmd, ...) ;
引數 描述
fd 檔案描述符
cmd 互動協議，裝置驅動將根據 cmd 執行對應操作
… 可變引數 arg，依賴 cmd 指定長度以及型別

ioctl() 函式執行成功時返回 0，失敗則返回 -1 並設定全域性變數 errorno 值，如下：

EBADF d is not a valid descriptor. 
EFAULT argp references an inaccessible memory area. 
EINVAL Request or argp is
 
 not valid. 
ENOTTY d is not associated with a character special device. 
ENOTTY The specified request does not apply to the kind of object that the descriptor d references.

因此，在使用者空間使用 ioctl 時，可以做如下的出錯判斷以及處理：

int ret;
ret = ioctl(fd, MYCMD);
if (ret == -1) {
    printf("ioctl: %s\n", strerror(errno));
}

在實際應用中，ioctl 最常見的 errorno 值為 ENOTTY（error not a typewriter），顧名思義，即第一個引數 fd 指向的不是一個字元裝置，不支援 ioctl 操作，這時候應該檢查前面的 open 函式是否出錯或者裝置路徑是否正確

3. 驅動程式 ioctl

long (*unlocked_ioctl) (struct file *, unsigned int, unsigned long);
long (*compat_ioctl) (struct file *, unsigned int, unsigned long);

在新版核心中， 與 取代了 。unlocked_ioctl，顧名思義，應該在無大核心鎖（BKL）的情況下呼叫；compat_ioctl，compat 全稱 compatible（相容的），主要目的是為 64 位系統提供 32 位 ioctl 的相容方法，也是在無大核心鎖的情況下呼叫。

在《Linux Kernel Development》中對兩種 ioctl 方法有詳細的解說。

在字元裝置驅動開發中，一般情況下只要實現 unlocked_ioctl 函式即可，因為在 vfs 層的程式碼是直接呼叫 unlocked_ioctl 函式

// fs/ioctl.c

static long vfs_ioctl(struct file *filp, unsigned int cmd,
              unsigned long arg)
{
    int error = -ENOTTY;

    if (!filp->f_op || !filp->f_op->unlocked_ioctl)           
        goto out;

    error = filp->f_op->unlocked_ioctl(filp, cmd, arg);
    if (error == -ENOIOCTLCMD) {
        error = -ENOTTY;
    }   
 out:
    return error;
}

4. ioctl 使用者與驅動之間的協議

前文提到 ioctl 方法第二個引數 cmd 為使用者與驅動的 “協議”，理論上可以為任意 int 型資料，可以為 0、1、2、3……，但是為了確保該 “協議” 的唯一性，ioctl 命令應該使用更科學嚴謹的方法賦值，在linux中，提供了一種 ioctl 命令的統一格式，將 32 位 int 型資料劃分為四個位段，如下圖所示：

image

在核心中，提供了巨集介面以生成上述格式的 ioctl 命令：

// include/uapi/asm-generic/ioctl.h

#define _IOC(dir,type,nr,size) \
    (((dir)  << _IOC_DIRSHIFT) | \
     ((type) << _IOC_TYPESHIFT) | \
     ((nr)   << _IOC_NRSHIFT) | \
     ((size) << _IOC_SIZESHIFT))
  1. dir（direction），ioctl 命令訪問模式（資料傳輸方向），佔據 2 bit，可以為 _IOC_NONE、_IOC_READ、_IOC_WRITE、_IOC_READ | _IOC_WRITE，分別指示了四種訪問模式：無資料、讀資料、寫資料、讀寫資料；
  2. type（device type），裝置型別，佔據 8 bit，在一些文獻中翻譯為 “幻數” 或者 “魔數”，可以為任意 char 型字元，例如
    ‘a’、’b’、’c’ 等等，其主要作用是使 ioctl 命令有唯一的裝置標識；
  3. nr（number），命令編號/序數，佔據 8 bit，可以為任意 unsigned char 型資料，取值範圍 0~255，如果定義了多個 ioctl 命令，通常從 0 開始編號遞增；
  4. size，涉及到 ioctl 函式 第三個引數 arg ，佔據 13bit 或者 14bit（體系相關，arm 架構一般為 14 位），指定了 arg 的資料型別及長度，如果在驅動的 ioctl 實現中不檢查，通常可以忽略該引數；

通常而言，為了方便會使用巨集 _IOC() 衍生的介面來直接定義 ioctl 命令：

// include/uapi/asm-generic/ioctl.h

/* used to create numbers */
#define _IO(type,nr)        _IOC(_IOC_NONE,(type),(nr),0)
#define _IOR(type,nr,size)  _IOC(_IOC_READ,(type),(nr),(_IOC_TYPECHECK(size)))
#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)))
_IO：       定義不帶引數的 ioctl 命令
_IOW：      定義帶寫引數的 ioctl 命令（copy_from_user）
_IOR：      定義帶讀引數的ioctl命令（copy_to_user）
_IOWR：     定義帶讀寫引數的 ioctl 命令

同時，核心還提供了反向解析 ioctl 命令的巨集介面：

// include/uapi/asm-generic/ioctl.h

/* used to decode ioctl numbers */
#define _IOC_DIR(nr)        (((nr) >> _IOC_DIRSHIFT) & _IOC_DIRMASK)
#define _IOC_TYPE(nr)       (((nr) >> _IOC_TYPESHIFT) & _IOC_TYPEMASK)
#define _IOC_NR(nr)     (((nr) >> _IOC_NRSHIFT) & _IOC_NRMASK)
#define _IOC_SIZE(nr)       (((nr) >> _IOC_SIZESHIFT) & _IOC_SIZEMASK)

5. ioctl_test 例項分析

本例假設一個帶暫存器的裝置，設計了一個 ioctl 介面實現裝置初始化、讀寫暫存器等功能。在本例中，為了攜帶更多的資料，ioctl 的第三個可變引數為指標型別，指向自定義的結構體 struct msg。

1、ioctl-test.h，使用者空間和核心空間共用的標頭檔案，包含 ioctl 命令及相關巨集定義，可以理解為一份 “協議” 檔案，程式碼如下：

// ioctl-test.h

#ifndef __IOCTL_TEST_H__
#define __IOCTL_TEST_H__

#include <linux/ioctl.h>    // 核心空間
// #include <sys/ioctl.h>   // 使用者空間

/* 定義裝置型別 */
#define IOC_MAGIC  'c'

/* 初始化裝置 */
#define IOCINIT    _IO(IOC_MAGIC, 0)

/* 讀暫存器 */
#define IOCGREG    _IOW(IOC_MAGIC, 1, int)

/* 寫暫存器 */
#define IOCWREG    _IOR(IOC_MAGIC, 2, int)

#define IOC_MAXNR  3

struct msg {
    int addr;
    unsigned int data;
};

#endif

2、ioctl-test-driver.c，字元裝置驅動，實現了unlocked_ioctl 介面，根據上層使用者的 cmd 執行對應的操作（初始化裝置、讀暫存器、寫暫存器）。在接收上層 cmd 之前應該對其進行充分的檢查，流程及具體程式碼實現如下：

// ioctl-test-driver.c
......

static const struct file_operations fops = {
    .owner = THIS_MODULE,
    .open = test_open,
    .release = test_close,
    .read = test_read,
    .write = etst_write,
    .unlocked_ioctl = test_ioctl,
};

......

static long test_ioctl(struct file *file, unsigned int cmd, \
                        unsigned long arg)
{
    //printk("[%s]\n", __func__);

    int ret;
    struct msg my_msg;

    /* 檢查裝置型別 */
    if (_IOC_TYPE(cmd) != IOC_MAGIC) {
        pr_err("[%s] command type [%c] error!\n", \
            __func__, _IOC_TYPE(cmd));
        return -ENOTTY; 
    }

    /* 檢查序數 */
    if (_IOC_NR(cmd) > IOC_MAXNR) { 
        pr_err("[%s] command numer [%d] exceeded!\n", 
            __func__, _IOC_NR(cmd));
        return -ENOTTY;
    }    

    /* 檢查訪問模式 */
    if (_IOC_DIR(cmd) & _IOC_READ)
        ret= !access_ok(VERIFY_WRITE, (void __user *)arg, \
                _IOC_SIZE(cmd));
    else if (_IOC_DIR(cmd) & _IOC_WRITE)
        ret= !access_ok(VERIFY_READ, (void __user *)arg, \
                _IOC_SIZE(cmd));
    if (ret)
        return -EFAULT;

    switch(cmd) {
    /* 初始化裝置 */
    case IOCINIT:
        init();
        break;

    /* 讀暫存器 */
    case IOCGREG:
        ret = copy_from_user(&msg, \
            (struct msg __user *)arg, sizeof(my_msg));
        if (ret) 
            return -EFAULT;
        msg->data = read_reg(msg->addr);
        ret = copy_to_user((struct msg __user *)arg, \
                &msg, sizeof(my_msg));
        if (ret) 
            return -EFAULT;
        break;

    /* 寫暫存器 */
    case IOCWREG:
        ret = copy_from_user(&msg, \
            (struct msg __user *)arg, sizeof(my_msg));
        if (ret) 
            return -EFAULT;
        write_reg(msg->addr, msg->data);
        break;

    default:
        return -ENOTTY;
    }

    return 0;
}

3、ioctl-test.c，執行在使用者空間的測試程式：

// ioctl-test.c

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <unistd.h>
#include <sys/ioctl.h> 

#include "ioctl-test.h"

int main(int argc, char **argv)
{

    int fd;
    int ret;
    struct msg my_msg;

    fd = open("/dev/ioctl-test", O_RDWR);
    if (fd < 0) {
        perror("open");
        exit(-2);
    }

    /* 初始化裝置 */
    ret = ioctl(fd, IOCINIT);
    if (ret) {
        perror("ioctl init:");
        exit(-3);
    }

    /* 往暫存器0x01寫入資料0xef */
    memset(&my_msg, 0, sizeof(my_msg));
    my_msg.addr = 0x01;
    my_msg.data = 0xef;
    ret = ioctl(fd, IOCWREG, &my_msg);
    if (ret) {
        perror("ioctl read:");
        exit(-4);
    }

    /* 讀暫存器0x01 */
    memset(&my_msg, 0, sizeof(my_msg));
    my_msg.addr = 0x01;
    ret = ioctl(fd, IOCGREG, &my_msg);
    if (ret) {
        perror("ioctl write");
        exit(-5);
    }
    printf("read: %#x\n", my_msg.data);

    return 0;
}

相關推薦

linux 核心 - ioctl 函式詳解

1. 概念 ioctl 是裝置驅動程式中裝置控制介面函式，一個字元裝置驅動通常會實現裝置開啟、關閉、讀、寫等功能，在一些需要細分的情境下，如果需要擴充套件新的功能，通常以增設 ioctl() 命令的方式實現。 在檔案 I/O 中，ioctl 扮演著重要角色，本文將以驅動開發為側重

(筆記)Linux下的ioctl()函式詳解

我這裡說的ioctl函式是指驅動程式裡的，因為我不知道還有沒有別的場合用到了它，所以就規定了我們討論的範圍。寫這篇文章是因為我前一陣子被ioctl給搞混了，這幾天才弄明白它，於是在這裡清理一下頭腦。 一、 什麼是ioctl      ioctl是裝置驅動程

linux下system函式詳解

一、system函式的簡單介紹 標頭檔案 #include <stdlib.h> 函式定義 int system(const char * string); 函式說明 system()會呼叫fork()產生子程序，由子程序來呼叫/bin/sh-

linux中fork() 函式詳解

fork入門知識 一個程序，包括程式碼、資料和分配給程序的資源。fork（）函式通過系統呼叫建立一個與原來程序幾乎完全相同的程序，也就是兩個程序可以做完全相同的事，但如果初始引數或者傳入的變數不同，兩個程序也可以做不同的事。 一個程序呼叫fork（）函式後，系統先給新的程序分配資源，例如儲存資料和程式碼的

Linux下exec函式詳解

exec核心函式呼叫 exec函式說明 exec函式的作用是執行一個檔案，他有很多同類型函式，對execl而言，所需要傳入的引數，第一個是檔案的絕對路徑，後面就是給要執行檔案傳入的引數，下面的程式，絕對路徑path="/mnt/nfs/hell"，傳入的引數有4個

作業系統之--linux核心編譯步驟詳解

ORIGIN 作為自由軟體,linux 核心版本不斷更新,新核心會修訂舊核心的 bug,並增加若干新特性,如支援更多的硬體、具備更好的系統管理能力、執行速度更快、更穩定等。使用者若想要使用這些新特性,或希望根據自身系統需求定製一個更高效、更穩定的核心,就需要重

Linux 核心編譯選項詳解

linux核心編譯選項詳解(一)：General setup [*]Prompt for development and/or incomplete code/drivers 顯示尚在開發中或尚未完成的程式碼與驅動.你應該選擇它，因為有許多裝置可能必需選擇這個選項才能進行配

[轉載]linux 核心定時器詳解

Linux核心2.4版中去掉了老版本核心中的靜態定時器機制，而只留下動態定時器。相應地在timer_bh()函式中也不再通過run_old_timers()函式來執行老式的靜態定時器。動態定時器與靜態定時器這二個概念是相對於Linux核心定時器機制的可擴充套件功能而言的，動態定時器是指核心的定時器佇列

嵌入式Linux核心I2C子系統詳解

1.1 I2C匯流排知識 1.1.1  I2C匯流排物理拓撲結構      I2C匯流排在物理連線上非常簡單，分別由SDA(序列資料線)和SCL(序列時鐘線)及上拉電阻組成。 通訊原理是通過對SCL和SDA線高低電平時序的控制，來產生I2C匯流排協議所需

linux核心 RCU機制詳解

 簡介         RCU（Read-Copy Update）是資料同步的一種方式，在當前的Linux核心中發揮著重要的作用。RCU主要針對的資料物件是連結串列，目的是提高遍歷讀取資料的效率，為了達到目的使用RCU機制讀取資料的時候不對連結串列進行耗時的加鎖操作。這樣在

linux：select()函式詳解

一.Select 函式詳細介紹 Select在Socket程式設計中還是比較重要的，可是對於初學Socket的人來說都不太愛用Select寫程式，他們只是習慣寫諸如connect、 accept、recv或recvfrom這樣的阻塞程式（所謂阻塞方式block

arm linux核心啟動過程詳解

         可以結合《hi3536uboot引導核心全過程》一文一起看 1、uImage生成過程 （1）vmlinux 根目錄下vmlinux為kernel未經過任何處理的原始可執行檔案。根據arch/arm/kernel/vmlinux.lds連線檔案生成：    

Linux核心等待佇列詳解

等待佇列用於管理應等待某個條件成立或者事件發生而防人之心不可無的程序。程序發出的請求暫時無法滿足的時候，需要將程序阻塞直到條件成立。核心將因相同原因而阻塞的程序集中在一個佇列上，該佇列就是等待佇列，對於每個需要等待的事件都有一個相應的等待佇列。等待佇列採用連結串

Linux下select函式詳解

原貼：https://www.cnblogs.com/hjslovewcl/archive/2011/03/16/2314330.html一.Select 函式詳細介紹  Select在Socket程式設計中還是比較重要的，可是對於初學Socket的人來說都不太愛用Selec

Linux下clock_gettime函式詳解

要包含這標頭檔案<time.h> 且在編譯連結時需加上 -lrt ;因為在librt中實現了clock_gettime函式。 --- struct timespec ts; clock_gettime(CLOCK_MONOTONIC,ts); pri

Linux核心分析 - 網路：netif_receive_skb平臺報文入口函式詳解

網路收包流程從網絡卡驅動開始，一直往上，涉及NAPI、GRO、RPS等特性，但是一般最後都會呼叫__netif_receive_skb函式： 函式主要有幾個處理： 1、vlan報文的處理，主要是迴圈把vlan頭剝掉，如果qinq場景，兩個vlan都會被剝掉； 2、交給rx_h

Linux串列埠程式設計詳解 linux串列埠相關設定函式

tcgetattr    函式用於獲取與終端相關的引數。引數fd為終端的檔案描述符，返回的結果儲存在termios 結構體中 http://baike.baidu.com/view/5644808.htm?fr=aladdin tcset

linux中alarm函式和pause函式詳解例項

轉載原文：https://www.cnblogs.com/yxk529188712/p/4982401.html alarm(time);執行之後告訴核心，讓核心在time秒時間之後向該程序傳送一個定時訊號，然後該程序捕獲該訊號並處理； pause()函式使該程序暫停讓出CPU,但是該函式的暫停

Linux下clock gettime函式詳解

分享一下我老師大神的人工智慧教程！零基礎，通俗易懂！http://blog.csdn.net/jiangjunshow 也歡迎大家轉載本篇文章。分享知識，造福人民，實現我們中華民族偉大復興！        

Linux 多工程式設計——多程序建立：fork() 和vfork() 函式詳解

一、fork() 函式詳解 需要的標頭檔案： #include <sys/types.h> #include <unistd.h> pid_t fork(void); 功能： 用於從一個已存在的程序中建立一個新程序，新程序稱為子程序，原程序稱為父程序。