Split debug - add an extra folder to the META-INF outputs

Author: r1viollet

README.md

@@ -64,6 +64,39 @@ The project includes both Java and C++ unit tests. You can run them using:
 ### Cross-JDK Testing
 `JAVA_TEST_HOME=<path to test JDK> ./gradlew testDebug`
 
+## Release Builds and Debug Information
+
+### Split Debug Information
+Release builds automatically generate split debug information to optimize deployment size while preserving debugging capabilities:
+
+- **Stripped libraries** (~1.2MB): Production-ready binaries with symbols removed for deployment
+- **Debug symbol files** (~6.1MB): Separate `.debug` files containing full debugging information
+- **Debug links**: Stripped libraries include `.gnu_debuglink` sections pointing to debug files
+
+### Build Artifacts Structure
+```
+ddprof-lib/build/
+├── lib/main/release/linux/x64/
+│   ├── libjavaProfiler.so              # Original library with debug symbols
+│   ├── stripped/
+│   │   └── libjavaProfiler.so          # Stripped library (83% smaller)
+│   └── debug/
+│       └── libjavaProfiler.so.debug    # Debug symbols only
+├── native/release/
+│   └── META-INF/native-libs/linux-x64/
+│       └── libjavaProfiler.so          # Final stripped library (deployed)
+└── native/release-debug/
+    └── META-INF/native-libs/linux-x64/
+        └── libjavaProfiler.so.debug    # Debug symbols package
+```
+
+### Build Options
+- **Skip debug extraction**: `./gradlew buildRelease -Pskip-debug-extraction=true`
+- **Debug extraction requires**: `objcopy` (Linux) or `dsymutil` (macOS)
+  - Ubuntu/Debian: `sudo apt-get install binutils`
+  - Alpine: `apk add binutils`
+  - macOS: Included with Xcode command line tools
+
 ## Development
 
 ### Code Quality

ddprof-lib/build.gradle

@@ -63,7 +63,7 @@ def getMissingToolErrorMessage(toolName, installInstructions) {
 def createDebugExtractionTask(config, linkTask) {
   return tasks.register('extractDebugLibRelease', Exec) {
     onlyIf {
-      config.active && !shouldSkipDebugExtraction()
+      !shouldSkipDebugExtraction()
     }
     dependsOn linkTask
     description = 'Extract debug symbols from release library'
@@ -109,7 +109,7 @@ def createDebugExtractionTask(config, linkTask) {
 def createDebugLinkTask(config, linkTask, extractDebugTask) {
   return tasks.register('addDebugLinkLibRelease', Exec) {
     onlyIf {
-      config.active && os().isLinux() && !shouldSkipDebugExtraction()
+      os().isLinux() && !shouldSkipDebugExtraction()
     }
     dependsOn extractDebugTask
     description = 'Add debug link to the original library'
@@ -148,16 +148,14 @@ def createDebugCopyTask(config, extractDebugTask) {
 
 // Main function to setup debug extraction for release builds
 def setupDebugExtraction(config, linkTask) {
-  if (config.name == 'release') {
+  if (config.name == 'release' && config.active && !project.hasProperty('skip-native')) {
     // Create all debug-related tasks
     def extractDebugTask = createDebugExtractionTask(config, linkTask)
     def addDebugLinkTask = createDebugLinkTask(config, linkTask, extractDebugTask)
 
     // Create the strip task and configure it properly
     def stripTask = tasks.register('stripLibRelease', StripSymbols) {
-      onlyIf {
-        config.active
-      }
+      // No onlyIf needed here - setupDebugExtraction already handles the main conditions
       dependsOn addDebugLinkTask
     }
 
@@ -176,6 +174,9 @@ def setupDebugExtraction(config, linkTask) {
     if (copyTask != null) {
       copyTask.dependsOn stripTask
       copyTask.inputs.files stripTask.get().outputs.files
+
+      // Create an extra folder for the debug symbols
+      copyTask.dependsOn copyDebugTask
     }
   }
 }