[apple/xnu.git] / osfmk / kern / ipc_kobject.c

/*
 * Copyright (c) 2000-2004 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_OSREFERENCE_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_LICENSE_OSREFERENCE_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.
 */
/*
 */
/*
 *	File:	kern/ipc_kobject.c
 *	Author:	Rich Draves
 *	Date:	1989
 *
 *	Functions for letting a port represent a kernel object.
 */

#include <mach_debug.h>
#include <mach_ipc_test.h>
#include <mach_machine_routines.h>
#include <norma_task.h>
#include <mach_rt.h>
#include <platforms.h>

#include <mach/mig.h>
#include <mach/port.h>
#include <mach/kern_return.h>
#include <mach/message.h>
#include <mach/mig_errors.h>
#include <mach/notify.h>
#include <mach/ndr.h>

#include <mach/mach_vm_server.h>
#include <mach/mach_port_server.h>
#include <mach/mach_host_server.h>
#include <mach/host_priv_server.h>
#include <mach/host_security_server.h>
#include <mach/clock_server.h>
#include <mach/clock_priv_server.h>
#include <mach/ledger_server.h>
#include <mach/lock_set_server.h>
#include <default_pager/default_pager_object_server.h>
#include <mach/memory_object_server.h>
#include <mach/memory_object_control_server.h>
#include <mach/memory_object_default_server.h>
#include <mach/memory_object_name_server.h>
#include <mach/processor_server.h>
#include <mach/processor_set_server.h>
#include <mach/semaphore_server.h>
#include <mach/task_server.h>
#include <mach/vm_map_server.h>
#include <mach/thread_act_server.h>

#include <device/device_types.h>
#include <device/device_server.h>

#include <UserNotification/UNDReplyServer.h>

#if     MACH_MACHINE_ROUTINES
#include <machine/machine_routines.h>
#endif	/* MACH_MACHINE_ROUTINES */
#if	XK_PROXY
#include <uk_xkern/xk_uproxy_server.h>
#endif	/* XK_PROXY */

#include <kern/ipc_tt.h>
#include <kern/ipc_mig.h>
#include <kern/ipc_kobject.h>
#include <kern/host_notify.h>
#include <kern/mk_timer.h>
#include <kern/misc_protos.h>
#include <ipc/ipc_kmsg.h>
#include <ipc/ipc_port.h>
#include <kern/counters.h>

#include <vm/vm_shared_memory_server.h>
#include <vm/vm_protos.h>

/*
 *	Routine:	ipc_kobject_notify
 *	Purpose:
 *		Deliver notifications to kobjects that care about them.
 */
boolean_t
ipc_kobject_notify(
        mach_msg_header_t *request_header,
        mach_msg_header_t *reply_header);

typedef struct {
        mach_msg_id_t num;
        mig_routine_t routine;
	int size;
#if	MACH_COUNTERS
	mach_counter_t callcount;
#endif
} mig_hash_t;

#define MAX_MIG_ENTRIES 1024
#define MIG_HASH(x) (x)

#ifndef max
#define max(a,b)        (((a) > (b)) ? (a) : (b))
#endif /* max */

mig_hash_t mig_buckets[MAX_MIG_ENTRIES];
int mig_table_max_displ;
mach_msg_size_t mig_reply_size;


const struct mig_subsystem *mig_e[] = {
        (const struct mig_subsystem *)&mach_vm_subsystem,
        (const struct mig_subsystem *)&mach_port_subsystem,
        (const struct mig_subsystem *)&mach_host_subsystem,
        (const struct mig_subsystem *)&host_priv_subsystem,
        (const struct mig_subsystem *)&host_security_subsystem,
        (const struct mig_subsystem *)&clock_subsystem,
        (const struct mig_subsystem *)&clock_priv_subsystem,
        (const struct mig_subsystem *)&processor_subsystem,
        (const struct mig_subsystem *)&processor_set_subsystem,
        (const struct mig_subsystem *)&is_iokit_subsystem,
        (const struct mig_subsystem *)&memory_object_name_subsystem,
	(const struct mig_subsystem *)&lock_set_subsystem,
	(const struct mig_subsystem *)&ledger_subsystem,
	(const struct mig_subsystem *)&semaphore_subsystem,
	(const struct mig_subsystem *)&task_subsystem,
	(const struct mig_subsystem *)&thread_act_subsystem,
	(const struct mig_subsystem *)&vm_map_subsystem,
	(const struct mig_subsystem *)&UNDReply_subsystem,
	(const struct mig_subsystem *)&default_pager_object_subsystem,

#if     XK_PROXY
        (const struct mig_subsystem *)&do_uproxy_xk_uproxy_subsystem,
#endif /* XK_PROXY */
#if     MACH_MACHINE_ROUTINES
        (const struct mig_subsystem *)&MACHINE_SUBSYSTEM,
#endif  /* MACH_MACHINE_ROUTINES */
#if     MCMSG && iPSC860
	(const struct mig_subsystem *)&mcmsg_info_subsystem,
#endif  /* MCMSG && iPSC860 */
};

