osfmk/ipc/ipc_mqueue.h

   1 /*
   2  * Copyright (c) 2000-2007 Apple 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 /*
  29  * @OSF_COPYRIGHT@
  30  */
  31 /*
  32  * Mach Operating System
  33  * Copyright (c) 1991,1990,1989 Carnegie Mellon University
  34  * All Rights Reserved.
  35  *
  36  * Permission to use, copy, modify and distribute this software and its
  37  * documentation is hereby granted, provided that both the copyright
  38  * notice and this permission notice appear in all copies of the
  39  * software, derivative works or modified versions, and any portions
  40  * thereof, and that both notices appear in supporting documentation.
  41  *
  42  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
  43  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
  44  * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
  45  *
  46  * Carnegie Mellon requests users of this software to return to
  47  *
  48  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
  49  *  School of Computer Science
  50  *  Carnegie Mellon University
  51  *  Pittsburgh PA 15213-3890
  52  *
  53  * any improvements or extensions that they make and grant Carnegie Mellon
  54  * the rights to redistribute these changes.
  55  */
  56 /*
  57  */
  58 /*
  59  *      File:   ipc/ipc_mqueue.h
  60  *      Author: Rich Draves
  61  *      Date:   1989
  62  *
  63  *      Definitions for message queues.
  64  */
  65
  66 #ifndef _IPC_IPC_MQUEUE_H_
  67 #define _IPC_IPC_MQUEUE_H_
  68
  69 #include <mach_assert.h>
  70
  71 #include <mach/message.h>
  72
  73 #include <kern/assert.h>
  74 #include <kern/macro_help.h>
  75 #include <kern/kern_types.h>
  76 #include <kern/wait_queue.h>
  77
  78 #include <ipc/ipc_kmsg.h>
  79 #include <ipc/ipc_object.h>
  80 #include <ipc/ipc_types.h>
  81
  82 typedef struct ipc_mqueue {
  83         union {
  84                 struct {
  85                         struct  wait_queue      wait_queue;
  86                         struct ipc_kmsg_queue   messages;
  87                         mach_port_msgcount_t    msgcount;
  88                         mach_port_msgcount_t    qlimit;
  89                         mach_port_seqno_t       seqno;
  90                         boolean_t               fullwaiters;
  91                 } port;
  92                 struct wait_queue_set           set_queue;
  93         } data;
  94 } *ipc_mqueue_t;
  95
  96 #define IMQ_NULL                ((ipc_mqueue_t) 0)
  97
  98 #define imq_wait_queue          data.port.wait_queue
  99 #define imq_messages            data.port.messages
 100 #define imq_msgcount            data.port.msgcount
 101 #define imq_qlimit              data.port.qlimit
 102 #define imq_seqno               data.port.seqno
 103 #define imq_fullwaiters         data.port.fullwaiters
 104
 105 #define imq_set_queue           data.set_queue
 106 #define imq_setlinks            data.set_queue.wqs_setlinks
 107 #define imq_is_set(mq)          wait_queue_is_set(&(mq)->imq_set_queue)
 108
 109 #define imq_lock(mq)            wait_queue_lock(&(mq)->imq_wait_queue)
 110 #define imq_lock_try(mq)        wait_queue_lock_try(&(mq)->imq_wait_queue)
 111 #define imq_unlock(mq)          wait_queue_unlock(&(mq)->imq_wait_queue)
 112 #define imq_held(mq)            wait_queue_held(&(mq)->imq_wait_queue)
 113
 114 #define imq_full(mq)            ((mq)->imq_msgcount >= (mq)->imq_qlimit)
 115 #define imq_full_kernel(mq)     ((mq)->imq_msgcount >= MACH_PORT_QLIMIT_KERNEL)
 116
 117 extern int ipc_mqueue_full;
 118 extern int ipc_mqueue_rcv;
 119
 120 #define IPC_MQUEUE_FULL         CAST_EVENT64_T(&ipc_mqueue_full)
 121 #define IPC_MQUEUE_RECEIVE      CAST_EVENT64_T(&ipc_mqueue_rcv)
 122
 123 /*
 124  * Exported interfaces
 125  */
 126
 127 /* Initialize a newly-allocated message queue */
 128 extern void ipc_mqueue_init(
 129         ipc_mqueue_t            mqueue,
 130         boolean_t               is_set);
 131
 132 /* destroy an mqueue */
 133 extern void ipc_mqueue_destroy(
 134         ipc_mqueue_t            mqueue);
 135
 136 /* Wake up receivers waiting in a message queue */
 137 extern void ipc_mqueue_changed(
 138         ipc_mqueue_t            mqueue);
 139
 140 /* Add the specific mqueue as a member of the set */
 141 extern kern_return_t ipc_mqueue_add(
 142         ipc_mqueue_t            mqueue,
 143         ipc_mqueue_t            set_mqueue);
 144
 145 /* Check to see if mqueue is member of set_mqueue */
 146 extern boolean_t ipc_mqueue_member(
 147         ipc_mqueue_t            mqueue,
 148         ipc_mqueue_t            set_mqueue);
 149
 150 /* Remove an mqueue from a specific set */
 151 extern kern_return_t ipc_mqueue_remove(
 152         ipc_mqueue_t            mqueue,
 153         ipc_mqueue_t            set_mqueue);
 154
 155 /* Remove an mqueue from all sets */
 156 extern void ipc_mqueue_remove_from_all(
 157         ipc_mqueue_t            mqueue);
 158
 159 /* Remove all the members of the specifiied set */
 160 extern void ipc_mqueue_remove_all(
 161         ipc_mqueue_t            mqueue);
 162
 163 /* Send a message to a port */
 164 extern mach_msg_return_t ipc_mqueue_send(
 165         ipc_mqueue_t            mqueue,
 166         ipc_kmsg_t              kmsg,
 167         mach_msg_option_t       option,
 168         mach_msg_timeout_t      timeout_val);
 169
 170 /* Deliver message to message queue or waiting receiver */
 171 extern void ipc_mqueue_post(
 172         ipc_mqueue_t            mqueue,
 173         ipc_kmsg_t              kmsg);
 174
 175 /* Receive a message from a message queue */
 176 extern void ipc_mqueue_receive(
 177         ipc_mqueue_t            mqueue,
 178         mach_msg_option_t       option,
 179         mach_msg_size_t         max_size,
 180         mach_msg_timeout_t      timeout_val,
 181         int                     interruptible);
 182
 183 /* Continuation routine for message receive */
 184 extern void ipc_mqueue_receive_continue(
 185         void                    *param,
 186         wait_result_t           wresult);
 187
 188 /* Select a message from a queue and try to post it to ourself */
 189 extern void ipc_mqueue_select(
 190         ipc_mqueue_t            mqueue,
 191         mach_msg_option_t       option,
 192         mach_msg_size_t         max_size);
 193
 194 /* Clear a message count reservation */
 195 extern void ipc_mqueue_release_msgcount(
 196         ipc_mqueue_t            mqueue);
 197
 198 /* Change a queue limit */
 199 extern void ipc_mqueue_set_qlimit(
 200         ipc_mqueue_t            mqueue,
 201         mach_port_msgcount_t    qlimit);
 202
 203 /* Change a queue's sequence number */
 204 extern void ipc_mqueue_set_seqno(
 205         ipc_mqueue_t            mqueue,
 206         mach_port_seqno_t       seqno);
 207
 208 /* Convert a name in a space to a message queue */
 209 extern mach_msg_return_t ipc_mqueue_copyin(
 210         ipc_space_t             space,
 211         mach_port_name_t        name,
 212         ipc_mqueue_t            *mqueuep,
 213         ipc_object_t            *objectp);
 214
 215 #endif  /* _IPC_IPC_MQUEUE_H_ */