peachsim 0.1.1625 → 0.1.1640

package/src/swift-objc-compile.ts

@@ -0,0 +1,355 @@
+import { spawnSync } from 'node:child_process'
+import { createHash } from 'node:crypto'
+import fs from 'node:fs'
+import path from 'node:path'
+import { cacheDir } from './home-paths'
+import { swiftSdkPaths, swiftModuleSdk } from './swift-compile'
+import { swiftModuleToolchain } from './swift-distribution'
+import { IOS_SDK_ID, materializeObjcSdk } from './swift-objc-standin'
+import { swiftTargetModuleName } from './swift-package'
+import { swiftPackageManifest, swiftTargetFiles } from './swift-package-manifest'
+import { remoteSwiftCheckouts, type SwiftPackageBinary } from './swift-packages'
+import { readPackageFile } from './swift-source-file'
+import { swiftEnvironment } from './swift-toolchain'
+import type { XcodeAppTarget } from './xcode-project'
+
+/** compile original implementations before any header-derived replacement can hide them.
+ * successful objects still require the canonical framework bridge before linking. */
+export function compileXcodeObjCImplementations(
+  app: XcodeAppTarget,
+  binaries: readonly SwiftPackageBinary[],
+  moduleRoot: string,
+): never {
+  const toolchain = swiftModuleToolchain(moduleRoot)
+  const sdk = swiftSdkPaths(moduleRoot, toolchain.toolchainBin)
+  const sources = new Map<string, Buffer>()
+  const links: Record<string, string> = {}
+  const checkouts = remoteSwiftCheckouts(app.rootDir)
+  const add = (file: string, header = false) => {
+    const resolved = header ? fs.realpathSync(file) : file
+    if (resolved !== file) links[file] = resolved
+    if (!sources.has(file))
+      sources.set(
+        file,
+        readPackageFile(
+          file.startsWith(`${checkouts}${path.sep}`) ? checkouts : app.rootDir,
+          resolved,
+          Infinity,
+        ),
+      )
+  }
+  const addHeaders = (directory: string): void => {
+    for (const entry of fs.readdirSync(directory, { withFileTypes: true })) {
+      const file = path.join(directory, entry.name)
+      if (entry.isDirectory()) addHeaders(file)
+      else if (/\.(h|hh|hpp|hxx|inc|inl|modulemap)$/.test(entry.name)) add(file, true)
+    }
+  }
+  const targets: {
+    name: string
+    deploymentTarget: string | null
+    files: string[]
+    includes: string[]
+    frameworks: string[]
+    flags: string[]
+    cxxFlags: string[]
+    prefix: string | null
+    fileFlags: Record<string, string[]>
+    publicHeaders?: string
+  }[] = []
+  const configuration = app.configuration === 'Debug' ? 'debug' : 'release'
+  for (const binary of binaries) {
+    if (!binary.reached || binary.publicHeaders === undefined) continue
+    const manifest = swiftPackageManifest(binary.dir)
+    const target = manifest.targets.get(binary.target)
+    if (!target)
+      throw new Error(`missing original implementation target ${binary.target}`)
+    const files = swiftTargetFiles(manifest, target)
+    for (const file of files) add(file)
+    addHeaders(path.join(target.dir, target.publicHeadersPath))
+    for (const dependency of binary.headerDependencies ?? [])
+      addHeaders(path.resolve(binary.dir, dependency.path))
+    const settings = target.nativeSettings.filter(
+      (setting) =>
+        setting.configuration === null || setting.configuration === configuration,
+    )
+    targets.push({
+      name: target.name,
+      deploymentTarget: app.iosDeploymentTarget,
+      files: files.filter((file) => /\.(c|cc|cpp|cxx|m|mm)$/.test(file)),
+      includes: [
+        path.join(target.dir, target.publicHeadersPath),
+        ...(binary.headerDependencies ?? []).map((dependency) =>
+          path.resolve(binary.dir, dependency.path),
+        ),
+      ],
+      frameworks: [],
+      // retain the source iOS package's ARC and module semantics on the wasm ABI.
+      flags: [
+        '-fobjc-arc',
+        '-fmodules',
+        '-DSWIFT_PACKAGE',
+        ...(configuration === 'debug' ? ['-DDEBUG'] : []),
+        ...settings
+          .filter((setting) => setting.tool === 'c')
+          .flatMap((setting) => setting.flags),
+      ],
+      cxxFlags: settings
+        .filter((setting) => setting.tool === 'cxx')
+        .flatMap((setting) => setting.flags),
+      prefix: null,
+      fileFlags: {},
+      publicHeaders: path.join(target.dir, target.publicHeadersPath),
+    })
+  }
+  for (const target of [...app.frameworks, app]) {
+    if (!target.objc) continue
+    const files = target.allSources.filter((file) => /\.(c|cc|cpp|cxx|m|mm)$/.test(file))
+    for (const file of files) add(file)
+    for (const file of [
+      ...target.objc.headers,
+      ...[target.objc.prefixHeader, target.objc.bridgingHeader].filter(
+        (file): file is string => file !== null,
+      ),
+    ])
+      add(file, true)
+    targets.push({
+      name: target.moduleName,
+      deploymentTarget: target.iosDeploymentTarget,
+      files,
+      includes: target.objc.headerSearchPaths,
+      frameworks: target.objc.frameworkSearchPaths,
+      flags: target.objc.flags,
+      cxxFlags: target.objc.cxxFlags,
+      prefix: target.objc.prefixHeader,
+      fileFlags: target.objc.fileFlags,
+    })
+  }
+  const digest = (bytes: Buffer | string) =>
+    createHash('sha256').update(bytes).digest('hex')
+  const inputs = Object.fromEntries(
+    [...sources].map(([file, bytes]) => [file, digest(bytes)]),
+  )
+  const identity = {
+    version: 1,
+    release: toolchain.release,
+    compiler: digest(fs.readFileSync(path.join(toolchain.toolchainBin, 'clang'))),
+    sdk: swiftModuleSdk(moduleRoot),
+    declarations: IOS_SDK_ID,
+    targets,
+    inputs,
+    links,
+  }
+  const parent = path.join(cacheDir(), 'swift-objc-implementations')
+  fs.mkdirSync(parent, { recursive: true })
+  const key = digest(JSON.stringify(identity))
+  const work = path.join(parent, key)
+  const resultFile = path.join(work, 'result.json')
+  const record = (value: unknown): value is Record<string, unknown> =>
+    value !== null && typeof value === 'object' && !Array.isArray(value)
+  if (fs.existsSync(work)) {
+    let message: string
+    try {
+      const result: unknown = JSON.parse(
+        readPackageFile(work, resultFile, Infinity).toString(),
+      )
+      if (
+        !record(result) ||
+        result.key !== key ||
+        typeof result.message !== 'string' ||
+        !result.message ||
+        !record(result.files) ||
+        Object.keys(result.files).length < sources.size + 1 ||
+        !('receipt.json' in result.files)
+      )
+        throw new Error('invalid completed receipt')
+      for (const [file, hash] of Object.entries(result.files)) {
+        if (
+          typeof hash !== 'string' ||
+          digest(readPackageFile(work, path.resolve(work, file), Infinity)) !== hash
+        )
+          throw new Error(`retained file changed: ${file}`)
+      }
+      message = result.message
+    } catch (cause) {
+      throw new Error(
+        `Objective-C implementation preparation has an incomplete or damaged receipt at ${work}`,
+        { cause },
+      )
+    }
+    throw new Error(message)
+  }
+  // exclusive creation prevents another caller from writing the same objects.
+  fs.mkdirSync(work)
+  const staged = (file: string): string => {
+    for (const { root, name } of [
+      { root: checkouts, name: 'packages' },
+      { root: app.rootDir, name: 'project' },
+    ]) {
+      const relative = path.relative(root, file)
+      if (
+        relative !== '..' &&
+        !relative.startsWith(`..${path.sep}`) &&
+        !path.isAbsolute(relative)
+      )
+        return path.join(work, name, relative)
+    }
+    // native SDK include paths select the wasm SDK, never host system headers.
+    if (file.startsWith('/usr/include/'))
+      return path.join(sdk.sysroot, 'include', file.slice('/usr/include/'.length))
+    throw new Error(
+      `Objective-C compiler input is outside the project and its pinned packages: ${file}`,
+    )
+  }
+  for (const [file, bytes] of sources) {
+    const output = staged(file)
+    fs.mkdirSync(path.dirname(output), { recursive: true })
+    fs.writeFileSync(output, bytes)
+  }
+  const headers = materializeObjcSdk(path.join(cacheDir(), 'swift-standins'))
+  const modulemaps = targets.flatMap((target, index) => {
+    if (!target.publicHeaders) return []
+    const custom = path.join(target.publicHeaders, 'module.modulemap')
+    if (sources.has(custom)) return [`-fmodule-map-file=${staged(custom)}`]
+    const output = path.join(work, `module-${index}.modulemap`)
+    fs.writeFileSync(
+      output,
+      `module ${swiftTargetModuleName(target.name)} {\n  umbrella ${JSON.stringify(staged(target.publicHeaders))}\n  export *\n}\n`,
+    )
+    return [`-fmodule-map-file=${output}`]
+  })
+  const commands: {
+    target: string
+    source: string
+    args: string[]
+    status: number | null
+    signal: string | null
+    object?: string
+  }[] = []
+  const receipt = path.join(work, 'receipt.json')
+  const save = (status: string) =>
+    fs.writeFileSync(
+      receipt,
+      JSON.stringify({ ...identity, work, status, commands }, null, 2),
+    )
+  const finish = (status: string, message: string): never => {
+    save(status)
+    const files = [
+      ...[...sources.keys()].map(staged),
+      ...modulemaps.map((flag) => flag.slice('-fmodule-map-file='.length)),
+      receipt,
+      ...commands.flatMap((command) => {
+        const output = command.args[command.args.lastIndexOf('-o') + 1]!
+        return [output.replace(/\.o$/, '.log'), ...(command.object ? [output] : [])]
+      }),
+    ]
+    const result = {
+      key,
+      message,
+      files: Object.fromEntries(
+        files.map((file) => [path.relative(work, file), digest(fs.readFileSync(file))]),
+      ),
+    }
+    fs.writeFileSync(`${resultFile}.pending`, JSON.stringify(result, null, 2))
+    fs.renameSync(`${resultFile}.pending`, resultFile)
+    throw new Error(message)
+  }
+  save('compiling')
+  for (const [index, target] of targets.entries()) {
+    const version = /^(\d{1,2})(?:\.(\d{1,2}))?(?:\.(\d{1,2}))?$/.exec(
+      target.deploymentTarget ?? '',
+    )
+    if (!version) {
+      return finish(
+        'unsupported-deployment-target',
+        `${target.name}: Objective-C compilation requires an explicit numeric IPHONEOS_DEPLOYMENT_TARGET; received ${JSON.stringify(target.deploymentTarget)}. Inputs: ${receipt}`,
+      )
+    }
+    const minimum =
+      Number(version[1]) * 10_000 +
+      Number(version[2] ?? 0) * 100 +
+      Number(version[3] ?? 0)
+    for (const [unit, file] of target.files.entries()) {
+      const output = path.join(work, `${index}-${unit}.o`)
+      const cxx = /\.(mm|cc|cpp|cxx)$/.test(file)
+      const objc = /\.mm?$/.test(file)
+      const flags = [
+        ...target.flags.filter(
+          (flag) =>
+            (!cxx || !flag.startsWith('-std=')) && (objc || flag !== '-fobjc-arc'),
+        ),
+        ...(cxx ? target.cxxFlags : []),
+        ...(target.fileFlags[file] ?? []),
+      ].map((flag, index, flags) => {
+        if (
+          ['-I', '-F', '-iquote', '-isystem', '-include'].includes(flags[index - 1] ?? '')
+        )
+          return staged(flag)
+        const include = /^(-I|-F)(\/.*)$/.exec(flag)
+        return include ? `${include[1]}${staged(include[2]!)}` : flag
+      })
+      const args = [
+        '--target=wasm32-unknown-wasip1',
+        `--sysroot=${sdk.sysroot}`,
+        '-fwasm-exceptions',
+        '-fexceptions',
+        '-D_WASI_EMULATED_SIGNAL',
+        '-D_WASI_EMULATED_MMAN',
+        `-D__ENVIRONMENT_IPHONE_OS_VERSION_MIN_REQUIRED__=${minimum}`,
+        `-D__IPHONE_OS_VERSION_MIN_REQUIRED=${minimum}`,
+        ...(objc ? ['-fobjc-runtime=gnustep-2.2', '-fobjc-exceptions', '-fblocks'] : []),
+        '-F',
+        path.join(headers, 'System/Library/Frameworks'),
+        // installed libc and objc runtime headers own the target ABI.
+        '-idirafter',
+        path.join(headers, 'usr/include'),
+        ...target.includes.flatMap((include) => ['-I', staged(include)]),
+        ...target.frameworks.flatMap((framework) => ['-F', staged(framework)]),
+        ...modulemaps,
+        `-fmodule-name=${swiftTargetModuleName(target.name)}`,
+        `-fmodules-cache-path=${path.join(work, 'module-cache')}`,
+        ...flags,
+        ...(target.prefix ? ['-include', staged(target.prefix)] : []),
+        '-Os',
+        '-c',
+        staged(file),
+        '-o',
+        output,
+      ]
+      const result = spawnSync(
+        path.join(toolchain.toolchainBin, cxx ? 'clang++' : 'clang'),
+        args,
+        {
+          cwd: work,
+          encoding: 'utf8',
+          env: swiftEnvironment(),
+          timeout: 120_000,
+          maxBuffer: 16 * 1024 * 1024,
+        },
+      )
+      fs.writeFileSync(
+        path.join(work, `${index}-${unit}.log`),
+        `${result.stdout ?? ''}${result.stderr ?? ''}${result.error?.message ?? ''}`,
+      )
+      commands.push({
+        target: target.name,
+        source: file,
+        args,
+        status: result.status,
+        signal: result.signal,
+        ...(result.status === 0 ? { object: digest(fs.readFileSync(output)) } : {}),
+      })
+      if (result.error || result.status !== 0) {
+        return finish(
+          'compile-failed',
+          `Objective-C implementation compile failed in ${target.name}: ${file}\n${result.stderr || result.stdout || result.error?.message}\nOriginal inputs, compiler command and diagnostics: ${receipt}`,
+        )
+      }
+      save('compiling')
+    }
+  }
+  return finish(
+    'requires-framework-bridge',
+    `Objective-C implementations compiled, but linking their original method bodies requires the canonical Swift framework object bridge. No implementation was replaced. Inputs and objects: ${receipt}`,
+  )
+}