osfmk/mach/host_special_ports.h

   1 /*
   2  * Copyright (c) 2003 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * Copyright (c) 1999-2003 Apple Computer, Inc.  All Rights Reserved.
   7  *
   8  * This file contains Original Code and/or Modifications of Original Code
   9  * as defined in and that are subject to the Apple Public Source License
  10  * Version 2.0 (the 'License'). You may not use this file except in
  11  * compliance with the License. Please obtain a copy of the License at
  12  * http://www.opensource.apple.com/apsl/ and read it before using this
  13  * file.
  14  *
  15  * The Original Code and all software distributed under the License are
  16  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  17  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  18  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  20  * Please see the License for the specific language governing rights and
  21  * limitations under the License.
  22  *
  23  * @APPLE_LICENSE_HEADER_END@
  24  */
  25 /*
  26  * @OSF_COPYRIGHT@
  27  */
  28 /*
  29  * Mach Operating System
  30  * Copyright (c) 1991 Carnegie Mellon University
  31  * All Rights Reserved.
  32  *
  33  * Permission to use, copy, modify and distribute this software and its
  34  * documentation is hereby granted, provided that both the copyright
  35  * notice and this permission notice appear in all copies of the
  36  * software, derivative works or modified versions, and any portions
  37  * thereof, and that both notices appear in supporting documentation.
  38  *
  39  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
  40  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
  41  * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
  42  *
  43  * Carnegie Mellon requests users of this software to return to
  44  *
  45  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
  46  *  School of Computer Science
  47  *  Carnegie Mellon University
  48  *  Pittsburgh PA 15213-3890
  49  *
  50  * any improvements or extensions that they make and grant Carnegie Mellon
  51  * the rights to redistribute these changes.
  52  */
  53 /*
  54  */
  55 /*
  56  *      File:   mach/host_special_ports.h
  57  *
  58  *      Defines codes for access to host-wide special ports.
  59  */
  60
  61 #ifndef _MACH_HOST_SPECIAL_PORTS_H_
  62 #define _MACH_HOST_SPECIAL_PORTS_H_
  63
  64 /*
  65  * Cannot be set or gotten from user space
  66  */
  67 #define HOST_SECURITY_PORT               0
  68
  69 /*
  70  * Always provided by kernel (cannot be set from user-space).
  71  */
  72 #define HOST_PORT                        1
  73 #define HOST_PRIV_PORT                   2
  74 #define HOST_IO_MASTER_PORT              3
  75 #define HOST_MAX_SPECIAL_KERNEL_PORT     7 /* room to grow */
  76
  77 /*
  78  * Not provided by kernel
  79  */
  80 #define HOST_DYNAMIC_PAGER_PORT         (1 + HOST_MAX_SPECIAL_KERNEL_PORT)
  81 #define HOST_AUDIT_CONTROL_PORT         (2 + HOST_MAX_SPECIAL_KERNEL_PORT)
  82 #define HOST_USER_NOTIFICATION_PORT     (3 + HOST_MAX_SPECIAL_KERNEL_PORT)
  83 #define HOST_MAX_SPECIAL_PORT           (8 + HOST_MAX_SPECIAL_KERNEL_PORT)
  84                                         /* room to grow here as well */
  85
  86 /*
  87  * Special node identifier to always represent the local node.
  88  */
  89 #define HOST_LOCAL_NODE                  -1
  90
  91 /*
  92  * Definitions for ease of use.
  93  *
  94  * In the get call, the host parameter can be any host, but will generally
  95  * be the local node host port. In the set call, the host must the per-node
  96  * host port for the node being affected.
  97  */
  98 #define host_get_host_port(host, port)  \
  99         (host_get_special_port((host),  \
 100         HOST_LOCAL_NODE, HOST_PORT, (port)))
 101 #define host_set_host_port(host, port) (KERN_INVALID_ARGUMENT)
 102
 103 #define host_get_host_priv_port(host, port)     \
 104         (host_get_special_port((host),          \
 105         HOST_LOCAL_NODE, HOST_PRIV_PORT, (port)))
 106 #define host_set_host_priv_port(host, port) (KERN_INVALID_ARGUMENT)
 107
 108 #define host_get_io_master_port(host, port)     \
 109         (host_get_special_port((host),          \
 110         HOST_LOCAL_NODE, HOST_IO_MASTER_PORT, (port)))
 111 #define host_set_io_master_port(host, port) (KERN_INVALID_ARGUMENT)
 112
 113 /*
 114  * User-settable special ports.
 115  */
 116 #define host_get_dynamic_pager_port(host, port) \
 117         (host_get_special_port((host),                  \
 118         HOST_LOCAL_NODE, HOST_DYNAMIC_PAGER_PORT, (port)))
 119 #define host_set_dynamic_pager_port(host, port) \
 120         (host_set_special_port((host), HOST_DYNAMIC_PAGER_PORT, (port)))
 121
 122 #define host_get_audit_control_port(host, port) \
 123         (host_get_special_port((host),          \
 124         HOST_LOCAL_NODE, HOST_AUDIT_CONTROL_PORT, (port)))
 125 #define host_set_audit_control_port(host, port) \
 126         (host_set_special_port((host), HOST_AUDIT_CONTROL_PORT, (port)))
 127
 128 #define host_get_user_notification_port(host, port)     \
 129         (host_get_special_port((host),                  \
 130         HOST_LOCAL_NODE, HOST_USER_NOTIFICATION_PORT, (port)))
 131 #define host_set_user_notification_port(host, port)     \
 132         (host_set_special_port((host), HOST_USER_NOTIFICATION_PORT, (port)))
 133
 134
 135 #endif  /* _MACH_HOST_SPECIAL_PORTS_H_ */