void
mig_init(void)
{
    unsigned int i, n = sizeof(mig_e)/sizeof(const struct mig_subsystem *);
    int howmany;
    mach_msg_id_t j, pos, nentry, range;
	
    for (i = 0; i < n; i++) {
	range = mig_e[i]->end - mig_e[i]->start;
	if (!mig_e[i]->start || range < 0)
	    panic("the msgh_ids in mig_e[] aren't valid!");
	mig_reply_size = max(mig_reply_size, mig_e[i]->maxsize);

	for  (j = 0; j < range; j++) {
	  if (mig_e[i]->routine[j].stub_routine) { 
	    /* Only put real entries in the table */
	    nentry = j + mig_e[i]->start;	
	    for (pos = MIG_HASH(nentry) % MAX_MIG_ENTRIES, howmany = 1;
		 mig_buckets[pos].num;
		 pos = ++pos % MAX_MIG_ENTRIES, howmany++) {
	         if (mig_buckets[pos].num == nentry) {
		        printf("message id = %d\n", nentry);
		 	panic("multiple entries with the same msgh_id");
	         }
		 if (howmany == MAX_MIG_ENTRIES)
		       panic("the mig dispatch table is too small");
	    }
		
	    mig_buckets[pos].num = nentry;
	    mig_buckets[pos].routine = mig_e[i]->routine[j].stub_routine;
	    if (mig_e[i]->routine[j].max_reply_msg)
		    mig_buckets[pos].size = mig_e[i]->routine[j].max_reply_msg;
	    else
		    mig_buckets[pos].size = mig_e[i]->maxsize;

	    mig_table_max_displ = max(howmany, mig_table_max_displ);
	  }
	}
    }
    printf("mig_table_max_displ = %d\n", mig_table_max_displ);
}


/*
 *	Routine:	ipc_kobject_server
 *	Purpose:
 *		Handle a message sent to the kernel.
 *		Generates a reply message.
 *		Version for Untyped IPC.
 *	Conditions:
 *		Nothing locked.
 */

ipc_kmsg_t
ipc_kobject_server(
	ipc_kmsg_t	request)
{
	mach_msg_size_t reply_size;
	ipc_kmsg_t reply;
	kern_return_t kr;
	ipc_port_t *destp;
	mach_msg_format_0_trailer_t *trailer;
	register mig_hash_t *ptr;

	/*
	 * Find out corresponding mig_hash entry if any
	 */
	{
	    register int key = request->ikm_header->msgh_id;
	    register int i = MIG_HASH(key);
	    register int max_iter = mig_table_max_displ;
	
	    do
		ptr = &mig_buckets[i++ % MAX_MIG_ENTRIES];
	    while (key != ptr->num && ptr->num && --max_iter);

	    if (!ptr->routine || key != ptr->num) {
	        ptr = (mig_hash_t *)0;
		reply_size = mig_reply_size;
	    } else {
		reply_size = ptr->size;
#if	MACH_COUNTER
		ptr->callcount++;
#endif
	    }
	}

	/* round up for trailer size */
        reply_size += MAX_TRAILER_SIZE;
	reply = ipc_kmsg_alloc(reply_size);

	if (reply == IKM_NULL) {
		printf("ipc_kobject_server: dropping request\n");
		ipc_kmsg_destroy(request);
		return IKM_NULL;
	}

	/*
	 * Initialize reply message.
	 */
	{
#define	InP	((mach_msg_header_t *) request->ikm_header)
#define	OutP	((mig_reply_error_t *) reply->ikm_header)

	    OutP->NDR = NDR_record;
	    OutP->Head.msgh_size = sizeof(mig_reply_error_t);

	    OutP->Head.msgh_bits =
		MACH_MSGH_BITS(MACH_MSGH_BITS_LOCAL(InP->msgh_bits), 0);
	    OutP->Head.msgh_remote_port = InP->msgh_local_port;
	    OutP->Head.msgh_local_port  = MACH_PORT_NULL;
	    OutP->Head.msgh_id = InP->msgh_id + 100;

#undef	InP
#undef	OutP
	}

	/*
	 * Find the routine to call, and call it
	 * to perform the kernel function
	 */
	{
	    if (ptr) {	
		(*ptr->routine)(request->ikm_header, reply->ikm_header);
		kernel_task->messages_received++;
	    }
	    else {
		if (!ipc_kobject_notify(request->ikm_header, reply->ikm_header)){
#if	MACH_IPC_TEST
		    printf("ipc_kobject_server: bogus kernel message, id=%d\n",
			request->ikm_header->msgh_id);
#endif	/* MACH_IPC_TEST */
		    _MIG_MSGID_INVALID(request->ikm_header->msgh_id);

		    ((mig_reply_error_t *) reply->ikm_header)->RetCode
			= MIG_BAD_ID;
		}
		else
		  kernel_task->messages_received++;
	    }
	    kernel_task->messages_sent++;
	}

	/*
	 *	Destroy destination. The following code differs from
	 *	ipc_object_destroy in that we release the send-once
	 *	right instead of generating a send-once notification
	 * 	(which would bring us here again, creating a loop).
	 *	It also differs in that we only expect send or
	 *	send-once rights, never receive rights.
	 *
	 *	We set msgh_remote_port to IP_NULL so that the kmsg
	 *	destroy routines don't try to destroy the port twice.
	 */
	destp = (ipc_port_t *) &request->ikm_header->msgh_remote_port;
	switch (MACH_MSGH_BITS_REMOTE(request->ikm_header->msgh_bits)) {
		case MACH_MSG_TYPE_PORT_SEND:
		    ipc_port_release_send(*destp);
		    break;
		
		case MACH_MSG_TYPE_PORT_SEND_ONCE:
		    ipc_port_release_sonce(*destp);
		    break;
		
		default:
		    panic("ipc_kobject_server: strange destination rights");
	}
	*destp = IP_NULL;

        if (!(reply->ikm_header->msgh_bits & MACH_MSGH_BITS_COMPLEX) &&
           ((mig_reply_error_t *) reply->ikm_header)->RetCode != KERN_SUCCESS)
	 	kr = ((mig_reply_error_t *) reply->ikm_header)->RetCode;
	else
		kr = KERN_SUCCESS;

	if ((kr == KERN_SUCCESS) || (kr == MIG_NO_REPLY)) {
		/*
		 *	The server function is responsible for the contents
		 *	of the message.  The reply port right is moved
		 *	to the reply message, and we have deallocated
		 *	the destination port right, so we just need
		 *	to free the kmsg.
		 */
		ipc_kmsg_free(request);

	} else {
		/*
		 *	The message contents of the request are intact.
		 *	Destroy everthing except the reply port right,
		 *	which is needed in the reply message.
		 */
		request->ikm_header->msgh_local_port = MACH_PORT_NULL;
		ipc_kmsg_destroy(request);
	}

	if (kr == MIG_NO_REPLY) {
		/*
		 *	The server function will send a reply message
		 *	using the reply port right, which it has saved.
		 */

		ipc_kmsg_free(reply);

		return IKM_NULL;
	} else if (!IP_VALID((ipc_port_t)reply->ikm_header->msgh_remote_port)) {
		/*
		 *	Can't queue the reply message if the destination
		 *	(the reply port) isn't valid.
		 */

		ipc_kmsg_destroy(reply);

		return IKM_NULL;
	}

 	trailer = (mach_msg_format_0_trailer_t *)
		((vm_offset_t)reply->ikm_header + (int)reply->ikm_header->msgh_size);

 	trailer->msgh_sender = KERNEL_SECURITY_TOKEN;
 	trailer->msgh_trailer_type = MACH_MSG_TRAILER_FORMAT_0;
 	trailer->msgh_trailer_size = MACH_MSG_TRAILER_MINIMUM_SIZE;

	return reply;
}

