Source to ipc/ipc_object.h
/*
* Copyright (c) 1999 Apple Computer, Inc. All rights reserved.
*
* @APPLE_LICENSE_HEADER_START@
*
* "Portions Copyright (c) 1999 Apple Computer, Inc. All Rights
* Reserved. 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 1.0 (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.
*
* 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."
*
* @APPLE_LICENSE_HEADER_END@
*/
/*
* Copyright (c) 1995, 1994, 1993, 1992, 1991, 1990
* Open Software Foundation, Inc.
*
* Permission to use, copy, modify, and distribute this software and
* its documentation for any purpose and without fee is hereby granted,
* provided that the above copyright notice appears in all copies and
* that both the copyright notice and this permission notice appear in
* supporting documentation, and that the name of ("OSF") or Open Software
* Foundation not be used in advertising or publicity pertaining to
* distribution of the software without specific, written prior permission.
*
* OSF DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE
* INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL OSF BE LIABLE FOR ANY
* SPECIAL, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
* ACTION OF CONTRACT, NEGLIGENCE, OR OTHER TORTIOUS ACTION, ARISING
* OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE
*/
/*
* OSF Research Institute MK6.1 (unencumbered) 1/31/1995
*/
/*
* 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.
*
* 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 [email protected]
* 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.
*/
/*
* File: ipc/ipc_object.h
* Author: Rich Draves
* Date: 1989
*
* Definitions for IPC objects, for which tasks have capabilities.
*/
#ifndef _IPC_IPC_OBJECT_H_
#define _IPC_IPC_OBJECT_H_
#import <mach/features.h>
#include <mach/kern_return.h>
#include <mach/message.h>
#include <kern/lock.h>
#include <kern/macro_help.h>
#include <kern/zalloc.h>
#include <ipc/ipc_types.h>
typedef unsigned int ipc_object_refs_t;
typedef unsigned int ipc_object_bits_t;
typedef unsigned int ipc_object_type_t;
typedef struct ipc_object {
decl_simple_lock_data(,io_lock_data)
ipc_object_refs_t io_references;
ipc_object_bits_t io_bits;
} *ipc_object_t;
#define IO_NULL ((ipc_object_t) 0)
#define IO_DEAD ((ipc_object_t) -1)
#define IO_VALID(io) (((io) != IO_NULL) && ((io) != IO_DEAD))
#define IO_BITS_KOTYPE 0x0000ffff /* used by the object */
#define IO_BITS_OTYPE 0x7fff0000 /* determines a zone */
#define IO_BITS_ACTIVE 0x80000000U /* is object alive? */
#define io_active(io) ((int)(io)->io_bits < 0) /* hack */
#define io_otype(io) (((io)->io_bits & IO_BITS_OTYPE) >> 16)
#define io_kotype(io) ((io)->io_bits & IO_BITS_KOTYPE)
#define io_makebits(active, otype, kotype) \
(((active) ? IO_BITS_ACTIVE : 0) | ((otype) << 16) | (kotype))
/*
* Object types: ports, port sets, kernel-loaded ports
*/
#define IOT_PORT 0
#define IOT_PORT_SET 1
#define IOT_NUMBER 2 /* number of types used */
extern zone_t ipc_object_zones[IOT_NUMBER];
#define io_alloc(otype) \
((ipc_object_t) zalloc(ipc_object_zones[(otype)]))
#define io_free(otype, io) \
zfree(ipc_object_zones[(otype)], (vm_offset_t) (io))
#define io_lock_init(io) simple_lock_init(&(io)->io_lock_data)
#define io_lock(io) simple_lock(&(io)->io_lock_data)
#define io_lock_try(io) simple_lock_try(&(io)->io_lock_data)
#define io_unlock(io) simple_unlock(&(io)->io_lock_data)
#define io_check_unlock(io) \
MACRO_BEGIN \
volatile ipc_object_refs_t _refs = (io)->io_references; \
\
io_unlock(io); \
if (_refs == 0) \
io_free(io_otype(io), io); \
MACRO_END
#define io_reference(io) \
MACRO_BEGIN \
(io)->io_references++; \
MACRO_END
#define io_release(io) \
MACRO_BEGIN \
(io)->io_references--; \
MACRO_END
/*
* Exported interfaces
*/
/* Take a reference to an object */
extern void ipc_object_reference(
ipc_object_t object);
/* Release a reference to an object */
extern void ipc_object_release(
ipc_object_t object);
/* Look up an object in a space */
extern kern_return_t ipc_object_translate(
ipc_space_t space,
mach_port_t name,
mach_port_right_t right,
ipc_object_t *objectp);
/* Allocate a dead-name entry */
extern kern_return_t
ipc_object_alloc_dead(
ipc_space_t space,
mach_port_t *namep);
/* Allocate a dead-name entry, with a specific name */
extern kern_return_t ipc_object_alloc_dead_name(
ipc_space_t space,
mach_port_t name);
/* Allocate an object */
extern kern_return_t ipc_object_alloc(
ipc_space_t space,
ipc_object_type_t otype,
mach_port_type_t type,
mach_port_urefs_t urefs,
mach_port_t *namep,
ipc_object_t *objectp);
/* Allocate an object, with a specific name */
extern kern_return_t ipc_object_alloc_name(
ipc_space_t space,
ipc_object_type_t otype,
mach_port_type_t type,
mach_port_urefs_t urefs,
mach_port_t name,
ipc_object_t *objectp);
/* Convert a send type name to a received type name */
extern mach_msg_type_name_t ipc_object_copyin_type(
mach_msg_type_name_t msgt_name);
/* Copyin a capability from a space */
extern kern_return_t ipc_object_copyin(
ipc_space_t space,
mach_port_t name,
mach_msg_type_name_t msgt_name,
ipc_object_t *objectp);
/* Copyin a naked capability from the kernel */
extern void ipc_object_copyin_from_kernel(
ipc_object_t object,
mach_msg_type_name_t msgt_name);
/* Destroy a naked capability */
extern void ipc_object_destroy(
ipc_object_t object,
mach_msg_type_name_t msgt_name);
/* Copyout a capability, placing it into a space */
extern kern_return_t ipc_object_copyout(
ipc_space_t space,
ipc_object_t object,
mach_msg_type_name_t msgt_name,
boolean_t overflow,
mach_port_t *namep);
/* Copyout a capability with a name, placing it into a space */
extern kern_return_t ipc_object_copyout_name(
ipc_space_t space,
ipc_object_t object,
mach_msg_type_name_t msgt_name,
boolean_t overflow,
mach_port_t name);
/* Translate/consume the destination right of a message */
extern void ipc_object_copyout_dest(
ipc_space_t space,
ipc_object_t object,
mach_msg_type_name_t msgt_name,
mach_port_t *namep);
/* Rename an entry in a space */
extern kern_return_t ipc_object_rename(
ipc_space_t space,
mach_port_t oname,
mach_port_t nname);
#if MACH_IPC_COMPAT
extern mach_msg_type_name_t
ipc_object_copyout_type_compat(/* mach_msg_type_name_t */);
extern kern_return_t
ipc_object_copyin_compat(/* ipc_space_t, mach_port_t,
mach_msg_type_name_t, boolean_t,
ipc_object_t * */);
extern kern_return_t
ipc_object_copyin_header(/* ipc_space_t, mach_port_t,
ipc_object_t *, mach_msg_type_name_t * */);
extern kern_return_t
ipc_object_copyout_compat(/* ipc_space_t, ipc_object_t,
mach_msg_type_name_t, mach_port_t * */);
extern kern_return_t
ipc_object_copyout_name_compat(/* ipc_space_t, ipc_object_t,
mach_msg_type_name_t, mach_port_t */);
#endif /* MACH_IPC_COMPAT */
#endif /* _IPC_IPC_OBJECT_H_ */