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