lustre/include/ioctl.h

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  * GPL HEADER START
   5  *
   6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 only,
  10  * as published by the Free Software Foundation.
  11  *
  12  * This program is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License version 2 for more details (a copy is included
  16  * in the LICENSE file that accompanied this code).
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * version 2 along with this program; If not, see
  20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  21  *
  22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  23  * CA 95054 USA or visit www.sun.com if you need additional information or
  24  * have any questions.
  25  *
  26  * GPL HEADER END
  27  */
  28 /*
  29  * Copyright  2008 Sun Microsystems, Inc. All rights reserved
  30  * Use is subject to license terms.
  31  */
  32 /*
  33  * This file is part of Lustre, http://www.lustre.org/
  34  * Lustre is a trademark of Sun Microsystems, Inc.
  35  */
  36
  37 #ifndef _IOWR
  38
  39 /* On i386 and x86_64, _ASM_I386_IOCTL_H is defined by the kernel's ioctl.h,
  40  * and on newer kernels this header is shared as _ASM_GENERIC_IOCTL_H.
  41  *
  42  * We can avoid any problems with the kernel header being included again by
  43  * defining _ASM_I386_IOCTL_H here so that a later occurence of <asm/ioctl.h>
  44  * does not include the kernel's ioctl.h after this one. b=14746 */
  45 #define _ASM_I386_IOCTL_H
  46 #define _ASM_GENERIC_IOCTL_H
  47
  48 /* ioctl command encoding: 32 bits total, command in lower 16 bits,
  49  * size of the parameter structure in the lower 14 bits of the
  50  * upper 16 bits.
  51  * Encoding the size of the parameter structure in the ioctl request
  52  * The highest 2 bits are reserved for indicating the ``access mode''.
  53  * NOTE: This limits the max parameter size to 16kB -1 !
  54  */
  55
  56 /*
  57  * The following is for compatibility across the various Linux
  58  * platforms.  The i386 ioctl numbering scheme doesn't really enforce
  59  * a type field.  De facto, however, the top 8 bits of the lower 16
  60  * bits are indeed used as a type field, so we might just as well make
  61  * this explicit here.  Please be sure to use the decoding macros
  62  * below from now on.
  63  */
  64 #define _IOC_NRBITS     8
  65 #define _IOC_TYPEBITS   8
  66 #define _IOC_SIZEBITS   14
  67 #define _IOC_DIRBITS    2
  68
  69 #define _IOC_NRMASK     ((1 << _IOC_NRBITS)-1)
  70 #define _IOC_TYPEMASK   ((1 << _IOC_TYPEBITS)-1)
  71 #define _IOC_SIZEMASK   ((1 << _IOC_SIZEBITS)-1)
  72 #define _IOC_DIRMASK    ((1 << _IOC_DIRBITS)-1)
  73
  74 #define _IOC_NRSHIFT    0
  75 #define _IOC_TYPESHIFT  (_IOC_NRSHIFT+_IOC_NRBITS)
  76 #define _IOC_SIZESHIFT  (_IOC_TYPESHIFT+_IOC_TYPEBITS)
  77 #define _IOC_DIRSHIFT   (_IOC_SIZESHIFT+_IOC_SIZEBITS)
  78
  79 /*
  80  * Direction bits.
  81  */
  82 #define _IOC_NONE       0U
  83 #define _IOC_WRITE      1U
  84 #define _IOC_READ       2U
  85
  86 #define _IOC(dir,type,nr,size) (((dir)  << _IOC_DIRSHIFT) | ((type) << _IOC_TYPESHIFT) | ((nr)   << _IOC_NRSHIFT) | ((size) << _IOC_SIZESHIFT))
  87
  88 /* used to create numbers */
  89 #define _IO(type,nr)            _IOC(_IOC_NONE,(type),(nr),0)
  90 #define _IOR(type,nr,size)      _IOC(_IOC_READ,(type),(nr),sizeof(size))
  91 #define _IOW(type,nr,size)      _IOC(_IOC_WRITE,(type),(nr),sizeof(size))
  92 #define _IOWR(type,nr,size)     _IOC(_IOC_READ|_IOC_WRITE,(type),(nr),sizeof(size))
  93
  94 /* used to decode ioctl numbers.. */
  95 #define _IOC_DIR(nr)            (((nr) >> _IOC_DIRSHIFT) & _IOC_DIRMASK)
  96 #define _IOC_TYPE(nr)           (((nr) >> _IOC_TYPESHIFT) & _IOC_TYPEMASK)
  97 #define _IOC_NR(nr)             (((nr) >> _IOC_NRSHIFT) & _IOC_NRMASK)
  98 #define _IOC_SIZE(nr)           (((nr) >> _IOC_SIZESHIFT) & _IOC_SIZEMASK)
  99
 100 /* ...and for the drivers/sound files... */
 101
 102 #define IOC_IN          (_IOC_WRITE << _IOC_DIRSHIFT)
 103 #define IOC_OUT         (_IOC_READ << _IOC_DIRSHIFT)
 104 #define IOC_INOUT       ((_IOC_WRITE|_IOC_READ) << _IOC_DIRSHIFT)
 105 #define IOCSIZE_MASK    (_IOC_SIZEMASK << _IOC_SIZESHIFT)
 106 #define IOCSIZE_SHIFT   (_IOC_SIZESHIFT)
 107
 108 #endif /* _IOWR */