[apple/xnu.git] / osfmk / ipc / ipc_init.c

/*
 * Copyright (c) 2000-2007 Apple Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 * 
 * 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 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 * 
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ 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, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */
/*
 * @OSF_COPYRIGHT@
 */
/* 
 * 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  Software.Distribution@CS.CMU.EDU
 *  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.
 */
/*
 * NOTICE: This file was modified by McAfee Research in 2004 to introduce
 * support for mandatory and extensible security protections.  This notice
 * is included in support of clause 2.2 (b) of the Apple Public License,
 * Version 2.0.
 * Copyright (c) 2005 SPARTA, Inc.
 */
/*
 */
/*
 *	File:	ipc/ipc_init.c
 *	Author:	Rich Draves
 *	Date:	1989
 *
 *	Functions to initialize the IPC system.
 */

#include <mach_debug.h>
#include <mach_rt.h>

#include <mach/port.h>
#include <mach/kern_return.h>

#include <kern/kern_types.h>
#include <kern/kalloc.h>
#include <kern/mach_param.h>
#include <kern/ipc_host.h>
#include <kern/ipc_mig.h>
#include <kern/host_notify.h>
#include <kern/mk_timer.h>
#include <kern/misc_protos.h>
#include <kern/sync_lock.h>
#include <kern/sync_sema.h>
#include <vm/vm_map.h>
#include <vm/vm_kern.h>

#include <ipc/ipc_entry.h>
#include <ipc/ipc_space.h>
#include <ipc/ipc_object.h>
#include <ipc/ipc_port.h>
#include <ipc/ipc_pset.h>
#include <ipc/ipc_notify.h>
#include <ipc/ipc_kmsg.h>
#include <ipc/ipc_hash.h>
#include <ipc/ipc_init.h>
#include <ipc/ipc_table.h>

#include <mach/machine/ndr_def.h>   /* NDR_record */
#include <ipc/ipc_labelh.h>

vm_map_t ipc_kernel_map;
vm_size_t ipc_kernel_map_size = 1024 * 1024;

vm_map_t ipc_kernel_copy_map;
#define IPC_KERNEL_COPY_MAP_SIZE (8 * 1024 * 1024)
vm_size_t ipc_kernel_copy_map_size = IPC_KERNEL_COPY_MAP_SIZE;
vm_size_t ipc_kmsg_max_vm_space = (IPC_KERNEL_COPY_MAP_SIZE * 7)/8;

int ipc_space_max;
int ipc_tree_entry_max;
int ipc_port_max;
int ipc_pset_max;


lck_grp_t 		ipc_lck_grp;
lck_attr_t 		ipc_lck_attr;

static lck_grp_attr_t	ipc_lck_grp_attr;

extern void ikm_cache_init(void);

/*
 *	Routine:	ipc_bootstrap
 *	Purpose:
 *		Initialization needed before the kernel task
 *		can be created.
 */

