ioctl()函式詳解

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

一、 什麼是ioctl 
    ioctl是裝置驅動程式中對裝置的I/O通道進行管理的函式。所謂對I/O通道進行管理，就是對裝置的一些特性進行控制，例如串列埠的傳輸波特率、馬達的轉速等等。它的呼叫個數如下： 
int ioctl(int fd, ind cmd, …)； 
    其中fd是使用者程式開啟裝置時使用open函式返回的檔案標示符，cmd是使用者程式對裝置的控制命令，至於後面的省略號，那是一些補充引數，一般最多一個，這個引數的有無和cmd的意義相關。 
    ioctl函式是檔案結構中的一個屬性分量，就是說如果你的驅動程式提供了對ioctl的支援，使用者就可以在使用者程式中使用ioctl函式來控制裝置的I/O通道。

二、 ioctl的必要性 
    如果不用ioctl的話，也可以實現對裝置I/O通道的控制，但那是蠻擰了。例如，我們可以在驅動程式中實現write的時候檢查一下是否有特殊約定的資料流通過，如果有的話，那麼後面就跟著控制命令（一般在socket程式設計中常常這樣做）。但是如果這樣做的話，會導致程式碼分工不明，程式結構混亂，程式設計師自己也會頭昏眼花的。所以，我們就使用ioctl來實現控制的功能。要記住，使用者程式所作的只是通過命令碼(cmd)告訴驅動程式它想做什麼，至於怎麼解釋這些命令和怎麼實現這些命令，這都是驅動程式要做的事情。

三、 ioctl如何實現 
    這是一個很麻煩的問題，我是能省則省。要說清楚它，沒有四五千字是不行的，所以我這裡是不可能把它說得非常清楚了，不過如果讀者對使用者程式是怎麼和驅動程式聯絡起來感興趣的話，可以看我前一陣子寫的《write的奧祕》。讀者只要把write換成ioctl，就知道使用者程式的ioctl是怎麼和驅動程式中的ioctl實現聯絡在一起的了。我這裡說一個大概思路，因為我覺得《Linux裝置驅動程式》這本書已經說的非常清楚了，但是得花一些時間來看。 
    在驅動程式中實現的ioctl函式體內，實際上是有一個switch{case}結構，每一個case對應一個命令碼，做出一些相應的操作。怎麼實現這些操作，這是每一個程式設計師自己的事情。因為裝置都是特定的，這裡也沒法說。關鍵在於怎樣組織命令碼，因為在ioctl中命令碼是唯一聯絡使用者程式命令和驅動程式支援的途徑。命令碼的組織是有一些講究的，因為我們一定要做到命令和裝置是一一對應的，這樣才不會將正確的命令發給錯誤的裝置，或者是把錯誤的命令發給正確的裝置，或者是把錯誤的命令發給錯誤的裝置。這些錯誤都會導致不可預料的事情發生，而當程式設計師發現了這些奇怪的事情的時候，再來除錯程式查詢錯誤，那將是非常困難的事情。所以在Linux核心中是這樣定義一個命令碼的： 
____________________________________
| 裝置型別 | 序列號 | 方向 |資料尺寸|
|----------|--------|------|--------|
| 8 bit | 8 bit |2 bit |8~14 bit|
|----------|--------|------|--------|

    這樣一來，一個命令就變成了一個整數形式的命令碼；但是命令碼非常的不直觀，所以Linux Kernel中提供了一些巨集。這些巨集可根據便於理解的字串生成命令碼，或者是從命令碼得到一些使用者可以理解的字串以標明這個命令對應的裝置型別、裝置序列號、資料傳送方向和資料傳輸尺寸。

    這些巨集我就不在這裡解釋了，具體的形式請讀者察看Linux核心原始碼中的巨集，檔案裡給這些巨集做了完整的定義。這裡我只多說一個地方，那就是"幻數"。 "幻數"是一個字母，資料長度也是8，用一個特定的字母來標明裝置型別，這和用一個數字是一樣的，只是更加利於記憶和理解。就是這樣，再沒有更復雜的了。 更多的說了也沒用，讀者還是看一看原始碼吧，推薦各位閱讀《Linux 裝置驅動程式》所帶原始碼中的short一例，因為它比較短小，功能比較簡單，可以看明白ioctl的功能和細節。

四、 cmd引數如何得出 
    這裡確實要說一說，cmd引數在使用者程式端由一些巨集根據裝置型別、序列號、傳送方向、資料尺寸等生成，這個整數通過系統呼叫傳遞到核心中的驅動程式，再由驅動程式使用解碼巨集從這個整數中得到裝置的型別、序列號、傳送方向、資料尺寸等資訊，然後通過switch{case}結構進行相應的操作。要透徹理解，只能是通過閱讀原始碼，我這篇文章實際上只是一個引子。cmd引數的組織還是比較複雜的，我認為要搞熟它還是得花不少時間的，但是這是值得的，因為驅動程式中最難的是對中斷的理解。

