NetBSD-5.0.2/sys/compat/mach/mach_message.h
/* $NetBSD: mach_message.h,v 1.30 2008/04/28 20:23:44 martin Exp $ */
/*-
* Copyright (c) 2001-2003 The NetBSD Foundation, Inc.
* All rights reserved.
*
* This code is derived from software contributed to The NetBSD Foundation
* by Christos Zoulas and Emmanuel Dreyfus.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
* ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef _MACH_MESSAGE_H_
#define _MACH_MESSAGE_H_
typedef unsigned int mach_msg_bits_t;
typedef unsigned int mach_msg_size_t;
typedef unsigned int mach_msg_id_t;
typedef unsigned int mach_msg_timeout_t;
typedef unsigned int mach_msg_option_t;
typedef unsigned int mach_msg_type_name_t;
typedef unsigned int mach_msg_type_number_t;
/*
* Options
*/
#define MACH_MSG_OPTION_NONE 0x00000000
#define MACH_SEND_MSG 0x00000001
#define MACH_RCV_MSG 0x00000002
#define MACH_RCV_LARGE 0x00000004
#define MACH_SEND_TIMEOUT 0x00000010
#define MACH_SEND_INTERRUPT 0x00000040
#define MACH_SEND_CANCEL 0x00000080
#define MACH_RCV_TIMEOUT 0x00000100
#define MACH_RCV_NOTIFY 0x00000200
#define MACH_RCV_INTERRUPT 0x00000400
#define MACH_RCV_OVERWRITE 0x00001000
#define MACH_SEND_ALWAYS 0x00010000
#define MACH_SEND_TRAILER 0x00020000
/* mach_msg error codes */
#define MACH_MSG_SUCCESS 0x00000000
#define MACH_MSG_MASK 0x00003e00
#define MACH_MSG_IPC_SPACE 0x00002000
#define MACH_MSG_VM_SPACE 0x00001000
#define MACH_MSG_IPC_KERNEL 0x00000800
#define MACH_MSG_VM_KERNEL 0x00000400
#define MACH_SEND_MSG 0x00000001
#define MACH_SEND_TIMEOUT 0x00000010
#define MACH_SEND_INTERRUPT 0x00000040
#define MACH_SEND_CANCEL 0x00000080
#define MACH_SEND_ALWAYS 0x00010000
#define MACH_SEND_TRAILER 0x00020000
#define MACH_SEND_IN_PROGRESS 0x10000001
#define MACH_SEND_INVALID_DATA 0x10000002
#define MACH_SEND_INVALID_DEST 0x10000003
#define MACH_SEND_TIMED_OUT 0x10000004
#define MACH_SEND_INTERRUPTED 0x10000007
#define MACH_SEND_MSG_TOO_SMALL 0x10000008
#define MACH_SEND_INVALID_REPLY 0x10000009
#define MACH_SEND_INVALID_RIGHT 0x1000000a
#define MACH_SEND_INVALID_NOTIFY 0x1000000b
#define MACH_SEND_INVALID_MEMORY 0x1000000c
#define MACH_SEND_NO_BUFFER 0x1000000d
#define MACH_SEND_TOO_LARGE 0x1000000e
#define MACH_SEND_INVALID_TYPE 0x1000000f
#define MACH_SEND_INVALID_HEADER 0x10000010
#define MACH_SEND_INVALID_TRAILER 0x10000011
#define MACH_SEND_INVALID_RT_OOL_SIZE 0x10000015
#define MACH_RCV_IN_PROGRESS 0x10004001
#define MACH_RCV_INVALID_NAME 0x10004002
#define MACH_RCV_TIMED_OUT 0x10004003
#define MACH_RCV_TOO_LARGE 0x10004004
#define MACH_RCV_INTERRUPTED 0x10004005
#define MACH_RCV_PORT_CHANGED 0x10004006
#define MACH_RCV_INVALID_NOTIFY 0x10004007
#define MACH_RCV_INVALID_DATA 0x10004008
#define MACH_RCV_PORT_DIED 0x10004009
#define MACH_RCV_IN_SET 0x1000400a
#define MACH_RCV_HEADER_ERROR 0x1000400b
#define MACH_RCV_BODY_ERROR 0x1000400c
#define MACH_RCV_INVALID_TYPE 0x1000400d
#define MACH_RCV_SCATTER_SMALL 0x1000400e
#define MACH_RCV_INVALID_TRAILER 0x1000400f
#define MACH_RCV_IN_PROGRESS_TIMED 0x10004011
#define MACH_MSG_OPTION_BITS "\177\20" \
"b\00send_msg\0b\01rcv_msg\0" \
"b\02rcv_large\0b\03invalid[0x8]\0" \
"b\04send_timeout\0b05invalid[0x20]\0" \
"b\06send_interrupt\0b\05send_cancel\0" \
"b\06rcv_timeout\0b\07rcv_notify\0" \
"b\10rcv_interrupt\0b\11invalid[0x800]\0" \
"b\12rcv_overwrite\0b\13invalid[0x2000]\0" \
"b\14invalid[0x4000]\0b\15invalid[0x8000]\0" \
"b\16send_always\0b\17send_trailer\0"
#define MACH_MSGH_BITS_REMOTE_MASK 0x000000ff
#define MACH_MSGH_BITS_LOCAL_MASK 0x0000ff00
#define MACH_MSGH_BITS_COMPLEX 0x80000000
#define MACH_MSGH_LOCAL_BITS(bits) (((bits) >> 8) & 0xff)
#define MACH_MSGH_REMOTE_BITS(bits) ((bits) & 0xff)
#define MACH_MSGH_REPLY_LOCAL_BITS(bits) (((bits) << 8) & 0xff00)
#define MACH_MSG_TYPE_MOVE_RECEIVE 16
#define MACH_MSG_TYPE_MOVE_SEND 17
#define MACH_MSG_TYPE_MOVE_SEND_ONCE 18
#define MACH_MSG_TYPE_COPY_SEND 19
#define MACH_MSG_TYPE_MAKE_SEND 20
#define MACH_MSG_TYPE_MAKE_SEND_ONCE 21
#define MACH_MSG_TYPE_COPY_RECEIVE 22
typedef unsigned int mach_msg_copy_options_t;
#define MACH_MSG_PHYSICAL_COPY 0
#define MACH_MSG_VIRTUAL_COPY 1
#define MACH_MSG_ALLOCATE 2
#define MACH_MSG_OVERWRITE 3
#define MACH_MSG_KALLOC_COPY_T 4
#define MACH_MSG_PAGE_LIST_COPY_T 5
typedef unsigned int mach_msg_descriptor_type_t;
#define MACH_MSG_PORT_DESCRIPTOR 0
#define MACH_MSG_OOL_DESCRIPTOR 1
#define MACH_MSG_OOL_PORTS_DESCRIPTOR 2
#define MACH_MSG_OOL_VOLATILE_DESCRIPTOR 3
#define MACH_MAX_MSG_LEN 65536
typedef struct {
mach_msg_bits_t msgh_bits;
mach_msg_size_t msgh_size;
mach_port_t msgh_remote_port;
mach_port_t msgh_local_port;
mach_msg_size_t msgh_reserved;
mach_msg_id_t msgh_id;
} mach_msg_header_t;
#define MACH_MSG_TRAILER_FORMAT_0 0
typedef u_int32_t mach_msg_trailer_type_t;
typedef u_int32_t mach_msg_trailer_size_t;
typedef struct {
mach_msg_trailer_type_t msgh_trailer_type;
mach_msg_trailer_size_t msgh_trailer_size;
} mach_msg_trailer_t;
typedef struct {
void* pad1;
mach_msg_size_t pad2;
unsigned int pad3 : 24;
mach_msg_descriptor_type_t type : 8;
} mach_msg_type_descriptor_t;
typedef struct {
mach_port_t name;
mach_msg_size_t pad1;
unsigned int pad2 : 16;
mach_msg_type_name_t disposition : 8;
mach_msg_descriptor_type_t type : 8;
} mach_msg_port_descriptor_t;
typedef struct {
void * address;
mach_msg_size_t count;
mach_boolean_t deallocate: 8;
mach_msg_copy_options_t copy: 8;
mach_msg_type_name_t disposition : 8;
mach_msg_descriptor_type_t type : 8;
} mach_msg_ool_ports_descriptor_t;
typedef struct {
void * address;
mach_msg_size_t size;
mach_boolean_t deallocate : 8;
mach_msg_copy_options_t copy : 8;
unsigned int pad1 : 8;
mach_msg_descriptor_type_t type : 8;
} mach_msg_ool_descriptor_t;
typedef struct {
mach_msg_size_t msgh_descriptor_count;
} mach_msg_body_t;
#define MACH_REQMSG_OVERFLOW(args, test) \
(((u_long)&test - (u_long)args->smsg) > args->ssize)
struct mach_short_reply {
mach_msg_header_t sr_header;
mach_msg_trailer_t sr_trailer;
};
struct mach_complex_msg {
mach_msg_header_t mcm_header;
mach_msg_body_t mcm_body;
union {
mach_msg_type_descriptor_t gen[1];
mach_msg_port_descriptor_t port[1];
mach_msg_ool_ports_descriptor_t ool_ports[1];
mach_msg_ool_descriptor_t ool[1];
} mcm_desc;
};
/* Kernel-private structures */
struct mach_trap_args {
struct lwp *l; /* Current task (doing the Mach system call) */
struct lwp *tl; /* Target task */
void *smsg; /* Sent message */
void *rmsg; /* Reply message */
size_t ssize; /* Sent message size */
size_t *rsize; /* Reply message maximum size, may be lowered */
};
struct mach_service {
int srv_id;
int (*srv_handler)(struct mach_trap_args *);
const char *srv_name;
size_t srv_reqlen; /* Minimum length of the request message */
size_t srv_replen; /* Maximum length of the reply message */
};
extern struct mach_service mach_services_table[];
/* In-kernel Mach messages description */
struct mach_message {
mach_msg_header_t *mm_msg; /* In-kernel copy of the message */
size_t mm_size; /* Message size */
TAILQ_ENTRY(mach_message) mm_list;
/* List of pending messages */
struct mach_port *mm_port; /* The port on which msg is queued */
struct lwp *mm_l; /* The thread that sent it */
};
/* Flags for mach_ool_copy{in|out} */
#define MACH_OOL_NONE 0x0
#define MACH_OOL_FREE 0x1 /* Free kernel buffer after copyout */
#define MACH_OOL_TRACE 0x2 /* ktrace OOL data */
__inline int mach_ool_copyin(struct lwp *, const void *, void **, size_t, int);
__inline int mach_ool_copyout(struct lwp *, const void *, void **, size_t, int);
__inline void mach_set_trailer(void *, size_t);
__inline void mach_set_header(void *, void *, size_t);
__inline void mach_add_port_desc(void *, mach_port_name_t);
__inline void mach_add_ool_ports_desc(void *, void *, int);
__inline void mach_add_ool_desc(void *, void *, size_t);
void mach_message_init(void);
struct mach_message *mach_message_get(mach_msg_header_t *,
size_t, struct mach_port *, struct lwp *);
void mach_message_put(struct mach_message *);
void mach_message_put_shlocked(struct mach_message *);
void mach_message_put_exclocked(struct mach_message *);
#ifdef DEBUG_MACH
void mach_debug_message(void);
#endif
#endif /* !_MACH_MESSAGE_H_ */