[apple/xnu.git] / osfmk / kern / mk_sp.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@
 * 
 */

/* The routines in this module are all obsolete */

#include <mach/boolean.h>
#include <mach/thread_switch.h>
#include <ipc/ipc_port.h>
#include <ipc/ipc_space.h>
#include <kern/ipc_kobject.h>
#include <kern/processor.h>
#include <kern/sched.h>
#include <kern/sched_prim.h>
#include <kern/spl.h>
#include <kern/task.h>
#include <kern/thread.h>
#include <mach/policy.h>
#include <kern/policy_internal.h>

#include <kern/syscall_subr.h>
#include <mach/mach_host_server.h>
#include <mach/mach_syscalls.h>

#include <kern/misc_protos.h>
#include <kern/spl.h>
#include <kern/sched.h>
#include <kern/sched_prim.h>
#include <kern/assert.h>
#include <kern/thread.h>
#include <mach/mach_host_server.h>
#include <mach/thread_act_server.h>
#include <mach/host_priv_server.h>


/*
 *	thread_set_policy
 *
 *	Set scheduling policy and parameters, both base and limit, for 
 *	the given thread. Policy can be any policy implemented by the
 *	processor set, whether enabled or not. 
 */
kern_return_t
thread_set_policy(
	thread_t				thread,
	processor_set_t			pset,
	policy_t				policy,
	policy_base_t			base,
	mach_msg_type_number_t	base_count,
	policy_limit_t			limit,
	mach_msg_type_number_t	limit_count)
{
	int 					max, bas;
	kern_return_t			result = KERN_SUCCESS;

	if (	thread == THREAD_NULL			||
			pset == PROCESSOR_SET_NULL || pset != &pset0)
		return (KERN_INVALID_ARGUMENT);

	if (invalid_policy(policy))
		return(KERN_INVALID_ARGUMENT);	

	switch (policy) {

	case POLICY_RR:
	{
		policy_rr_base_t		rr_base = (policy_rr_base_t) base;
		policy_rr_limit_t		rr_limit = (policy_rr_limit_t) limit;

		if (	base_count != POLICY_RR_BASE_COUNT		||
				limit_count != POLICY_RR_LIMIT_COUNT		) {
			result = KERN_INVALID_ARGUMENT;
			break;
		}

		bas = rr_base->base_priority;
		max = rr_limit->max_priority;
		if (invalid_pri(bas) || invalid_pri(max)) {
			result = KERN_INVALID_ARGUMENT;
			break;
		}

		break;
	}

	case POLICY_FIFO:
	{
		policy_fifo_base_t		fifo_base = (policy_fifo_base_t) base;
		policy_fifo_limit_t		fifo_limit = (policy_fifo_limit_t) limit;

		if (	base_count != POLICY_FIFO_BASE_COUNT	||
				limit_count != POLICY_FIFO_LIMIT_COUNT)		{
			result = KERN_INVALID_ARGUMENT;
			break;
		}

		bas = fifo_base->base_priority;
		max = fifo_limit->max_priority;
		if (invalid_pri(bas) || invalid_pri(max)) {
			result = KERN_INVALID_ARGUMENT;
			break;
		}

		break;
	}

	case POLICY_TIMESHARE:
	{
		policy_timeshare_base_t		ts_base = (policy_timeshare_base_t) base;
		policy_timeshare_limit_t	ts_limit =
						(policy_timeshare_limit_t) limit;

		if (	base_count != POLICY_TIMESHARE_BASE_COUNT		||
				limit_count != POLICY_TIMESHARE_LIMIT_COUNT			) {
			result = KERN_INVALID_ARGUMENT;
			break;
		}

		bas = ts_base->base_priority;
		max = ts_limit->max_priority;
		if (invalid_pri(bas) || invalid_pri(max)) {
			result = KERN_INVALID_ARGUMENT;
			break;
		}

		break;
	}

	default:
		result = KERN_INVALID_POLICY;
	}

	if (result != KERN_SUCCESS) {
		return (result);
	}

	/* Note that we do not pass on max priority. */
	if (result == KERN_SUCCESS) {
	    result = thread_set_mode_and_absolute_pri(thread, policy, bas);
	}

	return (result);
}


