X-Git-Url: https://git.saurik.com/apple/xnu.git/blobdiff_plain/8ad349bb6ed4a0be06e34c92be0d98b92e078db4..bca245acd4c03fd752d1a45f011ad495e60fe53d:/osfmk/mach/mig.h diff --git a/osfmk/mach/mig.h b/osfmk/mach/mig.h index 7cc006b3b..74d2d0109 100644 --- a/osfmk/mach/mig.h +++ b/osfmk/mach/mig.h @@ -1,31 +1,29 @@ /* - * Copyright (c) 2000-2005 Apple Computer, Inc. All rights reserved. + * Copyright (c) 2000-2007 Apple 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. + * @APPLE_OSREFERENCE_LICENSE_HEADER_START@ * - * Please obtain a copy of the License at - * http://www.opensource.apple.com/apsl/ and read it before using this - * file. + * 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. * - * 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 + * 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@ + * @APPLE_OSREFERENCE_LICENSE_HEADER_END@ */ /* * @OSF_COPYRIGHT@ @@ -35,7 +33,7 @@ * Mach MIG Subsystem Interfaces */ -#ifndef _MACH_MIG_H_ +#ifndef _MACH_MIG_H_ #define _MACH_MIG_H_ #include @@ -47,34 +45,40 @@ #if defined(MACH_KERNEL) +#if !defined(__MigTypeCheck) /* Turn MIG type checking on by default for kernel */ #define __MigTypeCheck 1 +#endif + #define __MigKernelSpecificCode 1 #define _MIG_KERNEL_SPECIFIC_CODE_ 1 -/* Otherwise check legacy setting (temporary) */ -#elif defined(TypeCheck) +#elif !defined(__MigTypeCheck) +#if defined(TypeCheck) +/* use legacy setting (temporary) */ #define __MigTypeCheck TypeCheck - -#endif /* defined(TypeCheck) */ +#else +/* default MIG type checking on */ +#define __MigTypeCheck 1 +#endif + +#endif /* !defined(MACH_KERNEL) && !defined(__MigTypeCheck) */ /* - * Pack MIG message structs if we have Power alignment of structs. + * Pack MIG message structs. * This is an indicator of the need to view shared structs in a * binary-compatible format - and MIG message structs are no different. */ -#if __DARWIN_ALIGN_POWER #define __MigPackStructs 1 -#endif /* * Definition for MIG-generated server stub routines. These routines * unpack the request message, call the server procedure, and pack the * reply message. */ -typedef void (*mig_stub_routine_t) (mach_msg_header_t *InHeadP, - mach_msg_header_t *OutHeadP); +typedef void (*mig_stub_routine_t) (mach_msg_header_t *InHeadP, + mach_msg_header_t *OutHeadP); typedef mig_stub_routine_t mig_routine_t; @@ -99,13 +103,13 @@ typedef mach_msg_type_descriptor_t *mig_routine_arg_descriptor_t; #define MIG_ROUTINE_ARG_DESCRIPTOR_NULL ((mig_routine_arg_descriptor_t)0) struct routine_descriptor { - mig_impl_routine_t impl_routine; /* Server work func pointer */ - mig_stub_routine_t stub_routine; /* Unmarshalling func pointer */ - unsigned int argc; /* Number of argument words */ - unsigned int descr_count; /* Number complex descriptors */ + mig_impl_routine_t impl_routine; /* Server work func pointer */ + mig_stub_routine_t stub_routine; /* Unmarshalling func pointer */ + unsigned int argc; /* Number of argument words */ + unsigned int descr_count; /* Number complex descriptors */ routine_arg_descriptor_t - arg_descr; /* pointer to descriptor array*/ - unsigned int max_reply_msg; /* Max size for reply msg */ + arg_descr; /* pointer to descriptor array*/ + unsigned int max_reply_msg; /* Max size for reply msg */ }; typedef struct routine_descriptor *routine_descriptor_t; @@ -115,28 +119,39 @@ typedef mig_routine_descriptor *mig_routine_descriptor_t; #define MIG_ROUTINE_DESCRIPTOR_NULL ((mig_routine_descriptor_t)0) typedef struct mig_subsystem { - mig_server_routine_t server; /* pointer to demux routine */ - mach_msg_id_t start; /* Min routine number */ - mach_msg_id_t end; /* Max routine number + 1 */ - mach_msg_size_t maxsize; /* Max reply message size */ - vm_address_t reserved; /* reserved for MIG use */ + mig_server_routine_t server; /* pointer to demux routine */ + mach_msg_id_t start; /* Min routine number */ + mach_msg_id_t end; /* Max routine number + 1 */ + mach_msg_size_t maxsize; /* Max reply message size */ + vm_address_t reserved; /* reserved for MIG use */ mig_routine_descriptor - routine[1]; /* Routine descriptor array */ + routine[1]; /* Routine descriptor array */ } *mig_subsystem_t; -#define MIG_SUBSYSTEM_NULL ((mig_subsystem_t)0) +#define MIG_SUBSYSTEM_NULL ((mig_subsystem_t)0) typedef struct mig_symtab { - char *ms_routine_name; - int ms_routine_number; - void (*ms_routine)(void); /* Since the functions in the - * symbol table have unknown - * signatures, this is the best - * we can do... - */ + char *ms_routine_name; + int ms_routine_number; + void (*ms_routine)(void); /* Since the functions in the + * symbol table have unknown + * signatures, this is the best + * we can do... + */ } mig_symtab_t; -#ifdef PRIVATE +/* + * A compiler attribute for annotating all MIG server routines and other + * functions that should behave similarly. Allows the compiler to perform + * additional static bug-finding over them. + */ +#if __has_attribute(mig_server_routine) +#define MIG_SERVER_ROUTINE __attribute__((mig_server_routine)) +#else +#define MIG_SERVER_ROUTINE +#endif + +#ifdef PRIVATE /* MIG object runtime - not ready for public consumption */ @@ -160,51 +175,51 @@ typedef struct mig_symtab { * Coming soon: * - User-level support */ -typedef unsigned int mig_notify_type_t; +typedef unsigned int mig_notify_type_t; typedef struct MIGIID { - unsigned long data1; - unsigned short data2; - unsigned short data3; - unsigned char data4[8]; + unsigned long data1; + unsigned short data2; + unsigned short data3; + unsigned char data4[8]; } MIGIID; -typedef struct IMIGObjectVtbl IMIGObjectVtbl; -typedef struct IMIGNotifyObjectVtbl IMIGNotifyObjectVtbl; +typedef struct IMIGObjectVtbl IMIGObjectVtbl; +typedef struct IMIGNotifyObjectVtbl IMIGNotifyObjectVtbl; typedef struct IMIGObject { - const IMIGObjectVtbl *pVtbl; + const IMIGObjectVtbl *pVtbl; } IMIGObject; typedef struct IMIGNotifyObject { - const IMIGNotifyObjectVtbl *pVtbl; + const IMIGNotifyObjectVtbl *pVtbl; } IMIGNotifyObject; struct IMIGObjectVtbl { kern_return_t (*QueryInterface)( - IMIGObject *object, - const MIGIID *iid, - void **ppv); + IMIGObject *object, + const MIGIID *iid, + void **ppv); unsigned long (*AddRef)( - IMIGObject *object); + IMIGObject *object); - unsigned long (*Release)( - IMIGObject *object); + unsigned long (*Release)( + IMIGObject *object); unsigned long (*GetServer)( - IMIGObject *object, - mig_server_routine_t *server); - + IMIGObject *object, + mig_server_routine_t *server); + boolean_t (*RaiseNotification)( - IMIGObject *object, - mig_notify_type_t notify_type); + IMIGObject *object, + mig_notify_type_t notify_type); boolean_t (*RequestNotification)( - IMIGObject *object, - IMIGNotifyObject *notify, - mig_notify_type_t notify_type); -}; + IMIGObject *object, + IMIGNotifyObject *notify, + mig_notify_type_t notify_type); +}; /* * IMIGNotifyObject @@ -224,36 +239,36 @@ struct IMIGObjectVtbl { */ struct IMIGNotifyObjectVtbl { kern_return_t (*QueryInterface)( - IMIGNotifyObject *notify, - const MIGIID *iid, - void **ppv); + IMIGNotifyObject *notify, + const MIGIID *iid, + void **ppv); - unsigned long (*AddRef)( - IMIGNotifyObject *notify); + unsigned long (*AddRef)( + IMIGNotifyObject *notify); - unsigned long (*Release)( - IMIGNotifyObject *notify); + unsigned long (*Release)( + IMIGNotifyObject *notify); unsigned long (*GetServer)( - IMIGNotifyObject *notify, - mig_server_routine_t *server); + IMIGNotifyObject *notify, + mig_server_routine_t *server); boolean_t (*RaiseNotification)( - IMIGNotifyObject *notify, - mig_notify_type_t notify_type); + IMIGNotifyObject *notify, + mig_notify_type_t notify_type); boolean_t (*RequestNotification)( - IMIGNotifyObject *notify, - IMIGNotifyObject *notify_notify, - mig_notify_type_t notify_type); + IMIGNotifyObject *notify, + IMIGNotifyObject *notify_notify, + mig_notify_type_t notify_type); void (*HandleNotification)( - IMIGNotifyObject *notify, - IMIGObject *object, - mig_notify_type_t notify_type); + IMIGNotifyObject *notify, + IMIGObject *object, + mig_notify_type_t notify_type); }; -#endif /* KERNEL_PRIVATE */ +#endif /* KERNEL_PRIVATE */ #endif /* PRIVATE */ __BEGIN_DECLS @@ -268,12 +283,13 @@ extern void mig_dealloc_reply_port(mach_port_t reply_port); extern void mig_put_reply_port(mach_port_t reply_port); /* Bounded string copy */ -extern int mig_strncpy(char *dest, const char *src, int len); +extern int mig_strncpy(char *dest, const char *src, int len); +extern int mig_strncpy_zerofill(char *dest, const char *src, int len); #ifdef KERNEL_PRIVATE /* Allocate memory for out-of-stack mig structures */ -extern char *mig_user_allocate(vm_size_t size); +extern void *mig_user_allocate(vm_size_t size); /* Deallocate memory used for out-of-stack mig structures */ extern void mig_user_deallocate(char *data, vm_size_t size); @@ -290,4 +306,4 @@ extern void mig_deallocate(vm_address_t, vm_size_t); __END_DECLS -#endif /* _MACH_MIG_H_ */ +#endif /* _MACH_MIG_H_ */