xnu-6153.61.1.tar.gz

[apple/xnu.git] / osfmk / ipc / ipc_pset.h

diff --git a/osfmk/ipc/ipc_pset.h b/osfmk/ipc/ipc_pset.h
index e673bd8d84650f578103bc53f9d856e63168721e..efdcbcf8193ea08e1d6abbee24d77a60725b1f60 100644 (file)
--- a/osfmk/ipc/ipc_pset.h
+++ b/osfmk/ipc/ipc_pset.h
@@ -1,49 +1,55 @@
 /*
 /*

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

  *
  *

- * @APPLE_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 Original Code and all software distributed under the License are
- * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
+ *
+ * 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.
+ *
+ * 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.
- * 
- * @APPLE_LICENSE_HEADER_END@
+ * 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_OSREFERENCE_LICENSE_HEADER_END@

  */
 /*
  * @OSF_COPYRIGHT@
  */
  */
 /*
  * @OSF_COPYRIGHT@
  */

-/* 
+/*

  * Mach Operating System
  * Copyright (c) 1991,1990,1989 Carnegie Mellon University
  * All Rights Reserved.
  * Mach Operating System
  * Copyright (c) 1991,1990,1989 Carnegie Mellon University
  * All Rights Reserved.

- * 
+ *

  * Permission to use, copy, modify and distribute this software and its
  * documentation is hereby granted, provided that both the copyright
  * notice and this permission notice appear in all copies of the
  * software, derivative works or modified versions, and any portions
  * thereof, and that both notices appear in supporting documentation.
  * Permission to use, copy, modify and distribute this software and its
  * documentation is hereby granted, provided that both the copyright
  * notice and this permission notice appear in all copies of the
  * software, derivative works or modified versions, and any portions
  * thereof, and that both notices appear in supporting documentation.

- * 
+ *

  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
  * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
  * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.

- * 
+ *

  * Carnegie Mellon requests users of this software to return to
  * Carnegie Mellon requests users of this software to return to

- * 
+ *

  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
  *  School of Computer Science
  *  Carnegie Mellon University
  *  Pittsburgh PA 15213-3890
  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
  *  School of Computer Science
  *  Carnegie Mellon University
  *  Pittsburgh PA 15213-3890

- * 
+ *

  * any improvements or extensions that they make and grant Carnegie Mellon
  * the rights to redistribute these changes.
  */
  * any improvements or extensions that they make and grant Carnegie Mellon
  * the rights to redistribute these changes.
  */


@@ -57,78 +63,104 @@
  *     Definitions for port sets.
  */
 
  *     Definitions for port sets.
  */
 

-#ifndef        _IPC_IPC_PSET_H_
+#ifndef _IPC_IPC_PSET_H_

 #define _IPC_IPC_PSET_H_
 
 #define _IPC_IPC_PSET_H_
 

+#include <mach/mach_types.h>

 #include <mach/port.h>
 #include <mach/kern_return.h>
 #include <mach/port.h>
 #include <mach/kern_return.h>

-#include <kern/ipc_kobject.h>
+#include <kern/kern_types.h>
+#include <ipc/ipc_types.h>

 #include <ipc/ipc_object.h>
 #include <ipc/ipc_mqueue.h>
 
 #include <ipc/ipc_object.h>
 #include <ipc/ipc_mqueue.h>
 

