osfmk/mach/mig_errors.h

   1 /*
   2  * Copyright (c) 2000-2005 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_OSREFERENCE_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
  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@
  29  */
  30 /*
  31  * @OSF_COPYRIGHT@
  32  */
  33 /*
  34  * Mach Operating System
  35  * Copyright (c) 1991,1990,1989,1988,1987 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  * Mach Interface Generator errors
  62  *
  63  */
  64
  65 #ifndef _MACH_MIG_ERRORS_H_
  66 #define _MACH_MIG_ERRORS_H_
  67
  68 #include <mach/mig.h>
  69 #include <mach/ndr.h>
  70 #include <mach/message.h>
  71 #include <mach/kern_return.h>
  72
  73 #include <sys/cdefs.h>
  74
  75 /*
  76  *      These error codes should be specified as system 4, subsytem 2.
  77  *      But alas backwards compatibility makes that impossible.
  78  *      The problem is old clients of new servers (eg, the kernel)
  79  *      which get strange large error codes when there is a Mig problem
  80  *      in the server.  Unfortunately, the IPC system doesn't have
  81  *      the knowledge to convert the codes in this situation.
  82  */
  83
  84 #define MIG_TYPE_ERROR          -300    /* client type check failure */
  85 #define MIG_REPLY_MISMATCH      -301    /* wrong reply message ID */
  86 #define MIG_REMOTE_ERROR        -302    /* server detected error */
  87 #define MIG_BAD_ID              -303    /* bad request message ID */
  88 #define MIG_BAD_ARGUMENTS       -304    /* server type check failure */
  89 #define MIG_NO_REPLY            -305    /* no reply should be send */
  90 #define MIG_EXCEPTION           -306    /* server raised exception */
  91 #define MIG_ARRAY_TOO_LARGE     -307    /* array not large enough */
  92 #define MIG_SERVER_DIED         -308    /* server died */
  93 #define MIG_TRAILER_ERROR       -309    /* trailer has an unknown format */
  94
  95 /*
  96  *      Whenever MIG detects an error, it sends back a generic
  97  *      mig_reply_error_t format message.  Clients must accept
  98  *      these in addition to the expected reply message format.
  99  */
 100 #pragma pack(4)
 101 typedef struct {
 102         mach_msg_header_t       Head;
 103         NDR_record_t            NDR;
 104         kern_return_t           RetCode;
 105 } mig_reply_error_t;
 106 #pragma pack()
 107
 108
 109 __BEGIN_DECLS
 110
 111 #define __NDR_convert__mig_reply_error_t__defined
 112 #if mig_internal
 113 mig_internal
 114 #else
 115 static
 116 #endif
 117 __inline__ void
 118 __NDR_convert__mig_reply_error_t(mig_reply_error_t *x)
 119 {
 120 #if defined(__NDR_convert__int_rep__kern_return_t__defined)
 121         if (x->NDR.int_rep != NDR_record.int_rep)
 122                 __NDR_convert__int_rep__kern_return_t(&x->RetCode, x->NDR.int_rep);
 123 #endif /* __NDR_convert__int_rep__kern_return_t__defined */
 124 }
 125
 126 __END_DECLS
 127
 128 #endif  /* _MACH_MIG_ERRORS_H_ */