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