-#include <mach_kdb.h>
-
-typedef struct ipc_pset {
-
+struct ipc_pset {

        /*
         * Initial sub-structure in common with all ipc_objects.
         */
        /*
         * Initial sub-structure in common with all ipc_objects.
         */

-       struct ipc_object       ips_object;
-       struct ipc_mqueue       ips_messages;
-} *ipc_pset_t;
-
-#define        ips_references          ips_object.io_references
-#define ips_local_name         ips_object.io_receiver_name
-
-#define        IPS_NULL                ((ipc_pset_t) IO_NULL)
-
-#define        ips_active(pset)        io_active(&(pset)->ips_object)
-#define        ips_lock(pset)          io_lock(&(pset)->ips_object)
-#define        ips_lock_try(pset)      io_lock_try(&(pset)->ips_object)
-#define        ips_unlock(pset)        io_unlock(&(pset)->ips_object)
-#define        ips_check_unlock(pset)  io_check_unlock(&(pset)->ips_object)
-#define        ips_reference(pset)     io_reference(&(pset)->ips_object)
-#define        ips_release(pset)       io_release(&(pset)->ips_object)
+       struct ipc_object       ips_object;
+       struct ipc_mqueue       ips_messages;
+};
+
+#define ips_references          ips_object.io_references
+
+#define ips_object_to_pset(io)  __container_of(io, struct ipc_pset, ips_object)
+#define ips_to_object(pset)     (&(pset)->ips_object)
+#define ips_active(pset)        io_active(ips_to_object(pset))
+#define ips_lock(pset)          io_lock(ips_to_object(pset))
+#define ips_lock_try(pset)      io_lock_try(ips_to_object(pset))
+#define ips_lock_held_kdp(pset) io_lock_held_kdp(ips_to_object(pset))
+#define ips_unlock(pset)        io_unlock(ips_to_object(pset))
+#define ips_reference(pset)     io_reference(ips_to_object(pset))
+#define ips_release(pset)       io_release(ips_to_object(pset))
+
+/* get an ipc_pset pointer from an ipc_mqueue pointer */
+#define ips_from_mq(mq) \
+               __container_of(mq, struct ipc_pset, ips_messages)

 
 /* Allocate a port set */
 extern kern_return_t ipc_pset_alloc(
 
 /* Allocate a port set */
 extern kern_return_t ipc_pset_alloc(

-       ipc_space_t             space,
-       mach_port_name_t        *namep,
-       ipc_pset_t              *psetp);
+       ipc_space_t             space,
+       mach_port_name_t        *namep,
+       ipc_pset_t              *psetp);

 
 /* Allocate a port set, with a specific name */
 extern kern_return_t ipc_pset_alloc_name(
 
 /* Allocate a port set, with a specific name */
 extern kern_return_t ipc_pset_alloc_name(

-       ipc_space_t             space,
-       mach_port_name_t        name,
-       ipc_pset_t              *psetp);
+       ipc_space_t             space,
+       mach_port_name_t        name,
+       ipc_pset_t              *psetp);
+
+/* Allocate a port set in a special space */
+extern ipc_pset_t ipc_pset_alloc_special(
+       ipc_space_t             space);

 
 /* Add a port to a port set */
 extern kern_return_t ipc_pset_add(
 
 /* Add a port to a port set */
 extern kern_return_t ipc_pset_add(

-       ipc_pset_t      pset,
-       ipc_port_t      port);
+       ipc_pset_t      pset,
+       ipc_port_t      port,
+       uint64_t        *reserved_link,
+       uint64_t        *reserved_prepost);
+
+/* determine if port is a member of set */
+extern boolean_t ipc_pset_member(
+       ipc_pset_t      pset,
+       ipc_port_t      port);

 
 /* Remove a port from a port set */
 extern kern_return_t ipc_pset_remove(
 
 /* Remove a port from a port set */
 extern kern_return_t ipc_pset_remove(

-       ipc_pset_t      pset,
-       ipc_port_t      port);
+       ipc_pset_t      pset,
+       ipc_port_t      port);
+
+/* lazily initialize the wqset of a port set */
+extern kern_return_t ipc_pset_lazy_allocate(
+       ipc_space_t      space,
+       mach_port_name_t psname);

 
 /* Remove a port from all its current port sets */
 extern kern_return_t ipc_pset_remove_from_all(
 
 /* Remove a port from all its current port sets */
 extern kern_return_t ipc_pset_remove_from_all(

-       ipc_port_t      port);
+       ipc_port_t      port);

 
 /* Destroy a port_set */
 extern void ipc_pset_destroy(
 
 /* Destroy a port_set */
 extern void ipc_pset_destroy(

-       ipc_pset_t      pset);
-
-#define        ipc_pset_reference(pset)        \
-               ipc_object_reference(&(pset)->ips_object)
-
-#define        ipc_pset_release(pset)          \
-               ipc_object_release(&(pset)->ips_object)
-
-
-#if    MACH_KDB
-int ipc_list_count(struct ipc_kmsg *base);
-#endif /* MACH_KDB */
-
-#endif /* _IPC_IPC_PSET_H_ */
+       ipc_space_t     space,
+       ipc_pset_t      pset);
+
+#if MACH_KERNEL_PRIVATE
+extern struct turnstile *filt_ipc_kqueue_turnstile(
+       struct knote *kn);
+bool
+filt_machport_kqueue_has_turnstile(
+       struct knote *kn);
+
+extern void filt_machport_turnstile_prepare_lazily(
+       struct knote *kn,
+       mach_msg_type_name_t    msgt_name,
+       ipc_port_t port);
+
+extern struct turnstile *filt_machport_stash_port(
+       struct knote *kn,
+       ipc_port_t port,
+       int *link);
+#endif
+
+#endif  /* _IPC_IPC_PSET_H_ */