/*
 *	Routine:	ipc_kobject_set
 *	Purpose:
 *		Make a port represent a kernel object of the given type.
 *		The caller is responsible for handling refs for the
 *		kernel object, if necessary.
 *	Conditions:
 *		Nothing locked.  The port must be active if setting
 *		a kobject linkage.  Clearing a linkage is OK on an
 *		inactive port.
 */
void
ipc_kobject_set(
	ipc_port_t			port,
	ipc_kobject_t		kobject,
	ipc_kobject_type_t	type)
{
	ip_lock(port);
	ipc_kobject_set_atomically(port, kobject, type);
	ip_unlock(port);
}

void
ipc_kobject_set_atomically(
	ipc_port_t			port,
	ipc_kobject_t		kobject,
	ipc_kobject_type_t	type)
{
	assert(type == IKOT_NONE || ip_active(port));
#if	MACH_ASSERT
	port->ip_spares[2] = (port->ip_bits & IO_BITS_KOTYPE);
#endif	/* MACH_ASSERT */
	port->ip_bits = (port->ip_bits &~ IO_BITS_KOTYPE) | type;
	port->ip_kobject = kobject;
}

/*
 *	Routine:	ipc_kobject_destroy
 *	Purpose:
 *		Release any kernel object resources associated
 *		with the port, which is being destroyed.
 *
 *		This should only be needed when resources are
 *		associated with a user's port.  In the normal case,
 *		when the kernel is the receiver, the code calling
 *		ipc_port_dealloc_kernel should clean up the resources.
 *	Conditions:
 *		The port is not locked, but it is dead.
 */

void
ipc_kobject_destroy(
	ipc_port_t		port)
{
	switch (ip_kotype(port)) {

	case IKOT_TIMER:
		mk_timer_port_destroy(port);
		break;

	case IKOT_NAMED_ENTRY:
		mach_destroy_memory_entry(port);
		break;

	case IKOT_HOST_NOTIFY:
		host_notify_port_destroy(port);
		break;

	default:
		break;
	}
}


boolean_t
ipc_kobject_notify(
	mach_msg_header_t *request_header,
	mach_msg_header_t *reply_header)
{
	ipc_port_t port = (ipc_port_t) request_header->msgh_remote_port;

	((mig_reply_error_t *) reply_header)->RetCode = MIG_NO_REPLY;
	switch (request_header->msgh_id) {
		case MACH_NOTIFY_NO_SENDERS:
		   if(ip_kotype(port) == IKOT_NAMED_ENTRY) {
			ip_lock(port);

			/*
			 * Bring the sequence number and mscount in
			 * line with ipc_port_destroy assertion.
			 */
			port->ip_mscount = 0;
			port->ip_messages.imq_seqno = 0;
			ipc_port_destroy(port); /* releases lock */
			return TRUE;
		   }
		   if (ip_kotype(port) == IKOT_UPL) {
			   upl_no_senders(
				request_header->msgh_remote_port, 
				(mach_port_mscount_t) 
				((mach_no_senders_notification_t *) 
				 request_header)->not_count);
			   (ipc_port_t)reply_header->msgh_remote_port
				   = MACH_PORT_NULL;
			   return TRUE;
		   }
				
	  	   break;

		case MACH_NOTIFY_PORT_DELETED:
		case MACH_NOTIFY_PORT_DESTROYED:
		case MACH_NOTIFY_SEND_ONCE:
		case MACH_NOTIFY_DEAD_NAME:
		break;

		default:
		return FALSE;
	}
	switch (ip_kotype(port)) {

#ifdef IOKIT
		case IKOT_IOKIT_OBJECT:
		case IKOT_IOKIT_CONNECT:
		case IKOT_IOKIT_SPARE:
		{
                return iokit_notify(request_header);
		}
#endif
		default:
                return FALSE;
        }
}


