xref: /xnu-8020.101.4/osfmk/ipc/ipc_table.c (revision e7776783b89a353188416a9a346c6cdb4928faad)
1 /*
2  * Copyright (c) 2000-2004 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,1990,1989 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  [email protected]
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:	ipc/ipc_table.c
60  *	Author:	Rich Draves
61  *	Date:	1989
62  *
63  *	Functions to manipulate tables of IPC capabilities.
64  */
65 
66 #include <mach/kern_return.h>
67 #include <mach/vm_param.h>
68 #include <ipc/ipc_table.h>
69 #include <ipc/ipc_port.h>
70 #include <ipc/ipc_entry.h>
71 #include <kern/kalloc.h>
72 #include <kern/hazard.h>
73 #include <vm/vm_kern.h>
74 
75 #define IPC_TABLE_ENTRIES_SIZE CONFIG_IPC_TABLE_ENTRIES_STEPS
76 SECURITY_READ_ONLY_LATE(struct ipc_table_size) ipc_table_entries[IPC_TABLE_ENTRIES_SIZE];
77 
78 #define IPC_TABLE_REQUESTS_SIZE 64
79 SECURITY_READ_ONLY_LATE(struct ipc_table_size) ipc_table_requests[IPC_TABLE_REQUESTS_SIZE];
80 
81 static void
ipc_table_fill(ipc_table_size_t its,unsigned int num,unsigned int min,vm_size_t elemsize)82 ipc_table_fill(
83 	ipc_table_size_t        its,         /* array to fill */
84 	unsigned int            num,         /* size of array */
85 	unsigned int            min,         /* at least this many elements */
86 	vm_size_t               elemsize)    /* size of elements */
87 {
88 	unsigned int index;
89 	vm_size_t minsize = min * elemsize;
90 	vm_size_t size;
91 	vm_size_t incrsize;
92 
93 	/* first use powers of two, up to the page size */
94 
95 	for (index = 0, size = 1;
96 	    (index < num) && (size < PAGE_MAX_SIZE);
97 	    size <<= 1) {
98 		if (size >= minsize) {
99 			its[index].its_size = (ipc_table_elems_t)(size / elemsize);
100 			index++;
101 		}
102 	}
103 
104 	/* then increments of a page, then two pages, etc. */
105 
106 	for (incrsize = PAGE_MAX_SIZE; index < num;) {
107 		unsigned int period;
108 
109 		for (period = 0;
110 		    (period < 15) && (index < num);
111 		    period++, size += incrsize) {
112 			if (size >= minsize) {
113 				its[index].its_size = (ipc_table_elems_t)(size / elemsize);
114 				index++;
115 			}
116 		}
117 		if (incrsize < (vm_size_t)(PAGE_MAX_SIZE << 3)) {
118 			incrsize <<= 1;
119 		}
120 	}
121 }
122 
123 __startup_func
124 static void
ipc_table_init(void)125 ipc_table_init(void)
126 {
127 	ipc_table_fill(ipc_table_entries, IPC_TABLE_ENTRIES_SIZE - 1,
128 	    16, sizeof(struct ipc_entry));
129 
130 	/* the last two elements should have the same size */
131 
132 	ipc_table_entries[IPC_TABLE_ENTRIES_SIZE - 1].its_size =
133 	    ipc_table_entries[IPC_TABLE_ENTRIES_SIZE - 2].its_size;
134 
135 	/* make sure the robin hood hashing in ipc hash will work */
136 	assert(ipc_table_entries[IPC_TABLE_ENTRIES_SIZE - 1].its_size <=
137 	    IPC_ENTRY_INDEX_MAX);
138 
139 	ipc_table_fill(ipc_table_requests, IPC_TABLE_REQUESTS_SIZE - 1,
140 	    2, sizeof(struct ipc_port_request));
141 
142 	/* the last element should have zero size */
143 
144 	ipc_table_requests[IPC_TABLE_REQUESTS_SIZE - 1].its_size = 0;
145 }
146 STARTUP(MACH_IPC, STARTUP_RANK_FIRST, ipc_table_init);
147 
148 
149 /*
150  *	Routine: ipc_table_max_entries
151  *	Purpose:
152  *		returns the maximum number of entries an IPC space
153  *		is allowed to contain (the maximum size to which it will grow)
154  *	Conditions:
155  *		none
156  */
157 unsigned int
ipc_table_max_entries(void)158 ipc_table_max_entries(void)
159 {
160 	static_assert(IPC_TABLE_ENTRIES_SIZE >= 1);
161 	return (unsigned int)ipc_table_entries[IPC_TABLE_ENTRIES_SIZE - 1].its_size;
162 }
163 
164 
165 /*
166  *	Routine: ipc_table_max_requests
167  *	Purpose:
168  *		returns the maximum number of requests an IPC request table
169  *		is allowed to contain (the maximum size to which it will grow)
170  *	Conditions:
171  *		none
172  */
173 unsigned int
ipc_table_max_requests(void)174 ipc_table_max_requests(void)
175 {
176 	static_assert(IPC_TABLE_REQUESTS_SIZE >= 2);
177 	return (unsigned int)ipc_table_requests[IPC_TABLE_REQUESTS_SIZE - 2].its_size;
178 }
179