[ { "path": ".github/workflows/swift.yml", "content": "name: Swift\n\non:\n push:\n branches: [ master ]\n pull_request:\n branches: [ master ]\n\njobs:\n build:\n\n runs-on: macos-12\n\n steps:\n - uses: actions/checkout@v3\n - name: Build\n run: swift build -v\n - name: Run tests\n run: swift test -v\n" }, { "path": ".gitignore", "content": ".docc-build/\n.swiftpm/\n.DS_Store\n.build\n/Packages\n/*.xcodeproj\nxcuserdata/\n" }, { "path": "LICENSE", "content": "MIT License\n\nCopyright (c) 2022 Yu Ao\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n" }, { "path": "Package.resolved", "content": "{\n \"object\": {\n \"pins\": [\n {\n \"package\": \"swift-crypto\",\n \"repositoryURL\": \"https://github.com/apple/swift-crypto.git\",\n \"state\": {\n \"branch\": null,\n \"revision\": \"a8911e0fadc25aef1071d582355bd1037a176060\",\n \"version\": \"2.0.4\"\n }\n }\n ]\n },\n \"version\": 1\n}\n" }, { "path": "Package.swift", "content": "// swift-tools-version:5.5\n// The swift-tools-version declares the minimum version of Swift required to build this package.\n\nimport PackageDescription\nimport Foundation\n\nlet isUsingSwiftWASMToolchain = (ProcessInfo.processInfo.environment[\"TOOLCHAINS\"] == \"swiftwasm\")\n\nlet packageDependencies: [Package.Dependency]\nif isUsingSwiftWASMToolchain {\n packageDependencies = []\n} else {\n packageDependencies = [.package(url: \"https://github.com/apple/swift-crypto.git\", \"1.0.0\" ..< \"3.0.0\")]\n}\n\nlet metalLibraryArchiveTargetDependencies: [Target.Dependency]\nif isUsingSwiftWASMToolchain {\n metalLibraryArchiveTargetDependencies = []\n} else {\n metalLibraryArchiveTargetDependencies = [.product(name: \"Crypto\", package: \"swift-crypto\")]\n}\n\nlet package = Package(\n name: \"MetalLibraryArchive\",\n platforms: [\n .macOS(.v10_15),\n .iOS(.v13),\n .watchOS(.v6),\n .tvOS(.v13),\n .macCatalyst(.v13)\n ],\n products: [\n .library(\n name: \"MetalLibraryArchive\",\n targets: [\"MetalLibraryArchive\"]),\n ],\n dependencies: packageDependencies,\n targets: [\n .executableTarget(name: \"Explorer\",\n dependencies: [\n \"MetalLibraryArchive\"\n ]),\n .target(name: \"MetalLibraryArchive\",\n dependencies: metalLibraryArchiveTargetDependencies),\n .testTarget(\n name: \"MetalLibraryArchiveTests\",\n dependencies: [\n \"MetalLibraryArchive\"\n ]),\n ]\n)\n" }, { "path": "README.md", "content": "# Metal Library Archive\n\n![](https://github.com/YuAo/MetalLibraryArchive/workflows/Swift/badge.svg)\n\n`MetalLibraryArchive` is a product of reverse-engineering Apple's `metallib` file format. \n\nYou can use `MetalLibraryArchive` to get the library type, target platform, Metal functions, etc., from a `metallib` file.\n\nThe extracted information of a Metal function includes:\n\n- Function name.\n- Function type - vertex, fragment, kernel, extern, etc.\n- Metal Shading Language version of the function.\n- Bitcode of the function which can be converted into human-readable LLVM assembly language using [llvm-dis](https://llvm.org/docs/CommandGuide/llvm-dis.html).\n- Source code of the function if the `metallib` is configured to include source code.\n\n## 🎈 Usage\n\n### Web App\n\nAvailable at: https://yuao.github.io/MetalLibraryExplorer\n\n[Learn more](https://github.com/YuAo/MetalLibraryExplorer)\n\n### Explorer App\n\nAn executable target called \"Explorer\" is included in the package. \"Explorer\" is a GUI app that can open, unpack and disassemble (with the help of `llvm-dis`) `metallib` files.\n\n**Note** `llvm-dis` is not included, you can get a copy of the binary at https://github.com/llvm/llvm-project/releases\n\nUse the \"Disassembler\" menu in the app to locate the `llvm-dis` executable file. \n\n![Screenshot](Assets/Explorer-Screenshot.png)\n\n### Library\n\nYou can also use `MetalLibraryArchive` as a library:\n\n```Swift\nimport MetalLibraryArchive\n\nlet archive = try Archive(data: Data(contentsOf: metallibURL))\nlet libraryType = archive.libraryType\nlet functions = archive.functions\n```\n\n## 🚧 Metal Library Archive Binary Layout\n\n### Header\n\n| Byte Range | Type | Content |\n|------------|--------|-------------------------------|\n| 0...3 | FourCharCode | MTLB |\n| 4...5 | UInt16 | Target platform |\n| 6...9 | (UInt16, UInt16) | Version of the metallib file (major, minor) |\n| 10 | UInt8 | Type of the metallib file |\n| 11 | UInt8 | Target OS |\n| 12...15 | (UInt16, UInt16) | Version of the target OS (major, minor) |\n| 16...23 | UInt64 | Size of the metallib file |\n| 24...39 | (UInt64, UInt64) | Offset and size of the function list |\n| 40...55 | (UInt64, UInt64) | Offset and size of the public metadata section |\n| 56...71 | (UInt64, UInt64) | Offset and size of the private metadata section |\n| 72...87 | (UInt64, UInt64) | Offset and size of the bitcode section |\n\n| Target Platform | Value |\n|----|-------|\n| macOS | 0x8001 (0x01,0x80)|\n| iOS | 0x0001 (0x01,0x00) |\n\n| metallib Type | Value |\n|----|-------|\n| Executable | 0x00 |\n| Core Image | 0x01 |\n| Dynamic | 0x02 |\n| Symbol Companion | 0x03 |\n\n| Target OS | Value |\n|----|-------|\n| Unknown | 0x00 |\n| macOS | 0x81 |\n| iOS | 0x82 | \n| tvOS | 0x83 |\n| watchOS | 0x84 |\n| bridgeOS [(Probably)](https://github.com/apple-oss-distributions/dyld/blob/419f8cbca6fb3420a248f158714a9d322af2aa5a/cache-builder/mrm_shared_cache_builder.h#L45) | 0x85 |\n| macCatalyst | 0x86 |\n| iOS Simulator | 0x87 |\n| tvOS Simulator | 0x88 |\n| watchOS Simulator | 0x89 |\n\n### Function List\n\n| Byte Range | Type | Content |\n|------------|------------|---------------------------------------|\n| 0...3 | UInt32 | Entry count (the number of functions) |\n| 4... | Tag Groups | Each tag group holds some information about a Metal function |\n\nThe number of tag groups equals the number of functions.\n\n### Tag Group\n\n| Byte Range | Type | Content |\n|------------|--------|------------------------|\n| 0...3 | UInt32 | Size of the tag group |\n| 4... | Tags | |\n\n### Tag\n\n| Byte Range | Type | Content |\n|------------|--------|--------------------|\n| 0...3 | FourCharCode | Name of the tag |\n| 4...5 | UInt16 | Size of the tag |\n| 6... | Bytes | Content of the tag |\n\n### Function Information Tags\n\n| Name | Content Data Type | Content |\n|------|----------------------------------|--------------------------------------------------------------------------------------------|\n| NAME | NULL-terminated C-style string | Name of the function |\n| MDSZ | UInt64 | Size of the bitcode |\n| TYPE | UInt8 | Type of the function |\n| HASH | SHA256 Digest | Hash of the bitcode data (SHA256) |\n| OFFT | (UInt64, UInt64, UInt64) | Offsets of the information about this function in the public metadata section, private metadata section, and bitcode section |\n| SOFF | UInt64 | Offset of the source code archive of the function in the embedded source code section |\n| VERS | (UInt16, UInt16, UInt16, UInt16) | Bitcode and language versions (air.major, air.minor, language.major, language.minor) |\n| LAYR | UInt8 | [Metal type](#metal-data-type-table) of the `render_target_array_index` (for [layered rendering](https://developer.apple.com/documentation/metal/render_passes/rendering_to_multiple_texture_slices_in_a_draw_command)) |\n| TESS | UInt8 | Patch type and number of control points per-patch (for post-tessellation vertex function) |\n| ENDT | | End of the tag group |\n\n| Function Type | Value | Note |\n|---------------|-------|-------------------------------------------------------------|\n| Vertex | 0x00 | |\n| Fragment | 0x01 | |\n| Kernel | 0x02 | |\n| Unqualified | 0x03 | Functions in Metal dynamic library |\n| Visible | 0x04 | Functions with `[[visible]]` or `[[stitchable]]` attributes |\n| Extern | 0x05 | Extern functions complied with `-fcikernel` option |\n| Intersection | 0x06 | |\n\nContent of the `TESS` tag:\n\n```swift\n// Patch types:\n// - triangle: 1\n// - quad: 2\n\nlet content: UInt8 = controlPointCount << 2 | patchType\n```\n\n### Public Metadata\n\nContains information about function constants, tessellation patches, return types, etc.\n\nTags: `CNST`, `VATT`, `VATY`, `RETR`, `ARGR`, etc.\n\n### Private Metadata\n\nContains paths to the shader source (`DEBI` tag) and `.air` (`DEPF` tag) files.\n\n### Header Extension\n\nOnly exists if `FunctionListOffset + FunctionListSize + 4 != PublicMetadataOffset`\n\n| Byte Range | Type | Content |\n|------------|--------|-------------------------------|\n| `FunctionListOffset + FunctionListSize + 4`... | Tags | Header extension tags |\n\n### Header Extension Tags\n\n| Name | Type | Content |\n|------|----------------------------------|------------------------|\n| HDYN | (UInt64, UInt64) | Offset and size of the dynamic header section |\n| VLST | (UInt64, UInt64) | Offset and size of the exported variable list | \n| ILST | (UInt64, UInt64) | Offset and size of the imported symbol list | \n| HSRD/HSRC | (UInt64, UInt64) | Offset and size of the embedded source code section |\n| UUID | UUID | UUID of the Metal library. |\n| ENDT | | End of the header extension |\n\n### Dynamic Header Section Tags\n\n| Name | Content Data Type | Content |\n|------|----------------------------------|------------------------|\n| NAME | NULL-terminated C-style string | Install name of the library |\n| DYNL | NULL-terminated C-style string | Linked dynamic library | \n\n### Variable List & Imported Symbol List\n\nVariable list and imported symbol list have structures that are similar to that of the function list.\n\n### Embedded Source Code Section\n\nOnly exists if the `metallib` build process is configured to [include source code](https://developer.apple.com/documentation/metal/developing_and_debugging_metal_shaders).\n\n| Byte Range | Type | Content |\n|------------|--------|--------------------|\n| 0...1 | UInt16 | Number of items in this section |\n| 2...n | NULL-terminated C-style string | Link options of the `metallib` file |\n| n...m | NULL-terminated C-style string | Working directory |\n| m... | Tag Group | `SARC` tag |\n\n**Note** \"Working directory\" only exists in `HSRD`.\n\n**Note** `SARC` tag uses 4-bytes (`UInt32`) content size.\n\nContent of the `SARC` tag:\n\n| Byte Range | Type | Content |\n|------------|--------|--------------------|\n| 0...n | NULL-terminated C-style string | ID of the source code archive |\n| n... | BZh | Bzip2 compressed source code archive |\n\n### Metal Data Type Table\n\n| Value | Type | Value | Type |\n| ----- | ---- | ----- | ---- |\n| 0x00 | None | 0x01 | Struct |\n| 0x02 | Array | 0x03 | Float |\n| 0x04 | Float2 | 0x05 | Float3 |\n| 0x06 | Float4 | 0x07 | Float2x2 |\n| 0x08 | Float2x3 | 0x09 | Float2x4 |\n| 0x0A | Float3x2 | 0x0B | Float3x3 |\n| 0x0C | Float3x4 | 0x0D | Float4x2 |\n| 0x0E | Float4x3 | 0x0F | Float4x4 |\n| 0x10 | Half | 0x11 | Half2 |\n| 0x12 | Half3 | 0x13 | Half4 |\n| 0x14 | Half2x2 | 0x15 | Half2x3 |\n| 0x16 | Half2x4 | 0x17 | Half3x2 |\n| 0x18 | Half3x3 | 0x19 | Half3x4 |\n| 0x1A | Half4x2 | 0x1B | Half4x3 |\n| 0x1C | Half4x4 | 0x1D | Int |\n| 0x1E | Int2 | 0x1F | Int3 |\n| 0x20 | Int4 | 0x21 | UInt |\n| 0x22 | UInt2 | 0x23 | UInt3 |\n| 0x24 | UInt4 | 0x25 | Short |\n| 0x26 | Short2 | 0x27 | Short3 |\n| 0x28 | Short4 | 0x29 | UShort |\n| 0x2A | UShort2 | 0x2B | UShort3 |\n| 0x2C | UShort4 | 0x2D | Char |\n| 0x2E | Char2 | 0x2F | Char3 |\n| 0x30 | Char4 | 0x31 | UChar |\n| 0x32 | UChar2 | 0x33 | UChar3 |\n| 0x34 | UChar4 | 0x35 | Bool |\n| 0x36 | Bool2 | 0x37 | Bool3 |\n| 0x38 | Bool4 | 0x3A | Texture |\n| 0x3B | Sampler | 0x3C | Pointer |\n| 0x3E | R8Unorm | 0x3F | R8Snorm |\n| 0x40 | R16Unorm | 0x41 | R16Snorm |\n| 0x42 | RG8Unorm | 0x43 | RG8Snorm |\n| 0x44 | RG16Unorm | 0x45 | RG16Snorm |\n| 0x46 | RGBA8Unorm | 0x47 | RGBA8Unorm_sRGB |\n| 0x48 | RGBA8Snorm | 0x49 | RGBA16Unorm |\n| 0x4A | RGBA16Snorm | 0x4B | RGB10A2Unorm |\n| 0x4C | RG11B10Float | 0x4D | RGB9E5Float |\n| 0x4E | RenderPipeline | 0x4F | ComputePipeline |\n| 0x50 | IndirectCommandBuffer | 0x51 | Long |\n| 0x52 | Long2 | 0x53 | Long3 |\n| 0x54 | Long4 | 0x55 | ULong |\n| 0x56 | ULong2 | 0x57 | ULong3 |\n| 0x58 | ULong4 | 0x59 | Double |\n| 0x5A | Double2 | 0x5B | Double3 |\n| 0x5C | Double4 | 0x5D | Float8 |\n| 0x5E | Float16 | 0x5F | Half8 |\n| 0x60 | Half16 | 0x61 | Int8 |\n| 0x62 | Int16 | 0x63 | UInt8 |\n| 0x64 | UInt16 | 0x65 | Short8 |\n| 0x66 | Short16 | 0x67 | UShort8 |\n| 0x68 | UShort16 | 0x69 | Char8 |\n| 0x6A | Char16 | 0x6B | UChar8 |\n| 0x6C | UChar16 | 0x6D | Long8 |\n| 0x6E | Long16 | 0x6F | ULong8 |\n| 0x70 | ULong16 | 0x71 | Double8 |\n| 0x72 | Double16 | 0x73 | VisibleFunctionTable |\n| 0x74 | IntersectionFunctionTable | 0x75 | PrimitiveAccelerationStructure |\n| 0x76 | InstanceAccelerationStructure | 0x77 | Bool8 |\n| 0x78 | Bool16 | | |\n\n## ❤️ Contributing\n\nIf you think there's a mistake, please open an issue. You can also choose to open a pull request with the failure test included. \n\n## 👾 The Story\n\nThis project would not have started without [zhuowei's research](https://worthdoingbadly.com/metalbitcode/) which revealed the basic binary layout of a `metallib` file, the function list as well as the bitcode section. Thanks, [@zhuowei](https://github.com/zhuowei)! \n\n### What the assembly can tell\n\nI tried to continue the research to get a complete structure of the `metallib` file, but found it too hard to move forward based on guesswork alone. So I turned my attention to the `Metal.framework` hoping to find out how the framework loads a `metallib` file. Fortunately, it's not too hard after dragging `Metal.framework/Metal` to [Hopper Disassembler](https://www.hopperapp.com/). \n\n`Metal.framework` uses `MTLLibraryDataWithArchive::parseArchiveSync(...)` to load `metallib` files. There is a lot of information hidden in the assembly of `MTLLibraryDataWithArchive`. For example:\n\n- The file starts with `0x424c544d`(MTLB); The size of the file is recorded at offset `0x10`.\n ```cpp\n int __ZN25MTLLibraryDataWithArchive16parseArchiveSyncEPP7NSErrorb(void * * arg0, bool arg1) {\n r12 = rdx;\n r14 = arg1;\n r13 = arg0;\n (*(*arg0 + 0xb8))(arg0, 0x0); //LibraryWithFile::setPosition(...)\n r15 = r13 + 0x78;\n rbx = (*(*r13 + 0xc0))(r13, r15, 0x58); //LibraryWithFile::readBytes(...)\n rax = *r13;\n rax = (*(rax + 0xc8))(r13); //LibraryWithFile::getFileSize(...)\n \n // 0x424c544d - MTLB\n // File size field offset: 0x88 - 0x78 = 0x10\n if (((rbx != 0x58) || (*(int32_t *)(r13 + 0x78) != 0x424c544d)) || (*(r13 + 0x88) != rax)) goto loc_6a65b;\n \n ...\n \n loc_6a65b:\n if (r14 == 0x0) goto loc_6a6c5;\n\n loc_6a660:\n rdx = @\"Invalid library file\";\n \n ...\n }\n ```\n \n- An `Int16` value at offset `0x4` is related to the target platform.\n\n ```cpp\n loc_6a610:\n // 0x7c - 0x78 = 0x4\n rax = *(int16_t *)(r13 + 0x7c) & 0xffff;\n \n if ((rax >= 0x0) || (r12 == 0x0)) goto loc_6a6ea;\n \n loc_6a627:\n if (r14 == 0x0) goto loc_6a6c5;\n\n loc_6a630:\n rdx = @\"This library format is not supported on this platform (or was built with an old version of the tools)\";\n goto loc_6a689;\n ```\n\n- There is a \"Header Extension Section\" that contains information about the \"Dynamic Header Section\", \"Imported Symbol List\" and \"Variable List\":\n\n ```cpp\n if (MTLLibraryDataWithArchive::parseHeaderExtension(r13, r13 + 0x100, r14) != 0x0) {\n if (MTLLibraryDataWithArchive::parseDynamicHeaderSection(r13) != 0x0) {\n if (MTLLibraryDataWithArchive::parseImportedSymbolListSection(r13) != 0x0) {\n rax = MTLLibraryDataWithArchive::parseVariableListSection(r13);\n } else {\n rax = 0x0;\n }\n } else {\n rax = 0x0;\n }\n } else {\n rax = 0x0;\n }\n ```\n \n- The bitcode is validated using SHA256.\n\n ```cpp\n int ____ZN25MTLLibraryDataWithArchive15validateBitCodeEmmPK6NSDataRK12MTLUINT256_t_block_invoke(int arg0) {\n ...\n CC_SHA256_Init(&var_B0);\n CC_SHA256_Update(&var_B0, r14, *(int32_t *)(r15 + 0x38));\n CC_SHA256_Final(&var_48, &var_B0);\n ...\n }\n ```\n \n- A lot of FourCC codes:\n\n ```cpp\n // 0x454e4454 - ENDT\n loc_6a8bc:\n if (rax == 0x454e4454) goto loc_6a871;\n ...\n // 0x54595045 - TYPE\n loc_6a984:\n if (rax == 0x54595045) goto loc_6a9dc;\n ...\n // 0x44594e4c - DYNL\n loc_6ae5b:\n if (rax != 0x44594e4c) goto loc_6b002;\n ...\n // 0x56455253 - VERS\n loc_6b731:\n if (rax == 0x56455253) goto loc_6b81c;\n ```\n\nAfter some digging around I was able to get an overview of the `metallib` file's structure:\n\n- The file has a 88 bytes header that contains the file version, target platform, library type, section indices, etc.\n\n- There are 4 sections recorded in the file header:\n \n - Function list\n \n - Public metadata\n \n - Private metadata\n \n - Bitcode modules\n\n Each section is recorded with an offset and a size. This means sections can be non-contiguous, which allows Apple to introduce new sections in between without breaking the compatibility. And Apple did that exactly for the \"header extension\" section - it lies between the function list and the public metadata section.\n \n- Most of the sections (except the bitcode section) resemble a \"tag\" based structure:\n\n - [FourCharCode](https://en.wikipedia.org/wiki/FourCC) is used as the tag's name/type.\n \n - An `UInt16` (in most cases) value of size follows the tag's name.\n \n The source archive data tag `SARC` unsurprisingly uses an `UInt32` value for its size - a source archive can easily exceed 65KB.\n \n - Tags are grouped:\n \n - Each group represents a set of properties of an item. \n \n - The tag group ends with an `ENDT` tag.\n\n### TDG - \"Test Driven Guessing\"\n\nNext, I need to figure out what information each tag/field holds. This can be hard to get from the assembly of the `Metal.framework` because:\n\n- Some fields may be designed purely for tooling or debugging, so `MTLLibraryDataWithArchive` may just ignore them.\n\n- The assembly is platform dependent. For example, the iOS version of `MTLLibraryDataWithArchive` may only check whether the `metallib` is built for iOS and cannot tell if the library is built for macOS.\n\n- Some fields are just hard to analyze and follow. Examples:\n \n - There are 3 offsets in the `OFFT` tag of the function, where are they pointing to? and how are they finally used?\n \n - What are the possible values of the function type? What does each value mean?\n\nIt seems that the quickest way to get this information is through experiments.\n\nI started by manually compiling `metal` files with different shaders, options, and SDKs, then inspecting each field I was interested in. My desktop was quickly flooded with `metallib` files and [HexFiend](https://hexfiend.com/) windows, but I didn't find much useful information. I need something that can automatically build `metallib` and presents me only the field that I'm interested in.\n\nI came up with the \"Test Driven Guessing\":\n\n1. Write a `metallib` parser based on the binary structure overview at hand.\n\n2. In the parser, log the value of a field/tag (or some related fields) that is currently unknown.\n\n3. Create tests that produce `metallib` files using different kinds of shaders and compile options that may affect the value of the field, and use the parser to parse the file data.\n\n4. Run tests and analyze the log to make hypotheses.\n\n5. Update the parser based on hypotheses.\n\n6. Run tests again to verify.\n\nAfter a few rounds, I was able to get the function type table, target OS table, and the meaning of 3 offsets in the `OFFT` tag.\n\nI also found a few things interesting in this process:\n\n- Metal does not support watchOS, however, it is possible to build a `metallib` targeting watchOS. And Apple does include some `metallib`s in the watchOS SDK. (e.g. `Xcode.app/Contents/Developer/Platforms/WatchOS.platform/Library/Developer/CoreSimulator/Profiles/Runtimes/watchOS.simruntime/Contents/Resources/RuntimeRoot/System/Library/Frameworks/CoreImage.framework/ci_filters.metallib`)\n\n- Empty `metallib`s targeting old versions of iOS are [mistakenly marked as targeting macOS](https://github.com/YuAo/MetalLibraryArchive/blob/da16437b0549c7b21408e51b210627f73e323cbf/Tests/MetalLibraryArchiveTests/Tests.swift#L559).\n\n- I cannot build a `metallib` that has the target OS value `0x85`. At first I thought it might be reserved for the concealed [realityOS](https://github.com/apple-oss-distributions/dyld/blob/5c9192436bb195e7a8fe61f22a229ee3d30d8222/common/MachOFile.cpp#L578), but later found out it is [more likely for the bridgeOS](https://github.com/apple-oss-distributions/dyld/blob/419f8cbca6fb3420a248f158714a9d322af2aa5a/cache-builder/mrm_shared_cache_builder.h#L45).\n\n### Updates\n\n**Apr 10, 2022**\n\nTags like `LAYR`, `VATY`, `CNST`, etc., contain `UInt8` values of Metal data types. The corresponding description for each data type value can be retrieved using a private class in Metal.framework - [MTLTypeInternal](https://github.com/nst/iOS-Runtime-Headers/blob/fbb634c78269b0169efdead80955ba64eaaa2f21/Frameworks/Metal.framework/MTLTypeInternal.h)\n\n```objective-c\nid value = [[NSClassFromString(@\"MTLTypeInternal\") alloc] initWithDataType:0x06];\nNSLog(@\"%@\", value.description); // MTLDataTypeFloat4\n```\n\nI created a command line tool to generate the Metal data type table.\n\n```shell\ncd Utilities\nswift run metal-data-type-tools gen-markdown --columns 2 # generate a markdown table\nswift run metal-data-type-tools gen-swift # generate a Swift enum for Metal data types.\n```\n\n**Mar 31, 2022** \n\nThe `air-lld` (`Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/metal/ios/bin/air-lld`) also provides a lot of information about how the `metallib` file is built. Some section names and descriptions are updated.\n\n```cpp\nint __ZN4llvm3air20MetalLibObjectWriter5writeEv() {\n r14 = rdi;\n rax = llvm::air::MetalLibObjectWriter::writeHeader();\n if (rax != 0x0) goto loc_1000351b9;\n\nloc_100035135:\n rax = llvm::air::MetalLibObjectWriter::writeFunctionList();\n if (rax != 0x0) goto loc_1000351b9;\n\nloc_100035141:\n rax = llvm::air::MetalLibObjectWriter::writeHeaderExtension();\n if (rax != 0x0) goto loc_1000351b9;\n\nloc_10003514d:\n rax = llvm::air::MetalLibObjectWriter::writePublicMetadata();\n if (rax != 0x0) goto loc_1000351b9;\n\nloc_100035159:\n rax = llvm::air::MetalLibObjectWriter::writePrivateMetadata();\n if (rax != 0x0) goto loc_1000351b9;\n\nloc_100035165:\n rax = llvm::air::MetalLibObjectWriter::writeModuleList();\n if (rax != 0x0) goto loc_1000351b9;\n\nloc_100035171:\n rax = llvm::air::MetalLibObjectWriter::writeSources();\n if (rax != 0x0) goto loc_1000351b9;\n\nloc_10003517d:\n rax = llvm::air::MetalLibObjectWriter::writeDynamicHeader();\n if (rax != 0x0) goto loc_1000351b9;\n\nloc_100035189:\n rax = llvm::air::MetalLibObjectWriter::writeVariableList();\n if (rax != 0x0) goto loc_1000351b9;\n\nloc_100035195:\n rax = llvm::air::MetalLibObjectWriter::writeImportedSymbolList();\n if (rax != 0x0) goto loc_1000351b9;\n\nloc_1000351a1:\n rax = llvm::air::MetalLibObjectWriter::computeUUID();\n if (rax != 0x0) goto loc_1000351b9;\n\nloc_1000351ad:\n rax = llvm::air::MetalLibObjectWriter::backpatchAllLocations();\n if (rax == 0x0) goto loc_1000351c2;\n\nloc_1000351b9:\n rbx = rax;\n goto loc_1000351bb;\n\nloc_1000351bb:\n rax = rbx;\n return rax;\n\nloc_1000351c2:\n rbx = 0x0;\n std::__1::system_category();\n goto loc_1000351bb;\n}\n```\n" }, { "path": "Sources/Explorer/AppIconView.swift", "content": "//\n// File.swift\n// \n//\n// Created by YuAo on 2022/3/18.\n//\n\nimport Foundation\nimport AppKit\n\npublic class LinearGradientView: NSView {\n \n override init(frame frameRect: NSRect) {\n super.init(frame: frameRect)\n self.setup()\n }\n \n required init?(coder: NSCoder) {\n super.init(coder: coder)\n self.setup()\n }\n \n \n public var colors: [NSColor] = [] {\n didSet {\n self.needsLayout = true\n }\n }\n \n public var locations: [CGFloat] = [] {\n didSet {\n self.needsLayout = true\n }\n }\n \n public var startPoint: CGPoint = .zero {\n didSet {\n self.needsLayout = true\n }\n }\n \n public var endPoint: CGPoint = CGPoint(x: 1, y: 1) {\n didSet {\n self.needsLayout = true\n }\n }\n \n private func setup() {\n //layer hosting view\n layer = CAGradientLayer()\n wantsLayer = true\n }\n \n private var gradientLayer: CAGradientLayer {\n return self.layer as! CAGradientLayer\n }\n \n public override func layout() {\n super.layout()\n self.gradientLayer.colors = self.colors.compactMap({ $0.cgColor })\n self.gradientLayer.locations = self.locations.count > 0 ? self.locations.map({ NSNumber(value: Float($0)) }) : nil\n self.gradientLayer.startPoint = self.startPoint\n self.gradientLayer.endPoint = self.endPoint\n }\n}\n\n@available(macOS 11.0, *)\nclass AppIconView: NSView {\n \n override init(frame frameRect: NSRect) {\n super.init(frame: frameRect)\n self.setup()\n }\n \n required init?(coder: NSCoder) {\n fatalError(\"init(coder:) has not been implemented\")\n }\n \n private weak var gradientView: LinearGradientView!\n private weak var imageView: NSImageView!\n \n private func setup() {\n let gradientView = LinearGradientView()\n gradientView.colors = [NSColor.darkGray, NSColor.black]\n gradientView.locations = [0, 1]\n gradientView.startPoint = CGPoint(x: 0.5, y: 0)\n gradientView.endPoint = CGPoint(x: 0.5, y: 1)\n self.addSubview(gradientView)\n self.gradientView = gradientView\n \n let imageView = NSImageView(image: NSImage(systemSymbolName: \"square.stack.3d.forward.dottedline.fill\", accessibilityDescription: nil)!)\n imageView.contentTintColor = .white\n imageView.rotate(byDegrees: 90)\n imageView.imageScaling = .scaleProportionallyUpOrDown\n self.addSubview(imageView)\n self.imageView = imageView\n }\n \n override func layout() {\n super.layout()\n self.imageView.frame = self.bounds.insetBy(dx: self.bounds.width/6, dy: self.bounds.height/6)\n self.gradientView.frame = self.bounds.insetBy(dx: self.bounds.width/11, dy: self.bounds.height/11)\n self.gradientView.layer?.cornerCurve = .continuous\n self.gradientView.layer?.cornerRadius = self.bounds.height/5\n let shadow = NSShadow()\n shadow.shadowColor = NSColor.black.withAlphaComponent(0.3)\n shadow.shadowBlurRadius = self.bounds.width/40\n self.gradientView.shadow = shadow\n }\n}\n" }, { "path": "Sources/Explorer/MetalLibraryAchiveUnpacker.swift", "content": "//\n// File.swift\n// \n//\n// Created by YuAo on 2022/3/18.\n//\n\nimport Foundation\nimport MetalLibraryArchive\n\n@available(macOS 11.0, *)\nstruct Unpacker {\n static func unpack(_ archive: Archive, to url: URL, disassembler: URL?) throws {\n let fileManager = FileManager()\n try fileManager.createDirectory(at: url, withIntermediateDirectories: true, attributes: nil)\n var savedData = Set()\n for function in archive.functions {\n if savedData.contains(function.bitcode) {\n continue\n }\n let airFileURL = url.appendingPathComponent(function.name).appendingPathExtension(\"air\")\n try function.bitcode.write(to: airFileURL)\n \n if let disassembler = disassembler {\n let process = Process()\n process.executableURL = disassembler\n process.arguments = [airFileURL.path]\n try process.run()\n process.waitUntilExit()\n }\n \n savedData.insert(function.bitcode)\n }\n for sourceArchive in archive.sourceArchives {\n let sourceArchiveURL = url.appendingPathComponent(\"SourceArchive-\\(sourceArchive.id)\").appendingPathExtension(\"bz2\")\n try sourceArchive.data.write(to: sourceArchiveURL)\n }\n }\n}\n" }, { "path": "Sources/Explorer/MetalLibraryArchiveDocument.swift", "content": "//\n// File.swift\n// \n//\n// Created by YuAo on 2022/3/17.\n//\n\nimport SwiftUI\nimport MetalLibraryArchive\nimport UniformTypeIdentifiers\n\n@available(macOS 11.0, *)\nstruct MetalLibraryArchiveDocument: FileDocument {\n \n enum Error: LocalizedError {\n case cannotLoadFile\n var errorDescription: String? {\n switch self {\n case .cannotLoadFile:\n return \"Error loading file content.\"\n }\n }\n var failureReason: String? { errorDescription }\n }\n \n static let readableContentTypes: [UTType] = [.data]\n \n let archive: Archive\n let filename: String\n \n init(configuration: ReadConfiguration) throws {\n guard let content = configuration.file.regularFileContents else {\n throw Error.cannotLoadFile\n }\n archive = try Archive(data: content)\n filename = configuration.file.filename ?? \"default.metallib\"\n }\n \n func fileWrapper(configuration: WriteConfiguration) throws -> FileWrapper {\n throw CocoaError(.fileWriteNoPermission)\n }\n}\n" }, { "path": "Sources/Explorer/MetalLibraryArchiveView.swift", "content": "//\n// File.swift\n// \n//\n// Created by YuAo on 2022/3/17.\n//\n\nimport SwiftUI\nimport MetalLibraryArchive\n\n@available(macOS 11.0, *)\nstruct MetalLibraryView: View {\n private let archive: Archive\n private let filename: String\n private let functionBitcodeID: [String: Int]\n \n @Environment(\\.disassemblerURL) private var disassemblerURL\n @Environment(\\.colorScheme) private var colorScheme\n @Environment(\\.controlActiveState) private var controlActiveState\n \n @ObservedObject private var toastController: ToastController = ToastController()\n \n init(archive: Archive, filename: String) {\n self.archive = archive\n self.filename = filename\n self.functionBitcodeID = {\n var currentID: Int = 0\n var functionBitcodeID: [String: Int] = [:]\n var bitcodeID: [Data: Int] = [:]\n for function in archive.functions {\n if let id = bitcodeID[function.bitcode] {\n functionBitcodeID[function.name] = id\n } else {\n bitcodeID[function.bitcode] = currentID\n functionBitcodeID[function.name] = currentID\n currentID += 1\n }\n }\n return functionBitcodeID\n }()\n }\n \n struct LanguageVersionView: View {\n private let text: String\n init(version: LanguageVersion) {\n text = \"MSL \\(version.major).\\(version.minor)\"\n }\n var body: some View {\n BadgeView(text: text, foregroundColor: .white, backgroundColor: .gray)\n }\n }\n \n struct BadgeView: View {\n @Environment(\\.controlActiveState) private var controlActiveState\n\n let text: String\n let foregroundColor: Color\n let backgroundColor: Color\n \n var body: some View {\n Text(text)\n .font(Font.system(.footnote, design: .monospaced).weight(.medium))\n .foregroundColor(foregroundColor)\n .padding(6)\n .background(RoundedRectangle(cornerRadius: 8).foregroundColor(controlActiveState == .inactive ? .gray.opacity(0.5) : backgroundColor))\n }\n }\n \n struct BitcodeSizeView: View {\n private let text: String\n init(bytes: Int) {\n let formatter = ByteCountFormatter()\n text = formatter.string(fromByteCount: Int64(bytes))\n }\n var body: some View {\n BadgeView(text: text, foregroundColor: .white, backgroundColor: .gray.opacity(0.75))\n }\n }\n \n struct BitcodeIDView: View {\n private let text: String\n init(id: Int) {\n text = \"BC \\(id)\"\n }\n var body: some View {\n BadgeView(text: text, foregroundColor: .white, backgroundColor: .gray.opacity(0.75))\n }\n }\n \n struct SourceBadge: View {\n @Environment(\\.controlActiveState) private var controlActiveState\n \n private var color: Color {\n controlActiveState == .inactive ? .gray.opacity(0.5) : .green.opacity(0.75)\n }\n \n var body: some View {\n Text(\"SRC\")\n .font(Font.system(.caption, design: .monospaced).smallCaps())\n .foregroundColor(color)\n .padding(EdgeInsets(top: 1, leading: 4, bottom: 1, trailing: 4))\n .background(GeometryReader(content: { proxy in\n RoundedRectangle(cornerRadius: proxy.size.height/2).strokeBorder(color, lineWidth: 1, antialiased: true)\n }))\n }\n }\n \n struct FunctionTypeView: View {\n private struct TypeInfo {\n var symbol: String\n var textColor: Color\n var backgroundColor: Color\n }\n \n private let typeInfo: TypeInfo?\n \n init(type: FunctionType?) {\n typeInfo = {\n let colors: [Color] = [.green, .blue, .orange, .red, .pink, .purple, .yellow]\n precondition(colors.count == FunctionType.allCases.count)\n if let type = type {\n let colorIndex = FunctionType.allCases.firstIndex(of: type)!\n return TypeInfo(symbol: type.description, textColor: .white, backgroundColor: colors[colorIndex])\n } else {\n return TypeInfo(symbol: \"Unknown\", textColor: .white, backgroundColor: .gray)\n }\n }()\n }\n \n var body: some View {\n if let info = typeInfo {\n BadgeView(text: info.symbol, foregroundColor: info.textColor, backgroundColor: info.backgroundColor)\n }\n }\n }\n \n struct TargetPlatformBadge: View {\n @Environment(\\.colorScheme) private var colorScheme\n @Environment(\\.controlActiveState) private var controlActiveState\n \n private var backgroundColor: Color {\n if controlActiveState == .inactive {\n return .gray.opacity(0.25)\n } else {\n if colorScheme == .dark {\n return .gray.opacity(0.25)\n } else {\n return .gray\n }\n }\n }\n\n let archive: Archive\n \n var body: some View {\n Group {\n if let deploymentTarget = archive.deploymentTarget {\n Text(\"\\(archive.targetPlatform.description) (\\(deploymentTarget.operatingSystem.description) \\(deploymentTarget.operatingSystemVersion.description)) - \\(archive.libraryType.description)\")\n } else {\n Text(\"\\(archive.targetPlatform.description) - \\(archive.libraryType.description)\")\n }\n }\n .font(Font.system(.footnote).weight(.medium))\n .foregroundColor(.white)\n .padding(6)\n .background(RoundedRectangle(cornerRadius: 6).foregroundColor(backgroundColor))\n }\n }\n \n @State private var functionType: FunctionType?\n \n var filteredEntries: [Function] {\n archive.functions.filter({\n if let filter = functionType {\n if $0.type != filter {\n return false\n }\n }\n return true\n })\n }\n \n var body: some View {\n List {\n HStack {\n if filteredEntries.count != archive.functions.count {\n Text(\"\\(filteredEntries.count)/\\(archive.functions.count) functions\")\n } else {\n Text(\"\\(archive.functions.count) functions\")\n }\n Spacer()\n Picker(\"\", selection: $functionType, content: {\n Text(\"All\").tag(Optional.none)\n ForEach(FunctionType.allCases) { type in\n Text(type.description).tag(Optional.some(type))\n }\n })\n .scaledToFit()\n }\n ForEach(filteredEntries, id: \\.name) { entry in\n HStack {\n Group {\n if #available(macOS 12.0, *) {\n Text(entry.name).textSelection(.enabled)\n } else {\n Text(entry.name)\n }\n }.font(Font.system(.headline, design: .monospaced).weight(.bold))\n if entry.isSourceIncluded {\n SourceBadge()\n }\n Spacer()\n FunctionTypeView(type: entry.type)\n LanguageVersionView(version: entry.languageVersion)\n BitcodeIDView(id: functionBitcodeID[entry.name]!)\n }\n .lineLimit(nil)\n .padding()\n .background(\n RoundedRectangle(cornerRadius: 12)\n .foregroundColor(colorScheme == .dark ? Color.black.opacity(0.35) : Color.white)\n )\n }\n }\n .presenter(for: toastController)\n .toolbar(content: {\n ToolbarItem(placement: .navigation, content: {\n TargetPlatformBadge(archive: archive)\n })\n ToolbarItem(placement: .primaryAction, content: {\n Menu(content: {\n Button(\"Unpack\", action: {\n unpack(disassemble: false)\n })\n Button(\"Unpack and Disassemble\", action: {\n unpack(disassemble: true)\n })\n }, label: {\n Image(systemName: \"tray.and.arrow.up.fill\")\n })\n })\n })\n .listStyle(.sidebar)\n }\n \n func unpack(disassemble: Bool) {\n let disassemblerURL: URL?\n if disassemble {\n if let url = self.disassemblerURL {\n disassemblerURL = url\n } else {\n class AlertDelegate: NSObject, NSAlertDelegate {\n func alertShowHelp(_ alert: NSAlert) -> Bool {\n NSWorkspace.shared.open(URL(string: \"https://github.com/YuAo/MetalLibraryArchive\")!)\n return true\n }\n }\n let delegate = AlertDelegate()\n let alert = NSAlert()\n alert.messageText = \"In order to disassemble .air files. llvm-dis is required. Use the \\\"Disassembler\\\" menu to locate llvm-dis.\"\n alert.showsHelp = true\n alert.delegate = delegate\n alert.icon = nil\n alert.runModal()\n withExtendedLifetime(delegate, {})\n return\n }\n } else {\n disassemblerURL = nil\n }\n \n let savePanel = NSSavePanel()\n savePanel.canCreateDirectories = true\n savePanel.nameFieldStringValue = \"\\(filename).unpacked\"\n let response = savePanel.runModal()\n guard let url = savePanel.url, response == .OK else {\n return\n }\n do {\n try Unpacker.unpack(archive, to: url, disassembler: disassemblerURL)\n toastController.showToast(title: \"Unpack Succeeded\", type: .success)\n } catch {\n NSAlert(error: error).runModal()\n }\n }\n}\n\nextension FunctionType: Identifiable {\n public var id: Int { self.rawValue }\n}\n" }, { "path": "Sources/Explorer/Toast.swift", "content": "//\n// File.swift\n// \n//\n// Created by YuAo on 2022/4/6.\n//\n\nimport Foundation\nimport SwiftUI\n\nenum ToastType {\n case `default`\n case success\n}\n\nstruct Toast {\n var title: String\n var type: ToastType\n}\n\nclass ToastController: ObservableObject {\n @Published private(set) var shouldShowToast: Bool = false\n @Published private(set) var toast: Toast = Toast(title: \"\", type: .default)\n \n private var timer: Timer?\n \n func showToast(title: String, type: ToastType = .default, duration: TimeInterval = 2.0) {\n timer?.invalidate()\n timer = Timer.scheduledTimer(withTimeInterval: duration, repeats: false, block: { [weak self] _ in\n self?.shouldShowToast = false\n })\n toast = Toast(title: title, type: type)\n shouldShowToast = true\n }\n}\n\n@available(macOS 11.0, *)\nfileprivate struct ToastPresenter: ViewModifier {\n @ObservedObject var controller: ToastController\n \n @State private var showsToast: Bool = false\n \n @Environment(\\.colorScheme) private var colorScheme\n \n func body(content: Content) -> some View {\n return content.overlay(VStack {\n if showsToast {\n Group {\n switch controller.toast.type {\n case .`default`:\n Text(controller.toast.title)\n case .success:\n Label(title: {\n Text(controller.toast.title)\n }, icon: {\n Image(systemName: \"checkmark\").foregroundColor(Color.green)\n })\n }\n }\n .padding(EdgeInsets(top: 10, leading: 12, bottom: 10, trailing: 12))\n .background(GeometryReader(content: { proxy in\n RoundedRectangle(cornerRadius: proxy.size.height / 2).fill(colorScheme == .dark ? Color(.sRGB, white: 0.25, opacity: 1) : Color.white)\n .shadow(color: .black.opacity(0.1), radius: 10, x: 0, y: 0)\n }))\n .padding()\n .transition(.move(edge: .top))\n }\n Spacer()\n }).onReceive(controller.$shouldShowToast, perform: { value in\n withAnimation(.spring(), {\n self.showsToast = value\n })\n }).clipped()\n }\n}\n\n@available(macOS 11.0, *)\nextension View {\n func presenter(for controller: ToastController) -> some View {\n self.modifier(ToastPresenter(controller: controller))\n }\n}\n" }, { "path": "Sources/Explorer/main.swift", "content": "//\n// File.swift\n// \n//\n// Created by YuAo on 2022/3/17.\n//\nimport UniformTypeIdentifiers\nimport SwiftUI\n\n// MARK: - Application Support\n@available(macOS 11.0, *)\nclass AppDelegate: NSObject, NSApplicationDelegate {\n func applicationDidFinishLaunching(_ notification: Notification) {\n NSApp.setActivationPolicy(.regular)\n NSApp.activate(ignoringOtherApps: true)\n \n NSApplication.shared.dockTile.contentView = AppIconView()\n NSApplication.shared.dockTile.display()\n }\n}\n\nprivate struct DisassemblerURLEnvironmentKey: EnvironmentKey {\n static let defaultValue: URL? = nil\n}\n\n@available(macOS 11.0, *)\nextension EnvironmentValues {\n var disassemblerURL: URL? {\n get { self[DisassemblerURLEnvironmentKey.self] }\n set { self[DisassemblerURLEnvironmentKey.self] = newValue }\n }\n}\n\n@available(macOS 11.0, *)\nstruct Main: App {\n @NSApplicationDelegateAdaptor var appDelegate: AppDelegate\n @AppStorage(\"llvm-disassembler-url\", store: UserDefaults(suiteName: \"com.imyuao.MetalLibraryArchive.app\")) var disassemblerURL: URL?\n\n var body: some Scene {\n DocumentGroup(viewing: MetalLibraryArchiveDocument.self, viewer: { configuration in\n MetalLibraryView(archive: configuration.document.archive, filename: configuration.document.filename).environment(\\.disassemblerURL, disassemblerURL)\n }).commands(content: {\n CommandMenu(\"Disassembler\", content: {\n if let url = disassemblerURL, FileManager.default.fileExists(atPath: url.path) {\n Text(\"Disassembler: \\(url.lastPathComponent) at \\(url.path)\")\n Divider()\n Button(\"Reset\", action: {\n disassemblerURL = nil\n })\n } else {\n Button(\"Locate llvm-dis\", action: {\n let openPanel = NSOpenPanel()\n openPanel.allowedContentTypes = [.unixExecutable]\n let response = openPanel.runModal()\n if let url = openPanel.url, response == .OK {\n disassemblerURL = url\n }\n })\n }\n })\n })\n }\n}\n\nif #available(macOS 11.0, *) {\n DispatchQueue.main.async {\n NSDocumentController.shared.openDocument(nil)\n }\n Main.main()\n} else {\n fatalError()\n}\n" }, { "path": "Sources/MetalLibraryArchive/Archive.swift", "content": "import Foundation\n\n#if canImport(Crypto)\nimport Crypto\n#endif\n\npublic struct Archive: Hashable {\n \n public class DataScanner {\n public enum Error: LocalizedError {\n case indexOutOfBounds\n case invalidStringData\n \n public var errorDescription: String? {\n switch self {\n case .indexOutOfBounds:\n return \"DataScanner: Index out of bounds.\"\n case .invalidStringData:\n return \"DataScanner: Invalid string data.\"\n }\n }\n \n public var failureReason: String? { errorDescription }\n }\n \n private(set) var offset: Int\n \n let data: Data\n \n init(data: Data) {\n self.data = data\n self.offset = data.startIndex\n }\n \n private func checkBoundsForReading(byteCount: Int) throws {\n if offset + byteCount > data.endIndex {\n throw Error.indexOutOfBounds\n }\n }\n \n func scanFourCharCode() throws -> String {\n let byteCount = 4\n try checkBoundsForReading(byteCount: byteCount)\n guard let string = String(data: data[offset..<(offset + byteCount)], encoding: .utf8) else {\n throw Error.invalidStringData\n }\n offset += byteCount\n assert(string.allSatisfy({ $0.isASCII }))\n return string\n }\n \n func scanData(byteCount: Int) throws -> Data {\n try checkBoundsForReading(byteCount: byteCount)\n let scanned = data[offset..<(offset + byteCount)]\n offset += byteCount\n return scanned\n }\n \n func scanDataToEnd() throws -> Data {\n try checkBoundsForReading(byteCount: 1)\n return data[offset...]\n }\n \n func scanCString() throws -> String {\n let string: String = try data[offset...].withUnsafeBytes({ pointer in\n guard let index = pointer.firstIndex(of: 0) else {\n throw Error.invalidStringData\n }\n let string = String(cString: pointer.bindMemory(to: UInt8.self).baseAddress!)\n guard index == string.lengthOfBytes(using: .utf8) else {\n throw Error.invalidStringData\n }\n return string\n })\n offset += (string.lengthOfBytes(using: .utf8) + 1)\n return string\n }\n \n func scan(_ type: T.Type) throws -> Int {\n let size = MemoryLayout.size\n try checkBoundsForReading(byteCount: size)\n let value = data[offset..<(offset + size)].withUnsafeBytes({ pointer in\n return pointer.bindMemory(to: T.self)[0]\n })\n offset += size\n return Int(value.littleEndian)\n }\n \n func scanTags(contentSizeType: T.Type) throws -> [Tag] {\n var tags: [Tag] = []\n while true {\n let tagName = try scanFourCharCode()\n if tagName == \"ENDT\" {\n break\n }\n let tagSize = try scan(T.self)\n let content = try scanData(byteCount: tagSize)\n tags.append(Tag(name: tagName, content: content))\n }\n return tags\n }\n \n func seek(to offset: Int) throws {\n if offset > data.count || offset < 0 {\n throw Error.indexOutOfBounds\n }\n self.offset = data.startIndex + offset\n }\n }\n \n public enum Error: LocalizedError {\n case invalidHeader\n case invalidFunctionListOffset\n case invalidTagGroupSize\n case incompleteFunctionInfo\n case incompleteSourceArchiveInfo\n case invalidBitcodeHash\n case unexpectedTagContentSize(tagName: String)\n case unexpectedFunctionListEnding\n case unexpectedLibraryType(Int)\n case unexpectedTargetPlatform(Int)\n case unexpectedBitcodeSize\n case unexpectedOperatingSystemType(Int)\n case unexpectedFileSize\n \n public var errorDescription: String? {\n switch self {\n case .invalidHeader:\n return \"Invalid file header.\"\n case .invalidFunctionListOffset:\n return \"Invalid function list offset.\"\n case .invalidTagGroupSize:\n return \"Invalid tag group size.\"\n case .incompleteFunctionInfo:\n return \"Incomplete function info.\"\n case .incompleteSourceArchiveInfo:\n return \"Incomplete source archive info.\"\n case .invalidBitcodeHash:\n return \"Invalid bitcode hash.\"\n case .unexpectedTagContentSize(let name):\n return \"Unexpected size for tag \\\"\\(name)\\\".\"\n case .unexpectedFunctionListEnding:\n return \"Unexpected function list ending.\"\n case .unexpectedLibraryType(let value):\n return \"Unexpected library type: \\(value).\"\n case .unexpectedTargetPlatform(let value):\n return \"Unexpected target platform: \\(value).\"\n case .unexpectedBitcodeSize:\n return \"Unexpected bitcode size.\"\n case .unexpectedOperatingSystemType(let value):\n return \"Unexpected OS type: \\(value).\"\n case .unexpectedFileSize:\n return \"Unexpected file size.\"\n }\n }\n \n public var failureReason: String? { errorDescription }\n }\n \n public struct Version: Hashable, CustomStringConvertible {\n public let major: Int\n public let minor: Int\n \n public var description: String {\n return \"\\(major).\\(minor)\"\n }\n }\n\n public let functions: [Function]\n \n public let headerExtensionTags: [Tag]\n \n public let libraryType: LibraryType\n \n public let targetPlatform: Platform\n \n public let deploymentTarget: DeploymentTarget?\n \n public let sourceArchives: [SourceArchive]\n \n public let version: Version\n \n public init(data: Data) throws {\n let dataScanner = DataScanner(data: data)\n \n do {\n guard try dataScanner.scanFourCharCode() == \"MTLB\" else {\n throw Error.invalidHeader\n }\n } catch {\n throw Error.invalidHeader\n }\n \n //4...5\n let targetPlatform = try dataScanner.scan(UInt16.self)\n if targetPlatform == 0x8001 {\n self.targetPlatform = .macOS\n } else if targetPlatform == 0x0001 {\n self.targetPlatform = .iOS\n } else {\n throw Error.unexpectedTargetPlatform(targetPlatform)\n }\n \n //6,7,8,9\n let libraryMajorVersion = try dataScanner.scan(UInt16.self)\n let libraryMinorVersion = try dataScanner.scan(UInt16.self)\n version = Version(major: libraryMajorVersion, minor: libraryMinorVersion)\n \n //10\n let libraryTypeValue = try dataScanner.scan(UInt8.self)\n if let type = LibraryType(rawValue: libraryTypeValue) {\n libraryType = type\n } else {\n throw Error.unexpectedLibraryType(libraryTypeValue)\n }\n \n // 11: Target OS\n let targetOSValue = try dataScanner.scan(UInt8.self)\n // 12...13: Target OS version, major\n let targetOSMajorVersion = try dataScanner.scan(UInt16.self)\n // 14...15: Target OS version, minor\n let targetOSMinorVersion = try dataScanner.scan(UInt16.self)\n if targetOSValue != 0 {\n guard let os = DeploymentTarget.OperatingSystem(rawValue: targetOSValue) else {\n throw Error.unexpectedOperatingSystemType(targetOSValue)\n }\n self.deploymentTarget = DeploymentTarget(operatingSystem: os, operatingSystemVersion: DeploymentTarget.OperatingSystem.Version(major: targetOSMajorVersion, minor: targetOSMinorVersion))\n } else {\n self.deploymentTarget = nil\n }\n\n // 16...23\n let fileSize = try dataScanner.scan(UInt64.self)\n guard fileSize == data.count else {\n throw Error.unexpectedFileSize\n }\n \n let functionListOffset = try dataScanner.scan(UInt64.self) //24...31\n let functionListSize = try dataScanner.scan(UInt64.self) //32...39\n \n // Public metadata offset\n let publicMetadataOffset = try dataScanner.scan(UInt64.self) //40...47\n // Public metadata size\n _ = try dataScanner.scan(UInt64.self) //48...55\n \n // Private metadata offset\n let privateMetadataOffset = try dataScanner.scan(UInt64.self) //56...63\n // Private metadata size\n _ = try dataScanner.scan(UInt64.self) //64...71\n \n let bitcodeOffset = try dataScanner.scan(UInt64.self) //72...79\n let bitcodeSize = try dataScanner.scan(UInt64.self) //80...87\n \n // Validations\n guard functionListOffset + functionListSize < fileSize, functionListOffset > 0 else {\n throw Error.invalidFunctionListOffset\n }\n if functionListSize > 0 {\n try dataScanner.seek(to: functionListOffset + functionListSize)\n let functionListEndMark = try dataScanner.scanFourCharCode()\n guard functionListEndMark == \"ENDT\" else {\n throw Error.unexpectedFunctionListEnding\n }\n }\n \n // Read header extension tags, 4 is for `ENDT` or `0x00000000`\n if functionListOffset + functionListSize + 4 != publicMetadataOffset {\n try dataScanner.seek(to: functionListOffset + functionListSize + 4)\n headerExtensionTags = try dataScanner.scanTags(contentSizeType: UInt16.self)\n } else {\n headerExtensionTags = []\n }\n \n guard functionListSize > 0 else {\n functions = []\n sourceArchives = []\n return\n }\n \n guard bitcodeSize > 0 else {\n throw Error.unexpectedBitcodeSize\n }\n \n // Read functions\n try dataScanner.seek(to: functionListOffset)\n let numberOfFunctions = try dataScanner.scan(UInt32.self)\n \n let functionInfos: [FunctionInfo] = try {\n var infos: [FunctionInfo] = []\n for _ in 0.. 0 else {\n throw Error.invalidTagGroupSize\n }\n infos.append(try Self.scanFunctionInfo(using: dataScanner))\n }\n return infos\n }()\n \n let functions: [Function] = try {\n var entries: [Function] = []\n for (index, info) in functionInfos.enumerated() {\n try dataScanner.seek(to: bitcodeOffset + Int(info.offsets.bitcode))\n let functionBitcodeSize: UInt64\n if let size = info.bitcodeSize {\n functionBitcodeSize = size\n } else {\n let nextOffset: UInt64 = index < functionInfos.count - 1 ? functionInfos[index + 1].offsets.bitcode : UInt64(bitcodeSize);\n functionBitcodeSize = nextOffset - info.offsets.bitcode;\n }\n let data = try dataScanner.scanData(byteCount: Int(functionBitcodeSize))\n \n #if canImport(Crypto)\n guard SHA256.hash(data: data) == info.hash else {\n throw Error.invalidBitcodeHash\n }\n #endif\n \n try dataScanner.seek(to: publicMetadataOffset + Int(info.offsets.publicMetadata))\n let publicMetadataTagSize = try dataScanner.scan(UInt32.self)\n guard publicMetadataTagSize > 0 else {\n throw Error.invalidTagGroupSize\n }\n let publicMetadataTags = try dataScanner.scanTags(contentSizeType: UInt16.self)\n \n try dataScanner.seek(to: privateMetadataOffset + Int(info.offsets.privateMetadata))\n let privateMetadataTagsSize = try dataScanner.scan(UInt32.self)\n guard privateMetadataTagsSize > 0 else {\n throw Error.invalidTagGroupSize\n }\n let privateMetadataTags = try dataScanner.scanTags(contentSizeType: UInt16.self)\n \n entries.append(Function(name: info.name,\n type: info.type,\n languageVersion: info.languageVersion,\n tags: info.tags,\n publicMetadataTags: publicMetadataTags,\n privateMetadataTags: privateMetadataTags,\n bitcode: data,\n bitcodeHash: info.hash))\n }\n return entries\n }()\n self.functions = functions\n \n if let embededSourceTag = headerExtensionTags.first(where: { $0.name == \"HSRD\" || $0.name == \"HSRC\" }) {\n guard embededSourceTag.content.count == MemoryLayout.size * 2 else {\n throw Error.unexpectedTagContentSize(tagName: embededSourceTag.name)\n }\n let offset = embededSourceTag.content.withUnsafeBytes({ ptr in\n ptr.bindMemory(to: UInt64.self)[0]\n })\n try dataScanner.seek(to: Int(offset))\n let archiveCount = try dataScanner.scan(UInt32.self)\n _ = try dataScanner.scanCString() //Link options\n if embededSourceTag.name == \"HSRD\" {\n _ = try dataScanner.scanCString() //Working dir\n }\n var archives: [SourceArchive] = []\n for _ in 0.. 0 else {\n throw Error.invalidTagGroupSize\n }\n guard let sourceArchiveTag = try dataScanner.scanTags(contentSizeType: UInt32.self).first(where: { $0.name == \"SARC\" }) else {\n throw Error.incompleteSourceArchiveInfo\n }\n let tagContentScanner = DataScanner(data: sourceArchiveTag.content)\n let archiveID = try tagContentScanner.scanCString()\n let archiveData = try tagContentScanner.scanDataToEnd()\n precondition(archiveData.count + archiveID.lengthOfBytes(using: .utf8) + 1 == sourceArchiveTag.content.count)\n archives.append(SourceArchive(id: archiveID, data: archiveData))\n }\n sourceArchives = archives\n } else {\n sourceArchives = []\n }\n }\n}\n\nextension Archive {\n \n private struct FunctionInfo {\n var name: String\n var bitcodeSize: UInt64?\n var offsets: (publicMetadata: UInt64, privateMetadata: UInt64, bitcode: UInt64)\n var type: FunctionType?\n var languageVersion: LanguageVersion\n var hash: Data\n var tags: [Tag]\n }\n \n private static func scanFunctionInfo(using scanner: DataScanner) throws -> FunctionInfo {\n let tags: [Tag] = try scanner.scanTags(contentSizeType: UInt16.self)\n var name: String?\n var bitcodeSize: UInt64?\n var offsets: (publicMetadata: UInt64, privateMetadata: UInt64, bitcode: UInt64)?\n var type: FunctionType?\n var hash: Data?\n var languageVersion: LanguageVersion?\n for tag in tags {\n switch tag.name {\n case \"NAME\":\n name = String(data: tag.content.dropLast(), encoding: .utf8)\n case \"MDSZ\":\n guard tag.content.count == MemoryLayout.size else {\n throw Error.unexpectedTagContentSize(tagName: tag.name)\n }\n bitcodeSize = tag.content.withUnsafeBytes({ pointer in\n pointer.bindMemory(to: UInt64.self)[0]\n })\n case \"TYPE\":\n guard tag.content.count == MemoryLayout.size else {\n throw Error.unexpectedTagContentSize(tagName: tag.name)\n }\n let rawType = tag.content.withUnsafeBytes({ pointer in\n pointer.bindMemory(to: UInt8.self)[0]\n })\n type = FunctionType(rawValue: Int(rawType))\n case \"HASH\":\n guard tag.content.count == 32 else {\n throw Error.unexpectedTagContentSize(tagName: tag.name)\n }\n hash = tag.content\n case \"OFFT\":\n guard tag.content.count == MemoryLayout.size * 3 else {\n throw Error.unexpectedTagContentSize(tagName: tag.name)\n }\n offsets = tag.content.withUnsafeBytes({ pointer in\n let offsetValues = pointer.bindMemory(to: UInt64.self)\n return (publicMetadata: offsetValues[0], privateMetadata: offsetValues[1], bitcode: offsetValues[2])\n })\n case \"VERS\":\n guard tag.content.count == MemoryLayout.size * 4 else {\n throw Error.unexpectedTagContentSize(tagName: tag.name)\n }\n let versionNumbers = tag.content.withUnsafeBytes({ pointer in\n Array(pointer.bindMemory(to: UInt16.self))\n })\n //air version\n _ = (Int(versionNumbers[0]), Int(versionNumbers[1]))\n languageVersion = LanguageVersion(major: Int(versionNumbers[2]), minor: Int(versionNumbers[3]))\n default:\n break\n }\n }\n guard let name = name, let offsets = offsets, let hash = hash, let languageVersion = languageVersion else {\n throw Error.incompleteFunctionInfo\n }\n return FunctionInfo(name: name, bitcodeSize: bitcodeSize, offsets: offsets, type: type, languageVersion: languageVersion, hash: hash, tags: tags)\n }\n}\n" }, { "path": "Sources/MetalLibraryArchive/DeploymentTarget.swift", "content": "//\n// File.swift\n// \n//\n// Created by YuAo on 2022/3/26.\n//\n\nimport Foundation\n\npublic struct DeploymentTarget: Hashable {\n \n public enum OperatingSystem: Int, CustomStringConvertible, CaseIterable, Hashable {\n case macOS = 0x81\n case iOS = 0x82\n case tvOS = 0x83\n case watchOS = 0x84\n case bridgeOS = 0x85\n case macCatalyst = 0x86\n case iOSSimulator = 0x87\n case tvOSSimulator = 0x88\n case watchOSSimulator = 0x89\n \n public var description: String {\n switch self {\n case .macOS:\n return \"macOS\"\n case .iOS:\n return \"iOS\"\n case .tvOS:\n return \"tvOS\"\n case .watchOS:\n return \"watchOS\"\n case .bridgeOS:\n return \"bridgeOS\"\n case .macCatalyst:\n return \"Mac Catalyst\"\n case .iOSSimulator:\n return \"iOS Simulator\"\n case .tvOSSimulator:\n return \"tvOS Simulator\"\n case .watchOSSimulator:\n return \"watchOS Simulator\"\n }\n }\n \n public struct Version: Hashable, CustomStringConvertible {\n public let major: Int\n public let minor: Int\n \n public var description: String {\n return \"\\(major).\\(minor)\"\n }\n }\n }\n \n public let operatingSystem: OperatingSystem\n public let operatingSystemVersion: OperatingSystem.Version\n}\n" }, { "path": "Sources/MetalLibraryArchive/Function.swift", "content": "//\n// File.swift\n// \n//\n// Created by YuAo on 2022/3/18.\n//\n\nimport Foundation\n\npublic enum FunctionType: Int, CaseIterable, CustomStringConvertible, Hashable {\n case vertex = 0\n case fragment = 1\n case kernel = 2\n case unqualified = 3\n case visible = 4\n case extern = 5\n case intersection = 6\n \n public var description: String {\n switch self {\n case .vertex:\n return \"Vertex\"\n case .fragment:\n return \"Fragment\"\n case .kernel:\n return \"Kernel\"\n case .unqualified:\n return \"Unqualified\"\n case .visible:\n return \"Visible\"\n case .extern:\n return \"Extern\"\n case .intersection:\n return \"Intersection\"\n }\n }\n}\n\npublic struct Function: Hashable {\n public let name: String\n public let type: FunctionType?\n public let languageVersion: LanguageVersion\n public let tags: [Tag]\n public let publicMetadataTags: [Tag]\n public let privateMetadataTags: [Tag]\n public let bitcode: Data\n public let bitcodeHash: Data\n}\n\nextension Function {\n public var isSourceIncluded: Bool {\n return tags.contains(where: { $0.name == \"SOFF\" })\n }\n}\n" }, { "path": "Sources/MetalLibraryArchive/LanguageVersion.swift", "content": "//\n// File.swift\n// \n//\n// Created by YuAo on 2022/3/22.\n//\n\nimport Foundation\n\npublic struct LanguageVersion: Hashable, CustomStringConvertible {\n public init(major: Int, minor: Int) {\n self.major = major\n self.minor = minor\n }\n \n public let major: Int\n public let minor: Int\n \n public var description: String {\n return \"\\(major).\\(minor)\"\n }\n}\n" }, { "path": "Sources/MetalLibraryArchive/LibraryType.swift", "content": "//\n// File.swift\n// \n//\n// Created by YuAo on 2022/3/22.\n//\n\nimport Foundation\n\npublic enum LibraryType: Int, CustomStringConvertible, CaseIterable, Hashable {\n case executable = 0\n case coreImage = 1\n case dynamic = 2\n case symbolCompanion = 3\n \n public var description: String {\n switch self {\n case .executable:\n return \"Executable\"\n case .coreImage:\n return \"Core Image\"\n case .dynamic:\n return \"Dynamic\"\n case .symbolCompanion:\n return \"Symbol Companion\"\n }\n }\n}\n" }, { "path": "Sources/MetalLibraryArchive/MetalDataType.swift", "content": "//\n// MetalDataType.swift\n// Generated on 2022-04-10 15:38:24 +0000\n//\n\npublic enum MetalDataType: UInt8, Hashable, CaseIterable {\n case none = 0x00\n case `struct` = 0x01\n case array = 0x02\n case float = 0x03\n case float2 = 0x04\n case float3 = 0x05\n case float4 = 0x06\n case float2x2 = 0x07\n case float2x3 = 0x08\n case float2x4 = 0x09\n case float3x2 = 0x0A\n case float3x3 = 0x0B\n case float3x4 = 0x0C\n case float4x2 = 0x0D\n case float4x3 = 0x0E\n case float4x4 = 0x0F\n case half = 0x10\n case half2 = 0x11\n case half3 = 0x12\n case half4 = 0x13\n case half2x2 = 0x14\n case half2x3 = 0x15\n case half2x4 = 0x16\n case half3x2 = 0x17\n case half3x3 = 0x18\n case half3x4 = 0x19\n case half4x2 = 0x1A\n case half4x3 = 0x1B\n case half4x4 = 0x1C\n case int = 0x1D\n case int2 = 0x1E\n case int3 = 0x1F\n case int4 = 0x20\n case uint = 0x21\n case uint2 = 0x22\n case uint3 = 0x23\n case uint4 = 0x24\n case short = 0x25\n case short2 = 0x26\n case short3 = 0x27\n case short4 = 0x28\n case ushort = 0x29\n case ushort2 = 0x2A\n case ushort3 = 0x2B\n case ushort4 = 0x2C\n case char = 0x2D\n case char2 = 0x2E\n case char3 = 0x2F\n case char4 = 0x30\n case uchar = 0x31\n case uchar2 = 0x32\n case uchar3 = 0x33\n case uchar4 = 0x34\n case bool = 0x35\n case bool2 = 0x36\n case bool3 = 0x37\n case bool4 = 0x38\n case texture = 0x3A\n case sampler = 0x3B\n case pointer = 0x3C\n case r8Unorm = 0x3E\n case r8Snorm = 0x3F\n case r16Unorm = 0x40\n case r16Snorm = 0x41\n case rg8Unorm = 0x42\n case rg8Snorm = 0x43\n case rg16Unorm = 0x44\n case rg16Snorm = 0x45\n case rgba8Unorm = 0x46\n case rgba8Unorm_sRGB = 0x47\n case rgba8Snorm = 0x48\n case rgba16Unorm = 0x49\n case rgba16Snorm = 0x4A\n case rgb10A2Unorm = 0x4B\n case rg11B10Float = 0x4C\n case rgb9E5Float = 0x4D\n case renderPipeline = 0x4E\n case computePipeline = 0x4F\n case indirectCommandBuffer = 0x50\n case long = 0x51\n case long2 = 0x52\n case long3 = 0x53\n case long4 = 0x54\n case ulong = 0x55\n case ulong2 = 0x56\n case ulong3 = 0x57\n case ulong4 = 0x58\n case double = 0x59\n case double2 = 0x5A\n case double3 = 0x5B\n case double4 = 0x5C\n case float8 = 0x5D\n case float16 = 0x5E\n case half8 = 0x5F\n case half16 = 0x60\n case int8 = 0x61\n case int16 = 0x62\n case uint8 = 0x63\n case uint16 = 0x64\n case short8 = 0x65\n case short16 = 0x66\n case ushort8 = 0x67\n case ushort16 = 0x68\n case char8 = 0x69\n case char16 = 0x6A\n case uchar8 = 0x6B\n case uchar16 = 0x6C\n case long8 = 0x6D\n case long16 = 0x6E\n case ulong8 = 0x6F\n case ulong16 = 0x70\n case double8 = 0x71\n case double16 = 0x72\n case visibleFunctionTable = 0x73\n case intersectionFunctionTable = 0x74\n case primitiveAccelerationStructure = 0x75\n case instanceAccelerationStructure = 0x76\n case bool8 = 0x77\n case bool16 = 0x78\n}\n\n" }, { "path": "Sources/MetalLibraryArchive/Platform.swift", "content": "//\n// File.swift\n// \n//\n// Created by YuAo on 2022/3/23.\n//\n\nimport Foundation\n\npublic enum Platform: CustomStringConvertible, CaseIterable, Hashable {\n case iOS\n case macOS\n \n public var description: String {\n switch self {\n case .iOS:\n return \"iOS\"\n case .macOS:\n return \"macOS\"\n }\n }\n}\n" }, { "path": "Sources/MetalLibraryArchive/SourceArchive.swift", "content": "//\n// File.swift\n// \n//\n// Created by YuAo on 2022/3/25.\n//\n\nimport Foundation\n\npublic struct SourceArchive: Hashable {\n public let id: String\n public let data: Data\n}\n" }, { "path": "Sources/MetalLibraryArchive/Tag.swift", "content": "//\n// File.swift\n// \n//\n// Created by YuAo on 2022/3/22.\n//\n\nimport Foundation\n\npublic struct Tag: Hashable {\n public let name: String\n public let content: Data\n}\n" }, { "path": "Tests/MetalLibraryArchiveTests/Tests.swift", "content": "import XCTest\nimport MetalLibraryArchive\n\nstruct SDK {\n var name: String\n var metalPlatform: String\n static let macOS = SDK(name: \"macosx\", metalPlatform: \"macos\")\n static let iOS = SDK(name: \"iphoneos\", metalPlatform: \"ios\")\n static let tvOS = SDK(name: \"appletvos\", metalPlatform: \"ios\")\n static let tvOSSimulator = SDK(name: \"appletvsimulator\", metalPlatform: \"ios\")\n static let iOSSimulator = SDK(name: \"iphonesimulator\", metalPlatform: \"ios\")\n static let watchOS = SDK(name: \"watchos\", metalPlatform: \"ios\")\n \n var targetPlatform: Platform {\n switch self.metalPlatform {\n case \"macos\":\n return .macOS\n case \"ios\":\n return .iOS\n default:\n fatalError()\n }\n }\n}\n\nstruct ComplieOptions {\n enum SourceRecordingOption {\n case none\n case embeded\n case separated\n }\n \n var target: String?\n var coreImageSupportEnabled: Bool = false\n var libraryType: LibraryType = .executable\n var languageVersion: LanguageVersion?\n var installName: String?\n var sourceRecordingOption: SourceRecordingOption = .none\n}\n\nstruct MetalLibraryArchiveTestUtilities {\n \n struct Library {\n var data: Data\n var symbolCompanionData: Data?\n }\n \n static var temporaryDirectory: URL {\n let tempDirectoryURL = FileManager.default.temporaryDirectory.appendingPathComponent(\"MetalLibraryArchiveTests\")\n try? FileManager.default.createDirectory(at: tempDirectoryURL, withIntermediateDirectories: true)\n return tempDirectoryURL\n }\n \n static func makeLibrary(source: String, sdk: SDK, options: ComplieOptions = ComplieOptions()) throws -> Library {\n let complierFlags: [String] = try {\n var flags: [String] = []\n if let target = options.target {\n flags.append(contentsOf: [\"-target\", target])\n }\n if let version = options.languageVersion {\n flags.append(\"-std=\\(sdk.metalPlatform)-metal\\(version.major).\\(version.minor)\")\n }\n if options.coreImageSupportEnabled {\n flags.append(\"-fcikernel\")\n }\n if options.libraryType == .dynamic {\n flags.append(\"-dynamiclib\")\n if let installName = options.installName {\n flags.append(\"-install_name\")\n flags.append(installName)\n }\n }\n switch options.sourceRecordingOption {\n case .none:\n break\n case .embeded:\n flags.append(\"-frecord-sources\")\n case .separated:\n if sdk.targetPlatform == .macOS {\n guard ProcessInfo.processInfo.operatingSystemVersion.majorVersion >= 12 else {\n throw XCTSkip(\"The target platform does not support companion metallib.\")\n }\n }\n flags.append(\"-frecord-sources=flat\")\n }\n return flags\n }()\n \n let tempDirectoryURL = self.temporaryDirectory\n let workUUID = UUID()\n let sourceURL = tempDirectoryURL.appendingPathComponent(workUUID.uuidString).appendingPathExtension(\"metal\")\n let libraryURL = tempDirectoryURL.appendingPathComponent(workUUID.uuidString).appendingPathExtension(\"metallib\")\n defer {\n do {\n try FileManager.default.removeItem(at: sourceURL)\n try FileManager.default.removeItem(at: libraryURL)\n } catch {}\n }\n try source.write(to: sourceURL, atomically: true, encoding: .utf8)\n \n let compileProcess = Process()\n compileProcess.executableURL = URL(fileURLWithPath: \"/usr/bin/xcrun\")\n compileProcess.arguments = [\"--sdk\", sdk.name, \"metal\"] + complierFlags + [\"-o\", libraryURL.path, sourceURL.path]\n try compileProcess.run()\n compileProcess.waitUntilExit()\n XCTAssert(compileProcess.terminationStatus == 0)\n \n \n let data = try Data(contentsOf: libraryURL)\n var library = Library(data: data)\n if options.sourceRecordingOption == .separated {\n library.symbolCompanionData = try Data(contentsOf: libraryURL.deletingPathExtension().appendingPathExtension(\"metallibsym\"))\n }\n return library\n }\n}\n\nclass MetalLibraryArchiveTests_macOSSDK: XCTestCase {\n var sdk: SDK = .macOS\n \n private func makeLibrary(source: String, options: ComplieOptions = ComplieOptions()) throws -> Data {\n return try MetalLibraryArchiveTestUtilities.makeLibrary(source: source, sdk: sdk, options: options).data\n }\n \n func testEmptyLibrary() throws {\n let data = try self.makeLibrary(source: \"\")\n let archive = try Archive(data: data)\n XCTAssertEqual(archive.targetPlatform, sdk.targetPlatform)\n XCTAssertEqual(archive.functions.count, 0)\n }\n \n func testVertexFunction() throws {\n let source = \"\"\"\n #include \n struct VertexOut { float4 position [[position]]; };\n vertex VertexOut testVertex() { VertexOut out = {0}; return out; }\n \"\"\"\n let data = try self.makeLibrary(source: source)\n let archive = try Archive(data: data)\n XCTAssertEqual(archive.targetPlatform, sdk.targetPlatform)\n XCTAssertEqual(archive.functions.count, 1)\n let function = try XCTUnwrap(archive.functions.first)\n XCTAssertEqual(function.name, \"testVertex\")\n XCTAssertEqual(function.type, .vertex)\n XCTAssert(function.bitcode.count > 0)\n }\n \n func testFragmentFunction() throws {\n let source = \"\"\"\n #include \n fragment float4 testFragment() { return float4(0); }\n \"\"\"\n let data = try self.makeLibrary(source: source)\n let archive = try Archive(data: data)\n XCTAssertEqual(archive.targetPlatform, sdk.targetPlatform)\n XCTAssertEqual(archive.functions.count, 1)\n let function = try XCTUnwrap(archive.functions.first)\n XCTAssertEqual(function.name, \"testFragment\")\n XCTAssertEqual(function.type, .fragment)\n XCTAssert(function.bitcode.count > 0)\n }\n \n func testKernelFunction() throws {\n let source = \"\"\"\n #include \n kernel void testKernel() {}\n \"\"\"\n let data = try self.makeLibrary(source: source)\n let archive = try Archive(data: data)\n XCTAssertEqual(archive.targetPlatform, sdk.targetPlatform)\n XCTAssertEqual(archive.functions.count, 1)\n let function = try XCTUnwrap(archive.functions.first)\n XCTAssertEqual(function.name, \"testKernel\")\n XCTAssertEqual(function.type, .kernel)\n XCTAssert(function.bitcode.count > 0)\n }\n \n func testVisibleFunction() throws {\n let source = \"\"\"\n #include \n [[visible]] void test() {}\n \"\"\"\n let data = try self.makeLibrary(source: source)\n let archive = try Archive(data: data)\n XCTAssertEqual(archive.targetPlatform, sdk.targetPlatform)\n XCTAssertEqual(archive.functions.count, 1)\n let function = try XCTUnwrap(archive.functions.first)\n XCTAssertEqual(function.name, \"test\")\n XCTAssertEqual(function.type, .visible)\n XCTAssert(function.bitcode.count > 0)\n }\n \n func testIntersectionFunction() throws {\n let source = \"\"\"\n #include \n [[intersection(triangle)]]\n bool testIntersectionFunction() { return true; }\n \"\"\"\n let data = try self.makeLibrary(source: source)\n let archive = try Archive(data: data)\n XCTAssertEqual(archive.targetPlatform, sdk.targetPlatform)\n XCTAssertEqual(archive.functions.count, 1)\n let function = try XCTUnwrap(archive.functions.first)\n XCTAssertEqual(function.name, \"testIntersectionFunction\")\n XCTAssertEqual(function.type, .intersection)\n XCTAssert(function.bitcode.count > 0)\n }\n \n func testUnqualifiedFunction() throws {\n let source = \"\"\"\n #include \n namespace test {\n void action() {}\n }\n \"\"\"\n let data = try self.makeLibrary(source: source, options: ComplieOptions(libraryType: .dynamic, installName: \"@executable_path/libtest.metallib\"))\n let archive = try Archive(data: data)\n XCTAssertEqual(archive.targetPlatform, sdk.targetPlatform)\n XCTAssertEqual(archive.functions.count, 1)\n let function = try XCTUnwrap(archive.functions.first)\n XCTAssertEqual(function.name, \"_ZN4test6actionEv\")\n XCTAssertEqual(function.type, .unqualified)\n XCTAssert(function.bitcode.count > 0)\n }\n \n func testUnqualifiedFunction_globalNamespace() throws {\n let source = \"\"\"\n #include \n void test() {}\n \"\"\"\n let data = try self.makeLibrary(source: source, options: ComplieOptions(libraryType: .dynamic, installName: \"@executable_path/libtest.metallib\"))\n let archive = try Archive(data: data)\n XCTAssertEqual(archive.targetPlatform, sdk.targetPlatform)\n XCTAssertEqual(archive.functions.count, 1)\n let function = try XCTUnwrap(archive.functions.first)\n XCTAssertEqual(function.name, \"_Z4testv\")\n XCTAssertEqual(function.type, .unqualified)\n XCTAssert(function.bitcode.count > 0)\n }\n \n func testUnqualifiedFunction_externC() throws {\n let source = \"\"\"\n #include \n extern \"C\" void test() {}\n \"\"\"\n let data = try self.makeLibrary(source: source, options: ComplieOptions(libraryType: .dynamic, installName: \"@executable_path/libtest.metallib\"))\n let archive = try Archive(data: data)\n XCTAssertEqual(archive.targetPlatform, sdk.targetPlatform)\n XCTAssertEqual(archive.functions.count, 1)\n let function = try XCTUnwrap(archive.functions.first)\n XCTAssertEqual(function.name, \"test\")\n XCTAssertEqual(function.type, .unqualified)\n XCTAssert(function.bitcode.count > 0)\n }\n \n func testExternFunction() throws {\n let source = \"\"\"\n #include \n using namespace metal;\n #include \n \n extern \"C\" { namespace coreimage {\n float4 test(sample_t s) {\n return s.rgba;\n }\n }}\n \"\"\"\n let data = try self.makeLibrary(source: source, options: ComplieOptions(coreImageSupportEnabled: true))\n let archive = try Archive(data: data)\n XCTAssertEqual(archive.targetPlatform, sdk.targetPlatform)\n XCTAssertEqual(archive.functions.count, 1)\n XCTAssertEqual(archive.libraryType, .coreImage)\n let function = try XCTUnwrap(archive.functions.first)\n XCTAssertEqual(function.name, \"test\")\n XCTAssertEqual(function.type, .extern)\n XCTAssert(function.bitcode.count > 0)\n XCTAssert(archive.functions[0].publicMetadataTags.contains(where: { $0.name == \"RETR\" }))\n XCTAssert(archive.functions[0].publicMetadataTags.contains(where: { $0.name == \"ARGR\" }))\n }\n \n func testLanguageVersion_2_0() throws {\n let source = \"\"\"\n #include \n kernel void testKernel() {}\n \"\"\"\n let mslVersion = LanguageVersion(major: 2, minor: 0)\n let data = try self.makeLibrary(source: source, options: ComplieOptions(languageVersion: mslVersion))\n let archive = try Archive(data: data)\n XCTAssertEqual(archive.targetPlatform, sdk.targetPlatform)\n XCTAssertEqual(archive.functions.count, 1)\n let function = try XCTUnwrap(archive.functions.first)\n XCTAssertEqual(function.name, \"testKernel\")\n XCTAssertEqual(function.type, .kernel)\n XCTAssertEqual(function.languageVersion, mslVersion)\n XCTAssert(function.bitcode.count > 0)\n }\n \n func testLanguageVersion_1_2() throws {\n let source = \"\"\"\n #include \n kernel void testKernel() {}\n \"\"\"\n let mslVersion = LanguageVersion(major: 1, minor: 2)\n let data = try self.makeLibrary(source: source, options: ComplieOptions(languageVersion: mslVersion))\n let archive = try Archive(data: data)\n XCTAssertEqual(archive.targetPlatform, sdk.targetPlatform)\n XCTAssertEqual(archive.functions.count, 1)\n let function = try XCTUnwrap(archive.functions.first)\n XCTAssertEqual(function.name, \"testKernel\")\n XCTAssertEqual(function.type, .kernel)\n XCTAssertEqual(function.languageVersion, mslVersion)\n XCTAssert(function.bitcode.count > 0)\n }\n \n func testMultipleFunctions() throws {\n let source = \"\"\"\n #include \n struct VertexOut { float4 position [[position]]; };\n vertex VertexOut testVertex() { VertexOut out = {0}; return out; }\n kernel void testKernel() {}\n fragment float4 testFragment() { return float4(0); }\n \"\"\"\n let data = try self.makeLibrary(source: source)\n let archive = try Archive(data: data)\n XCTAssertEqual(archive.targetPlatform, sdk.targetPlatform)\n XCTAssertEqual(archive.functions.count, 3)\n }\n \n func testMultipleExternFunctions() throws {\n let source = \"\"\"\n #include \n using namespace metal;\n #include \n \n extern \"C\" { namespace coreimage {\n float4 test1(sample_t s) {\n return s.rgba;\n }\n void test2() { }\n void test3() { }\n }}\n \"\"\"\n let data = try self.makeLibrary(source: source, options: ComplieOptions(coreImageSupportEnabled: true))\n let archive = try Archive(data: data)\n XCTAssertEqual(archive.targetPlatform, sdk.targetPlatform)\n XCTAssertEqual(archive.functions.count, 3)\n }\n \n func testQualifiedFunctionNames() throws {\n let source = \"\"\"\n #include \n namespace test {\n struct VertexOut { float4 position [[position]]; };\n vertex VertexOut testVertex() { VertexOut out = {0}; return out; }\n kernel void testKernel() {}\n fragment float4 testFragment() { return float4(0); }\n }\n \"\"\"\n let data = try self.makeLibrary(source: source)\n let archive = try Archive(data: data)\n XCTAssertEqual(archive.targetPlatform, sdk.targetPlatform)\n XCTAssertEqual(archive.functions.count, 3)\n for function in archive.functions {\n XCTAssert(function.name.hasPrefix(\"test::\"))\n }\n }\n \n func testLinkedLibraries() throws {\n let tempDirectoryURL = MetalLibraryArchiveTestUtilities.temporaryDirectory\n let workUUID = UUID()\n let workingDirectory = tempDirectoryURL.appendingPathComponent(workUUID.uuidString)\n try FileManager.default.createDirectory(at: workingDirectory, withIntermediateDirectories: true)\n defer {\n try? FileManager.default.removeItem(at: workingDirectory)\n }\n do {\n let source = \"\"\"\n #include \n namespace test {\n float4 blackColor() { return float4(0); }\n }\n \"\"\"\n let sourceURL = workingDirectory.appendingPathComponent(\"dylib.metal\")\n let libraryURL = workingDirectory.appendingPathComponent(\"libTest.metallib\")\n try source.write(to: sourceURL, atomically: true, encoding: .utf8)\n \n let compileProcess = Process()\n compileProcess.executableURL = URL(fileURLWithPath: \"/usr/bin/xcrun\")\n compileProcess.arguments = [\"--sdk\", sdk.name, \"metal\", \"-dynamiclib\", \"-install_name\", \"@executable_path/libTest.metallib\", \"-o\", libraryURL.path, sourceURL.path]\n try compileProcess.run()\n compileProcess.waitUntilExit()\n XCTAssert(compileProcess.terminationStatus == 0)\n \n let archive = try Archive(data: Data(contentsOf: libraryURL))\n XCTAssertEqual(archive.targetPlatform, sdk.targetPlatform)\n XCTAssertEqual(archive.libraryType, .dynamic)\n XCTAssertEqual(archive.functions.count, 1)\n }\n do {\n let source = \"\"\"\n #include \n namespace test {\n float4 blackColor();\n }\n kernel void testKernel() {\n test::blackColor();\n }\n \"\"\"\n let sourceURL = workingDirectory.appendingPathComponent(\"exe.metal\")\n let libraryURL = workingDirectory.appendingPathComponent(\"default.metallib\")\n try source.write(to: sourceURL, atomically: true, encoding: .utf8)\n \n let compileProcess = Process()\n compileProcess.executableURL = URL(fileURLWithPath: \"/usr/bin/xcrun\")\n compileProcess.arguments = [\"--sdk\", sdk.name, \"metal\", \"-L\", workingDirectory.path, \"-lTest\", \"-o\", libraryURL.path, sourceURL.path]\n try compileProcess.run()\n compileProcess.waitUntilExit()\n XCTAssert(compileProcess.terminationStatus == 0)\n \n let archive = try Archive(data: Data(contentsOf: libraryURL))\n XCTAssertEqual(archive.targetPlatform, sdk.targetPlatform)\n XCTAssertEqual(archive.libraryType, .executable)\n }\n }\n \n func testLibraryType() throws {\n let source = \"\"\"\n #include \n namespace test {\n void action() {}\n }\n \"\"\"\n do {\n let data = try self.makeLibrary(source: source, options: ComplieOptions(libraryType: .dynamic, installName: \"@executable_path/libtest.metallib\"))\n let archive = try Archive(data: data)\n XCTAssertEqual(archive.libraryType, .dynamic)\n }\n do {\n let data = try self.makeLibrary(source: source, options: ComplieOptions(libraryType: .executable))\n let archive = try Archive(data: data)\n XCTAssertEqual(archive.targetPlatform, sdk.targetPlatform)\n XCTAssertEqual(archive.libraryType, .executable)\n }\n }\n \n func testTessellationFuntion() throws {\n let source = \"\"\"\n #include \n using namespace metal;\n \n struct ControlPoint {\n float4 position [[attribute(0)]];\n float3 normal [[attribute(1)]];\n };\n \n struct PatchIn {\n patch_control_point controlPoints;\n };\n \n struct VertexOut {\n float4 position [[position]];\n };\n\n [[patch(quad, 4)]]\n vertex VertexOut vertex_subdiv_quad(PatchIn patch [[stage_in]],\n float2 positionInPatch [[position_in_patch]]) {\n VertexOut out = {0};\n return out;\n }\n \"\"\"\n let data = try self.makeLibrary(source: source)\n let archive = try Archive(data: data)\n XCTAssertEqual(archive.functions.count, 1)\n XCTAssertEqual(archive.targetPlatform, sdk.targetPlatform)\n XCTAssertEqual(archive.libraryType, .executable)\n let tessellationTag = try XCTUnwrap(archive.functions.first?.tags.first(where: { $0.name == \"TESS\" }))\n XCTAssertEqual(tessellationTag.content.withUnsafeBytes({ $0.bindMemory(to: UInt8.self)[0] }), 4 << 2 | 2)\n XCTAssert(archive.functions[0].publicMetadataTags.contains(where: { $0.name == \"VATT\" }))\n XCTAssert(archive.functions[0].publicMetadataTags.contains(where: { $0.name == \"VATY\" }))\n \n let vatyTag = try XCTUnwrap(archive.functions.first?.publicMetadataTags.first(where: { $0.name == \"VATY\" }))\n XCTAssertEqual(vatyTag.content.withUnsafeBytes({ $0.bindMemory(to: UInt16.self)[0] }), 2) // count\n XCTAssertEqual(vatyTag.content.withUnsafeBytes({ $0.bindMemory(to: UInt8.self)[2] }), MetalDataType.float4.rawValue) //position\n XCTAssertEqual(vatyTag.content.withUnsafeBytes({ $0.bindMemory(to: UInt8.self)[3] }), MetalDataType.float3.rawValue) //normal\n }\n \n func testFuntionConstants() throws {\n let source = \"\"\"\n #include \n constant int constantValueA [[function_constant(0)]];\n kernel void testKernel(device float *io) {\n for (int i = 0; i < constantValueA; i += 1) {\n io[i] = 0;\n }\n }\n \"\"\"\n let data = try self.makeLibrary(source: source)\n let archive = try Archive(data: data)\n XCTAssertEqual(archive.functions.count, 1)\n XCTAssertEqual(archive.targetPlatform, sdk.targetPlatform)\n XCTAssertEqual(archive.libraryType, .executable)\n XCTAssert(archive.functions[0].publicMetadataTags.contains(where: { $0.name == \"CNST\" }))\n }\n \n func testFuntionConstants_unused() throws {\n let source = \"\"\"\n #include \n constant int constantValueA [[function_constant(0)]];\n kernel void testKernel(device float *io) {\n for (int i = 0; i < constantValueA; i += 1) {\n break;\n }\n }\n \"\"\"\n let data = try self.makeLibrary(source: source)\n let archive = try Archive(data: data)\n XCTAssertEqual(archive.functions.count, 1)\n XCTAssertEqual(archive.targetPlatform, sdk.targetPlatform)\n XCTAssertEqual(archive.libraryType, .executable)\n XCTAssertEqual(archive.functions[0].publicMetadataTags.contains(where: { $0.name == \"CNST\" }), false)\n }\n \n func testLayeredRendering_uint() throws {\n let source = \"\"\"\n typedef struct {\n uint layer [[render_target_array_index]];\n float4 position [[position]];\n } ColorInOut;\n \n vertex ColorInOut vertexTransform(){\n ColorInOut out;\n out.layer = 0;\n out.position = float4(0);\n return out;\n }\n \"\"\"\n let data = try self.makeLibrary(source: source)\n let archive = try Archive(data: data)\n XCTAssertEqual(archive.functions.count, 1)\n XCTAssertEqual(archive.targetPlatform, sdk.targetPlatform)\n XCTAssertEqual(archive.libraryType, .executable)\n let layerTag = try XCTUnwrap(archive.functions.first?.tags.first(where: { $0.name == \"LAYR\" }))\n XCTAssertEqual(layerTag.content.withUnsafeBytes({ $0.bindMemory(to: UInt8.self)[0] }), MetalDataType.uint.rawValue)\n }\n \n func testLayeredRendering_ushort() throws {\n let source = \"\"\"\n typedef struct {\n ushort layer [[render_target_array_index]];\n float4 position [[position]];\n } ColorInOut;\n \n vertex ColorInOut vertexTransform(){\n ColorInOut out;\n out.layer = 0;\n out.position = float4(0);\n return out;\n }\n \"\"\"\n let data = try self.makeLibrary(source: source)\n let archive = try Archive(data: data)\n XCTAssertEqual(archive.functions.count, 1)\n XCTAssertEqual(archive.targetPlatform, sdk.targetPlatform)\n XCTAssertEqual(archive.libraryType, .executable)\n let layerTag = try XCTUnwrap(archive.functions.first?.tags.first(where: { $0.name == \"LAYR\" }))\n XCTAssertEqual(layerTag.content.withUnsafeBytes({ $0.bindMemory(to: UInt8.self)[0] }), MetalDataType.ushort.rawValue)\n }\n \n func testSourceArchives_executable() throws {\n let source = \"\"\"\n #include \n kernel void testKernel() {}\n \"\"\"\n let library = try MetalLibraryArchiveTestUtilities.makeLibrary(source: source, sdk: sdk, options: ComplieOptions(sourceRecordingOption: .embeded))\n let archive = try Archive(data: library.data)\n XCTAssertEqual(archive.functions.count, 1)\n XCTAssertEqual(archive.targetPlatform, sdk.targetPlatform)\n XCTAssertEqual(archive.libraryType, .executable)\n XCTAssert(archive.sourceArchives.count > 0)\n XCTAssert(archive.functions[0].privateMetadataTags.contains(where: { $0.name == \"DEPF\" }))\n }\n \n func testSourceArchives_dynamic() throws {\n let source = \"\"\"\n #include \n namespace test {\n void action() {}\n }\n \"\"\"\n let library = try MetalLibraryArchiveTestUtilities.makeLibrary(source: source, sdk: sdk, options: ComplieOptions(libraryType: .dynamic, installName: \"@executable_path/libtest.metallib\", sourceRecordingOption: .embeded))\n let archive = try Archive(data: library.data)\n XCTAssertEqual(archive.functions.count, 1)\n XCTAssertEqual(archive.targetPlatform, sdk.targetPlatform)\n XCTAssertEqual(archive.libraryType, .dynamic)\n XCTAssert(archive.sourceArchives.count > 0)\n }\n \n func testSourceArchives_executable_sym() throws {\n let source = \"\"\"\n #include \n kernel void testKernel() {}\n \"\"\"\n let library = try MetalLibraryArchiveTestUtilities.makeLibrary(source: source, sdk: sdk, options: ComplieOptions(sourceRecordingOption: .separated))\n let archive = try Archive(data: library.data)\n XCTAssertEqual(archive.functions.count, 1)\n XCTAssertEqual(archive.targetPlatform, sdk.targetPlatform)\n XCTAssertEqual(archive.libraryType, .executable)\n XCTAssertEqual(archive.sourceArchives.count, 0)\n \n let symArchive = try Archive(data: XCTUnwrap(library.symbolCompanionData))\n XCTAssertEqual(symArchive.functions.count, 1)\n XCTAssertEqual(symArchive.targetPlatform, sdk.targetPlatform)\n XCTAssertEqual(symArchive.libraryType, .symbolCompanion)\n XCTAssert(symArchive.sourceArchives.count > 0)\n }\n \n func testSourceArchives_dynamic_sym() throws {\n let source = \"\"\"\n #include \n namespace test {\n void action() {}\n }\n \"\"\"\n let library = try MetalLibraryArchiveTestUtilities.makeLibrary(source: source, sdk: sdk, options: ComplieOptions(libraryType: .dynamic, installName: \"@executable_path/libtest.metallib\", sourceRecordingOption: .separated))\n let archive = try Archive(data: library.data)\n XCTAssertEqual(archive.functions.count, 1)\n XCTAssertEqual(archive.targetPlatform, sdk.targetPlatform)\n XCTAssertEqual(archive.libraryType, .dynamic)\n XCTAssertEqual(archive.sourceArchives.count, 0)\n \n let symArchive = try Archive(data: XCTUnwrap(library.symbolCompanionData))\n XCTAssertEqual(symArchive.functions.count, 1)\n XCTAssertEqual(symArchive.targetPlatform, sdk.targetPlatform)\n XCTAssertEqual(symArchive.libraryType, .symbolCompanion)\n XCTAssert(symArchive.sourceArchives.count > 0)\n }\n}\n\nclass MetalLibraryArchiveTests_iOSSDK: MetalLibraryArchiveTests_macOSSDK {\n override func setUp() {\n self.sdk = .iOS\n super.setUp()\n }\n}\n\nclass MetalLibraryArchiveTests_tvOSSDK: MetalLibraryArchiveTests_macOSSDK {\n override func setUp() {\n self.sdk = .tvOS\n super.setUp()\n }\n}\n\nclass MetalLibraryArchiveTests_iOSSimulatorSDK: MetalLibraryArchiveTests_macOSSDK {\n override func setUp() {\n self.sdk = .iOSSimulator\n super.setUp()\n }\n}\n\nclass MetalLibraryArchiveTests_tvOSSimulatorSDK: MetalLibraryArchiveTests_macOSSDK {\n override func setUp() {\n self.sdk = .tvOSSimulator\n super.setUp()\n }\n}\n\nclass MetalLibraryArchiveTests: XCTestCase {\n func testInvalidLibraryData() throws {\n do {\n let data = Data()\n XCTAssertThrowsError(try Archive(data: data))\n }\n do {\n let data = \"MTLB\".data(using: .utf8)!\n XCTAssertThrowsError(try Archive(data: data))\n }\n }\n}\n\nclass MetalLibraryArchiveTests_TargetPlatformBug: XCTestCase {\n func testEmptyLibraryTargetPlatform_expectFailure() throws {\n let library = try MetalLibraryArchiveTestUtilities.makeLibrary(source: \"\", sdk: .iOS, options: ComplieOptions(target: \"air64-apple-ios14.0\"))\n let archive = try Archive(data: library.data)\n XCTExpectFailure(failingBlock: {\n XCTAssertEqual(archive.targetPlatform, .iOS)\n })\n }\n \n func testEmptyLibraryTargetPlatform_expectSuccess() throws {\n let library = try MetalLibraryArchiveTestUtilities.makeLibrary(source: \"\", sdk: .iOS, options: ComplieOptions(target: \"air64-apple-ios15.0\"))\n let archive = try Archive(data: library.data)\n XCTAssertEqual(archive.targetPlatform, .iOS)\n }\n}\n\nclass MetalLibraryArchiveTests_DeploymentTarget: XCTestCase {\n private let source = \"\"\"\n #include \n kernel void testKernel() {}\n \"\"\"\n \n func testDeploymentTarget_macOS_12() throws {\n let library = try MetalLibraryArchiveTestUtilities.makeLibrary(source: source, sdk: .macOS, options: ComplieOptions(target: \"air64-apple-macos12.0\"))\n let archive = try Archive(data: library.data)\n XCTAssertEqual(archive.targetPlatform, .macOS)\n XCTAssertEqual(archive.deploymentTarget?.operatingSystem, .macOS)\n XCTAssertEqual(archive.deploymentTarget?.operatingSystemVersion.description, \"12.0\")\n }\n \n func testDeploymentTarget_iOS_15() throws {\n let library = try MetalLibraryArchiveTestUtilities.makeLibrary(source: source, sdk: .iOS, options: ComplieOptions(target: \"air64-apple-ios15.0\"))\n let archive = try Archive(data: library.data)\n XCTAssertEqual(archive.targetPlatform, .iOS)\n XCTAssertEqual(archive.deploymentTarget?.operatingSystem, .iOS)\n XCTAssertEqual(archive.deploymentTarget?.operatingSystemVersion.description, \"15.0\")\n }\n \n func testDeploymentTarget_iOS_15_1() throws {\n let library = try MetalLibraryArchiveTestUtilities.makeLibrary(source: source, sdk: .iOS, options: ComplieOptions(target: \"air64-apple-ios15.1\"))\n let archive = try Archive(data: library.data)\n XCTAssertEqual(archive.targetPlatform, .iOS)\n XCTAssertEqual(archive.deploymentTarget?.operatingSystem, .iOS)\n XCTAssertEqual(archive.deploymentTarget?.operatingSystemVersion.description, \"15.1\")\n }\n \n func testDeploymentTarget_iOS_11() throws {\n let library = try MetalLibraryArchiveTestUtilities.makeLibrary(source: source, sdk: .iOS, options: ComplieOptions(target: \"air64-apple-ios11.0\"))\n let archive = try Archive(data: library.data)\n XCTAssertEqual(archive.targetPlatform, .iOS)\n XCTAssertEqual(archive.deploymentTarget, nil)\n }\n \n func testDeploymentTarget_watchOS_8_5() throws {\n let library = try MetalLibraryArchiveTestUtilities.makeLibrary(source: source, sdk: .watchOS, options: ComplieOptions(target: \"air64-apple-watchos8.5\"))\n let archive = try Archive(data: library.data)\n XCTAssertEqual(archive.targetPlatform, .iOS)\n XCTAssertEqual(archive.deploymentTarget?.operatingSystem, .watchOS)\n XCTAssertEqual(archive.deploymentTarget?.operatingSystemVersion.description, \"8.5\")\n }\n \n func testDeploymentTarget_iOSSimulator_15_2() throws {\n let library = try MetalLibraryArchiveTestUtilities.makeLibrary(source: source, sdk: .iOSSimulator, options: ComplieOptions(target: \"air64-apple-ios15.2-simulator\"))\n let archive = try Archive(data: library.data)\n XCTAssertEqual(archive.targetPlatform, .iOS)\n XCTAssertEqual(archive.deploymentTarget?.operatingSystem, .iOSSimulator)\n XCTAssertEqual(archive.deploymentTarget?.operatingSystemVersion.description, \"15.2\")\n }\n \n func testDeploymentTarget_macCatalyst_15() throws {\n let library = try MetalLibraryArchiveTestUtilities.makeLibrary(source: source, sdk: .iOS, options: ComplieOptions(target: \"air64-apple-ios15.0-macabi\"))\n let archive = try Archive(data: library.data)\n XCTAssertEqual(archive.targetPlatform, .macOS)\n XCTAssertEqual(archive.deploymentTarget?.operatingSystem, .macCatalyst)\n XCTAssertEqual(archive.deploymentTarget?.operatingSystemVersion.description, \"15.0\")\n }\n}\n" }, { "path": "Utilities/Package.resolved", "content": "{\n \"object\": {\n \"pins\": [\n {\n \"package\": \"swift-argument-parser\",\n \"repositoryURL\": \"https://github.com/apple/swift-argument-parser\",\n \"state\": {\n \"branch\": null,\n \"revision\": \"82905286cc3f0fa8adc4674bf49437cab65a8373\",\n \"version\": \"1.1.1\"\n }\n }\n ]\n },\n \"version\": 1\n}\n" }, { "path": "Utilities/Package.swift", "content": "// swift-tools-version:5.4\n// The swift-tools-version declares the minimum version of Swift required to build this package.\n\nimport PackageDescription\n\nlet package = Package(\n name: \"Utilities\",\n platforms: [.macOS(.v10_13)],\n products: [\n .executable(name: \"metal-data-type-tools\", targets: [\"MetalDataTypeTools\"])\n ],\n dependencies: [\n .package(url: \"https://github.com/apple/swift-argument-parser\", from: \"1.0.0\")\n ],\n targets: [\n .executableTarget(\n name: \"MetalDataTypeTools\",\n dependencies: [\n .product(name: \"ArgumentParser\", package: \"swift-argument-parser\")\n ])\n ]\n)\n" }, { "path": "Utilities/Sources/MetalDataTypeTools/Command.swift", "content": "//\n// File.swift\n// \n//\n// Created by YuAo on 2020/3/16.\n//\n\nimport Foundation\nimport ArgumentParser\n\nextension URL: ExpressibleByArgument {\n public init?(argument: String) {\n if let url = URL(string: argument), url.scheme != nil {\n self.init(string: argument)\n } else {\n //Assuming it is a file url.\n self.init(fileURLWithPath: argument)\n }\n }\n}\n\nstruct GenerateMetalDataTypeTableMarkdown: ParsableCommand {\n static let configuration: CommandConfiguration = CommandConfiguration(commandName: \"gen-markdown\")\n \n @Option var columns: Int = 1\n \n func run() throws {\n let rows = (MetalDataType.allTypes.count + columns - 1) / columns\n var table: String = \"\"\n for _ in 0.. = [\"struct\", \"enum\", \"class\"]\n let code = \"\"\"\n //\n // MetalDataType.swift\n // Generated on \\(Date())\n //\n \n public enum MetalDataType: UInt8, Hashable, CaseIterable {\n \\(MetalDataType.allTypes.map({ type in\n if keywords.contains(type.camelCaseDescription) {\n return \" case `\\(type.camelCaseDescription)` = \\(type.hexID)\"\n } else {\n return \" case \\(type.camelCaseDescription) = \\(type.hexID)\"\n }\n }).joined(separator: \"\\n\"))\n }\n \n \"\"\"\n print(code)\n }\n}\n\n@main\nstruct MetalDataTypeTools: ParsableCommand {\n static let configuration: CommandConfiguration = CommandConfiguration(subcommands: [GenerateMetalDataTypeDefinition.self, GenerateMetalDataTypeTableMarkdown.self])\n}\n" }, { "path": "Utilities/Sources/MetalDataTypeTools/MetalDataTypes.swift", "content": "//\n// File.swift\n// \n//\n// Created by YuAo on 2022/4/10.\n//\n\nimport Foundation\nimport Metal\n\n// https://github.com/nst/iOS-Runtime-Headers/blob/fbb634c78269b0169efdead80955ba64eaaa2f21/Frameworks/Metal.framework/MTLTypeInternal.h\n@objc private protocol MTLTypeInternalProtocol: NSObjectProtocol {\n init(dataType: UInt64)\n var dataType: UInt64 { get }\n}\n\nstruct MetalDataType {\n var id: UInt8\n var description: String\n}\n\nextension MetalDataType {\n static let allTypes: [MetalDataType] = (UInt8.min...UInt8.max).compactMap({ id in\n struct Static {\n static let MTLTypeInternal: MTLTypeInternalProtocol.Type = {\n let type: AnyClass = NSClassFromString(\"MTLTypeInternal\")!\n class_addProtocol(type, MTLTypeInternalProtocol.self)\n return type as! MTLTypeInternalProtocol.Type\n }()\n }\n \n let type = Static.MTLTypeInternal.init(dataType: UInt64(id))\n if !type.description.isEmpty && type.description != \"Unknown\" {\n let prefix = \"MTLDataType\"\n precondition(type.description.hasPrefix(prefix))\n let description = String(type.description.dropFirst(prefix.count))\n return MetalDataType(id: id, description: description)\n } else {\n return nil\n }\n })\n}\n\nextension MetalDataType {\n var hexID: String {\n if id < 16 {\n return \"0x0\\(String(id, radix: 16, uppercase: true))\"\n } else {\n return \"0x\\(String(id, radix: 16, uppercase: true))\"\n }\n }\n \n var camelCaseDescription: String {\n let prefix = description.prefix(while: { $0.isUppercase })\n return prefix.lowercased() + description.dropFirst(prefix.count)\n }\n}\n" } ]