#include <mach_kdb.h>
#if	MACH_COUNTERS && MACH_KDB

#include <ddb/db_output.h>
#include <ddb/db_sym.h>

#define printf  kdbprintf

extern void kobjserver_stats(void);
extern void bucket_stats_print(mig_hash_t *bucket);

extern void kobjserver_stats_clear(void);


void
kobjserver_stats_clear(void)
{
	int i;
	for (i = 0; i < MAX_MIG_ENTRIES; i++) {
		mig_buckets[i].callcount = 0;
	}
}

void
kobjserver_stats(void)
{
    register unsigned int i, n = sizeof(mig_e)/sizeof(struct mig_subsystem);
    register unsigned int howmany;
    register mach_msg_id_t j, pos, nentry, range;
	
    db_printf("Kobject server call counts:\n");
    for (i = 0; i < n; i++) {
	db_printf("  ");
	db_printsym((vm_offset_t)mig_e[i], DB_STGY_ANY);
	db_printf(":\n");
	range = mig_e[i]->end - mig_e[i]->start;
	if (!mig_e[i]->start || range < 0) continue;

	for  (j = 0; j < range; j++) {
	    nentry = j + mig_e[i]->start;	
	    for (pos = MIG_HASH(nentry) % MAX_MIG_ENTRIES, howmany = 1;
		 mig_buckets[pos].num;
		 pos = ++pos % MAX_MIG_ENTRIES, howmany++) {
		    if (mig_buckets[pos].num == nentry)
			bucket_stats_print(&mig_buckets[pos]);
	    }
	}
    }
}

void
bucket_stats_print(mig_hash_t *bucket)
{
	if (bucket->callcount) {
		db_printf("    ");
		db_printsym((vm_offset_t)bucket->routine, DB_STGY_ANY);
		db_printf(" (%d):\t%d\n", bucket->num, bucket->callcount);
	}
}


#endif	/* MACH_COUNTERS && MACH_KDB */
Commit	Line	Data
1c79356b	1	/*
91447636	2	* Copyright (c) 2000-2004 Apple Computer, Inc. All rights reserved.
1c79356b	3	*
8ad349bb	4	* @APPLE_LICENSE_OSREFERENCE_HEADER_START@
1c79356b	5	*
8ad349bb 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
	10	* License may not be used to create, or enable the creation or
	11	* redistribution of, unlawful or unlicensed copies of an Apple operating
	12	* system, or to circumvent, violate, or enable the circumvention or
	13	* violation of, any terms of an Apple operating system software license
	14	* agreement.
	15	*
	16	* Please obtain a copy of the License at
	17	* http://www.opensource.apple.com/apsl/ and read it before using this
	18	* file.
	19	*
	20	* The Original Code and all software distributed under the License are
	21	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
	22	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
	23	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
	24	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	25	* Please see the License for the specific language governing rights and
	26	* limitations under the License.
	27	*
	28	* @APPLE_LICENSE_OSREFERENCE_HEADER_END@
1c79356b A	29	*/
	30	/*
	31	* @OSF_COPYRIGHT@
	32	*/
	33	/*
	34	* Mach Operating System
	35	* Copyright (c) 1991,1990,1989 Carnegie Mellon University
	36	* All Rights Reserved.
	37	*
	38	* Permission to use, copy, modify and distribute this software and its
	39	* documentation is hereby granted, provided that both the copyright
	40	* notice and this permission notice appear in all copies of the
	41	* software, derivative works or modified versions, and any portions
	42	* thereof, and that both notices appear in supporting documentation.
	43	*
	44	* CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
	45	* CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
	46	* ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
	47	*
	48	* Carnegie Mellon requests users of this software to return to
	49	*
	50	* Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
	51	* School of Computer Science
	52	* Carnegie Mellon University
	53	* Pittsburgh PA 15213-3890
	54	*
	55	* any improvements or extensions that they make and grant Carnegie Mellon
	56	* the rights to redistribute these changes.
	57	*/
	58	/*
	59	*/
	60	/*
	61	* File: kern/ipc_kobject.c
	62	* Author: Rich Draves
	63	* Date: 1989
	64	*
	65	* Functions for letting a port represent a kernel object.
	66	*/
	67
	68	#include <mach_debug.h>
	69	#include <mach_ipc_test.h>
	70	#include <mach_machine_routines.h>
	71	#include <norma_task.h>
	72	#include <mach_rt.h>
	73	#include <platforms.h>
	74
9bccf70c	75	#include <mach/mig.h>
1c79356b A	76	#include <mach/port.h>
	77	#include <mach/kern_return.h>
	78	#include <mach/message.h>
	79	#include <mach/mig_errors.h>
	80	#include <mach/notify.h>