/*
 * 	thread_policy
 *
 *	Set scheduling policy and parameters, both base and limit, for
 *	the given thread. Policy must be a policy which is enabled for the
 *	processor set. Change contained threads if requested. 
 */
kern_return_t
thread_policy(
	thread_t				thread,
	policy_t				policy,
	policy_base_t			base,
	mach_msg_type_number_t	count,
	boolean_t				set_limit)
{
	kern_return_t			result = KERN_SUCCESS;
	processor_set_t			pset = &pset0;
	policy_limit_t			limit = NULL;
	int						limcount = 0;
	policy_rr_limit_data_t			rr_limit;
	policy_fifo_limit_data_t		fifo_limit;
	policy_timeshare_limit_data_t	ts_limit;
	
	if (thread == THREAD_NULL)
		return (KERN_INVALID_ARGUMENT);

	thread_mtx_lock(thread);

	if (	invalid_policy(policy)											||
			((POLICY_TIMESHARE | POLICY_RR | POLICY_FIFO) & policy) == 0	) {
		thread_mtx_unlock(thread);

		return (KERN_INVALID_POLICY);
	}

	if (set_limit) {
		/*
	 	 * 	Set scheduling limits to base priority.
		 */
		switch (policy) {

		case POLICY_RR:
		{
			policy_rr_base_t rr_base;

			if (count != POLICY_RR_BASE_COUNT) {
				result = KERN_INVALID_ARGUMENT;
				break;
			}

			limcount = POLICY_RR_LIMIT_COUNT;
			rr_base = (policy_rr_base_t) base;
			rr_limit.max_priority = rr_base->base_priority;
			limit = (policy_limit_t) &rr_limit;

			break;
		}

		case POLICY_FIFO:
		{
			policy_fifo_base_t fifo_base;

			if (count != POLICY_FIFO_BASE_COUNT) {
				result = KERN_INVALID_ARGUMENT;
				break;
			}

			limcount = POLICY_FIFO_LIMIT_COUNT;
			fifo_base = (policy_fifo_base_t) base;
			fifo_limit.max_priority = fifo_base->base_priority;
			limit = (policy_limit_t) &fifo_limit;

			break;
		}

		case POLICY_TIMESHARE:
		{
			policy_timeshare_base_t ts_base;

			if (count != POLICY_TIMESHARE_BASE_COUNT) {
				result = KERN_INVALID_ARGUMENT;
				break;
			}

			limcount = POLICY_TIMESHARE_LIMIT_COUNT;
			ts_base = (policy_timeshare_base_t) base;
			ts_limit.max_priority = ts_base->base_priority;
			limit = (policy_limit_t) &ts_limit;

			break;
		}

		default:
			result = KERN_INVALID_POLICY;
			break;
		}

	}
	else {
		/*
		 *	Use current scheduling limits. Ensure that the
		 *	new base priority will not exceed current limits.
		 */
		switch (policy) {

		case POLICY_RR:
		{
			policy_rr_base_t rr_base;

			if (count != POLICY_RR_BASE_COUNT) {
				result = KERN_INVALID_ARGUMENT;
				break;
			}

			limcount = POLICY_RR_LIMIT_COUNT;
			rr_base = (policy_rr_base_t) base;
			if (rr_base->base_priority > thread->max_priority) {
				result = KERN_POLICY_LIMIT;
				break;
			}

			rr_limit.max_priority = thread->max_priority;
			limit = (policy_limit_t) &rr_limit;

			break;
		}

		case POLICY_FIFO:
		{
			policy_fifo_base_t fifo_base;

			if (count != POLICY_FIFO_BASE_COUNT) {
				result = KERN_INVALID_ARGUMENT;
				break;
			}

			limcount = POLICY_FIFO_LIMIT_COUNT;
			fifo_base = (policy_fifo_base_t) base;
			if (fifo_base->base_priority > thread->max_priority) {
				result = KERN_POLICY_LIMIT;
				break;
			}

			fifo_limit.max_priority = thread->max_priority;
			limit = (policy_limit_t) &fifo_limit;

			break;
		}

		case POLICY_TIMESHARE:
		{
			policy_timeshare_base_t ts_base;

			if (count != POLICY_TIMESHARE_BASE_COUNT) {
				result = KERN_INVALID_ARGUMENT;
				break;
			}

			limcount = POLICY_TIMESHARE_LIMIT_COUNT;
			ts_base = (policy_timeshare_base_t) base;
			if (ts_base->base_priority > thread->max_priority) {
				result = KERN_POLICY_LIMIT;
				break;
			}

			ts_limit.max_priority = thread->max_priority;
			limit = (policy_limit_t) &ts_limit;

			break;
		}

		default:
			result = KERN_INVALID_POLICY;
			break;
		}

	}

	thread_mtx_unlock(thread);

	if (result == KERN_SUCCESS)
	    result = thread_set_policy(thread, pset,
					 policy, base, count, limit, limcount);

	return(result);
}
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
91447636	33	/* The routines in this module are all obsolete */
1c79356b A	34
	35	#include <mach/boolean.h>
	36	#include <mach/thread_switch.h>
	37	#include <ipc/ipc_port.h>
	38	#include <ipc/ipc_space.h>
	39	#include <kern/ipc_kobject.h>
	40	#include <kern/processor.h>
	41	#include <kern/sched.h>
	42	#include <kern/sched_prim.h>
	43	#include <kern/spl.h>
	44	#include <kern/task.h>
	45	#include <kern/thread.h>
