FreeBSD/Linux Kernel Cross Reference
sys/ipc/ipc_mqueue.h

     /* 
      * Mach Operating System
      * Copyright (c) 1993,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.
     * 
     * 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
     * 
     *  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.
     */
    /*
     * HISTORY
     * $Log:        ipc_mqueue.h,v $
     * Revision 2.7  93/11/17  16:59:06  dbg
     *      Use CONTINUE_NULL instead of IMQ_NULL_CONTINUE.
     *      [93/06/03            dbg]
     * 
     *      Use proper type for continuations.
     *      [93/05/04            dbg]
     * 
     *      Added ANSI function prototypes.  Cleaned up return type of
     *      ipc_kmsg result parameter from ipc_mqueue_receive by using union
     *      type defined in ipc/ipc_types.h.
     *      [93/03/29            dbg]
     * 
     * Revision 2.6  91/08/28  11:13:37  jsb
     *      Added seqno argument to ipc_mqueue_receive.
     *      [91/08/10            rpd]
     * 
     * Revision 2.5  91/05/14  16:34:12  mrt
     *      Correcting copyright
     * 
     * Revision 2.4  91/02/05  17:22:29  mrt
     *      Changed to new Mach copyright
     *      [91/02/01  15:46:46  mrt]
     * 
     * Revision 2.3  91/01/08  15:14:42  rpd
     *      Changed continuation argument and IMQ_NULL_CONTINUE to (void (*)()).
     *      [90/12/18            rpd]
     *      Reorganized ipc_mqueue_receive.
     *      [90/11/22            rpd]
     * 
     * Revision 2.2  90/06/02  14:50:44  rpd
     *      Created for new IPC.
     *      [90/03/26  20:57:40  rpd]
     * 
     */
    /*
     *      File:   ipc/ipc_mqueue.h
     *      Author: Rich Draves
     *      Date:   1989
     *
     *      Definitions for message queues.
     */
    
    #ifndef _IPC_IPC_MQUEUE_H_
    #define _IPC_IPC_MQUEUE_H_
    
    #include <mach_assert.h>
    
    #include <mach/message.h>
    #include <kern/assert.h>
    #include <kern/lock.h>
    #include <kern/macro_help.h>
    #include <kern/sched_prim.h>    /* continuation_t */
    #include <ipc/ipc_types.h>
    #include <ipc/ipc_kmsg.h>
    #include <ipc/ipc_object.h>
    #include <ipc/ipc_thread.h>
    
    typedef struct ipc_mqueue {
            decl_simple_lock_data(, imq_lock_data)
            struct ipc_kmsg_queue imq_messages;
            struct ipc_thread_queue imq_threads;
    } *ipc_mqueue_t;
    
    #define IMQ_NULL                ((ipc_mqueue_t) 0)
    
    #define imq_lock_init(mq)       simple_lock_init(&(mq)->imq_lock_data)
    #define imq_lock(mq)            simple_lock(&(mq)->imq_lock_data)
    #define imq_lock_try(mq)        simple_lock_try(&(mq)->imq_lock_data)
    #define imq_unlock(mq)          simple_unlock(&(mq)->imq_lock_data)
    
    extern void
   ipc_mqueue_init(ipc_mqueue_t);
   
   extern void
   ipc_mqueue_move(
           ipc_mqueue_t    dest,
           ipc_mqueue_t    source,
           ipc_port_t      port);
   
   extern void
   ipc_mqueue_changed(
           ipc_mqueue_t    mqueue,
           mach_msg_return_t mr);
   
   extern mach_msg_return_t
   ipc_mqueue_send(
           ipc_kmsg_t      kmsg,
           mach_msg_option_t option,
           mach_msg_timeout_t time_out);
   
   extern mach_msg_return_t
   ipc_mqueue_copyin(
           ipc_space_t     space,
           mach_port_t     name,
           ipc_mqueue_t    *mqueuep,
           ipc_object_t    *objectp);
   
   extern mach_msg_return_t
   ipc_mqueue_receive(
           ipc_mqueue_t            mqueue,
           mach_msg_option_t       option,
           mach_msg_size_t         max_size,
           mach_msg_timeout_t      time_out,
           boolean_t               resume,
           continuation_t          continuation,
           union ipc_kmsg_return   *kmsg_retp,
           mach_port_seqno_t       *seqnop);
   
   /*
    *      extern void
    *      ipc_mqueue_send_always(ipc_kmsg_t);
    *
    *      Unfortunately, to avoid warnings/lint about unused variables
    *      when assertions are turned off, we need two versions of this.
    */
   
   #if     MACH_ASSERT
   
   #define ipc_mqueue_send_always(kmsg)                                    \
   MACRO_BEGIN                                                             \
           mach_msg_return_t mr;                                           \
                                                                           \
           mr = ipc_mqueue_send((kmsg), MACH_SEND_ALWAYS,                  \
                                MACH_MSG_TIMEOUT_NONE);                    \
           assert(mr == MACH_MSG_SUCCESS);                                 \
   MACRO_END
   
   #else   /* MACH_ASSERT */
   
   #define ipc_mqueue_send_always(kmsg)                                    \
   MACRO_BEGIN                                                             \
           (void) ipc_mqueue_send((kmsg), MACH_SEND_ALWAYS,                \
                                  MACH_MSG_TIMEOUT_NONE);                  \
   MACRO_END
   
   #endif  /* MACH_ASSERT */
   
   #endif  /* _IPC_IPC_MQUEUE_H_ */

Cache object: 1ea31c0c567de27c185c816853073e9c