91447636 A	81	#include <mach/ndr.h>
	82
	83	#include <mach/mach_vm_server.h>
	84	#include <mach/mach_port_server.h>
	85	#include <mach/mach_host_server.h>
	86	#include <mach/host_priv_server.h>
	87	#include <mach/host_security_server.h>
	88	#include <mach/clock_server.h>
	89	#include <mach/clock_priv_server.h>
	90	#include <mach/ledger_server.h>
	91	#include <mach/lock_set_server.h>
	92	#include <default_pager/default_pager_object_server.h>
	93	#include <mach/memory_object_server.h>
	94	#include <mach/memory_object_control_server.h>
	95	#include <mach/memory_object_default_server.h>
	96	#include <mach/memory_object_name_server.h>
	97	#include <mach/processor_server.h>
	98	#include <mach/processor_set_server.h>
	99	#include <mach/semaphore_server.h>
	100	#include <mach/task_server.h>
	101	#include <mach/vm_map_server.h>
	102	#include <mach/thread_act_server.h>
	103
	104	#include <device/device_types.h>
	105	#include <device/device_server.h>
	106
	107	#include <UserNotification/UNDReplyServer.h>
	108
	109	#if MACH_MACHINE_ROUTINES
	110	#include <machine/machine_routines.h>
	111	#endif /* MACH_MACHINE_ROUTINES */
	112	#if XK_PROXY
	113	#include <uk_xkern/xk_uproxy_server.h>
	114	#endif /* XK_PROXY */
9bccf70c	115
91447636	116	#include <kern/ipc_tt.h>
1c79356b A	117	#include <kern/ipc_mig.h>
1c79356b A	118	#include <kern/ipc_kobject.h>
55e303ae	119	#include <kern/host_notify.h>
1c79356b	120	#include <kern/mk_timer.h>
55e303ae	121	#include <kern/misc_protos.h>
1c79356b A	122	#include <ipc/ipc_kmsg.h>
	123	#include <ipc/ipc_port.h>
	124	#include <kern/counters.h>
	125
91447636 A	126	#include <vm/vm_shared_memory_server.h>
91447636 A	127	#include <vm/vm_protos.h>
1c79356b	128
1c79356b A	129	/*
	130	* Routine: ipc_kobject_notify
	131	* Purpose:
	132	* Deliver notifications to kobjects that care about them.
	133	*/
	134	boolean_t
	135	ipc_kobject_notify(
	136	mach_msg_header_t *request_header,
	137	mach_msg_header_t *reply_header);
	138
1c79356b A	139	typedef struct {
	140	mach_msg_id_t num;
	141	mig_routine_t routine;
	142	int size;
	143	#if MACH_COUNTERS
	144	mach_counter_t callcount;
	145	#endif
	146	} mig_hash_t;
	147
	148	#define MAX_MIG_ENTRIES 1024
	149	#define MIG_HASH(x) (x)
	150
	151	#ifndef max
	152	#define max(a,b) (((a) > (b)) ? (a) : (b))
	153	#endif /* max */
	154
	155	mig_hash_t mig_buckets[MAX_MIG_ENTRIES];
	156	int mig_table_max_displ;
	157	mach_msg_size_t mig_reply_size;
	158
	159
