xnu-2782.10.72.tar.gz

[apple/xnu.git] / bsd / sys / ipc.h

diff --git a/bsd/sys/ipc.h b/bsd/sys/ipc.h
index 2a3f3169ad05eb41b4d3b12d85ca0538f405a26e..91f3492c38c173131c1202d6a7ce426688de25ed 100644 (file)
--- a/bsd/sys/ipc.h
+++ b/bsd/sys/ipc.h
@@ -1,23 +1,29 @@
 /*
 /*

- * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 2000-2002 Apple Computer, Inc. All rights reserved.

  *
  *

- * @APPLE_LICENSE_HEADER_START@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_START@

  * 
  * 

- * The contents of this file constitute Original Code as defined in and
- * are subject to the Apple Public Source License Version 1.1 (the
- * "License").  You may not use this file except in compliance with the
- * License.  Please obtain a copy of the License at
- * http://www.apple.com/publicsource and read it before using this file.
+ * This file contains Original Code and/or Modifications of Original Code
+ * as defined in and that are subject to the Apple Public Source License
+ * Version 2.0 (the 'License'). You may not use this file except in
+ * compliance with the License. The rights granted to you under the License
+ * may not be used to create, or enable the creation or redistribution of,
+ * unlawful or unlicensed copies of an Apple operating system, or to
+ * circumvent, violate, or enable the circumvention or violation of, any
+ * terms of an Apple operating system software license agreement.

  * 
  * 

- * This Original Code and all software distributed under the License are
- * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * Please obtain a copy of the License at
+ * http://www.opensource.apple.com/apsl/ and read it before using this file.
+ * 
+ * The Original Code and all software distributed under the License are
+ * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER

  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,

- * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
- * License for the specific language governing rights and limitations
- * under the License.
+ * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
+ * Please see the License for the specific language governing rights and
+ * limitations under the License.

  * 
  * 

- * @APPLE_LICENSE_HEADER_END@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_END@

  */
 /*
  * Copyright (c) 1988 University of Utah.
  */
 /*
  * Copyright (c) 1988 University of Utah.


@@ -70,51 +76,119 @@
 #ifndef _SYS_IPC_H_
 #define _SYS_IPC_H_
 
 #ifndef _SYS_IPC_H_
 #define _SYS_IPC_H_
 

-struct ipc_perm {
-       ushort  cuid;   /* creator user id */
-       ushort  cgid;   /* creator group id */
-       ushort  uid;    /* user id */
-       ushort  gid;    /* group id */
-       ushort  mode;   /* r/w permission */
-       ushort  seq;    /* sequence # (to generate unique msg/sem/shm id) */
-       key_t   key;    /* user specified msg/sem/shm key */
+#include <sys/appleapiopts.h>
+#include <sys/cdefs.h>
+
+#include <sys/_types.h>
+
+/*
+ * [XSI] The uid_t, gid_t, mode_t, and key_t types SHALL be defined as
+ * described in <sys/types.h>.
+ */
+#include <sys/_types/_uid_t.h>
+#include <sys/_types/_gid_t.h>
+#include <sys/_types/_mode_t.h>
+#include <sys/_types/_key_t.h>
+
+
+#pragma pack(4)
+
+/*
+ * Technically, we should force all code references to the new structure
+ * definition, not in just the standards conformance case, and leave the
+ * legacy interface there for binary compatibility only.  Currently, we
+ * are only forcing this for programs requesting standards conformance.
+ */
+#if __DARWIN_UNIX03 || defined(KERNEL)
+/*
+ * [XSI] Information used in determining permission to perform an IPC
+ * operation
+ */
+struct ipc_perm
+{
+       uid_t           uid;            /* [XSI] Owner's user ID */
+       gid_t           gid;            /* [XSI] Owner's group ID */
+       uid_t           cuid;           /* [XSI] Creator's user ID */
+       gid_t           cgid;           /* [XSI] Creator's group ID */
+       mode_t          mode;           /* [XSI] Read/write permission */
+       unsigned short  _seq;           /* Reserved for internal use */
+       key_t           _key;           /* Reserved for internal use */
+};
+#define        __ipc_perm_new  ipc_perm
+#else  /* !__DARWIN_UNIX03 */
+#define        ipc_perm        __ipc_perm_old
+#endif /* !__DARWIN_UNIX03 */
+
+#if !__DARWIN_UNIX03
+/*
+ * Legacy structure; this structure is maintained for binary backward
+ * compatability with previous versions of the interface.  New code
+ * should not use this interface, since ID values may be truncated.
+ */
+struct __ipc_perm_old {
+       __uint16_t      cuid;           /* Creator's user ID */
+       __uint16_t      cgid;           /* Creator's group ID */
+       __uint16_t      uid;            /* Owner's user ID */
+       __uint16_t      gid;            /* Owner's group ID */
+       mode_t          mode;           /* Read/Write permission */
+       __uint16_t      seq;            /* Reserved for internal use */
+       key_t           key;            /* Reserved for internal use */

 };
 };

