osfmk/mach/mig_errors.h

   1 /*
   2  * Copyright (c) 2000-2005 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_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. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23 /*
  24  * @OSF_COPYRIGHT@
  25  */
  26 /*
  27  * Mach Operating System
  28  * Copyright (c) 1991,1990,1989,1988,1987 Carnegie Mellon University
  29  * All Rights Reserved.
  30  *
  31  * Permission to use, copy, modify and distribute this software and its
  32  * documentation is hereby granted, provided that both the copyright
  33  * notice and this permission notice appear in all copies of the
  34  * software, derivative works or modified versions, and any portions
  35  * thereof, and that both notices appear in supporting documentation.
  36  *
  37  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
  38  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
  39  * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
  40  *
  41  * Carnegie Mellon requests users of this software to return to
  42  *
  43  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
  44  *  School of Computer Science
  45  *  Carnegie Mellon University
  46  *  Pittsburgh PA 15213-3890
  47  *
  48  * any improvements or extensions that they make and grant Carnegie Mellon
  49  * the rights to redistribute these changes.
  50  */
  51 /*
  52  */
  53 /*
  54  * Mach Interface Generator errors
  55  *
  56  */
  57
  58 #ifndef _MACH_MIG_ERRORS_H_
  59 #define _MACH_MIG_ERRORS_H_
  60
  61 #include <mach/mig.h>
  62 #include <mach/ndr.h>
  63 #include <mach/message.h>
  64 #include <mach/kern_return.h>
  65
  66 #include <sys/cdefs.h>
  67
  68 /*
  69  *      These error codes should be specified as system 4, subsytem 2.
  70  *      But alas backwards compatibility makes that impossible.
  71  *      The problem is old clients of new servers (eg, the kernel)
  72  *      which get strange large error codes when there is a Mig problem
  73  *      in the server.  Unfortunately, the IPC system doesn't have
  74  *      the knowledge to convert the codes in this situation.
  75  */
  76
  77 #define MIG_TYPE_ERROR          -300    /* client type check failure */
  78 #define MIG_REPLY_MISMATCH      -301    /* wrong reply message ID */
  79 #define MIG_REMOTE_ERROR        -302    /* server detected error */
  80 #define MIG_BAD_ID              -303    /* bad request message ID */
  81 #define MIG_BAD_ARGUMENTS       -304    /* server type check failure */
  82 #define MIG_NO_REPLY            -305    /* no reply should be send */
  83 #define MIG_EXCEPTION           -306    /* server raised exception */
  84 #define MIG_ARRAY_TOO_LARGE     -307    /* array not large enough */
  85 #define MIG_SERVER_DIED         -308    /* server died */
  86 #define MIG_TRAILER_ERROR       -309    /* trailer has an unknown format */
  87
  88 /*
  89  *      Whenever MIG detects an error, it sends back a generic
  90  *      mig_reply_error_t format message.  Clients must accept
  91  *      these in addition to the expected reply message format.
  92  */
  93 #pragma pack(4)
  94 typedef struct {
  95         mach_msg_header_t       Head;
  96         NDR_record_t            NDR;
  97         kern_return_t           RetCode;
  98 } mig_reply_error_t;
  99 #pragma pack()
 100
 101
 102 __BEGIN_DECLS
 103
 104 #define __NDR_convert__mig_reply_error_t__defined
 105 #if mig_internal
 106 mig_internal
 107 #else
 108 static
 109 #endif
 110 __inline__ void
 111 __NDR_convert__mig_reply_error_t(mig_reply_error_t *x)
 112 {
 113 #if defined(__NDR_convert__int_rep__kern_return_t__defined)
 114         if (x->NDR.int_rep != NDR_record.int_rep)
 115                 __NDR_convert__int_rep__kern_return_t(&x->RetCode, x->NDR.int_rep);
 116 #endif /* __NDR_convert__int_rep__kern_return_t__defined */
 117 }
 118
 119 __END_DECLS
 120
 121 #endif  /* _MACH_MIG_ERRORS_H_ */