llama : update structure of XCFramework to meet App Store requirements

This commit updates the structure of the XCFramework to meet the
requirements for App Store submission.

This involved generating debug symbols and the creation of dSYM bundles
for each platform. While having the dSYM bundles should allow this
framework to pass App Store validation. One thing to note though is that
the UUID for the dSYM is missing for this combined static library but
the object files them selfes contains debugging symbols which I've
verified by running a simple macos application in lldb and stepping
through the llama library code. Hopefully this will be enough for
reports that are generated by the App Store but I don't now for sure
yet as I currently don't have a developer account set up to test this.

Author: danbev

build-xcframework.sh

@@ -15,8 +15,8 @@ GGML_BLAS_DEFAULT=ON
 GGML_METAL_USE_BF16=ON
 GGML_OPENMP=OFF
 
-COMMON_C_FLAGS="-Wno-macro-redefined -Wno-shorten-64-to-32 -Wno-unused-command-line-argument"
-COMMON_CXX_FLAGS="-Wno-macro-redefined -Wno-shorten-64-to-32 -Wno-unused-command-line-argument"
+COMMON_C_FLAGS="-Wno-macro-redefined -Wno-shorten-64-to-32 -Wno-unused-command-line-argument -g"
+COMMON_CXX_FLAGS="-Wno-macro-redefined -Wno-shorten-64-to-32 -Wno-unused-command-line-argument -g"
 
 check_required_tool() {
     local tool=$1
@@ -41,30 +41,38 @@ rm -rf build-ios-sim
 rm -rf build-ios-device
 rm -rf build-macos
 rm -rf build-visionos
+rm -rf build-visionos-sim
 
 # Function to setup framework structure for a given architecture
 setup_framework_structure() {
     local build_dir=$1
     local framework_name="llama"
     local min_os_version=$2
 
-    # Create framework directory structure
-    mkdir -p ${build_dir}/framework/${framework_name}.framework
-    mkdir -p ${build_dir}/framework/${framework_name}.framework/Headers
-    mkdir -p ${build_dir}/framework/${framework_name}.framework/Modules
+    # Create framework directory structure with versions folder (macOS structure)
+    mkdir -p ${build_dir}/framework/${framework_name}.framework/Versions/A/Headers
+    mkdir -p ${build_dir}/framework/${framework_name}.framework/Versions/A/Modules
+    mkdir -p ${build_dir}/framework/${framework_name}.framework/Versions/A/Resources
+
+    # Create symbolic links
+    ln -sf A ${build_dir}/framework/${framework_name}.framework/Versions/Current
+    ln -sf Versions/Current/Headers ${build_dir}/framework/${framework_name}.framework/Headers
+    ln -sf Versions/Current/Modules ${build_dir}/framework/${framework_name}.framework/Modules
+    ln -sf Versions/Current/Resources ${build_dir}/framework/${framework_name}.framework/Resources
+    ln -sf Versions/Current/${framework_name} ${build_dir}/framework/${framework_name}.framework/${framework_name}
 
     # Copy all required headers
-    cp include/llama.h             ${build_dir}/framework/${framework_name}.framework/Headers/
-    cp ggml/include/ggml.h         ${build_dir}/framework/${framework_name}.framework/Headers/
-    cp ggml/include/ggml-alloc.h   ${build_dir}/framework/${framework_name}.framework/Headers/
-    cp ggml/include/ggml-backend.h ${build_dir}/framework/${framework_name}.framework/Headers/
-    cp ggml/include/ggml-metal.h   ${build_dir}/framework/${framework_name}.framework/Headers/
-    cp ggml/include/ggml-cpu.h     ${build_dir}/framework/${framework_name}.framework/Headers/
-    cp ggml/include/ggml-blas.h    ${build_dir}/framework/${framework_name}.framework/Headers/
-    cp ggml/include/gguf.h         ${build_dir}/framework/${framework_name}.framework/Headers/
+    cp include/llama.h             ${build_dir}/framework/${framework_name}.framework/Versions/A/Headers/
+    cp ggml/include/ggml.h         ${build_dir}/framework/${framework_name}.framework/Versions/A/Headers/
+    cp ggml/include/ggml-alloc.h   ${build_dir}/framework/${framework_name}.framework/Versions/A/Headers/
+    cp ggml/include/ggml-backend.h ${build_dir}/framework/${framework_name}.framework/Versions/A/Headers/
+    cp ggml/include/ggml-metal.h   ${build_dir}/framework/${framework_name}.framework/Versions/A/Headers/
+    cp ggml/include/ggml-cpu.h     ${build_dir}/framework/${framework_name}.framework/Versions/A/Headers/
+    cp ggml/include/ggml-blas.h    ${build_dir}/framework/${framework_name}.framework/Versions/A/Headers/
+    cp ggml/include/gguf.h         ${build_dir}/framework/${framework_name}.framework/Versions/A/Headers/
 
     # Create module map
-    cat > ${build_dir}/framework/${framework_name}.framework/Modules/module.modulemap << EOF
+    cat > ${build_dir}/framework/${framework_name}.framework/Versions/A/Modules/module.modulemap << EOF
 framework module llama {
     header "llama.h"
     header "ggml.h"
@@ -85,7 +93,7 @@ framework module llama {
 EOF
 
     # Create Info.plist
-    cat > ${build_dir}/framework/${framework_name}.framework/Info.plist << EOF
+    cat > ${build_dir}/framework/${framework_name}.framework/Versions/A/Resources/Info.plist << EOF
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
 <plist version="1.0">
@@ -113,11 +121,73 @@ EOF
 EOF
 }
 
+# Function to combine static libraries
+combine_static_libraries() {
+    local build_dir="$1"
+    local platform="$2"
+    local output_lib="${build_dir}/framework/llama.framework/Versions/A/llama"
+    local base_dir="$(pwd)"
+
+    # Combine all static libraries using libtool
+    libtool -static -no_warning_for_no_symbols -o "${base_dir}/${output_lib}" \
+        "${base_dir}/${build_dir}/src/${platform}/libllama.a" \
+        "${base_dir}/${build_dir}/ggml/src/${platform}/libggml.a" \
+        "${base_dir}/${build_dir}/ggml/src/${platform}/libggml-base.a" \
+        "${base_dir}/${build_dir}/ggml/src/${platform}/libggml-cpu.a" \
+        "${base_dir}/${build_dir}/ggml/src/ggml-metal/${platform}/libggml-metal.a" \
+        "${base_dir}/${build_dir}/ggml/src/ggml-blas/${platform}/libggml-blas.a"
+}
+
+# Function to create dSYM for App Store submission
+create_app_store_dsym() {
+    local build_dir="$1"
+    local base_dir="$(pwd)"
+    local lib_path="${base_dir}/${build_dir}/framework/llama.framework/Versions/A/llama"
+    local dsym_path="${base_dir}/${build_dir}/framework/llama.framework/Versions/A/llama.dSYM"
+
+    #echo "Creating App Store compatible dSYM for ${build_dir}"
+
+    # Create directory structure
+    mkdir -p "${dsym_path}/Contents/Resources/DWARF"
+
+    # Create Info.plist
+    cat > "${dsym_path}/Contents/Info.plist" << EOF
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+    <dict>
+        <key>CFBundleDevelopmentRegion</key>
+        <string>English</string>
+        <key>CFBundleIdentifier</key>
+        <string>ggml-org.llama.dsym</string>
+        <key>CFBundleInfoDictionaryVersion</key>
+        <string>6.0</string>
+        <key>CFBundlePackageType</key>
+        <string>dSYM</string>
+        <key>CFBundleSignature</key>
+        <string>LLAM</string>
+        <key>CFBundleShortVersionString</key>
+        <string>1.0</string>
+        <key>CFBundleVersion</key>
+        <string>1</string>
+    </dict>
+</plist>
+EOF
+
+    # Copy the binary to the DWARF directory
+    cp "${lib_path}" "${dsym_path}/Contents/Resources/DWARF/llama"
+}
+
 # Common options for all builds
 COMMON_CMAKE_ARGS=(
     -DCMAKE_XCODE_ATTRIBUTE_CODE_SIGNING_REQUIRED=NO
     -DCMAKE_XCODE_ATTRIBUTE_CODE_SIGN_IDENTITY=""
     -DCMAKE_XCODE_ATTRIBUTE_CODE_SIGNING_ALLOWED=NO
+    -DCMAKE_XCODE_ATTRIBUTE_DEBUG_INFORMATION_FORMAT="dwarf-with-dsym"
+    -DCMAKE_XCODE_ATTRIBUTE_GCC_GENERATE_DEBUGGING_SYMBOLS=YES
+    -DCMAKE_XCODE_ATTRIBUTE_COPY_PHASE_STRIP=NO
+    -DCMAKE_XCODE_ATTRIBUTE_STRIP_INSTALLED_PRODUCT=NO
+    -DCMAKE_XCODE_ATTRIBUTE_DEVELOPMENT_TEAM=ggml
     -DBUILD_SHARED_LIBS=OFF
     -DLLAMA_BUILD_EXAMPLES=${LLAMA_BUILD_EXAMPLES}
     -DLLAMA_BUILD_TESTS=${LLAMA_BUILD_TESTS}
@@ -166,7 +236,6 @@ cmake -B build-macos -G Xcode \
     -S .
 cmake --build build-macos --config Release -- -quiet
 
-
 # Build for visionOS
 cmake -B build-visionos -G Xcode \
     "${COMMON_CMAKE_ARGS[@]}" \
@@ -194,44 +263,44 @@ cmake -B build-visionos-sim -G Xcode \
 cmake --build build-visionos-sim --config Release -- -quiet
 
 # Setup frameworks and copy binaries and headers
+echo "Setting up framework structures..."
 setup_framework_structure "build-ios-sim" ${IOS_MIN_OS_VERSION}
 setup_framework_structure "build-ios-device" ${IOS_MIN_OS_VERSION}
 setup_framework_structure "build-macos" ${MACOS_MIN_OS_VERSION}
 setup_framework_structure "build-visionos" ${VISIONOS_MIN_OS_VERSION}
 setup_framework_structure "build-visionos-sim" ${VISIONOS_MIN_OS_VERSION}
 
-# Function to combine static libraries
-combine_static_libraries() {
-    local build_dir="$1"
-    local platform="$2"
-    local output_lib="${build_dir}/framework/llama.framework/llama"
-    local base_dir="$(pwd)"
-
-    # Combine all static libraries using libtool
-    libtool -static -no_warning_for_no_symbols -o "${base_dir}/${output_lib}" \
-        "${base_dir}/${build_dir}/src/${platform}/libllama.a" \
-        "${base_dir}/${build_dir}/ggml/src/${platform}/libggml.a" \
-        "${base_dir}/${build_dir}/ggml/src/${platform}/libggml-base.a" \
-        "${base_dir}/${build_dir}/ggml/src/${platform}/libggml-cpu.a" \
-        "${base_dir}/${build_dir}/ggml/src/ggml-metal/${platform}/libggml-metal.a" \
-        "${base_dir}/${build_dir}/ggml/src/ggml-blas/${platform}/libggml-blas.a"
-}
-
-# Combine libraries for simulator and device builds
+# Combine libraries for each platform
+echo "Combining libraries..."
 combine_static_libraries "build-ios-sim" "Release-iphonesimulator"
 combine_static_libraries "build-ios-device" "Release-iphoneos"
 combine_static_libraries "build-macos" "Release"
 combine_static_libraries "build-visionos" "Release-xros"
 combine_static_libraries "build-visionos-sim" "Release-xrsimulator"
 
+# Create App Store compatible dSYMs
+echo "Creating dSYM bundles..."
+create_app_store_dsym "build-ios-sim"
+create_app_store_dsym "build-ios-device"
+create_app_store_dsym "build-macos"
+create_app_store_dsym "build-visionos"
+create_app_store_dsym "build-visionos-sim"
+
 # Create XCFramework
+echo "Creating XCFramework..."
 xcodebuild -create-xcframework \
     -framework $(pwd)/build-ios-sim/framework/llama.framework \
+    -debug-symbols $(pwd)/build-ios-sim/framework/llama.framework/Versions/A/llama.dSYM \
     -framework $(pwd)/build-ios-device/framework/llama.framework \
+    -debug-symbols $(pwd)/build-ios-device/framework/llama.framework/Versions/A/llama.dSYM \
     -framework $(pwd)/build-macos/framework/llama.framework \
+    -debug-symbols $(pwd)/build-macos/framework/llama.framework/Versions/A/llama.dSYM \
     -framework $(pwd)/build-visionos/framework/llama.framework \
+    -debug-symbols $(pwd)/build-visionos/framework/llama.framework/Versions/A/llama.dSYM \
     -framework $(pwd)/build-visionos-sim/framework/llama.framework \
+    -debug-symbols $(pwd)/build-visionos-sim/framework/llama.framework/Versions/A/llama.dSYM \
     -output $(pwd)/build-apple/llama.xcframework
 
 # The generated framework can be found in build-apple/llama.xcframework and
 # can be added to a projects "Frameworks, Libraries, and Embedded Content"
+