osfmk/mach/host_special_ports.h

   1 /*
   2  * Copyright (c) 2003 Apple Computer, 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 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:   mach/host_special_ports.h
  60  *
  61  *      Defines codes for access to host-wide special ports.
  62  */
  63
  64 #ifndef _MACH_HOST_SPECIAL_PORTS_H_
  65 #define _MACH_HOST_SPECIAL_PORTS_H_
  66
  67 /*
  68  * Cannot be set or gotten from user space
  69  */
  70 #define HOST_SECURITY_PORT               0
  71
  72 /*
  73  * Always provided by kernel (cannot be set from user-space).
  74  */
  75 #define HOST_PORT                        1
  76 #define HOST_PRIV_PORT                   2
  77 #define HOST_IO_MASTER_PORT              3
  78 #define HOST_MAX_SPECIAL_KERNEL_PORT     7 /* room to grow */
  79
  80 /*
  81  * Not provided by kernel
  82  */
  83 #define HOST_DYNAMIC_PAGER_PORT         (1 + HOST_MAX_SPECIAL_KERNEL_PORT)
  84 #define HOST_AUDIT_CONTROL_PORT         (2 + HOST_MAX_SPECIAL_KERNEL_PORT)
  85 #define HOST_USER_NOTIFICATION_PORT     (3 + HOST_MAX_SPECIAL_KERNEL_PORT)
  86 #define HOST_LOCKD_PORT                 (5 + HOST_MAX_SPECIAL_KERNEL_PORT)
  87 #define HOST_SEATBELT_PORT              (7 + HOST_MAX_SPECIAL_KERNEL_PORT)
  88 #define HOST_MAX_SPECIAL_PORT           (8 + HOST_MAX_SPECIAL_KERNEL_PORT)
  89                                         /* room to grow here as well */
  90
  91 /*
  92  * Special node identifier to always represent the local node.
  93  */
  94 #define HOST_LOCAL_NODE                  -1
  95
  96 /*
  97  * Definitions for ease of use.
  98  *
  99  * In the get call, the host parameter can be any host, but will generally
 100  * be the local node host port. In the set call, the host must the per-node
 101  * host port for the node being affected.
 102  */
 103 #define host_get_host_port(host, port)  \
 104         (host_get_special_port((host),  \
 105         HOST_LOCAL_NODE, HOST_PORT, (port)))
 106 #define host_set_host_port(host, port) (KERN_INVALID_ARGUMENT)
 107
 108 #define host_get_host_priv_port(host, port)     \
 109         (host_get_special_port((host),          \
 110         HOST_LOCAL_NODE, HOST_PRIV_PORT, (port)))
 111 #define host_set_host_priv_port(host, port) (KERN_INVALID_ARGUMENT)
 112
 113 #define host_get_io_master_port(host, port)     \
 114         (host_get_special_port((host),          \
 115         HOST_LOCAL_NODE, HOST_IO_MASTER_PORT, (port)))
 116 #define host_set_io_master_port(host, port) (KERN_INVALID_ARGUMENT)
 117
 118 /*
 119  * User-settable special ports.
 120  */
 121 #define host_get_dynamic_pager_port(host, port) \
 122         (host_get_special_port((host),                  \
 123         HOST_LOCAL_NODE, HOST_DYNAMIC_PAGER_PORT, (port)))
 124 #define host_set_dynamic_pager_port(host, port) \
 125         (host_set_special_port((host), HOST_DYNAMIC_PAGER_PORT, (port)))
 126
 127 #define host_get_audit_control_port(host, port) \
 128         (host_get_special_port((host),          \
 129         HOST_LOCAL_NODE, HOST_AUDIT_CONTROL_PORT, (port)))
 130 #define host_set_audit_control_port(host, port) \
 131         (host_set_special_port((host), HOST_AUDIT_CONTROL_PORT, (port)))
 132
 133 #define host_get_user_notification_port(host, port)     \
 134         (host_get_special_port((host),                  \
 135         HOST_LOCAL_NODE, HOST_USER_NOTIFICATION_PORT, (port)))
 136 #define host_set_user_notification_port(host, port)     \
 137         (host_set_special_port((host), HOST_USER_NOTIFICATION_PORT, (port)))
 138
 139 #define host_get_lockd_port(host, port) \
 140         (host_get_special_port((host),                  \
 141         HOST_LOCAL_NODE, HOST_LOCKD_PORT, (port)))
 142 #define host_set_lockd_port(host, port) \
 143         (host_set_special_port((host), HOST_LOCKD_PORT, (port)))
 144
 145 #endif  /* _MACH_HOST_SPECIAL_PORTS_H_ */