1c79356b A	160
1c79356b A	161
91447636 A	162	const struct mig_subsystem *mig_e[] = {
	163	(const struct mig_subsystem *)&mach_vm_subsystem,
	164	(const struct mig_subsystem *)&mach_port_subsystem,
	165	(const struct mig_subsystem *)&mach_host_subsystem,
	166	(const struct mig_subsystem *)&host_priv_subsystem,
	167	(const struct mig_subsystem *)&host_security_subsystem,
	168	(const struct mig_subsystem *)&clock_subsystem,
	169	(const struct mig_subsystem *)&clock_priv_subsystem,
	170	(const struct mig_subsystem *)&processor_subsystem,
	171	(const struct mig_subsystem *)&processor_set_subsystem,
	172	(const struct mig_subsystem *)&is_iokit_subsystem,
	173	(const struct mig_subsystem *)&memory_object_name_subsystem,
	174	(const struct mig_subsystem *)&lock_set_subsystem,
	175	(const struct mig_subsystem *)&ledger_subsystem,
	176	(const struct mig_subsystem *)&semaphore_subsystem,
	177	(const struct mig_subsystem *)&task_subsystem,
	178	(const struct mig_subsystem *)&thread_act_subsystem,
	179	(const struct mig_subsystem *)&vm_map_subsystem,
	180	(const struct mig_subsystem *)&UNDReply_subsystem,
	181	(const struct mig_subsystem *)&default_pager_object_subsystem,
1c79356b A	182
1c79356b A	183	#if XK_PROXY
91447636	184	(const struct mig_subsystem *)&do_uproxy_xk_uproxy_subsystem,
1c79356b A	185	#endif /* XK_PROXY */
1c79356b A	186	#if MACH_MACHINE_ROUTINES
91447636	187	(const struct mig_subsystem *)&MACHINE_SUBSYSTEM,
1c79356b A	188	#endif /* MACH_MACHINE_ROUTINES */
1c79356b A	189	#if MCMSG && iPSC860
91447636	190	(const struct mig_subsystem *)&mcmsg_info_subsystem,
1c79356b A	191	#endif /* MCMSG && iPSC860 */
	192	};
	193
	194	void
	195	mig_init(void)
	196	{
91447636 A	197	unsigned int i, n = sizeof(mig_e)/sizeof(const struct mig_subsystem *);
	198	int howmany;
	199	mach_msg_id_t j, pos, nentry, range;
1c79356b A	200
	201	for (i = 0; i < n; i++) {
	202	range = mig_e[i]->end - mig_e[i]->start;
	203	if (!mig_e[i]->start \|\| range < 0)
	204	panic("the msgh_ids in mig_e[] aren't valid!");
	205	mig_reply_size = max(mig_reply_size, mig_e[i]->maxsize);
	206
	207	for (j = 0; j < range; j++) {
	208	if (mig_e[i]->routine[j].stub_routine) {
	209	/* Only put real entries in the table */
	210	nentry = j + mig_e[i]->start;
	211	for (pos = MIG_HASH(nentry) % MAX_MIG_ENTRIES, howmany = 1;
	212	mig_buckets[pos].num;
	213	pos = ++pos % MAX_MIG_ENTRIES, howmany++) {
	214	if (mig_buckets[pos].num == nentry) {
	215	printf("message id = %d\n", nentry);
	216	panic("multiple entries with the same msgh_id");
	217	}
	218	if (howmany == MAX_MIG_ENTRIES)
	219	panic("the mig dispatch table is too small");
	220	}
	221
	222	mig_buckets[pos].num = nentry;
	223	mig_buckets[pos].routine = mig_e[i]->routine[j].stub_routine;
	224	if (mig_e[i]->routine[j].max_reply_msg)
	225	mig_buckets[pos].size = mig_e[i]->routine[j].max_reply_msg;
	226	else
	227	mig_buckets[pos].size = mig_e[i]->maxsize;
	228
	229	mig_table_max_displ = max(howmany, mig_table_max_displ);
	230	}
	231	}
	232	}
0b4e3aa0	233	printf("mig_table_max_displ = %d\n", mig_table_max_displ);
1c79356b A	234	}
	235
	236
	237	/*
	238	* Routine: ipc_kobject_server
	239	* Purpose:
	240	* Handle a message sent to the kernel.
	241	* Generates a reply message.
	242	* Version for Untyped IPC.
	243	* Conditions:
	244	* Nothing locked.
	245	*/
	246
	247	ipc_kmsg_t
	248	ipc_kobject_server(
	249	ipc_kmsg_t request)
	250	{
	251	mach_msg_size_t reply_size;
	252	ipc_kmsg_t reply;
	253	kern_return_t kr;
1c79356b A	254	ipc_port_t *destp;
	255	mach_msg_format_0_trailer_t *trailer;
	256	register mig_hash_t *ptr;
91447636	257
1c79356b	258	/*
91447636 A	259	* Find out corresponding mig_hash entry if any
91447636 A	260	*/
1c79356b	261	{
91447636	262	register int key = request->ikm_header->msgh_id;
1c79356b A	263	register int i = MIG_HASH(key);
	264	register int max_iter = mig_table_max_displ;
	265
	266	do
	267	ptr = &mig_buckets[i++ % MAX_MIG_ENTRIES];
	268	while (key != ptr->num && ptr->num && --max_iter);
	269
	270	if (!ptr->routine \|\| key != ptr->num) {
	271	ptr = (mig_hash_t *)0;
	272	reply_size = mig_reply_size;
	273	} else {
	274	reply_size = ptr->size;
	275	#if MACH_COUNTER
	276	ptr->callcount++;
	277	#endif
	278	}
	279	}
	280
	281	/* round up for trailer size */
	282	reply_size += MAX_TRAILER_SIZE;
	283	reply = ipc_kmsg_alloc(reply_size);
	284
	285	if (reply == IKM_NULL) {
	286	printf("ipc_kobject_server: dropping request\n");
	287	ipc_kmsg_destroy(request);
	288	return IKM_NULL;
	289	}
	290
	291	/*
	292	* Initialize reply message.
	293	*/
	294	{
91447636 A	295	#define InP ((mach_msg_header_t *) request->ikm_header)
91447636 A	296	#define OutP ((mig_reply_error_t *) reply->ikm_header)
1c79356b A	297
	298	OutP->NDR = NDR_record;
	299	OutP->Head.msgh_size = sizeof(mig_reply_error_t);
	300
	301	OutP->Head.msgh_bits =
	302	MACH_MSGH_BITS(MACH_MSGH_BITS_LOCAL(InP->msgh_bits), 0);
	303	OutP->Head.msgh_remote_port = InP->msgh_local_port;
	304	OutP->Head.msgh_local_port = MACH_PORT_NULL;
	305	OutP->Head.msgh_id = InP->msgh_id + 100;
	306
	307	#undef InP
	308	#undef OutP
	309	}
	310
	311	/*
	312	* Find the routine to call, and call it
	313	* to perform the kernel function
	314	*/
	315	{
	316	if (ptr) {
91447636	317	(*ptr->routine)(request->ikm_header, reply->ikm_header);
1c79356b A	318	kernel_task->messages_received++;
	319	}
	320	else {
91447636	321	if (!ipc_kobject_notify(request->ikm_header, reply->ikm_header)){
1c79356b A	322	#if MACH_IPC_TEST
1c79356b A	323	printf("ipc_kobject_server: bogus kernel message, id=%d\n",
91447636	324	request->ikm_header->msgh_id);
1c79356b	325	#endif /* MACH_IPC_TEST */
91447636	326	_MIG_MSGID_INVALID(request->ikm_header->msgh_id);
1c79356b	327
91447636	328	((mig_reply_error_t *) reply->ikm_header)->RetCode
1c79356b A	329	= MIG_BAD_ID;
	330	}
	331	else
	332	kernel_task->messages_received++;
	333	}
	334	kernel_task->messages_sent++;
	335	}
	336
	337	/*
	338	* Destroy destination. The following code differs from
	339	* ipc_object_destroy in that we release the send-once
	340	* right instead of generating a send-once notification
	341	* (which would bring us here again, creating a loop).
	342	* It also differs in that we only expect send or
	343	* send-once rights, never receive rights.
	344	*
	345	* We set msgh_remote_port to IP_NULL so that the kmsg
	346	* destroy routines don't try to destroy the port twice.
	347	*/
91447636 A	348	destp = (ipc_port_t *) &request->ikm_header->msgh_remote_port;
91447636 A	349	switch (MACH_MSGH_BITS_REMOTE(request->ikm_header->msgh_bits)) {
1c79356b A	350	case MACH_MSG_TYPE_PORT_SEND:
	351	ipc_port_release_send(*destp);
	352	break;
	353
	354	case MACH_MSG_TYPE_PORT_SEND_ONCE:
	355	ipc_port_release_sonce(*destp);
	356	break;
	357
	358	default:
9bccf70c	359	panic("ipc_kobject_server: strange destination rights");
1c79356b A	360	}
	361	*destp = IP_NULL;
	362
91447636 A	363	if (!(reply->ikm_header->msgh_bits & MACH_MSGH_BITS_COMPLEX) &&
	364	((mig_reply_error_t *) reply->ikm_header)->RetCode != KERN_SUCCESS)
	365	kr = ((mig_reply_error_t *) reply->ikm_header)->RetCode;
1c79356b A	366	else
	367	kr = KERN_SUCCESS;
	368
	369	if ((kr == KERN_SUCCESS) \|\| (kr == MIG_NO_REPLY)) {
	370	/*
	371	* The server function is responsible for the contents
	372	* of the message. The reply port right is moved
	373	* to the reply message, and we have deallocated
	374	* the destination port right, so we just need
	375	* to free the kmsg.
	376	*/
	377	ipc_kmsg_free(request);
	378
	379	} else {
	380	/*
	381	* The message contents of the request are intact.
	382	* Destroy everthing except the reply port right,
	383	* which is needed in the reply message.
	384	*/
91447636	385	request->ikm_header->msgh_local_port = MACH_PORT_NULL;
1c79356b A	386	ipc_kmsg_destroy(request);
	387	}
	388
	389	if (kr == MIG_NO_REPLY) {
	390	/*
	391	* The server function will send a reply message
	392	* using the reply port right, which it has saved.
	393	*/
	394
	395	ipc_kmsg_free(reply);
	396
1c79356b	397	return IKM_NULL;
91447636	398	} else if (!IP_VALID((ipc_port_t)reply->ikm_header->msgh_remote_port)) {
1c79356b A	399	/*
	400	* Can't queue the reply message if the destination
	401	* (the reply port) isn't valid.
	402	*/
	403
	404	ipc_kmsg_destroy(reply);
	405
1c79356b A	406	return IKM_NULL;
	407	}
	408
	409	trailer = (mach_msg_format_0_trailer_t *)
91447636 A	410	((vm_offset_t)reply->ikm_header + (int)reply->ikm_header->msgh_size);
91447636 A	411
1c79356b A	412	trailer->msgh_sender = KERNEL_SECURITY_TOKEN;
	413	trailer->msgh_trailer_type = MACH_MSG_TRAILER_FORMAT_0;
	414	trailer->msgh_trailer_size = MACH_MSG_TRAILER_MINIMUM_SIZE;
	415
1c79356b A	416	return reply;
	417	}
	418
	419	/*
	420	* Routine: ipc_kobject_set
	421	* Purpose:
	422	* Make a port represent a kernel object of the given type.
	423	* The caller is responsible for handling refs for the
	424	* kernel object, if necessary.
	425	* Conditions:
	426	* Nothing locked. The port must be active if setting
	427	* a kobject linkage. Clearing a linkage is OK on an
	428	* inactive port.
	429	*/
	430	void
	431	ipc_kobject_set(
	432	ipc_port_t port,
	433	ipc_kobject_t kobject,
	434	ipc_kobject_type_t type)
	435	{
	436	ip_lock(port);
	437	ipc_kobject_set_atomically(port, kobject, type);
	438	ip_unlock(port);
	439	}
	440
	441	void
	442	ipc_kobject_set_atomically(
	443	ipc_port_t port,
	444	ipc_kobject_t kobject,
	445	ipc_kobject_type_t type)
	446	{
	447	assert(type == IKOT_NONE \|\| ip_active(port));
	448	#if MACH_ASSERT
	449	port->ip_spares[2] = (port->ip_bits & IO_BITS_KOTYPE);
	450	#endif /* MACH_ASSERT */
	451	port->ip_bits = (port->ip_bits &~ IO_BITS_KOTYPE) \| type;
	452	port->ip_kobject = kobject;
	453	}
	454
	455	/*
	456	* Routine: ipc_kobject_destroy
	457	* Purpose:
	458	* Release any kernel object resources associated
	459	* with the port, which is being destroyed.
	460	*
	461	* This should only be needed when resources are
	462	* associated with a user's port. In the normal case,
	463	* when the kernel is the receiver, the code calling
	464	* ipc_port_dealloc_kernel should clean up the resources.
	465	* Conditions:
	466	* The port is not locked, but it is dead.
	467	*/
	468
	469	void
	470	ipc_kobject_destroy(
	471	ipc_port_t port)
	472	{
	473	switch (ip_kotype(port)) {
	474
	475	case IKOT_TIMER:
	476	mk_timer_port_destroy(port);
	477	break;
	478
	479	case IKOT_NAMED_ENTRY:
480	mach_destroy_memory_entry(port);
481	break;
482
55e303ae A	483	case IKOT_HOST_NOTIFY:
	484	host_notify_port_destroy(port);
	485	break;
	486
	487	default:
1c79356b A	488	break;
	489	}
	490	}
	491
	492