+#endif /* !__DARWIN_UNIX03 */
+
+#pragma pack()
+
+/*
+ * [XSI] Definitions shall be provided for the following constants:
+ */
+
+/* Mode bits */
+#define        IPC_CREAT       001000          /* Create entry if key does not exist */
+#define        IPC_EXCL        002000          /* Fail if key exists */
+#define        IPC_NOWAIT      004000          /* Error if request must wait */
+
+/* Keys */
+#define        IPC_PRIVATE     ((key_t)0)      /* Private key */
+
+/* Control commands */
+#define        IPC_RMID        0               /* Remove identifier */
+#define        IPC_SET         1               /* Set options */
+#define        IPC_STAT        2               /* Get options */
+
+
+#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)

 
 /* common mode bits */
 
 /* common mode bits */

-#define        IPC_R           000400  /* read permission */
-#define        IPC_W           000200  /* write/alter permission */
-#define        IPC_M           010000  /* permission to change control info */
+#define        IPC_R           000400          /* Read permission */
+#define        IPC_W           000200          /* Write/alter permission */
+#define        IPC_M           010000          /* Modify control info permission */

 
 

-/* SVID required constants (same values as system 5) */
-#define        IPC_CREAT       001000  /* create entry if key does not exist */
-#define        IPC_EXCL        002000  /* fail if key exists */
-#define        IPC_NOWAIT      004000  /* error if request must wait */
+#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */

 
 

-#define        IPC_PRIVATE     (key_t)0 /* private key */

 
 

-#define        IPC_RMID        0       /* remove identifier */
-#define        IPC_SET         1       /* set options */
-#define        IPC_STAT        2       /* get options */
+#ifdef BSD_KERNEL_PRIVATE
+/*
+ * Kernel implementation details which should not be utilized by user
+ * space programs.
+ */

 
 

-#ifdef KERNEL

 /* Macros to convert between ipc ids and array indices or sequence ids */
 #define        IPCID_TO_IX(id)         ((id) & 0xffff)
 #define        IPCID_TO_SEQ(id)        (((id) >> 16) & 0xffff)
 /* Macros to convert between ipc ids and array indices or sequence ids */
 #define        IPCID_TO_IX(id)         ((id) & 0xffff)
 #define        IPCID_TO_SEQ(id)        (((id) >> 16) & 0xffff)

-#define        IXSEQ_TO_IPCID(ix,perm) (((perm.seq) << 16) | (ix & 0xffff))
+#define        IXSEQ_TO_IPCID(ix,perm) (((perm._seq) << 16L) | ((ix) & 0xffff))

 
 struct ucred;
 
 
 struct ucred;
 

-int    ipcperm __P((struct ucred *, struct ipc_perm *, int));
-#else /* ! KERNEL */
-
-/* XXX doesn't really belong here, but has been historical practice in SysV. */
+int    ipcperm(struct ucred *, struct ipc_perm *, int);
+#endif /* BSD_KERNEL_PRIVATE */

 
 

-#include <sys/cdefs.h>
+#ifndef KERNEL

 
 __BEGIN_DECLS
 
 __BEGIN_DECLS

-key_t  ftok __P((const char *, int));
+/* [XSI] */
+key_t  ftok(const char *, int);

 __END_DECLS
 
 __END_DECLS
 

-#endif /* KERNEL */
+#endif /* !KERNEL */

 
 #endif /* !_SYS_IPC_H_ */
 
 #endif /* !_SYS_IPC_H_ */