void
ipc_bootstrap(void)
{
	kern_return_t kr;
	
	lck_grp_attr_setdefault(&ipc_lck_grp_attr);
	lck_grp_init(&ipc_lck_grp, "ipc", &ipc_lck_grp_attr);
	lck_attr_setdefault(&ipc_lck_attr);
	
	ipc_port_multiple_lock_init();

	ipc_port_timestamp_lock_init();
	ipc_port_timestamp_data = 0;

	/* all IPC zones should be exhaustible */

	ipc_space_zone = zinit(sizeof(struct ipc_space),
			       ipc_space_max * sizeof(struct ipc_space),
			       sizeof(struct ipc_space),
			       "ipc spaces");
#if 0
	/* make it exhaustible */
	zone_change(ipc_space_zone, Z_EXHAUST, TRUE);
#endif
	zone_change(ipc_space_zone, Z_NOENCRYPT, TRUE);

	ipc_tree_entry_zone =
		zinit(sizeof(struct ipc_tree_entry),
			ipc_tree_entry_max * sizeof(struct ipc_tree_entry),
			sizeof(struct ipc_tree_entry),
			"ipc tree entries");
#if 0
	/* make it exhaustible */
	zone_change(ipc_tree_entry_zone, Z_EXHAUST, TRUE);
#endif
	zone_change(ipc_tree_entry_zone, Z_NOENCRYPT, TRUE);

	/*
	 * populate all port(set) zones
	 */
	ipc_object_zones[IOT_PORT] =
		zinit(sizeof(struct ipc_port),
		      ipc_port_max * sizeof(struct ipc_port),
		      sizeof(struct ipc_port),
		      "ipc ports");
	/*
	 * XXX  Can't make the port zone exhaustible because the kernel
	 * XXX	panics when port allocation for an internal object fails.
	 *zone_change(ipc_object_zones[IOT_PORT], Z_EXHAUST, TRUE);
	 */
	zone_change(ipc_object_zones[IOT_PORT], Z_NOENCRYPT, TRUE);

	ipc_object_zones[IOT_PORT_SET] =
		zinit(sizeof(struct ipc_pset),
		      ipc_pset_max * sizeof(struct ipc_pset),
		      sizeof(struct ipc_pset),
		      "ipc port sets");
	/* make it exhaustible */
	zone_change(ipc_object_zones[IOT_PORT_SET], Z_EXHAUST, TRUE);
	zone_change(ipc_object_zones[IOT_PORT_SET], Z_NOENCRYPT, TRUE);

	/*
	 * Create the basic ipc_kmsg_t zone (the one we also cache)
	 * elements at the processor-level to avoid the locking.
	 */
	ipc_kmsg_zone = zinit(IKM_SAVED_KMSG_SIZE,
			      ipc_port_max * MACH_PORT_QLIMIT_DEFAULT *
			      IKM_SAVED_KMSG_SIZE,
			      IKM_SAVED_KMSG_SIZE,
			      "ipc kmsgs");
	zone_change(ipc_kmsg_zone, Z_NOENCRYPT, TRUE);

#if CONFIG_MACF_MACH
	ipc_labelh_zone = 
		zinit(sizeof(struct ipc_labelh),
		      ipc_port_max * sizeof(struct ipc_labelh),
		      sizeof(struct ipc_labelh),
		      "label handles");
#endif

	/* create special spaces */

	kr = ipc_space_create_special(&ipc_space_kernel);
	assert(kr == KERN_SUCCESS);


	kr = ipc_space_create_special(&ipc_space_reply);
	assert(kr == KERN_SUCCESS);

	/* initialize modules with hidden data structures */

#if	MACH_ASSERT
	ipc_port_debug_init();
#endif
	mig_init();
	ipc_table_init();
	ipc_hash_init();
	semaphore_init();
	lock_set_init();
	mk_timer_init();
	host_notify_init();
}

/* 
 * XXX tunable, belongs in mach.message.h 
 */
#define MSG_OOL_SIZE_SMALL_MAX 4096
vm_size_t msg_ool_size_small;

/*
 *	Routine:	ipc_init
 *	Purpose:
 *		Final initialization of the IPC system.
 */

void
ipc_init(void)
{
	kern_return_t retval;
	vm_offset_t min;

	retval = kmem_suballoc(kernel_map, &min, ipc_kernel_map_size,
			       TRUE, VM_FLAGS_ANYWHERE, &ipc_kernel_map);

	if (retval != KERN_SUCCESS)
		panic("ipc_init: kmem_suballoc of ipc_kernel_map failed");

	retval = kmem_suballoc(kernel_map, &min, ipc_kernel_copy_map_size,
			       TRUE, VM_FLAGS_ANYWHERE, &ipc_kernel_copy_map);

	if (retval != KERN_SUCCESS)
		panic("ipc_init: kmem_suballoc of ipc_kernel_copy_map failed");

	ipc_kernel_copy_map->no_zero_fill = TRUE;
	ipc_kernel_copy_map->wait_for_space = TRUE;

	/*
	 * As an optimization, 'small' out of line data regions using a 
	 * physical copy strategy are copied into kalloc'ed buffers.
	 * The value of 'small' is determined here.  Requests kalloc()
	 * with sizes greater or equal to kalloc_max_prerounded may fail.
	 */
	if (kalloc_max_prerounded <=  MSG_OOL_SIZE_SMALL_MAX) {
		msg_ool_size_small = kalloc_max_prerounded;
	}
	else {
		msg_ool_size_small = MSG_OOL_SIZE_SMALL_MAX;
	}

	ipc_host_init();
}
Commit	Line	Data
1c79356b	1	/*
2d21ac55	2	* Copyright (c) 2000-2007 Apple Inc. All rights reserved.
1c79356b	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b	5	*
2d21ac55 A	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.
8f6c56a5	14	*
2d21ac55 A	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
8f6c56a5 A	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
8f6c56a5 A	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55 A	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.
8f6c56a5	25	*
2d21ac55	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b A	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 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	*/
2d21ac55 A	56	/*
	57	* NOTICE: This file was modified by McAfee Research in 2004 to introduce
	58	* support for mandatory and extensible security protections. This notice
	59	* is included in support of clause 2.2 (b) of the Apple Public License,
	60	* Version 2.0.
	61	* Copyright (c) 2005 SPARTA, Inc.
	62	*/
1c79356b A	63	/*
	64	*/
	65	/*
	66	* File: ipc/ipc_init.c
	67	* Author: Rich Draves
	68	* Date: 1989
	69	*
	70	* Functions to initialize the IPC system.
	71	*/
	72
	73	#include <mach_debug.h>
	74	#include <mach_rt.h>
	75