1c79356b A	493	boolean_t
	494	ipc_kobject_notify(
	495	mach_msg_header_t *request_header,
	496	mach_msg_header_t *reply_header)
	497	{
	498	ipc_port_t port = (ipc_port_t) request_header->msgh_remote_port;
1c79356b A	499
	500	((mig_reply_error_t *) reply_header)->RetCode = MIG_NO_REPLY;
	501	switch (request_header->msgh_id) {
	502	case MACH_NOTIFY_NO_SENDERS:
	503	if(ip_kotype(port) == IKOT_NAMED_ENTRY) {
	504	ip_lock(port);
	505
	506	/*
	507	* Bring the sequence number and mscount in
	508	* line with ipc_port_destroy assertion.
	509	*/
	510	port->ip_mscount = 0;
	511	port->ip_messages.imq_seqno = 0;
	512	ipc_port_destroy(port); /* releases lock */
	513	return TRUE;
	514	}
0b4e3aa0 A	515	if (ip_kotype(port) == IKOT_UPL) {
0b4e3aa0 A	516	upl_no_senders(
91447636	517	request_header->msgh_remote_port,
0b4e3aa0 A	518	(mach_port_mscount_t)
	519	((mach_no_senders_notification_t *)
	520	request_header)->not_count);
	521	(ipc_port_t)reply_header->msgh_remote_port
	522	= MACH_PORT_NULL;
	523	return TRUE;
1c79356b	524	}
0b4e3aa0	525
1c79356b	526	break;
0b4e3aa0	527
1c79356b A	528	case MACH_NOTIFY_PORT_DELETED:
	529	case MACH_NOTIFY_PORT_DESTROYED:
	530	case MACH_NOTIFY_SEND_ONCE:
	531	case MACH_NOTIFY_DEAD_NAME:
	532	break;
	533
	534	default:
	535	return FALSE;
	536	}
	537	switch (ip_kotype(port)) {
	538
	539	#ifdef IOKIT
	540	case IKOT_IOKIT_OBJECT:
	541	case IKOT_IOKIT_CONNECT:
	542	case IKOT_IOKIT_SPARE:
	543	{
1c79356b A	544	return iokit_notify(request_header);
	545	}
	546	#endif
	547	default:
	548	return FALSE;
	549	}
	550	}
	551
	552
	553
	554	#include <mach_kdb.h>
	555	#if MACH_COUNTERS && MACH_KDB
	556
	557	#include <ddb/db_output.h>
	558	#include <ddb/db_sym.h>
	559
	560	#define printf kdbprintf
	561
	562	extern void kobjserver_stats(void);
	563	extern void bucket_stats_print(mig_hash_t *bucket);
	564
	565	extern void kobjserver_stats_clear(void);
	566
	567
	568	void
	569	kobjserver_stats_clear(void)
	570	{
	571	int i;
	572	for (i = 0; i < MAX_MIG_ENTRIES; i++) {
	573	mig_buckets[i].callcount = 0;
	574	}
	575	}
	576
	577	void
	578	kobjserver_stats(void)
	579	{
91447636	580	register unsigned int i, n = sizeof(mig_e)/sizeof(struct mig_subsystem);
1c79356b A	581	register unsigned int howmany;
	582	register mach_msg_id_t j, pos, nentry, range;
	583
	584	db_printf("Kobject server call counts:\n");
	585	for (i = 0; i < n; i++) {
	586	db_printf(" ");
	587	db_printsym((vm_offset_t)mig_e[i], DB_STGY_ANY);
	588	db_printf(":\n");
	589	range = mig_e[i]->end - mig_e[i]->start;
	590	if (!mig_e[i]->start \|\| range < 0) continue;
	591
	592	for (j = 0; j < range; j++) {
	593	nentry = j + mig_e[i]->start;
	594	for (pos = MIG_HASH(nentry) % MAX_MIG_ENTRIES, howmany = 1;
	595	mig_buckets[pos].num;
	596	pos = ++pos % MAX_MIG_ENTRIES, howmany++) {
	597	if (mig_buckets[pos].num == nentry)
	598	bucket_stats_print(&mig_buckets[pos]);
	599	}
	600	}
	601	}
	602	}
	603
	604	void
	605	bucket_stats_print(mig_hash_t *bucket)
	606	{
	607	if (bucket->callcount) {
	608	db_printf(" ");
	609	db_printsym((vm_offset_t)bucket->routine, DB_STGY_ANY);
	610	db_printf(" (%d):\t%d\n", bucket->num, bucket->callcount);
	611	}
	612	}
	613
	614
	615	#endif /* MACH_COUNTERS && MACH_KDB */