From 1bd07cb0fe493e0f398e568cf3602fec85aa3144 Mon Sep 17 00:00:00 2001 From: CxAI Ops Date: Sat, 16 May 2026 10:52:04 -0500 Subject: [PATCH] chore: initial commit (Phase 3 scaffold) --- .editorconfig | 15 + .gitea/workflows/ci.yml | 36 ++ .github/workflows/ci.yml | 27 ++ .gitignore | 54 +++ CHANGELOG.md | 16 + CODEOWNERS | 6 + CONTRIBUTING.md | 23 ++ CxLLM-LB-SDK.xcodeproj/project.pbxproj | 343 ++++++++++++++++++ .../contents.xcworkspacedata | 7 + CxLLM-LB-SDK/CxLLM_LB_SDK.cpp | 22 ++ CxLLM-LB-SDK/CxLLM_LB_SDK.iig | 21 ++ CxLLM-LB-SDK/Info.plist | 28 ++ LICENSE | 21 ++ Makefile | 43 +++ README.md | 53 +++ SECURITY.md | 19 + docs/ARCHITECTURE.md | 24 ++ .../adr/0001-record-architecture-decisions.md | 13 + 18 files changed, 771 insertions(+) create mode 100644 .editorconfig create mode 100644 .gitea/workflows/ci.yml create mode 100644 .github/workflows/ci.yml create mode 100644 .gitignore create mode 100644 CHANGELOG.md create mode 100644 CODEOWNERS create mode 100644 CONTRIBUTING.md create mode 100644 CxLLM-LB-SDK.xcodeproj/project.pbxproj create mode 100644 CxLLM-LB-SDK.xcodeproj/project.xcworkspace/contents.xcworkspacedata create mode 100644 CxLLM-LB-SDK/CxLLM_LB_SDK.cpp create mode 100644 CxLLM-LB-SDK/CxLLM_LB_SDK.iig create mode 100644 CxLLM-LB-SDK/Info.plist create mode 100644 LICENSE create mode 100644 Makefile create mode 100644 README.md create mode 100644 SECURITY.md create mode 100644 docs/ARCHITECTURE.md create mode 100644 docs/adr/0001-record-architecture-decisions.md diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..5ef197b --- /dev/null +++ b/.editorconfig @@ -0,0 +1,15 @@ +root = true + +[*] +charset = utf-8 +end_of_line = lf +insert_final_newline = true +trim_trailing_whitespace = true +indent_style = space +indent_size = 4 + +[*.{yml,yaml,json,md}] +indent_size = 2 + +[Makefile] +indent_style = tab diff --git a/.gitea/workflows/ci.yml b/.gitea/workflows/ci.yml new file mode 100644 index 0000000..2a804da --- /dev/null +++ b/.gitea/workflows/ci.yml @@ -0,0 +1,36 @@ +name: ci +on: + push: + branches: [main, master] + pull_request: {} + workflow_dispatch: {} + +# We run a Linux runner; macOS xcodebuild is not available here. +# This workflow validates structure (yaml, file presence) and basic Swift. +jobs: + validate: + runs-on: cxai-hostinger + container: debian:bookworm + steps: + - name: Install deps + run: | + apt-get update -qq + apt-get install -y --no-install-recommends git ca-certificates curl python3-yaml >/dev/null + - uses: actions/checkout@v4 + - name: Lint workflow YAML + run: | + python3 - <<'PY' + import sys, yaml, glob + for f in glob.glob('.gitea/workflows/*.yml') + glob.glob('.github/workflows/*.yml'): + try: + yaml.safe_load(open(f)) + except Exception as e: + print(f'YAML ERROR {f}: {e}'); sys.exit(1) + print('workflows ok') + PY + - name: Project sanity + run: | + test -f README.md || (echo "missing README" && exit 1) + test -f Makefile || (echo "missing Makefile" && exit 1) + ls *.xcodeproj >/dev/null 2>&1 && echo "xcodeproj: $(ls -d *.xcodeproj)" || true + [ -f Package.swift ] && echo "Package.swift present" || true diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..39d201f --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,27 @@ +name: ci +on: + push: + branches: [main] + pull_request: + branches: [main] + +jobs: + build: + name: build (${{ matrix.os }}) + runs-on: ${{ matrix.os }} + strategy: + fail-fast: false + matrix: + os: [macos-14] + steps: + - uses: actions/checkout@v4 + - name: Show toolchain + run: | + xcodebuild -version || true + swift --version || true + - name: Build + run: make build + - name: Test + run: make test + - name: Lint + run: make lint diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..f4ca831 --- /dev/null +++ b/.gitignore @@ -0,0 +1,54 @@ +# macOS +.DS_Store +.AppleDouble +.LSOverride +Icon? + +# Xcode +build/ +DerivedData/ +*.xcworkspace/xcuserdata/ +*.xcodeproj/xcuserdata/ +*.xcodeproj/project.xcworkspace/xcuserdata/ +*.xcuserstate +*.moved-aside +*.pbxuser +!default.pbxuser +*.mode1v3 +!default.mode1v3 +*.mode2v3 +!default.mode2v3 +*.perspectivev3 +!default.perspectivev3 + +# SwiftPM +.build/ +.swiftpm/xcode/ +.swiftpm/configuration/ +Package.resolved + +# CocoaPods / Carthage +Pods/ +Carthage/Build/ + +# fastlane +fastlane/report.xml +fastlane/Preview.html +fastlane/screenshots/**/*.png +fastlane/test_output/ + +# Coverage +*.gcno +*.gcda +*.profdata +*.profraw +coverage/ + +# Editors +.vscode/ +.idea/ +*.swp + +# Local +*.local +secrets.env diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..fe58153 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,16 @@ +# Changelog + +All notable changes to this project will be documented here. +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) +and this project adheres to [Semantic Versioning](https://semver.org/). + +## [Unreleased] + +### Added +- Repository scaffolding: README, LICENSE (MIT), .gitignore, Makefile, + CONTRIBUTING, SECURITY, CODEOWNERS, .editorconfig, CI workflow. + +## [0.1.0] - 2026-04-22 + +### Added +- Initial driverkit-sdk scaffold for CxLLM-LB-SDK. diff --git a/CODEOWNERS b/CODEOWNERS new file mode 100644 index 0000000..7e6dfca --- /dev/null +++ b/CODEOWNERS @@ -0,0 +1,6 @@ +# Default owners for everything in this repo. +* @CxAI-LLM/maintainers + +# Build & CI +/.github/ @CxAI-LLM/devops +/Makefile @CxAI-LLM/devops diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..3f8226f --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,23 @@ +# Contributing to CxLLM-LB-SDK + +Thanks for taking the time to contribute! + +## Workflow + +1. Open an issue describing the change before sending a PR for non-trivial work. +2. Fork / branch off `main`. Use a descriptive branch name (`feat/...`, `fix/...`). +3. Keep commits scoped and use **Conventional Commits** (`feat:`, `fix:`, + `docs:`, `refactor:`, `test:`, `chore:`). +4. Run `make lint` and `make test` before pushing. +5. Open a PR — CI must pass before review. + +## Coding style + +- Swift: `swiftformat` defaults + `swiftlint` rules from the umbrella repo. +- Objective-C / C / C++: clang-format `-style=Google`. +- No tabs in Swift; 4-space indent in C/C++. + +## Code of conduct + +By contributing you agree to abide by the project's Code of Conduct +(see the umbrella `cxllm-code` repo). diff --git a/CxLLM-LB-SDK.xcodeproj/project.pbxproj b/CxLLM-LB-SDK.xcodeproj/project.pbxproj new file mode 100644 index 0000000..4c4f98a --- /dev/null +++ b/CxLLM-LB-SDK.xcodeproj/project.pbxproj @@ -0,0 +1,343 @@ +// !$*UTF8*$! +{ + archiveVersion = 1; + classes = { + }; + objectVersion = 77; + objects = { + +/* Begin PBXBuildFile section */ + 20F2B05C2F9972CA00E7D2D9 /* DriverKit.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 20F2B05B2F9972CA00E7D2D9 /* DriverKit.framework */; }; +/* End PBXBuildFile section */ + +/* Begin PBXFileReference section */ + 20F2B0582F9972CA00E7D2D9 /* cxai-studio.CxLLM-LB-SDK.dext */ = {isa = PBXFileReference; explicitFileType = "wrapper.driver-extension"; includeInIndex = 0; path = "cxai-studio.CxLLM-LB-SDK.dext"; sourceTree = BUILT_PRODUCTS_DIR; }; + 20F2B05B2F9972CA00E7D2D9 /* DriverKit.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = DriverKit.framework; path = Library/Frameworks/DriverKit.framework; sourceTree = DEVELOPER_DIR; }; +/* End PBXFileReference section */ + +/* Begin PBXFileSystemSynchronizedBuildFileExceptionSet section */ + 20F2B0632F9972CA00E7D2D9 /* Exceptions for "CxLLM-LB-SDK" folder in "CxLLM-LB-SDK" target */ = { + isa = PBXFileSystemSynchronizedBuildFileExceptionSet; + membershipExceptions = ( + Info.plist, + ); + target = 20F2B0572F9972CA00E7D2D9 /* CxLLM-LB-SDK */; + }; +/* End PBXFileSystemSynchronizedBuildFileExceptionSet section */ + +/* Begin PBXFileSystemSynchronizedRootGroup section */ + 20F2B05D2F9972CA00E7D2D9 /* CxLLM-LB-SDK */ = { + isa = PBXFileSystemSynchronizedRootGroup; + exceptions = ( + 20F2B0632F9972CA00E7D2D9 /* Exceptions for "CxLLM-LB-SDK" folder in "CxLLM-LB-SDK" target */, + ); + path = "CxLLM-LB-SDK"; + sourceTree = ""; + }; +/* End PBXFileSystemSynchronizedRootGroup section */ + +/* Begin PBXFrameworksBuildPhase section */ + 20F2B0552F9972CA00E7D2D9 /* Frameworks */ = { + isa = PBXFrameworksBuildPhase; + buildActionMask = 2147483647; + files = ( + 20F2B05C2F9972CA00E7D2D9 /* DriverKit.framework in Frameworks */, + ); + runOnlyForDeploymentPostprocessing = 0; + }; +/* End PBXFrameworksBuildPhase section */ + +/* Begin PBXGroup section */ + 20F2B04E2F9972CA00E7D2D9 = { + isa = PBXGroup; + children = ( + 20F2B05D2F9972CA00E7D2D9 /* CxLLM-LB-SDK */, + 20F2B05A2F9972CA00E7D2D9 /* Frameworks */, + 20F2B0592F9972CA00E7D2D9 /* Products */, + ); + sourceTree = ""; + }; + 20F2B0592F9972CA00E7D2D9 /* Products */ = { + isa = PBXGroup; + children = ( + 20F2B0582F9972CA00E7D2D9 /* cxai-studio.CxLLM-LB-SDK.dext */, + ); + name = Products; + sourceTree = ""; + }; + 20F2B05A2F9972CA00E7D2D9 /* Frameworks */ = { + isa = PBXGroup; + children = ( + 20F2B05B2F9972CA00E7D2D9 /* DriverKit.framework */, + ); + name = Frameworks; + sourceTree = ""; + }; +/* End PBXGroup section */ + +/* Begin PBXHeadersBuildPhase section */ + 20F2B0532F9972CA00E7D2D9 /* Headers */ = { + isa = PBXHeadersBuildPhase; + buildActionMask = 2147483647; + files = ( + ); + runOnlyForDeploymentPostprocessing = 0; + }; +/* End PBXHeadersBuildPhase section */ + +/* Begin PBXNativeTarget section */ + 20F2B0572F9972CA00E7D2D9 /* CxLLM-LB-SDK */ = { + isa = PBXNativeTarget; + buildConfigurationList = 20F2B0642F9972CA00E7D2D9 /* Build configuration list for PBXNativeTarget "CxLLM-LB-SDK" */; + buildPhases = ( + 20F2B0532F9972CA00E7D2D9 /* Headers */, + 20F2B0542F9972CA00E7D2D9 /* Sources */, + 20F2B0552F9972CA00E7D2D9 /* Frameworks */, + 20F2B0562F9972CA00E7D2D9 /* Resources */, + ); + buildRules = ( + ); + dependencies = ( + ); + fileSystemSynchronizedGroups = ( + 20F2B05D2F9972CA00E7D2D9 /* CxLLM-LB-SDK */, + ); + name = "CxLLM-LB-SDK"; + packageProductDependencies = ( + ); + productName = "CxLLM-LB-SDK"; + productReference = 20F2B0582F9972CA00E7D2D9 /* cxai-studio.CxLLM-LB-SDK.dext */; + productType = "com.apple.product-type.driver-extension"; + }; +/* End PBXNativeTarget section */ + +/* Begin PBXProject section */ + 20F2B04F2F9972CA00E7D2D9 /* Project object */ = { + isa = PBXProject; + attributes = { + BuildIndependentTargetsInParallel = 1; + LastUpgradeCheck = 2630; + TargetAttributes = { + 20F2B0572F9972CA00E7D2D9 = { + CreatedOnToolsVersion = 26.3; + }; + }; + }; + buildConfigurationList = 20F2B0522F9972CA00E7D2D9 /* Build configuration list for PBXProject "CxLLM-LB-SDK" */; + developmentRegion = en; + hasScannedForEncodings = 0; + knownRegions = ( + en, + Base, + ); + mainGroup = 20F2B04E2F9972CA00E7D2D9; + minimizedProjectReferenceProxies = 1; + preferredProjectObjectVersion = 77; + productRefGroup = 20F2B0592F9972CA00E7D2D9 /* Products */; + projectDirPath = ""; + projectRoot = ""; + targets = ( + 20F2B0572F9972CA00E7D2D9 /* CxLLM-LB-SDK */, + ); + }; +/* End PBXProject section */ + +/* Begin PBXResourcesBuildPhase section */ + 20F2B0562F9972CA00E7D2D9 /* Resources */ = { + isa = PBXResourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + ); + runOnlyForDeploymentPostprocessing = 0; + }; +/* End PBXResourcesBuildPhase section */ + +/* Begin PBXSourcesBuildPhase section */ + 20F2B0542F9972CA00E7D2D9 /* Sources */ = { + isa = PBXSourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + ); + runOnlyForDeploymentPostprocessing = 0; + }; +/* End PBXSourcesBuildPhase section */ + +/* Begin XCBuildConfiguration section */ + 20F2B0652F9972CA00E7D2D9 /* Debug */ = { + isa = XCBuildConfiguration; + buildSettings = { + CODE_SIGN_STYLE = Automatic; + CURRENT_PROJECT_VERSION = 1; + DEVELOPMENT_TEAM = DKWVC9FQJY; + GENERATE_INFOPLIST_FILE = YES; + INFOPLIST_FILE = "CxLLM-LB-SDK/Info.plist"; + MARKETING_VERSION = 1.0; + PRODUCT_BUNDLE_IDENTIFIER = "cxai-studio.CxLLM-LB-SDK"; + PRODUCT_NAME = "$(inherited)"; + RUN_CLANG_STATIC_ANALYZER = YES; + SKIP_INSTALL = YES; + STRING_CATALOG_GENERATE_SYMBOLS = YES; + SWIFT_EMIT_LOC_STRINGS = YES; + }; + name = Debug; + }; + 20F2B0662F9972CA00E7D2D9 /* Release */ = { + isa = XCBuildConfiguration; + buildSettings = { + CODE_SIGN_STYLE = Automatic; + CURRENT_PROJECT_VERSION = 1; + DEVELOPMENT_TEAM = DKWVC9FQJY; + GENERATE_INFOPLIST_FILE = YES; + INFOPLIST_FILE = "CxLLM-LB-SDK/Info.plist"; + MARKETING_VERSION = 1.0; + PRODUCT_BUNDLE_IDENTIFIER = "cxai-studio.CxLLM-LB-SDK"; + PRODUCT_NAME = "$(inherited)"; + RUN_CLANG_STATIC_ANALYZER = YES; + SKIP_INSTALL = YES; + STRING_CATALOG_GENERATE_SYMBOLS = YES; + SWIFT_EMIT_LOC_STRINGS = YES; + }; + name = Release; + }; + 20F2B0672F9972CA00E7D2D9 /* Debug */ = { + isa = XCBuildConfiguration; + buildSettings = { + ALWAYS_SEARCH_USER_PATHS = NO; + ASSETCATALOG_COMPILER_GENERATE_SWIFT_ASSET_SYMBOL_EXTENSIONS = YES; + CLANG_ANALYZER_NONNULL = YES; + CLANG_ANALYZER_NUMBER_OBJECT_CONVERSION = YES_AGGRESSIVE; + CLANG_CXX_LANGUAGE_STANDARD = "gnu++20"; + CLANG_ENABLE_MODULES = YES; + CLANG_ENABLE_OBJC_ARC = YES; + CLANG_ENABLE_OBJC_WEAK = YES; + CLANG_WARN_BLOCK_CAPTURE_AUTORELEASING = YES; + CLANG_WARN_BOOL_CONVERSION = YES; + CLANG_WARN_COMMA = YES; + CLANG_WARN_CONSTANT_CONVERSION = YES; + CLANG_WARN_DEPRECATED_OBJC_IMPLEMENTATIONS = YES; + CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR; + CLANG_WARN_DOCUMENTATION_COMMENTS = YES; + CLANG_WARN_EMPTY_BODY = YES; + CLANG_WARN_ENUM_CONVERSION = YES; + CLANG_WARN_INFINITE_RECURSION = YES; + CLANG_WARN_INT_CONVERSION = YES; + CLANG_WARN_NON_LITERAL_NULL_CONVERSION = YES; + CLANG_WARN_OBJC_IMPLICIT_RETAIN_SELF = YES; + CLANG_WARN_OBJC_LITERAL_CONVERSION = YES; + CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR; + CLANG_WARN_QUOTED_INCLUDE_IN_FRAMEWORK_HEADER = YES; + CLANG_WARN_RANGE_LOOP_ANALYSIS = YES; + CLANG_WARN_STRICT_PROTOTYPES = YES; + CLANG_WARN_SUSPICIOUS_MOVE = YES; + CLANG_WARN_UNGUARDED_AVAILABILITY = YES_AGGRESSIVE; + CLANG_WARN_UNREACHABLE_CODE = YES; + CLANG_WARN__DUPLICATE_METHOD_MATCH = YES; + COPY_PHASE_STRIP = NO; + DEBUG_INFORMATION_FORMAT = dwarf; + DEVELOPMENT_TEAM = DKWVC9FQJY; + DRIVERKIT_DEPLOYMENT_TARGET = 25.2; + ENABLE_STRICT_OBJC_MSGSEND = YES; + ENABLE_TESTABILITY = YES; + ENABLE_USER_SCRIPT_SANDBOXING = YES; + GCC_C_LANGUAGE_STANDARD = gnu17; + GCC_DYNAMIC_NO_PIC = NO; + GCC_NO_COMMON_BLOCKS = YES; + GCC_OPTIMIZATION_LEVEL = 0; + GCC_PREPROCESSOR_DEFINITIONS = ( + "DEBUG=1", + "$(inherited)", + ); + GCC_WARN_64_TO_32_BIT_CONVERSION = YES; + GCC_WARN_ABOUT_RETURN_TYPE = YES_ERROR; + GCC_WARN_UNDECLARED_SELECTOR = YES; + GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE; + GCC_WARN_UNUSED_FUNCTION = YES; + GCC_WARN_UNUSED_VARIABLE = YES; + LOCALIZATION_PREFERS_STRING_CATALOGS = YES; + MTL_ENABLE_DEBUG_INFO = INCLUDE_SOURCE; + MTL_FAST_MATH = YES; + ONLY_ACTIVE_ARCH = YES; + SDKROOT = driverkit; + }; + name = Debug; + }; + 20F2B0682F9972CA00E7D2D9 /* Release */ = { + isa = XCBuildConfiguration; + buildSettings = { + ALWAYS_SEARCH_USER_PATHS = NO; + ASSETCATALOG_COMPILER_GENERATE_SWIFT_ASSET_SYMBOL_EXTENSIONS = YES; + CLANG_ANALYZER_NONNULL = YES; + CLANG_ANALYZER_NUMBER_OBJECT_CONVERSION = YES_AGGRESSIVE; + CLANG_CXX_LANGUAGE_STANDARD = "gnu++20"; + CLANG_ENABLE_MODULES = YES; + CLANG_ENABLE_OBJC_ARC = YES; + CLANG_ENABLE_OBJC_WEAK = YES; + CLANG_WARN_BLOCK_CAPTURE_AUTORELEASING = YES; + CLANG_WARN_BOOL_CONVERSION = YES; + CLANG_WARN_COMMA = YES; + CLANG_WARN_CONSTANT_CONVERSION = YES; + CLANG_WARN_DEPRECATED_OBJC_IMPLEMENTATIONS = YES; + CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR; + CLANG_WARN_DOCUMENTATION_COMMENTS = YES; + CLANG_WARN_EMPTY_BODY = YES; + CLANG_WARN_ENUM_CONVERSION = YES; + CLANG_WARN_INFINITE_RECURSION = YES; + CLANG_WARN_INT_CONVERSION = YES; + CLANG_WARN_NON_LITERAL_NULL_CONVERSION = YES; + CLANG_WARN_OBJC_IMPLICIT_RETAIN_SELF = YES; + CLANG_WARN_OBJC_LITERAL_CONVERSION = YES; + CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR; + CLANG_WARN_QUOTED_INCLUDE_IN_FRAMEWORK_HEADER = YES; + CLANG_WARN_RANGE_LOOP_ANALYSIS = YES; + CLANG_WARN_STRICT_PROTOTYPES = YES; + CLANG_WARN_SUSPICIOUS_MOVE = YES; + CLANG_WARN_UNGUARDED_AVAILABILITY = YES_AGGRESSIVE; + CLANG_WARN_UNREACHABLE_CODE = YES; + CLANG_WARN__DUPLICATE_METHOD_MATCH = YES; + COPY_PHASE_STRIP = NO; + DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym"; + DEVELOPMENT_TEAM = DKWVC9FQJY; + DRIVERKIT_DEPLOYMENT_TARGET = 25.2; + ENABLE_NS_ASSERTIONS = NO; + ENABLE_STRICT_OBJC_MSGSEND = YES; + ENABLE_USER_SCRIPT_SANDBOXING = YES; + GCC_C_LANGUAGE_STANDARD = gnu17; + GCC_NO_COMMON_BLOCKS = YES; + GCC_WARN_64_TO_32_BIT_CONVERSION = YES; + GCC_WARN_ABOUT_RETURN_TYPE = YES_ERROR; + GCC_WARN_UNDECLARED_SELECTOR = YES; + GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE; + GCC_WARN_UNUSED_FUNCTION = YES; + GCC_WARN_UNUSED_VARIABLE = YES; + LOCALIZATION_PREFERS_STRING_CATALOGS = YES; + MTL_ENABLE_DEBUG_INFO = NO; + MTL_FAST_MATH = YES; + SDKROOT = driverkit; + }; + name = Release; + }; +/* End XCBuildConfiguration section */ + +/* Begin XCConfigurationList section */ + 20F2B0522F9972CA00E7D2D9 /* Build configuration list for PBXProject "CxLLM-LB-SDK" */ = { + isa = XCConfigurationList; + buildConfigurations = ( + 20F2B0672F9972CA00E7D2D9 /* Debug */, + 20F2B0682F9972CA00E7D2D9 /* Release */, + ); + defaultConfigurationIsVisible = 0; + defaultConfigurationName = Release; + }; + 20F2B0642F9972CA00E7D2D9 /* Build configuration list for PBXNativeTarget "CxLLM-LB-SDK" */ = { + isa = XCConfigurationList; + buildConfigurations = ( + 20F2B0652F9972CA00E7D2D9 /* Debug */, + 20F2B0662F9972CA00E7D2D9 /* Release */, + ); + defaultConfigurationIsVisible = 0; + defaultConfigurationName = Release; + }; +/* End XCConfigurationList section */ + }; + rootObject = 20F2B04F2F9972CA00E7D2D9 /* Project object */; +} diff --git a/CxLLM-LB-SDK.xcodeproj/project.xcworkspace/contents.xcworkspacedata b/CxLLM-LB-SDK.xcodeproj/project.xcworkspace/contents.xcworkspacedata new file mode 100644 index 0000000..919434a --- /dev/null +++ b/CxLLM-LB-SDK.xcodeproj/project.xcworkspace/contents.xcworkspacedata @@ -0,0 +1,7 @@ + + + + + diff --git a/CxLLM-LB-SDK/CxLLM_LB_SDK.cpp b/CxLLM-LB-SDK/CxLLM_LB_SDK.cpp new file mode 100644 index 0000000..2ed1508 --- /dev/null +++ b/CxLLM-LB-SDK/CxLLM_LB_SDK.cpp @@ -0,0 +1,22 @@ +// +// CxLLM_LB_SDK.cpp +// CxLLM-LB-SDK +// +// Created by Stephen Carter on 4/22/26. +// + +#include + +#include +#include + +#include "CxLLM_LB_SDK.h" + +kern_return_t +IMPL(CxLLM_LB_SDK, Start) +{ + kern_return_t ret; + ret = Start(provider, SUPERDISPATCH); + os_log(OS_LOG_DEFAULT, "Hello World"); + return ret; +} diff --git a/CxLLM-LB-SDK/CxLLM_LB_SDK.iig b/CxLLM-LB-SDK/CxLLM_LB_SDK.iig new file mode 100644 index 0000000..1f37bb9 --- /dev/null +++ b/CxLLM-LB-SDK/CxLLM_LB_SDK.iig @@ -0,0 +1,21 @@ +// +// CxLLM_LB_SDK.iig +// CxLLM-LB-SDK +// +// Created by Stephen Carter on 4/22/26. +// + +#ifndef CxLLM_LB_SDK_h +#define CxLLM_LB_SDK_h + +#include +#include + +class CxLLM_LB_SDK: public IOService +{ +public: + virtual kern_return_t + Start(IOService * provider) override; +}; + +#endif /* CxLLM_LB_SDK_h */ diff --git a/CxLLM-LB-SDK/Info.plist b/CxLLM-LB-SDK/Info.plist new file mode 100644 index 0000000..208c2e9 --- /dev/null +++ b/CxLLM-LB-SDK/Info.plist @@ -0,0 +1,28 @@ + + + + + IOKitPersonalities + + CxLLM_LB_SDK + + CFBundleIdentifierKernel + com.apple.kpi.iokit + IOClass + IOUserService + IOMatchCategory + $(PRODUCT_BUNDLE_IDENTIFIER) + IOProviderClass + IOUserResources + IOResourceMatch + IOKit + IOUserClass + CxLLM_LB_SDK + IOUserServerName + $(PRODUCT_BUNDLE_IDENTIFIER) + + + OSBundleUsageDescription + + + diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..114f83a --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2026 CxAI-LLM + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..f3cee21 --- /dev/null +++ b/Makefile @@ -0,0 +1,43 @@ +# Makefile — common entry points for CxLLM-LB-SDK +SHELL := /bin/bash +.DEFAULT_GOAL := help + +PROJECT := CxLLM-LB-SDK +SCHEME ?= $(PROJECT) +CONFIG ?= Debug +DERIVED ?= build + +.PHONY: help build test lint clean fmt info + +help: ## show this help + @grep -E '^[a-zA-Z_-]+:.*## ' $(MAKEFILE_LIST) | awk -F':.*## ' '{printf " %-12s %s\n", $$1, $$2}' + +info: ## show project info + @echo "project : $(PROJECT)" + @echo "scheme : $(SCHEME)" + @echo "config : $(CONFIG)" + @echo "derived : $(DERIVED)" + +build: ## xcodebuild build (skip if no .xcodeproj) + @if ls *.xcodeproj 1>/dev/null 2>&1; then \ + xcodebuild -project "$(PROJECT).xcodeproj" -scheme "$(SCHEME)" -configuration "$(CONFIG)" -derivedDataPath "$(DERIVED)" build | xcbeautify || true ; \ + elif [ -f Package.swift ]; then \ + swift build -c $(shell echo "$(CONFIG)" | tr '[:upper:]' '[:lower:]') ; \ + else echo "no buildable target" ; fi + +test: ## xcodebuild test + @if ls *.xcodeproj 1>/dev/null 2>&1; then \ + xcodebuild -project "$(PROJECT).xcodeproj" -scheme "$(SCHEME)" -configuration "$(CONFIG)" -derivedDataPath "$(DERIVED)" test | xcbeautify || true ; \ + elif [ -f Package.swift ]; then \ + swift test ; \ + else echo "no testable target" ; fi + +lint: ## swiftlint + swiftformat (no-op if missing) + @command -v swiftlint >/dev/null && swiftlint --quiet || echo "swiftlint not installed" + @command -v swiftformat >/dev/null && swiftformat --lint . || echo "swiftformat not installed" + +fmt: ## swiftformat in-place + @command -v swiftformat >/dev/null && swiftformat . || echo "swiftformat not installed" + +clean: ## remove build artifacts + rm -rf "$(DERIVED)" .build DerivedData diff --git a/README.md b/README.md new file mode 100644 index 0000000..16640f1 --- /dev/null +++ b/README.md @@ -0,0 +1,53 @@ +# CxLLM-LB-SDK + +> CxLLM Local-Bus SDK + +DriverKit interface description (.iig) and C++ runtime that surfaces the CxLLM Local Bus to user-space clients. + +[![ci](https://git.cxllm-studio.com/CxAI-LLM/CxLLM-LB-SDK/actions/workflows/ci.yml/badge.svg)](https://git.cxllm-studio.com/CxAI-LLM/CxLLM-LB-SDK/actions) +[![license](https://img.shields.io/badge/license-MIT-7C3AED)](LICENSE) +[![category](https://img.shields.io/badge/category-driverkit-sdk-1F6FEB)](#) + +## Overview + +`CxLLM-LB-SDK` is part of the **CxLLM** product family — a layered runtime that +spans Apple kernel extensions, user-space frameworks, host applications, and +spatial / web surfaces. This module focuses on **driverkit-sdk** concerns and is +intentionally narrow so that the CxLLM monorepo can compose targets without +pulling in unrelated dependencies. + +## Repository layout + +- `CxLLM-LB-SDK/` — primary source folder (matches the Xcode group / SwiftPM root). +- `CxLLM-LB-SDK.xcodeproj` — Xcode project (where applicable). +- `Makefile` — common entry points (`build`, `test`, `lint`, `clean`). +- `.github/workflows/ci.yml` — CI pipeline (Xcode build + lint). +- `docs/` — architecture notes and ADRs. + +## Quick start + +```bash +# Build (defaults to Debug for the host platform): +make build + +# Run the full test suite (unit + UI where applicable): +make test + +# Static analysis + format check: +make lint +``` + +## Versioning + +This module follows [Semantic Versioning 2.0](https://semver.org/) and is +released in lock-step with the umbrella **CxLLM** product line. See +[`CHANGELOG.md`](CHANGELOG.md) for the user-facing change log. + +## Security + +Please report security issues per [`SECURITY.md`](SECURITY.md). Do **not** +open public issues for vulnerabilities. + +## License + +Released under the [MIT License](LICENSE) © 2026 CxAI-LLM. diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..c61b4bf --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,19 @@ +# Security policy for CxLLM-LB-SDK + +## Reporting a vulnerability + +Please email **security@cxllm-studio.com** with: + +- A description of the vulnerability and its impact. +- Steps to reproduce, ideally with a minimal proof-of-concept. +- The affected version(s) / commit SHAs. + +We aim to acknowledge within **2 business days** and to publish a fix or +mitigation within **30 days** for high-severity issues. + +Do **not** open a public Gitea / GitHub issue for vulnerabilities. + +## Supported versions + +Only the `main` branch and the most recent tagged release receive security +updates. diff --git a/docs/ARCHITECTURE.md b/docs/ARCHITECTURE.md new file mode 100644 index 0000000..4a12988 --- /dev/null +++ b/docs/ARCHITECTURE.md @@ -0,0 +1,24 @@ +# Architecture — CxLLM-LB-SDK + +> CxLLM Local-Bus SDK + +## Goals + +- Provide a focused, well-tested driverkit-sdk surface for the CxLLM family. +- Stay deployable on its own (no monorepo coupling). +- Keep the public ABI small and explicitly versioned. + +## Boundaries + +```text + +----------------------+ + client --> | CxLLM-LB-SDK | + +----------+-----------+ + | + v + CxLLM runtime / kernel +``` + +## Decisions + +- See `docs/adr/` for Architecture Decision Records. diff --git a/docs/adr/0001-record-architecture-decisions.md b/docs/adr/0001-record-architecture-decisions.md new file mode 100644 index 0000000..4fc033a --- /dev/null +++ b/docs/adr/0001-record-architecture-decisions.md @@ -0,0 +1,13 @@ +# 1. Record architecture decisions + +## Status +Accepted + +## Context +We need a lightweight, append-only log of architectural choices. + +## Decision +Use Markdown ADRs in `docs/adr/`, numbered sequentially. + +## Consequences +Future maintainers can read the chain of decisions without spelunking PR history.