91447636	76	#include <mach/port.h>
1c79356b	77	#include <mach/kern_return.h>
91447636 A	78
	79	#include <kern/kern_types.h>
	80	#include <kern/kalloc.h>
1c79356b A	81	#include <kern/mach_param.h>
1c79356b A	82	#include <kern/ipc_host.h>
91447636	83	#include <kern/ipc_mig.h>
55e303ae A	84	#include <kern/host_notify.h>
55e303ae A	85	#include <kern/mk_timer.h>
1c79356b	86	#include <kern/misc_protos.h>
91447636 A	87	#include <kern/sync_lock.h>
91447636 A	88	#include <kern/sync_sema.h>
1c79356b A	89	#include <vm/vm_map.h>
1c79356b A	90	#include <vm/vm_kern.h>
91447636	91
1c79356b A	92	#include <ipc/ipc_entry.h>
	93	#include <ipc/ipc_space.h>
	94	#include <ipc/ipc_object.h>
	95	#include <ipc/ipc_port.h>
	96	#include <ipc/ipc_pset.h>
	97	#include <ipc/ipc_notify.h>
	98	#include <ipc/ipc_kmsg.h>
	99	#include <ipc/ipc_hash.h>
	100	#include <ipc/ipc_init.h>
91447636 A	101	#include <ipc/ipc_table.h>
91447636 A	102
1c79356b	103	#include <mach/machine/ndr_def.h> /* NDR_record */
2d21ac55	104	#include <ipc/ipc_labelh.h>
1c79356b A	105
	106	vm_map_t ipc_kernel_map;
	107	vm_size_t ipc_kernel_map_size = 1024 * 1024;
	108
	109	vm_map_t ipc_kernel_copy_map;
	110	#define IPC_KERNEL_COPY_MAP_SIZE (8 * 1024 * 1024)
	111	vm_size_t ipc_kernel_copy_map_size = IPC_KERNEL_COPY_MAP_SIZE;
	112	vm_size_t ipc_kmsg_max_vm_space = (IPC_KERNEL_COPY_MAP_SIZE * 7)/8;
	113
b0d623f7 A	114	int ipc_space_max;
	115	int ipc_tree_entry_max;
	116	int ipc_port_max;
	117	int ipc_pset_max;
	118
	119
	120	lck_grp_t ipc_lck_grp;
	121	lck_attr_t ipc_lck_attr;
	122
	123	static lck_grp_attr_t ipc_lck_grp_attr;
