bsd/sys/file.h

   1 /*
   2  * Copyright (c) 2000-2008 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28 /* Copyright (c) 1995, 1997 Apple Computer, Inc. All Rights Reserved */
  29 /*
  30  * Copyright (c) 1982, 1986, 1989, 1993
  31  *      The Regents of the University of California.  All rights reserved.
  32  *
  33  * Redistribution and use in source and binary forms, with or without
  34  * modification, are permitted provided that the following conditions
  35  * are met:
  36  * 1. Redistributions of source code must retain the above copyright
  37  *    notice, this list of conditions and the following disclaimer.
  38  * 2. Redistributions in binary form must reproduce the above copyright
  39  *    notice, this list of conditions and the following disclaimer in the
  40  *    documentation and/or other materials provided with the distribution.
  41  * 3. All advertising materials mentioning features or use of this software
  42  *    must display the following acknowledgement:
  43  *      This product includes software developed by the University of
  44  *      California, Berkeley and its contributors.
  45  * 4. Neither the name of the University nor the names of its contributors
  46  *    may be used to endorse or promote products derived from this software
  47  *    without specific prior written permission.
  48  *
  49  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  50  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  51  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  52  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  53  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  54  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  55  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  56  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  57  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  58  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  59  * SUCH DAMAGE.
  60  *
  61  *      @(#)file.h      8.3 (Berkeley) 1/9/95
  62  */
  63
  64 #ifndef _SYS_FILE_H_
  65 #define _SYS_FILE_H_
  66
  67 #include <sys/appleapiopts.h>
  68 #include <sys/types.h>
  69 #include <sys/fcntl.h>
  70 #include <sys/unistd.h>
  71 #include <sys/queue.h>
  72 #include <sys/cdefs.h>
  73
  74 #ifdef KERNEL
  75 #include <sys/queue.h>
  76 #include <sys/kernel_types.h>
  77 #include <sys/uio.h>
  78 #endif
  79
  80 #ifndef _KAUTH_CRED_T
  81 #define _KAUTH_CRED_T
  82 struct ucred;
  83 typedef struct ucred *kauth_cred_t;
  84 #endif  /* !_KAUTH_CRED_T */
  85
  86 #pragma pack(4)
  87
  88 /* for the compat sake;  */
  89 struct extern_file {
  90         LIST_ENTRY(extern_file) f_list; /* list of active files */
  91         short   f_flag;         /* see fcntl.h */
  92         short   f_type;         /* descriptor type */
  93         short   f_count;        /* reference count */
  94         short   f_msgcount;     /* references from message queue */
  95         kauth_cred_t f_cred;    /* credentials associated with descriptor */
  96         void * f_ops;
  97         off_t   f_offset;
  98         caddr_t f_data;         /* vnode or socket or SHM or semaphore */
  99 };
 100
 101 #pragma pack()
 102
 103 __BEGIN_DECLS
 104 #ifdef KERNEL
 105 int file_socket(int, socket_t *);
 106 int file_vnode(int, vnode_t *);
 107 int file_vnode_withvid(int, vnode_t *, uint32_t *);
 108 int file_flags(int, int *);
 109 int file_drop(int);
 110 #endif /* KERNEL */
 111
 112 #ifdef KERNEL_PRIVATE
 113 int fd_rdwr(int fd, enum uio_rw, uint64_t base, int64_t len, enum uio_seg,
 114             off_t offset, int io_flg, int64_t *aresid);
 115 #endif  /* KERNEL_PRIVATE */
 116 __END_DECLS
 117 #endif /* !_SYS_FILE_H_ */