osfmk/mach/kext_panic_report.h

   1 /*
   2  * Copyright (c) 2009 Apple Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_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. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28 #ifndef _KEXT_PANIC_REPORT_H_
  29 #define _KEXT_PANIC_REPORT_H_
  30
  31 #include <sys/cdefs.h>
  32
  33 __BEGIN_DECLS
  34
  35 /*******************************************************************************
  36 * String-compaction tables for panic reports' kext listing.
  37 *******************************************************************************/
  38
  39 typedef struct subs_entry_t {
  40     const char * substring;
  41     char         substitute;
  42 } subs_entry_t;
  43
  44 /* Prefix substitution list. Common prefixes are replaced with a single
  45  * nonalphanumeric character at the beginning of the identifier.
  46  *
  47  * List should be in descending order of # components, and should then
  48  * be in descending frequency order.
  49  */
  50 subs_entry_t kext_identifier_prefix_subs[] = {
  51     { "com.apple.driver.",   '>' },
  52     { "com.apple.iokit.",    '|' },
  53     { "com.apple.security.", '$' },
  54     { "com.apple.",          '@' },
  55
  56     { (char *)0,             '\0' }
  57 };
  58
  59 /* Substring substitution list. Substrings are replaced with a '!' followed
  60  * by a single letter mapping to the original string.
  61  *
  62  * List should be in descending frequency order, and within
  63  * groups containing same prefix, in descending length order.
  64  */
  65 subs_entry_t kext_identifier_substring_subs[] = {
  66     { "AppleUSB",   'U' },
  67     { "Apple",      'A' },
  68     { "Family",     'F' },
  69     { "Storage",    'S' },
  70     { "Controller", 'C' },
  71     { "Bluetooth",  'B' },
  72     { "Intel",      'I' },
  73
  74     // CHUD kexts, typically not on user installs
  75     { "Profile",    'P' },
  76     { "Action",     'a' },   // maybe K if we want to stick to all-caps
  77
  78     { (char *)0,    '\0' }
  79 };
  80
  81 __END_DECLS
  82 #endif /* _KEXT_PANIC_REPORT_H_ */