osfmk/mach/mig_errors.h

   1 /*
   2  * Copyright (c) 2000-2003 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * Copyright (c) 1999-2003 Apple Computer, Inc.  All Rights Reserved.
   7  *
   8  * This file contains Original Code and/or Modifications of Original Code
   9  * as defined in and that are subject to the Apple Public Source License
  10  * Version 2.0 (the 'License'). You may not use this file except in
  11  * compliance with the License. Please obtain a copy of the License at
  12  * http://www.opensource.apple.com/apsl/ and read it before using this
  13  * file.
  14  *
  15  * The Original Code and all software distributed under the License are
  16  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  17  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  18  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  20  * Please see the License for the specific language governing rights and
  21  * limitations under the License.
  22  *
  23  * @APPLE_LICENSE_HEADER_END@
  24  */
  25 /*
  26  * @OSF_COPYRIGHT@
  27  */
  28 /*
  29  * Mach Operating System
  30  * Copyright (c) 1991,1990,1989,1988,1987 Carnegie Mellon University
  31  * All Rights Reserved.
  32  *
  33  * Permission to use, copy, modify and distribute this software and its
  34  * documentation is hereby granted, provided that both the copyright
  35  * notice and this permission notice appear in all copies of the
  36  * software, derivative works or modified versions, and any portions
  37  * thereof, and that both notices appear in supporting documentation.
  38  *
  39  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
  40  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
  41  * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
  42  *
  43  * Carnegie Mellon requests users of this software to return to
  44  *
  45  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
  46  *  School of Computer Science
  47  *  Carnegie Mellon University
  48  *  Pittsburgh PA 15213-3890
  49  *
  50  * any improvements or extensions that they make and grant Carnegie Mellon
  51  * the rights to redistribute these changes.
  52  */
  53 /*
  54  */
  55 /*
  56  * Mach Interface Generator errors
  57  *
  58  */
  59
  60 #ifndef _MACH_MIG_ERRORS_H_
  61 #define _MACH_MIG_ERRORS_H_
  62
  63 #include <mach/mig.h>
  64 #include <mach/ndr.h>
  65 #include <mach/message.h>
  66 #include <mach/kern_return.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 typedef struct {
  94         mach_msg_header_t       Head;
  95         NDR_record_t            NDR;
  96         kern_return_t           RetCode;
  97 } mig_reply_error_t;
  98
  99 #define __NDR_convert__mig_reply_error_t__defined
 100 #if mig_internal
 101 mig_internal
 102 #else
 103 static
 104 #endif
 105 __inline__ void
 106 __NDR_convert__mig_reply_error_t(mig_reply_error_t *x)
 107 {
 108 #if defined(__NDR_convert__int_rep__kern_return_t__defined)
 109         if (x->NDR.int_rep != NDR_record.int_rep)
 110                 __NDR_convert__int_rep__kern_return_t(&x->RetCode, x->NDR.int_rep);
 111 #endif /* __NDR_convert__int_rep__kern_return_t__defined */
 112 }
 113
 114 #endif  /* _MACH_MIG_ERRORS_H_ */
 115