xnu-1228.tar.gz

[apple/xnu.git] / osfmk / kern / ipc_mig.h

diff --git a/osfmk/kern/ipc_mig.h b/osfmk/kern/ipc_mig.h
index 2759aa5e6f5f2a9bf7bffefadaedb03070b34c35..3ddfc945d5f15198ba7e46aa8cb333c5a680cd9c 100644 (file)
--- a/osfmk/kern/ipc_mig.h
+++ b/osfmk/kern/ipc_mig.h
@@ -1,32 +1,46 @@
 /*
- * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 2000-2005 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,
- * 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@
  */
 /*
  * @OSF_COPYRIGHT@
  */
 
-#ifndef        _IPC_MIG_H_
-#define        _IPC_MIG_H_
+#ifndef        _KERN_IPC_MIG_H_
+#define        _KERN_IPC_MIG_H_
 
+#include <mach/mig.h>
+#include <mach/mach_types.h>
 #include <mach/message.h>
+#include <kern/kern_types.h>
+
+#include <sys/cdefs.h>
+
+#ifdef XNU_KERNEL_PRIVATE
+
 #include <sys/kdebug.h>
 
 /*
@@ -112,6 +126,10 @@
                              (unsigned int)(0),                                      \
                              (unsigned int)(0))
 
+#endif /* XNU_KERNEL_PRIVATE */
+
+__BEGIN_DECLS
+
 /* Send a message from the kernel */
 extern mach_msg_return_t mach_msg_send_from_kernel(
        mach_msg_header_t       *msg,
@@ -123,6 +141,70 @@ extern mach_msg_return_t mach_msg_rpc_from_kernel(
        mach_msg_size_t         send_size,
        mach_msg_size_t         rcv_size);
 
+extern mach_msg_return_t mach_msg_send_from_kernel_with_options(
+       mach_msg_header_t       *msg,
+       mach_msg_size_t         send_size,
+       mach_msg_option_t       option,
+       mach_msg_timeout_t      timeout_val);
+
+__END_DECLS
+
+#ifdef MACH_KERNEL_PRIVATE
+
 extern void mach_msg_receive_continue(void);
 
-#endif /* _IPC_MIG_H_ */
+/* Initialize kernel server dispatch table */
+extern void            mig_init(void) __attribute__((section("__TEXT, initcode")));
+
+/*
+ * Kernel implementation of the MIG object base class
+ *
+ * Conforms to the MIGObjectInterface defined in <mach/mig.h>
+ * Ports are automatically allocated for the duration of outstanding
+ * cross-task references and then released.  
+ */
+
+typedef struct mig_object {
+                       const IMIGObjectVtbl    *pVtbl; /* our interface def */
+                       mach_port_t             port;    /* our port pointer  */
+} mig_object_data_t;
+
+
+/*
+ * MIG notify base class definition
+ * These are chained off the mig object to which the are registered.
+ * When that object triggers a notification delivery, we walk this
+ * chain and deliver the appropriate notification.
+ */
+typedef struct mig_notify_object {
+                       const IMIGNotifyObjectVtbl *pVtbl; /* our interface def */
+                       mach_port_t             port;    /* our port pointer  */
+} mig_notify_object_data_t;
+
+extern kern_return_t mig_object_init(
+                       mig_object_t            mig_object,
+                       const IMIGObject        *interface);
+
+extern void mig_object_destroy(
+                       mig_object_t            mig_object);
+
+extern void mig_object_reference(
+                       mig_object_t            mig_object);
+
+extern void mig_object_deallocate(
+                       mig_object_t            mig_object);
+
+extern ipc_port_t convert_mig_object_to_port(
+                       mig_object_t            mig_object);
+
+extern mig_object_t convert_port_to_mig_object(
+                       ipc_port_t              port,
+                       const MIGIID            *iid);
+
+boolean_t mig_object_no_senders(
+                       ipc_port_t              port,
+                       mach_port_mscount_t     mscount);
+
+#endif  /* MACH_KERNEL_PRIVATE */
+
+#endif /* _KERN_IPC_MIG_H_ */