CachelessInternal.h

Go to the documentation of this file.

 
#ifndef CACHELESS_INTERNAL_H
#define CACHELESS_INTERNAL_H
 
#include <Library/OcAppleKernelLib.h>
#include <Library/OcStringLib.h>
 
//
// Names are of format OcXXXXXXXX.kext, where XXXXXXXX is a 32-bit hexadecimal number.
//
#define KEXT_BUNDLE_NAME       L"OcXXXXXXXX.kext"
#define KEXT_BUNDLE_NAME_SIZE  (L_STR_SIZE (KEXT_BUNDLE_NAME))
#define KEXT_BUNDLE_NAME_LEN   (L_STR_LEN (KEXT_BUNDLE_NAME))
#define KEXT_BUNDLE_INFO_SIZE  (SIZE_OF_EFI_FILE_INFO + KEXT_BUNDLE_NAME_SIZE)
 
enum {
  KEXT_OSBUNDLE_REQUIRED_NONE = 0,
  KEXT_OSBUNDLE_REQUIRED_INVALID,
  KEXT_OSBUNDLE_REQUIRED_VALID
};
 
//
// Kext dependency.
//
typedef struct {
  //
  // Signature.
  //
  UINT32        Signature;
  //
  // Link for global list.
  //
  LIST_ENTRY    Link;
  //
  // Bundle identifier.
  //
  CHAR8         *Identifier;
} DEPEND_KEXT;
 
//
// Cacheless kext.
//
typedef struct {
  //
  // Signature.
  //
  UINT32        Signature;
  //
  // Link for global list (CACHELESS_CONTEXT -> InjectedKexts).
  //
  LIST_ENTRY    Link;
  //
  // Bundle filename used during S/L/E overlay creation.
  //
  CHAR16        BundleFileName[KEXT_BUNDLE_NAME_LEN + 1];
  //
  // Plist data.
  //
  CHAR8         *PlistData;
  //
  // Plist data size.
  //
  UINT32        PlistDataSize;
  //
  // Binary data.
  //
  UINT8         *BinaryData;
  //
  // Binary data size.
  //
  UINT32        BinaryDataSize;
  //
  // Binary file name.
  //
  CHAR16        *BinaryFileName;
} CACHELESS_KEXT;
 
//
// Kext patch.
//
typedef struct {
  //
  // Signature.
  //
  UINT32                   Signature;
  //
  // Link for global list (PATCHED_BUILTIN_KEXT -> Patches).
  //
  LIST_ENTRY               Link;
  //
  // Generic patch.
  //
  PATCHER_GENERIC_PATCH    Patch;
  //
  // Apply Quirk instead of Patch.
  //
  BOOLEAN                  ApplyQuirk;
  //
  // Kernel quirk to apply.
  //
  KERNEL_QUIRK_NAME        QuirkName;
} KEXT_PATCH;
 
//
// Built-in kext in SLE requiring patches.
//
typedef struct {
  //
  // Signature.
  //
  UINT32        Signature;
  //
  // Link for global list (CACHELESS_CONTEXT -> PatchedKexts).
  //
  LIST_ENTRY    Link;
  //
  // Bundle identifier.
  //
  CHAR8         *Identifier;
  //
  // List of patches to apply.
  //
  LIST_ENTRY    Patches;
  //
  // Block kext.
  //
  BOOLEAN       Block;
} PATCHED_KEXT;
 
//
// Built-in kexts in SLE.
//
typedef struct {
  //
  // Signature.
  //
  UINT32        Signature;
  //
  // Link for global list (CACHELESS_CONTEXT -> BuiltInKexts).
  //
  LIST_ENTRY    Link;
  //
  // Plist path.
  //
  CHAR16        *PlistPath;
  //
  // Bundle identifier.
  //
  CHAR8         *Identifier;
  //
  // Binary file name.
  //
  CHAR16        *BinaryFileName;
  //
  // Binary file path.
  //
  CHAR16        *BinaryPath;
  //
  // Dependencies.
  //
  LIST_ENTRY    Dependencies;
  //
  // OSBundleRequired is valid?
  //
  UINT8         OSBundleRequiredValue;
  //
  // Needs OSBundleRequired override for dependency injection?
  //
  BOOLEAN       PatchValidOSBundleRequired;
  //
  // Needs patches or blocks?
  //
  BOOLEAN       PatchKext;
} BUILTIN_KEXT;
 
//
// DEPEND_KEXT signature for list identification.
//
#define DEPEND_KEXT_SIGNATURE  SIGNATURE_32 ('S', 'l', 'e', 'D')
 
#define GET_DEPEND_KEXT_FROM_LINK(This)  \
  (CR (                                  \
    (This),                              \
    DEPEND_KEXT,                         \
    Link,                                \
    DEPEND_KEXT_SIGNATURE                \
    ))
 
//
// CACHELESS_KEXT signature for list identification.
//
#define CACHELESS_KEXT_SIGNATURE  SIGNATURE_32 ('S', 'l', 'e', 'X')
 
#define GET_CACHELESS_KEXT_FROM_LINK(This)  \
  (CR (                                     \
    (This),                                 \
    CACHELESS_KEXT,                         \
    Link,                                   \
    CACHELESS_KEXT_SIGNATURE                \
    ))
 
//
// KEXT_PATCH signature for list identification.
//
#define KEXT_PATCH_SIGNATURE  SIGNATURE_32 ('K', 'x', 't', 'P')
 
#define GET_KEXT_PATCH_FROM_LINK(This)  \
  (CR (                                 \
    (This),                             \
    KEXT_PATCH,                         \
    Link,                               \
    KEXT_PATCH_SIGNATURE                \
    ))
 
//
// PATCHED_KEXT signature for list identification.
//
#define PATCHED_KEXT_SIGNATURE  SIGNATURE_32 ('S', 'l', 'e', 'P')
 
#define GET_PATCHED_KEXT_FROM_LINK(This)  \
  (CR (                                   \
    (This),                               \
    PATCHED_KEXT,                         \
    Link,                                 \
    PATCHED_KEXT_SIGNATURE                \
    ))
 
//
// BUILTIN_KEXT signature for list identification.
//
#define BUILTIN_KEXT_SIGNATURE  SIGNATURE_32 ('S', 'l', 'e', 'B')
 
#define GET_BUILTIN_KEXT_FROM_LINK(This)  \
  (CR (                                   \
    (This),                               \
    BUILTIN_KEXT,                         \
    Link,                                 \
    BUILTIN_KEXT_SIGNATURE                \
    ))
 
#endif