五、 小結 
    ioctl其實沒有什麼很難的東西需要理解，關鍵是理解cmd命令碼是怎麼在使用者程式裡生成並在驅動程式裡解析的，程式設計師最主要的工作量在switch{case}結構中，因為對裝置的I/O控制都是通過這一部分的程式碼實現的。

******************************************************************************************************************************************

    一般的說，使用者空間的IOCTL系統呼叫如下所示：ioctl(int fd, int command, (char *) argstruct);  因為這個呼叫擁有與網路相關的程式碼，所以檔案描述符號fd就是socket()系統呼叫所返回的，而command引數可以是/usr/include/linux/sockios.h 標頭檔案中的任何一個。這些命令根據它可以解決的問題所涉及的方面而被分為多種型別。比如：

  改變路由表（SIOCADDRT, SIOCDELRT）　　

  讀取或更新ARP/RARP快取（SIOCDARP, SIOCSRARP）

  一般的和網路有關的函式（SIOCGIFNAME, SIOCSIFADDR等等）

    Goodies目錄中包含了很多展示ioctl用法的示例程式，看這些程式的時候，注意根據ioctl的命令型別來使用具體的呼叫引數結構，比如：和路由表相關的IOCTL用RTENTRY結構，rtentry結構是被定義在/usr/include/linux/route.h檔案中的，和ARP相關的ioctl呼叫到的arpreq結構被定義在/usr/include/linux/if_arp.h檔案之中。網路介面相關的ioctl命令最具有代表性的特徵的是都以S或G開頭，其實就是設定或得到資料，getifinfo.c程式用這些命令去讀取IP地址資訊，硬體地址資訊，廣播地址資訊和與網路介面相關的標誌。對於這些ioctl，第三個引數是一個IFREQ結構體，這個結構體被定義在/usr/include/linux/if.h標頭檔案中。在一些情況下，新的ioctl命令可能會被使用 (除了在那個標頭檔案中被定義的除外），比如 WAVELAN無線網路卡保持著無線訊號強度的資訊，這些資訊可能會對使用者程式有用。使用者程式是怎麼訪問到這些資訊的呢？我們的第一反應就是在sockios.h標頭檔案中定義一個新的命令，比如SIOCGIFWVLNSS，但不幸的是，這個命令在其他的網路介面上是沒有任何意義的。另外試圖在其他介面上用這個命令而並非是在無線網口上用會出現違規訪問，我們需要的是定義新特性介面命令的機理。幸運的是，LINUX作業系統為此目的而內建了鉤子，如果你再看一下sockios.h這個標頭檔案，你會注意到每一個裝置都有一個預定義的SIOCDEVPRIVATE命令，實現它的任務就全權交給了寫這個裝置驅動的程式設計師了。根據常規約定，一個使用者程式呼叫一個特定的ioctl命令如下：ioctl(sockid, SIOCDEVPRIVATE, (char *) &ifr); 這裡ifr是一個ifreq結構體變數，它用一個和這個裝置聯絡的介面名稱來填充ifr的ifr NAME域，比如前述的無線網路卡介面名稱為eth1。

    不失一般性，一個使用者程式將同樣要與核心交換命令引數和操作結果，而這些已經通過了對域ifr.ifr_data的填充而做到了。比如這個網路卡的訊號強度資訊被返回到這個域當中。LINUX原始碼已經包含了兩個特殊裝置：de4x5和ewrk3，他們定義和實現了特殊的ioctl命令。這些裝置的原始碼在以下的檔案中：de4x5.h, de4x5.c, ewrk3.h, ewrk3.c。兩個裝置都為在使用者空間和驅動間交換資料定義了他們自己的私有結構，在ioctl之前，使用者程式需填充需要的資料並且將ifr.ifr_data指向這個結構體。

    在進入程式碼前，讓我們跟蹤一下處理ioctl系統呼叫的若干步驟。所有介面型別的ioctl請求都導致dev_ioctl()被呼叫，這個ioctl僅僅是個包裝，大部分的真實的操作留給了dev_ifsioc()，這個dev_ioctl()要做的唯一一件事情就是檢查呼叫過程是否擁有合適的許可去核發這個命令，然後dev_ifsioc()首先要做的事情之一就是得到和名字域ifr.ifr_name中所對應的裝置結構，這在一個很大的switch語塊的程式碼後實現。

    SIOCDEVPRIVATE命令和SIOCDEVPRIVATE+15的命令引數全部交給了預設操作，這些都是switch的分支語句。這裡發生的是，核心檢查是否一個裝置特殊的ioctl的回撥已經在裝置結構中被設定，這個回撥是保持在裝置結構中的一個函式指標。如果回撥已經被設定了，核心就會呼叫它。

    所以，為了實現一個特殊的ioctl，需要做的就是寫一個特殊ioctl的回撥，然後讓device結構中的do_ioctl域指向它。對於EWK3裝置，這個函式叫做ewrk3_ioctl()，對應的裝置結構在ewrk3_init()中被初始化，ewrk3_ioctl()的程式碼清晰的展示了ifr.ifr_data的作用，是為了在使用者程式和驅動之間交換資訊。注意，記憶體的這個區域有雙方向交換資料的作用，例如，在ewrk3驅動程式碼中ifr.ifr_data最初的2個位元組被用做向驅動傳遞預想要的動作。同樣第五個位元組指向的緩衝區用於交換其他的資訊。

    當你瀏覽ewrk3_ioctl()程式碼的時候，記住在一個應用中使用者空間的指令是無法訪問核心空間的，由於這個原因，核心給驅動編寫人員提供了2個特殊的步驟。他們是memcpy_tofs()和memcpy_fromfs()。核心裡的做法是用memcpy_tofs() 拷貝核心資料到使用者空間，類似的memcpy_fromfs()也是這樣的，只是他拷貝使用者資料到核心空間。這些程式步驟是由於呼叫verify_area()而被執行的，目的是確認資料訪問不會違法。同樣需要記住printk()的用法是列印除錯資訊，這個函式和printf()很相像，但是它不能處理浮點資料。printf()函式在核心中是不能被使用的。由printk()產生的輸出被轉儲到了一個目錄./usr/adm/messages。

******************************************************************************************************************************************

linux系統ioctl使用示例
These were writed and collected by kf701,
you can use and modify them but NO WARRANTY.
Contact with me : 
程式1：檢測介面的inet_addr, netmask, broad_addr
程式2：檢查介面的物理連線是否正常
程式3：測試物理連線
程式4：調節音量

***************************程式1****************************************
#include <stdio.h>
#include <string.h>
#include <stdlib.h>
#include <errno.h>
#include <unistd.h>
#include <sys/types.h>
#include <sys/socket.h>
#include <netinet/in.h>
#include <arpa/inet.h>
#include <sys/ioctl.h>
#include <net/if.h>

static void usage()
{
   printf("usage : ipconfig interface \n");
   exit(0);
}

int main(int argc,char **argv)
{
   struct sockaddr_in *addr;
   struct ifreq ifr;
   char *name,*address;
   int sockfd;

   if(argc != 2)  usage();
    else  name = argv[1];

   sockfd = socket(AF_INET,SOCK_DGRAM,0);
   strncpy(ifr.ifr_name,name,IFNAMSIZ-1);

   if(ioctl(sockfd,SIOCGIFADDR,&ifr) == -1)
      perror("ioctl error"),exit(1);

   addr = (struct sockaddr_in *)&(ifr.ifr_addr);
   address = inet_ntoa(addr->sin_addr);
   printf("inet addr: %s ",address);

   if(ioctl(sockfd,SIOCGIFBRDADDR,&ifr) == -1)
      perror("ioctl error"),exit(1);

   addr = (struct sockaddr_in *)&ifr.ifr_broadaddr;
   address = inet_ntoa(addr->sin_addr);
   printf("broad addr: %s ",address);

   if(ioctl(sockfd,SIOCGIFNETMASK,&ifr) == -1)
      perror("ioctl error"),exit(1);
   addr = (struct sockaddr_in *)&ifr.ifr_addr;
   address = inet_ntoa(addr->sin_addr);
   printf("inet mask: %s ",address);

   printf("\n");
   exit(0);
}

******************************** 程式2*****************************************************
#include <stdio.h>
#include <string.h>
#include <errno.h>
#include <fcntl.h>
#include <getopt.h>
#include <sys/socket.h>
#include <sys/ioctl.h>
#include <net/if.h>
#include <stdlib.h>
#include <unistd.h>
typedef unsigned short u16;
typedef unsigned int u32;
typedef unsigned char u8;
#include <linux/ethtool.h>
#include <linux/sockios.h>

int detect_mii(int skfd, char *ifname)
{
   struct ifreq ifr;
   u16 *data, mii_val;
   unsigned phy_id;

   /* Get the vitals from the interface. */
   strncpy(ifr.ifr_name, ifname, IFNAMSIZ);

   if (ioctl(skfd, SIOCGMIIPHY, &ifr) < 0)
      {
         fprintf(stderr, "SIOCGMIIPHY on %s failed: %s\n", ifname, strerror(errno));
         (void) close(skfd);
         return 2;
      }

   data = (u16 *)(&ifr.ifr_data);
   phy_id = data[0];
   data[1] = 1;

   if (ioctl(skfd, SIOCGMIIREG, &ifr) < 0)
     {
        fprintf(stderr, "SIOCGMIIREG on %s failed: %s\n", ifr.ifr_name, strerror(errno));
        return 2;
     }

   mii_val = data[3];
   return(((mii_val & 0x0016) == 0x0004) ? 0 : 1);
}

int detect_ethtool(int skfd, char *ifname)
{
   struct ifreq ifr;
   struct ethtool_value edata;
   memset(&ifr, 0, sizeof(ifr));
   edata.cmd = ETHTOOL_GLINK;

   strncpy(ifr.ifr_name, ifname, sizeof(ifr.ifr_name)-1);
   ifr.ifr_data = (char *) &edata;

   if (ioctl(skfd, SIOCETHTOOL, &ifr) == -1)
     {
        printf("ETHTOOL_GLINK failed: %s\n", strerror(errno));
        return 2;
     }

   return (edata.data ? 0 : 1);
}

int main(int argc, char **argv)
{
   int skfd = -1;
   char *ifname;
   int retval;

   if( argv[1] )  ifname = argv[1];
     else  ifname = "eth0";

   /* Open a socket. */
   if (( skfd = socket( AF_INET, SOCK_DGRAM, 0 ) ) < 0 )
      {
         printf("socket error\n");
         exit(-1);
      }

   retval = detect_ethtool(skfd, ifname);
   if (retval == 2)
     retval = detect_mii(skfd, ifname);

   close(skfd);
 
   if (retval == 2)
     printf("Could not determine status\n");
   if (retval == 1)
     printf("Link down\n");
   if (retval == 0)
     printf("Link up\n");

   return retval;
}

*******************************程式3*****************************************************
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <errno.h>
#include <net/if.h>
#include <linux/sockios.h>
#include <sys/ioctl.h>

#define LINKTEST_GLINK 0x0000000a

struct linktest_value {
        unsigned int    cmd;
        unsigned int    data;
};

static void usage(const char * pname)
{
   fprintf(stderr, "usage: %s <device>\n", pname);
   fprintf(stderr, "returns: \n");
   fprintf(stderr, "\t 0: link detected\n");
   fprintf(stderr, "\t%d: %s\n", ENODEV, strerror(ENODEV));
   fprintf(stderr, "\t%d: %s\n", ENONET, strerror(ENONET));
   fprintf(stderr, "\t%d: %s\n", EOPNOTSUPP, strerror(EOPNOTSUPP));
   exit(EXIT_FAILURE);
}

static int linktest(const char * devname)
{
   struct ifreq ifr;
   struct linktest_value edata;
   int fd;

   /* setup our control structures. */
   memset(&ifr, 0, sizeof(ifr));
   strcpy(ifr.ifr_name, devname);

   /* open control socket. */
   fd=socket(AF_INET, SOCK_DGRAM, 0);
   if(fd < 0 ) 
     return -ECOMM;

   errno=0;
   edata.cmd = LINKTEST_GLINK;
   ifr.ifr_data = (caddr_t)&edata;

   if(!ioctl(fd, SIOCETHTOOL, &ifr)) 
      {
        if(edata.data) 
          {
            fprintf(stdout, "link detected on %s\n", devname);
            return 0;
          } else 
             {
               errno=ENONET;
              }
     }

   perror("linktest");
   return errno;
}

int main(int argc, char *argv[])
{
   if(argc != 2) 
      {
         usage(argv[0]);
      }
   return linktest(argv[1]);
}

*************************************程式4*********************************************************
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <sys/ioctl.h>
#include <sys/soundcard.h>
#include <stdio.h>
#include <unistd.h>
#include <math.h>
#include <string.h>
#include <stdlib.h>
#define  BASE_VALUE 257

int main(int argc,char *argv[])
{
   int mixer_fd=0;
   char *names[SOUND_MIXER_NRDEVICES]=SOUND_DEVICE_LABELS;
   int value,i;

   printf("\nusage:%s dev_no.[0..24] value[0..100]\n\n",argv[0]);
   printf("eg. %s 0 100\n",argv[0]);
   printf("will change the volume to MAX volume.\n\n");
   printf("The dev_no. are as below:\n");

   for (i=0;i<SOUND_MIXER_NRDEVICES;i++)
     {
        if (i%3==0) printf("\n");
        printf("%s:%d\t\t",names[i],i);
     }

   printf("\n\n");

   if (argc<3)  exit(1);

   if ((mixer_fd = open("/dev/mixer",O_RDWR)))
     {
         printf("Mixer opened successfully,working...\n");
         value=BASE_VALUE*atoi(argv[2]);

         if (ioctl(mixer_fd,MIXER_WRITE(atoi(argv[1])),&value)==0)
            printf("successfully.....");
         else
            printf("unsuccessfully.....");
       
         printf("done.\n");
     }
   else
      printf("can't open /dev/mixer error....\n");

exit(0);

}