1c79356b	124
1c79356b A	125	extern void ikm_cache_init(void);
	126
	127	/*
	128	* Routine: ipc_bootstrap
	129	* Purpose:
	130	* Initialization needed before the kernel task
	131	* can be created.
	132	*/
	133
	134	void
	135	ipc_bootstrap(void)
	136	{
	137	kern_return_t kr;
b0d623f7 A	138
	139	lck_grp_attr_setdefault(&ipc_lck_grp_attr);
	140	lck_grp_init(&ipc_lck_grp, "ipc", &ipc_lck_grp_attr);
	141	lck_attr_setdefault(&ipc_lck_attr);
	142
1c79356b A	143	ipc_port_multiple_lock_init();
	144
	145	ipc_port_timestamp_lock_init();
	146	ipc_port_timestamp_data = 0;
	147
	148	/* all IPC zones should be exhaustible */
	149
	150	ipc_space_zone = zinit(sizeof(struct ipc_space),
	151	ipc_space_max * sizeof(struct ipc_space),
	152	sizeof(struct ipc_space),
	153	"ipc spaces");
	154	#if 0
	155	/* make it exhaustible */
	156	zone_change(ipc_space_zone, Z_EXHAUST, TRUE);
	157	#endif
0b4c1975	158	zone_change(ipc_space_zone, Z_NOENCRYPT, TRUE);
1c79356b A	159
	160	ipc_tree_entry_zone =
	161	zinit(sizeof(struct ipc_tree_entry),
	162	ipc_tree_entry_max * sizeof(struct ipc_tree_entry),
	163	sizeof(struct ipc_tree_entry),
	164	"ipc tree entries");
	165	#if 0
	166	/* make it exhaustible */
	167	zone_change(ipc_tree_entry_zone, Z_EXHAUST, TRUE);
	168	#endif
0b4c1975	169	zone_change(ipc_tree_entry_zone, Z_NOENCRYPT, TRUE);
1c79356b A	170
	171	/*
	172	* populate all port(set) zones
	173	*/
	174	ipc_object_zones[IOT_PORT] =
	175	zinit(sizeof(struct ipc_port),
	176	ipc_port_max * sizeof(struct ipc_port),
	177	sizeof(struct ipc_port),
	178	"ipc ports");
	179	/*
	180	* XXX Can't make the port zone exhaustible because the kernel
	181	* XXX panics when port allocation for an internal object fails.
	182	*zone_change(ipc_object_zones[IOT_PORT], Z_EXHAUST, TRUE);
	183	*/
0b4c1975	184	zone_change(ipc_object_zones[IOT_PORT], Z_NOENCRYPT, TRUE);
1c79356b A	185
	186	ipc_object_zones[IOT_PORT_SET] =
	187	zinit(sizeof(struct ipc_pset),
	188	ipc_pset_max * sizeof(struct ipc_pset),
	189	sizeof(struct ipc_pset),
	190	"ipc port sets");
	191	/* make it exhaustible */
	192	zone_change(ipc_object_zones[IOT_PORT_SET], Z_EXHAUST, TRUE);
0b4c1975	193	zone_change(ipc_object_zones[IOT_PORT_SET], Z_NOENCRYPT, TRUE);
1c79356b	194
91447636 A	195	/*
	196	* Create the basic ipc_kmsg_t zone (the one we also cache)
	197	* elements at the processor-level to avoid the locking.
	198	*/
	199	ipc_kmsg_zone = zinit(IKM_SAVED_KMSG_SIZE,
2d21ac55	200	ipc_port_max * MACH_PORT_QLIMIT_DEFAULT *
91447636 A	201	IKM_SAVED_KMSG_SIZE,
	202	IKM_SAVED_KMSG_SIZE,
	203	"ipc kmsgs");
0b4c1975	204	zone_change(ipc_kmsg_zone, Z_NOENCRYPT, TRUE);
91447636	205
2d21ac55 A	206	#if CONFIG_MACF_MACH
	207	ipc_labelh_zone =
	208	zinit(sizeof(struct ipc_labelh),
	209	ipc_port_max * sizeof(struct ipc_labelh),
	210	sizeof(struct ipc_labelh),
	211	"label handles");
	212	#endif
	213
1c79356b A	214	/* create special spaces */
	215
	216	kr = ipc_space_create_special(&ipc_space_kernel);
	217	assert(kr == KERN_SUCCESS);
	218
	219
	220	kr = ipc_space_create_special(&ipc_space_reply);
	221	assert(kr == KERN_SUCCESS);
	222
	223	/* initialize modules with hidden data structures */
	224
	225	#if MACH_ASSERT
	226	ipc_port_debug_init();
	227	#endif
	228	mig_init();
	229	ipc_table_init();
1c79356b	230	ipc_hash_init();
1c79356b A	231	semaphore_init();
1c79356b A	232	lock_set_init();
55e303ae A	233	mk_timer_init();
55e303ae A	234	host_notify_init();
1c79356b A	235	}
	236
	237	/*
	238	* XXX tunable, belongs in mach.message.h
	239	*/
	240	#define MSG_OOL_SIZE_SMALL_MAX 4096
	241	vm_size_t msg_ool_size_small;
	242
	243	/*
	244	* Routine: ipc_init
	245	* Purpose:
	246	* Final initialization of the IPC system.
	247	*/
	248
	249	void
	250	ipc_init(void)
	251	{
	252	kern_return_t retval;
91447636	253	vm_offset_t min;
1c79356b A	254
1c79356b A	255	retval = kmem_suballoc(kernel_map, &min, ipc_kernel_map_size,
91447636 A	256	TRUE, VM_FLAGS_ANYWHERE, &ipc_kernel_map);
91447636 A	257
1c79356b A	258	if (retval != KERN_SUCCESS)
	259	panic("ipc_init: kmem_suballoc of ipc_kernel_map failed");
	260
	261	retval = kmem_suballoc(kernel_map, &min, ipc_kernel_copy_map_size,
91447636 A	262	TRUE, VM_FLAGS_ANYWHERE, &ipc_kernel_copy_map);
91447636 A	263
1c79356b A	264	if (retval != KERN_SUCCESS)
	265	panic("ipc_init: kmem_suballoc of ipc_kernel_copy_map failed");
	266
	267	ipc_kernel_copy_map->no_zero_fill = TRUE;
	268	ipc_kernel_copy_map->wait_for_space = TRUE;
	269
	270	/*
	271	* As an optimization, 'small' out of line data regions using a
	272	* physical copy strategy are copied into kalloc'ed buffers.
	273	* The value of 'small' is determined here. Requests kalloc()
	274	* with sizes greater or equal to kalloc_max_prerounded may fail.
	275	*/
	276	if (kalloc_max_prerounded <= MSG_OOL_SIZE_SMALL_MAX) {
	277	msg_ool_size_small = kalloc_max_prerounded;
	278	}
	279	else {
	280	msg_ool_size_small = MSG_OOL_SIZE_SMALL_MAX;
	281	}
	282
	283	ipc_host_init();
	284	}