/*
 * Copyright (c) 2016 Apple Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_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.
 *
 * 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_OSREFERENCE_LICENSE_HEADER_END@
 */
/*
 * Mach Operating System
 * Copyright (c) 1989 Carnegie-Mellon University
 * Copyright (c) 1988 Carnegie-Mellon University
 * Copyright (c) 1987 Carnegie-Mellon University
 * All rights reserved.  The CMU software License Agreement specifies
 * the terms and conditions for use and redistribution.
 */

/*
 * EXC_GUARD related macros, namespace etc.
 */

#ifndef _EXC_GUARD_H_
#define _EXC_GUARD_H_

/*
 * EXC_GUARD exception code namespace.
 *
 * code:
 * +-------------------+----------------+--------------+
 * |[63:61] guard type | [60:32] flavor | [31:0] target|
 * +-------------------+----------------+--------------+
 *
 * subcode:
 * +---------------------------------------------------+
 * |[63:0] guard identifier                            |
 * +---------------------------------------------------+
 */

#define EXC_GUARD_DECODE_GUARD_TYPE(code) \
	((((uint64_t)(code)) >> 61) & 0x7ull)
#define EXC_GUARD_DECODE_GUARD_FLAVOR(code) \
	((((uint64_t)(code)) >> 32) & 0x1fffffff)
#define EXC_GUARD_DECODE_GUARD_TARGET(code) \
	((uint32_t)(code))

/* EXC_GUARD types */

#define GUARD_TYPE_NONE         0x0

/*
 * Mach port guards use the exception codes like this:
 *
 * code:
 * +-----------------------------+----------------+-----------------+
 * |[63:61] GUARD_TYPE_MACH_PORT | [60:32] flavor | [31:0] target   |
 * +-----------------------------+----------------+-----------------+
 *
 * subcode:
 * +----------------------------------------------------------------+
 * |[63:0] payload                                                  |
 * +----------------------------------------------------------------+
 *
 * - flavors are defined in <mach/port.h>
 * - meaning of target and payload is described
 *   in doc/mach_ipc/guard_exceptions.md
 */

#define GUARD_TYPE_MACH_PORT    0x1      /* guarded mach port */

/*
 * File descriptor guards use the exception codes this:
 *
 * code:
 * +-----------------------------+----------------+-----------------+
 * |[63:61] GUARD_TYPE_FD        | [60:32] flavor | [31:0] fd       |
 * +-----------------------------+----------------+-----------------+
 *
 * subcode:
 * +----------------------------------------------------------------+
 * |[63:0] guard identifier                                         |
 * +----------------------------------------------------------------+
 */

#define GUARD_TYPE_FD           0x2     /* guarded file descriptor */

/*
 * User generated guards use the exception codes this:
 *
 * code:
 * +-----------------------------+----------------+-----------------+
 * |[63:61] GUARD_TYPE_USER      | [60:32] unused | [31:0] namespc  |
 * +-----------------------------+----------------+-----------------+
 *
 * subcode:
 * +----------------------------------------------------------------+
 * |[63:0] reason_code                                              |
 * +----------------------------------------------------------------+
 */

#define GUARD_TYPE_USER         0x3     /* Userland assertions */

/*
 * Vnode guards use the exception codes like this:
 *
 * code:
 * +-----------------------------+----------------+-----------------+
 * |[63:61] GUARD_TYPE_VN        | [60:32] flavor | [31:0] pid      |
 * +-----------------------------+----------------+-----------------+
 *
 * subcode:
 * +----------------------------------------------------------------+
 * |[63:0] guard identifier                                         |
 * +----------------------------------------------------------------+
 */

#define GUARD_TYPE_VN           0x4     /* guarded vnode */

/*
 * VM guards use the exception codes like this:
 *
 * code:
 * +-------------------------------+----------------+-----------------+
 * |[63:61] GUARD_TYPE_VIRT_MEMORY | [60:32] flavor | [31:0] unused   |
 * +-------------------------------+----------------+-----------------+
 *
 * subcode:
 * +----------------------------------------------------------------+
 * |[63:0] offset                                                   |
 * +----------------------------------------------------------------+
 */

#define GUARD_TYPE_VIRT_MEMORY  0x5     /* VM operation violating guard */

/*
 * Rejected syscalls use the exception codes like this:
 *
 * code:
 * +-------------------------------+----------------+------------------+
 * |[63:61] GUARD_TYPE_REJECTED_SC | [60:32] unused | [31:0] mach_trap |
 * +-------------------------------+----------------+------------------+
 *
 * subcode:
 * +----------------------------------------------------------------+
 * |[63:0] syscall (if mach_trap field is 0), or mach trap number   |
 * +----------------------------------------------------------------+
 */

#define GUARD_TYPE_REJECTED_SC  0x6     /* rejected system call trap */

/*
 * App resumes use the exception codes like this:
 *
 * code:
 * +-------------------------------+----------------------+------------+
 * |[63:61] GUARD_TYPE_APP_RESUME  | [60:32] unused       | [31:0] pid |
 * +-------------------------------+----------------------+------------+
 *
 * subcode:
 * +----------------------------------------------------------------+
 * |[63:0] unused                                                   |
 * +----------------------------------------------------------------+
 */

#define GUARD_TYPE_FROZEN_SWAPIN 0x7     /* swapin of frozen app */

/*
 * Return a human-readable string for a guard type.
 */
#define EXC_GUARD_NAME_FOR_TYPE(guard_type) \
	(((guard_type) == GUARD_TYPE_NONE)        ? "NONE" : \
	 ((guard_type) == GUARD_TYPE_MACH_PORT)   ? "MACH_PORT" : \
	 ((guard_type) == GUARD_TYPE_FD)          ? "FD" : \
	 ((guard_type) == GUARD_TYPE_USER)        ? "USER" : \
	 ((guard_type) == GUARD_TYPE_VN)          ? "VNODE" : \
	 ((guard_type) == GUARD_TYPE_VIRT_MEMORY) ? "VIRT_MEMORY" : \
	 ((guard_type) == GUARD_TYPE_REJECTED_SC) ? "REJECTED_SC" : \
	 ((guard_type) == GUARD_TYPE_FROZEN_SWAPIN) ? "FROZEN_SWAPIN" : \
	 "UNKNOWN")


#define EXC_GUARD_ENCODE_TYPE(code, type) \
	((code) |= (((uint64_t)(type) & 0x7ull) << 61))
#define EXC_GUARD_ENCODE_FLAVOR(code, flavor) \
	((code) |= (((uint64_t)(flavor) & 0x1fffffffull) << 32))
#define EXC_GUARD_ENCODE_TARGET(code, target) \
	((code) |= (((uint64_t)(target) & 0xffffffffull)))
#define EXC_GUARD_ENCODE_RESIDENT_FOOTPRINT(code, flavor) \
	((code) |= (((uint64_t)(flavor) & 0x1fffffffull) << 32))


#endif /* _EXC_GUARD_H_ */
