Whamcloud - gitweb
Branch HEAD
[fs/lustre-release.git] / lustre / include / ioctl.h
1
2 #ifndef _IOWR
3
4 /*
5  * on i386 and x86_64, _ASM_I386_IOCTL_H is defined by the kernel's ioctl.h
6  *
7  * We can avoid any problems with the kernel header being included again
8  * by defining _ASM_I386_IOCTL_H here so that a later occurence of
9  * <asm/ioctl.h> does not include the kernel's ioctl.h after this one.
10  */
11 #define _ASM_I386_IOCTL_H
12
13 /* ioctl command encoding: 32 bits total, command in lower 16 bits,
14  * size of the parameter structure in the lower 14 bits of the
15  * upper 16 bits.
16  * Encoding the size of the parameter structure in the ioctl request
17  * The highest 2 bits are reserved for indicating the ``access mode''.
18  * NOTE: This limits the max parameter size to 16kB -1 !
19  */
20
21 /*
22  * The following is for compatibility across the various Linux
23  * platforms.  The i386 ioctl numbering scheme doesn't really enforce
24  * a type field.  De facto, however, the top 8 bits of the lower 16
25  * bits are indeed used as a type field, so we might just as well make
26  * this explicit here.  Please be sure to use the decoding macros
27  * below from now on.
28  */
29 #define _IOC_NRBITS     8
30 #define _IOC_TYPEBITS   8
31 #define _IOC_SIZEBITS   14
32 #define _IOC_DIRBITS    2
33
34 #define _IOC_NRMASK     ((1 << _IOC_NRBITS)-1)
35 #define _IOC_TYPEMASK   ((1 << _IOC_TYPEBITS)-1)
36 #define _IOC_SIZEMASK   ((1 << _IOC_SIZEBITS)-1)
37 #define _IOC_DIRMASK    ((1 << _IOC_DIRBITS)-1)
38
39 #define _IOC_NRSHIFT    0
40 #define _IOC_TYPESHIFT  (_IOC_NRSHIFT+_IOC_NRBITS)
41 #define _IOC_SIZESHIFT  (_IOC_TYPESHIFT+_IOC_TYPEBITS)
42 #define _IOC_DIRSHIFT   (_IOC_SIZESHIFT+_IOC_SIZEBITS)
43
44 /*
45  * Direction bits.
46  */
47 #define _IOC_NONE       0U
48 #define _IOC_WRITE      1U
49 #define _IOC_READ       2U
50
51 #define _IOC(dir,type,nr,size) (((dir)  << _IOC_DIRSHIFT) | ((type) << _IOC_TYPESHIFT) | ((nr)   << _IOC_NRSHIFT) | ((size) << _IOC_SIZESHIFT))
52
53 /* used to create numbers */
54 #define _IO(type,nr)            _IOC(_IOC_NONE,(type),(nr),0)
55 #define _IOR(type,nr,size)      _IOC(_IOC_READ,(type),(nr),sizeof(size))
56 #define _IOW(type,nr,size)      _IOC(_IOC_WRITE,(type),(nr),sizeof(size))
57 #define _IOWR(type,nr,size)     _IOC(_IOC_READ|_IOC_WRITE,(type),(nr),sizeof(size))
58
59 /* used to decode ioctl numbers.. */
60 #define _IOC_DIR(nr)            (((nr) >> _IOC_DIRSHIFT) & _IOC_DIRMASK)
61 #define _IOC_TYPE(nr)           (((nr) >> _IOC_TYPESHIFT) & _IOC_TYPEMASK)
62 #define _IOC_NR(nr)             (((nr) >> _IOC_NRSHIFT) & _IOC_NRMASK)
63 #define _IOC_SIZE(nr)           (((nr) >> _IOC_SIZESHIFT) & _IOC_SIZEMASK)
64
65 /* ...and for the drivers/sound files... */
66
67 #define IOC_IN          (_IOC_WRITE << _IOC_DIRSHIFT)
68 #define IOC_OUT         (_IOC_READ << _IOC_DIRSHIFT)
69 #define IOC_INOUT       ((_IOC_WRITE|_IOC_READ) << _IOC_DIRSHIFT)
70 #define IOCSIZE_MASK    (_IOC_SIZEMASK << _IOC_SIZESHIFT)
71 #define IOCSIZE_SHIFT   (_IOC_SIZESHIFT)
72
73 #endif /* _IOWR */
74