1c79356b	46	#include <mach/policy.h>
39037602	47	#include <kern/policy_internal.h>
1c79356b A	48
	49	#include <kern/syscall_subr.h>
	50	#include <mach/mach_host_server.h>
	51	#include <mach/mach_syscalls.h>
	52
1c79356b A	53	#include <kern/misc_protos.h>
	54	#include <kern/spl.h>
	55	#include <kern/sched.h>
	56	#include <kern/sched_prim.h>
	57	#include <kern/assert.h>
	58	#include <kern/thread.h>
	59	#include <mach/mach_host_server.h>
1c79356b A	60	#include <mach/thread_act_server.h>
	61	#include <mach/host_priv_server.h>
	62
1c79356b A	63
	64	/*
	65	* thread_set_policy
	66	*
	67	* Set scheduling policy and parameters, both base and limit, for
	68	* the given thread. Policy can be any policy implemented by the
	69	* processor set, whether enabled or not.
	70	*/
	71	kern_return_t
	72	thread_set_policy(
91447636	73	thread_t thread,
1c79356b A	74	processor_set_t pset,
	75	policy_t policy,
	76	policy_base_t base,
	77	mach_msg_type_number_t base_count,
	78	policy_limit_t limit,
	79	mach_msg_type_number_t limit_count)
	80	{
0b4e3aa0	81	int max, bas;
1c79356b A	82	kern_return_t result = KERN_SUCCESS;
1c79356b A	83
91447636	84	if ( thread == THREAD_NULL \|\|
2d21ac55	85	pset == PROCESSOR_SET_NULL \|\| pset != &pset0)
1c79356b A	86	return (KERN_INVALID_ARGUMENT);
1c79356b A	87
fe8ab488 A	88	if (invalid_policy(policy))
	89	return(KERN_INVALID_ARGUMENT);
	90
1c79356b A	91	switch (policy) {
	92
	93	case POLICY_RR:
	94	{
	95	policy_rr_base_t rr_base = (policy_rr_base_t) base;
	96	policy_rr_limit_t rr_limit = (policy_rr_limit_t) limit;
	97
	98	if ( base_count != POLICY_RR_BASE_COUNT \|\|
	99	limit_count != POLICY_RR_LIMIT_COUNT ) {
	100	result = KERN_INVALID_ARGUMENT;
	101	break;
	102	}
	103
1c79356b A	104	bas = rr_base->base_priority;
	105	max = rr_limit->max_priority;
	106	if (invalid_pri(bas) \|\| invalid_pri(max)) {
	107	result = KERN_INVALID_ARGUMENT;
	108	break;
	109	}
	110
	111	break;
	112	}
	113
	114	case POLICY_FIFO:
	115	{
	116	policy_fifo_base_t fifo_base = (policy_fifo_base_t) base;
	117	policy_fifo_limit_t fifo_limit = (policy_fifo_limit_t) limit;
	118
	119	if ( base_count != POLICY_FIFO_BASE_COUNT \|\|
	120	limit_count != POLICY_FIFO_LIMIT_COUNT) {
	121	result = KERN_INVALID_ARGUMENT;
	122	break;
	123	}
	124
1c79356b A	125	bas = fifo_base->base_priority;
	126	max = fifo_limit->max_priority;
	127	if (invalid_pri(bas) \|\| invalid_pri(max)) {
	128	result = KERN_INVALID_ARGUMENT;
	129	break;
	130	}
	131
	132	break;
	133	}
	134
	135	case POLICY_TIMESHARE:
	136	{
	137	policy_timeshare_base_t ts_base = (policy_timeshare_base_t) base;
	138	policy_timeshare_limit_t ts_limit =
	139	(policy_timeshare_limit_t) limit;
	140
	141	if ( base_count != POLICY_TIMESHARE_BASE_COUNT \|\|
	142	limit_count != POLICY_TIMESHARE_LIMIT_COUNT ) {
	143	result = KERN_INVALID_ARGUMENT;
	144	break;
	145	}
	146
1c79356b A	147	bas = ts_base->base_priority;
	148	max = ts_limit->max_priority;
	149	if (invalid_pri(bas) \|\| invalid_pri(max)) {
	150	result = KERN_INVALID_ARGUMENT;
	151	break;
	152	}
	153
	154	break;
	155	}
	156
	157	default:
	158	result = KERN_INVALID_POLICY;
	159	}
	160
	161	if (result != KERN_SUCCESS) {
91447636	162	return (result);
1c79356b A	163	}
1c79356b A	164
fe8ab488 A	165	/* Note that we do not pass on max priority. */
	166	if (result == KERN_SUCCESS) {
	167	result = thread_set_mode_and_absolute_pri(thread, policy, bas);
	168	}
1c79356b	169
91447636	170	return (result);
1c79356b A	171	}
	172
	173
	174	/*
	175	* thread_policy
	176	*
	177	* Set scheduling policy and parameters, both base and limit, for
	178	* the given thread. Policy must be a policy which is enabled for the
	179	* processor set. Change contained threads if requested.
	180	*/
	181	kern_return_t
	182	thread_policy(
91447636	183	thread_t thread,
1c79356b A	184	policy_t policy,
	185	policy_base_t base,
	186	mach_msg_type_number_t count,
	187	boolean_t set_limit)
	188	{
1c79356b	189	kern_return_t result = KERN_SUCCESS;
2d21ac55 A	190	processor_set_t pset = &pset0;
	191	policy_limit_t limit = NULL;
	192	int limcount = 0;
1c79356b A	193	policy_rr_limit_data_t rr_limit;
	194	policy_fifo_limit_data_t fifo_limit;
	195	policy_timeshare_limit_data_t ts_limit;
	196
91447636	197	if (thread == THREAD_NULL)
1c79356b A	198	return (KERN_INVALID_ARGUMENT);
1c79356b A	199
91447636 A	200	thread_mtx_lock(thread);
91447636 A	201
0b4e3aa0 A	202	if ( invalid_policy(policy) \|\|
0b4e3aa0 A	203	((POLICY_TIMESHARE \| POLICY_RR \| POLICY_FIFO) & policy) == 0 ) {
91447636	204	thread_mtx_unlock(thread);
1c79356b	205
91447636	206	return (KERN_INVALID_POLICY);
1c79356b A	207	}
	208
	209	if (set_limit) {
	210	/*
	211	* Set scheduling limits to base priority.
	212	*/
	213	switch (policy) {
	214
	215	case POLICY_RR:
	216	{
	217	policy_rr_base_t rr_base;
	218
	219	if (count != POLICY_RR_BASE_COUNT) {
	220	result = KERN_INVALID_ARGUMENT;
	221	break;
	222	}
	223
	224	limcount = POLICY_RR_LIMIT_COUNT;
	225	rr_base = (policy_rr_base_t) base;
	226	rr_limit.max_priority = rr_base->base_priority;
	227	limit = (policy_limit_t) &rr_limit;
	228
	229	break;
	230	}
	231
	232	case POLICY_FIFO:
	233	{
	234	policy_fifo_base_t fifo_base;
	235
	236	if (count != POLICY_FIFO_BASE_COUNT) {
	237	result = KERN_INVALID_ARGUMENT;
	238	break;
	239	}
	240
	241	limcount = POLICY_FIFO_LIMIT_COUNT;
	242	fifo_base = (policy_fifo_base_t) base;
	243	fifo_limit.max_priority = fifo_base->base_priority;
	244	limit = (policy_limit_t) &fifo_limit;
	245
	246	break;
	247	}
	248
	249	case POLICY_TIMESHARE:
	250	{
	251	policy_timeshare_base_t ts_base;
	252
	253	if (count != POLICY_TIMESHARE_BASE_COUNT) {
	254	result = KERN_INVALID_ARGUMENT;
	255	break;
	256	}
	257
	258	limcount = POLICY_TIMESHARE_LIMIT_COUNT;
	259	ts_base = (policy_timeshare_base_t) base;
	260	ts_limit.max_priority = ts_base->base_priority;
	261	limit = (policy_limit_t) &ts_limit;
	262
	263	break;
	264	}
	265
	266	default:
	267	result = KERN_INVALID_POLICY;
	268	break;
	269	}
	270
271	}
272	else {
273	/*
274	* Use current scheduling limits. Ensure that the
275	* new base priority will not exceed current limits.
276	*/
277	switch (policy) {
278
279	case POLICY_RR:
280	{
281	policy_rr_base_t rr_base;
282
283	if (count != POLICY_RR_BASE_COUNT) {
284	result = KERN_INVALID_ARGUMENT;
285	break;
286	}
287
288	limcount = POLICY_RR_LIMIT_COUNT;
289	rr_base = (policy_rr_base_t) base;
290	if (rr_base->base_priority > thread->max_priority) {
291	result = KERN_POLICY_LIMIT;
292	break;
293	}
294
295	rr_limit.max_priority = thread->max_priority;
296	limit = (policy_limit_t) &rr_limit;
297
298	break;
299	}
300
301	case POLICY_FIFO:
302	{
303	policy_fifo_base_t fifo_base;
304
305	if (count != POLICY_FIFO_BASE_COUNT) {
306	result = KERN_INVALID_ARGUMENT;
307	break;
308	}
309
310	limcount = POLICY_FIFO_LIMIT_COUNT;
311	fifo_base = (policy_fifo_base_t) base;
312	if (fifo_base->base_priority > thread->max_priority) {
313	result = KERN_POLICY_LIMIT;
314	break;
315	}
316
317	fifo_limit.max_priority = thread->max_priority;
318	limit = (policy_limit_t) &fifo_limit;
319
320	break;
321	}
322
323	case POLICY_TIMESHARE:
324	{
325	policy_timeshare_base_t ts_base;
326
327	if (count != POLICY_TIMESHARE_BASE_COUNT) {
328	result = KERN_INVALID_ARGUMENT;
329	break;
330	}
331
332	limcount = POLICY_TIMESHARE_LIMIT_COUNT;
333	ts_base = (policy_timeshare_base_t) base;
334	if (ts_base->base_priority > thread->max_priority) {
335	result = KERN_POLICY_LIMIT;
336	break;
337	}
338
339	ts_limit.max_priority = thread->max_priority;
340	limit = (policy_limit_t) &ts_limit;
341
342	break;
343	}
344
345	default:
346	result = KERN_INVALID_POLICY;
347	break;
348	}
349
350	}
351
91447636	352	thread_mtx_unlock(thread);
1c79356b A	353
1c79356b A	354	if (result == KERN_SUCCESS)
91447636	355	result = thread_set_policy(thread, pset,
1c79356b A	356	policy, base, count, limit, limcount);
	357
	358	return(result);
	359	}