xref: /xnu-11215.1.10/libsyscall/mach/mach/port_descriptions.h (revision 8d741a5de7ff4191bf97d57b9f54c2f6d4a15585)
1 /*
2  * Copyright (c) 2018 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 #ifndef _MACH_PORT_DESCRIPTIONS_
29 #define _MACH_PORT_DESCRIPTIONS_
30 
31 #include <sys/cdefs.h>
32 
33 __BEGIN_DECLS
34 
35 /*
36  * Returns a string describing the host special port offset provided, or NULL if
37  * the provided offset is not a host special port offset.
38  */
39 const char *mach_host_special_port_description(int offset);
40 
41 /*
42  * Returns a string describing the task special port offset provided, or NULL if
43  * the provided offset is not a task special port offset.
44  */
45 const char *mach_task_special_port_description(int offset);
46 
47 /*
48  * Returns a string describing the thread special port offset provided, or NULL if
49  * the provided offset is not a thread special port offset.
50  */
51 const char *mach_thread_special_port_description(int offset);
52 
53 /*
54  * Returns the port for the given identifier of a host special port.  For
55  * instance, passing "HOST_PRIV_PORT" would return 1.
56  *
57  * Returns -1 on error.
58  */
59 int mach_host_special_port_for_id(const char *id);
60 
61 /*
62  * Returns the port for the given identifier of a task special port.
63  *
64  * Returns -1 on error.
65  */
66 int mach_task_special_port_for_id(const char *id);
67 
68 /*
69  * Returns the port for the given identifier of a thread special port.
70  *
71  * Returns -1 on error.
72  */
73 int mach_thread_special_port_for_id(const char *id);
74 
75 __END_DECLS
76 
77 #endif /* !defined(_MACH_PORT_DESCRIPTIONS_) */
78