Unix編程之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控制都是通過這一部分的代碼實現的。

下面以幾個示例代碼來說明問題：

程序1：檢測接口的inet_addr, netmask, broad_addr

#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：測試物理連接   
*******************************程序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);     
}