setup basic logging for native and fix static libs (#98)

Author: aajtodd

CMakeLists.txt

@@ -1,9 +1,8 @@
-cmake_minimum_required(VERSION 3.1)
+cmake_minimum_required(VERSION 3.21)
 project(aws-crt-kotlin C)
 message(STATUS "CMake ${CMAKE_VERSION}")
-
 option(BUILD_DEPS "Builds aws common runtime dependencies as part of build. Turn off if you want to control your dependency chain." ON)
-option(BUILD_SHARED_LIBS "Build shared library for FFI: default: ON" ON)
+option(BUILD_SHARED_LIBS "Build shared library for FFI: default: OFF" OFF)
 
 if (POLICY CMP0069)
     cmake_policy(SET CMP0069 NEW) # Enable LTO/IPO if available in the compiler
@@ -21,12 +20,20 @@ if (UNIX AND NOT APPLE)
     set(FIND_LIBRARY_USE_LIB64_PATHS true)
 endif()
 
+# Multi-config generators like Xcode, Visual Studio, and Ninja don't always respect
+# CMAKE_BUILD_TYPE. Set the available configuration to the build type.
+if (${CMAKE_BUILD_TYPE} STREQUAL "Release")
+    set(CMAKE_CONFIGURATION_TYPES ${CMAKE_BUILD_TYPE})
+    message(STATUS "Setting CMAKE_CONFIGURATION_TYPES = ${CMAKE_CONFIGURATION_TYPES}")
+endif()
+
 # This is required in order to append /lib/cmake to each element in CMAKE_PREFIX_PATH
 set(AWS_MODULE_DIR "/${CMAKE_INSTALL_LIBDIR}/cmake")
 string(REPLACE ";" "${AWS_MODULE_DIR};" AWS_MODULE_PATH "${CMAKE_PREFIX_PATH}${AWS_MODULE_DIR}")
 # Append that generated list to the module search path
 list(APPEND CMAKE_MODULE_PATH ${AWS_MODULE_PATH})
 
+set(ADDITIONAL_DEPS "")
 
 if (BUILD_DEPS)
     list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_LIST_DIR}/crt/aws-c-common/cmake")
@@ -60,6 +67,7 @@ if (BUILD_DEPS)
             set(DISABLE_GO ON)
             set(SEARCH_LIBCRYPTO OFF)
             set(BUILD_LIBSSL OFF)
+            list(APPEND ADDITIONAL_DEPS crypto)
             add_subdirectory(crt/aws-lc)
         else()
             set(SEARCH_LIBCRYPTO ON)
@@ -74,6 +82,7 @@ if (BUILD_DEPS)
             endif()
         endif()
         add_subdirectory(crt/s2n)
+        list(APPEND ADDITIONAL_DEPS s2n)
     endif()
     add_subdirectory(crt/aws-c-sdkutils)
     add_subdirectory(crt/aws-c-io)
@@ -87,9 +96,6 @@ else()
     set(IN_SOURCE_BUILD OFF)
 endif()
 
-# Restore BUILD_SHARED_LIBS for this project
-set(BUILD_SHARED_LIBS ${SHARED_FFI_LIB})
-
 include(AwsCFlags)
 include(AwsSharedLibSetup)
 include(AwsSanitizers)
@@ -103,7 +109,80 @@ aws_use_package(aws-c-http)
 aws_use_package(aws-c-auth)
 aws_use_package(aws-checksums)
 
-# TODO - bundling static libraries into single static library composed of all the static libraries
-# to enable IPO/LTO. See also:
-# * https://cristianadam.eu/20190501/bundling-together-static-libraries-with-cmake/
-# * https://cmake.org/cmake/help/latest/module/CheckIPOSupported.html
+if (XCODE)
+    # we only ever build for a single device/simulator and turning this on leaks into generator expressions like `$<TARGET_FILE:${tgt}>`
+    # and breaks for ios/tvos/watchos builds
+    set_property(GLOBAL PROPERTY XCODE_EMIT_EFFECTIVE_PLATFORM_NAME OFF)
+endif()
+
+# Create a single static library that combines all the individual libs
+# We do this to work around issues with link order when including multiple
+# `staticLibraries` in the cinterop file.
+function(bundle_static_library name deps)
+    set(tgt_full_name ${CMAKE_BINARY_DIR}/${CMAKE_STATIC_LIBRARY_PREFIX}${name}${CMAKE_STATIC_LIBRARY_SUFFIX})
+
+    if(XCODE)
+        find_program(lib_tool libtool)
+        foreach(tgt IN LISTS deps)
+            list(APPEND static_libs_full_names $<TARGET_FILE:${tgt}>)
+        endforeach()
+
+        add_custom_command(
+            COMMAND 
+                ${lib_tool} -static -o ${tgt_full_name} ${static_libs_full_names}
+            OUTPUT 
+                ${tgt_full_name}
+            COMMENT 
+                "Bundling ${name}"
+            VERBATIM
+            COMMAND_EXPAND_LISTS
+        )
+
+    elseif (CMAKE_C_COMPILER_ID MATCHES "^(Clang|GNU)$")
+        # archive tool needs to support -M flag 
+        file(WRITE ${CMAKE_BINARY_DIR}/${name}.ar.in "CREATE ${tgt_full_name}\n")
+
+        foreach(tgt IN LISTS deps)
+            message("tgt=${tgt}")
+            file(APPEND ${CMAKE_BINARY_DIR}/${name}.ar.in "ADDLIB $<TARGET_FILE:${tgt}>\n")
+        endforeach()
+
+        file(APPEND ${CMAKE_BINARY_DIR}/${name}.ar.in "SAVE\n")
+        file(APPEND ${CMAKE_BINARY_DIR}/${name}.ar.in "END\n")
+
+        file(
+            GENERATE
+            OUTPUT ${CMAKE_BINARY_DIR}/${name}.ar
+            INPUT ${CMAKE_BINARY_DIR}/${name}.ar.in
+        )
+
+        add_custom_command(
+            COMMAND ${CMAKE_AR} -M < ${CMAKE_BINARY_DIR}/${name}.ar
+            OUTPUT ${tgt_full_name}
+            COMMENT "Bundling ${name}"
+            VERBATIM
+        )
+    else()
+        message(FATAL_ERROR "Unknown bundling!")
+    endif()
+
+    add_custom_target(bundling_target ALL DEPENDS ${tgt_full_name})
+    foreach(tgt IN LISTS deps)
+        message("adding dependency on ${tgt}")
+        add_dependencies(bundling_target ${tgt})
+    endforeach()
+
+  add_library(${name} STATIC IMPORTED)
+  set_target_properties(${name}
+    PROPERTIES
+      IMPORTED_LOCATION ${tgt_full_name}
+      INTERFACE_INCLUDE_DIRECTORIES $<TARGET_PROPERTY:${name},INTERFACE_INCLUDE_DIRECTORIES>)
+  add_dependencies(${name} bundling_target)
+
+  install(FILES ${tgt_full_name} TYPE LIB)
+endfunction()
+
+list(APPEND STATIC_LIBS ${DEP_AWS_LIBS} ${ADDITIONAL_DEPS})
+bundle_static_library(aws-crt-kotlin "${STATIC_LIBS}")
+
+message("CMAKE_C_COMPILER_ID=${CMAKE_C_COMPILER_ID}")

README.md

@@ -84,7 +84,7 @@ The `elasticurl` project contains an MPP (JVM and Native only) executable that p
 ```
 # replace "PLATFORM" with the target platform you want to run (e.g. macosX64, linuxX64, etc)
 
-./elasticurl/bin/PLATFORM/elasticurl.kexe [OPTIONS] URL
+./elasticurl/bin/PLATFORM/elasticurlDebugExecutable/elasticurl.kexe [OPTIONS] URL
 ```
 
 
@@ -99,7 +99,7 @@ To enable memory tracing specify the environment variable `CRTDEBUG=trace=N` and
 
 e.g.
 ```
-CRTDEBUG=trace=2 ./elasticurl/bin/macosX64/elasticurl.kexe -v trace https://aws.amazon.com
+CRTDEBUG=trace=2 ./elasticurl/bin/macosX64/elasticurlDebugExecutable/elasticurl.kexe -v trace https://aws.amazon.com
 ```
 
 

aws-crt-kotlin/build.gradle.kts

@@ -164,11 +164,6 @@ kotlin {
                 dependsOn(cmakeInstallTask)
             }
         }
-
-        compilations["test"].compilerOptions.configure {
-            // TODO - can we remove this if we are bundling the static libs
-            freeCompilerArgs.addAll(listOf("-linker-options", "-L${libDir.absolutePath}"))
-        }
     }
 }
 

aws-crt-kotlin/native/interop/crt.def

@@ -1,5 +1,6 @@
 package = libcrt
 headers = aws/common/allocator.h \
+        aws/common/common.h \
         aws/common/error.h \
         aws/common/byte_buf.h \
         aws/common/string.h \
@@ -21,21 +22,12 @@ headers = aws/common/allocator.h \
         aws/compression/compression.h
 headerFilter = aws/common/* aws/io/* aws/http/* aws/compression/*
 
-linkerOpts = -laws-c-common -laws-c-cal -laws-c-io -laws-c-http -laws-c-compression
 linkerOpts.osx = -framework Security
 linkerOpts.ios = -framework Security
-linkerOpts.linux = -ls2n -lcrypto
 
-staticLibraries = libaws-c-common.a \
-        libaws-c-cal.a \
-        libaws-c-io.a \
-        libaws-c-compression.a \
-        libaws-c-sdkutils.a \
-        libaws-c-http.a \
-        libaws-c-auth.a \
-        libaws-checksums.a
-
-staticLibraries.linux = libs2n.a libcrypto.a
+# included libs are linked automatically, adding linkerOpts like `-laws-c-common` causes
+# issues downstream as it will search for that library still.
+staticLibraries = libaws-crt-kotlin.a
 
 ---
 
@@ -49,6 +41,24 @@ static void s_crt_kotlin_log(enum aws_log_level level, aws_log_subject_t subject
 static struct aws_allocator *s_crt_kotlin_allocator = NULL;
 int g_memtrace_level = 0;
 
+#define AWS_CRT_KOTLIN_PACKAGE_ID 16
+
+enum aws_kotlin_crt_log_subject {
+    AWS_LS_KOTLIN_CRT_GENERAL = AWS_LOG_SUBJECT_BEGIN_RANGE(AWS_CRT_KOTLIN_PACKAGE_ID),
+    AWS_LS_KOTLIN_CRT_LAST = AWS_LOG_SUBJECT_END_RANGE(AWS_CRT_KOTLIN_PACKAGE_ID)
+};
+
+static struct aws_log_subject_info s_crt_log_subject_infos[] = {
+    DEFINE_LOG_SUBJECT_INFO(
+        AWS_LS_KOTLIN_CRT_GENERAL, "kotlin-crt-general", "Subject for aws-crt-kotlin logging that defies categorization"),
+};
+
+static struct aws_log_subject_info_list s_crt_log_subject_list = {
+    .subject_list = s_crt_log_subject_infos,
+    .count = AWS_ARRAY_SIZE(s_crt_log_subject_infos),
+};
+
+
 static void s_crt_kotlin_init_allocator(int trace_level) {
     if (trace_level > 0) {
         g_memtrace_level = trace_level;
@@ -99,4 +109,4 @@ static void s_crt_kotlin_logger_cleanup(void) {
         aws_logger_set(NULL);
         aws_logger_clean_up(&s_crt_kotlin_logger);
     }
-}
+}

aws-crt-kotlin/native/src/aws/sdk/kotlin/crt/Allocator.kt

@@ -28,16 +28,3 @@ internal class AwsAllocator : NativeFreeablePlacement, CValuesRef<aws_allocator>
 
     override fun getPointer(scope: AutofreeScope): CPointer<aws_allocator> = allocator
 }
-
-/**
- * Clean up CRT resources after K/N runtime has been released.
- */
-@OptIn(ExperimentalForeignApi::class)
-internal fun cleanup() {
-    aws_http_library_clean_up()
-    aws_compression_library_clean_up()
-    aws_io_library_clean_up()
-    aws_common_library_clean_up()
-
-    s_crt_kotlin_clean_up()
-}

aws-crt-kotlin/native/src/aws/sdk/kotlin/crt/CRTNative.kt

@@ -5,10 +5,7 @@
 
 package aws.sdk.kotlin.crt
 
-import kotlinx.cinterop.ExperimentalForeignApi
-import kotlinx.cinterop.convert
-import kotlinx.cinterop.staticCFunction
-import kotlinx.cinterop.toKString
+import kotlinx.cinterop.*
 import kotlinx.coroutines.runBlocking
 import kotlinx.coroutines.sync.Mutex
 import kotlinx.coroutines.sync.withLock
@@ -39,6 +36,7 @@ public actual object CRT {
             aws_http_library_init(Allocator.Default)
 
             Logging.initialize(config)
+            aws_register_log_subject_info_list(s_crt_log_subject_list.ptr)
             atexit(staticCFunction(::cleanup))
 
             initialized = true
@@ -102,3 +100,16 @@ public actual object CRT {
             0
         }
 }
+
+/**
+ * Clean up CRT resources after K/N runtime has been released.
+ */
+private fun cleanup() {
+    aws_unregister_log_subject_info_list(s_crt_log_subject_list.ptr)
+    aws_http_library_clean_up()
+    aws_compression_library_clean_up()
+    aws_io_library_clean_up()
+    aws_common_library_clean_up()
+
+    s_crt_kotlin_clean_up()
+}

aws-crt-kotlin/native/src/aws/sdk/kotlin/crt/Logging.kt

@@ -68,3 +68,7 @@ internal object Logging {
         }
     }
 }
+
+internal inline fun log(level: LogLevel, message: String, subject: aws_log_subject_t = AWS_LS_KOTLIN_CRT_GENERAL) {
+    s_crt_kotlin_log(level.value.convert(), subject, message)
+}

aws-crt-kotlin/native/src/aws/sdk/kotlin/crt/http/HttpClientConnectionNative.kt

@@ -154,6 +154,7 @@ private fun onResponseHeaders(
     try {
         ctx.handler.onResponseHeaders(stream, stream.responseStatusCode, blockType.value.toInt(), headers)
     } catch (ex: Exception) {
+        log(LogLevel.Error, "onResponseHeaders: $ex")
         return aws_raise_error(AWS_ERROR_HTTP_CALLBACK_FAILURE.toInt())
     }
     return AWS_OP_SUCCESS
@@ -169,6 +170,7 @@ private fun onResponseHeaderBlockDone(
     try {
         ctx.handler.onResponseHeadersDone(stream, blockType.value.toInt())
     } catch (ex: Exception) {
+        log(LogLevel.Error, "onResponseHeaderBlockDone: $ex")
         return aws_raise_error(AWS_ERROR_HTTP_CALLBACK_FAILURE.toInt())
     }
 
@@ -194,7 +196,7 @@ private fun onIncomingBody(
             aws_http_stream_update_window(nativeStream, windowIncrement.convert())
         }
     } catch (ex: Exception) {
-        // FIXME - we need our own logging block so we can log exceptions and errors from FFI layer
+        log(LogLevel.Error, "onIncomingBody: $ex")
         return aws_raise_error(AWS_ERROR_HTTP_CALLBACK_FAILURE.toInt())
     }
 
@@ -212,6 +214,7 @@ private fun onStreamComplete(
     try {
         ctx.handler.onResponseComplete(stream, errorCode)
     } catch (ex: Exception) {
+        log(LogLevel.Error, "onStreamComplete: $ex")
         // close connection if callback throws an exception
         aws_http_connection_close(aws_http_stream_get_connection(nativeStream))
     } finally {

aws-crt-kotlin/native/src/aws/sdk/kotlin/crt/http/RequestBodyStream.kt

@@ -5,7 +5,9 @@
 package aws.sdk.kotlin.crt.http
 
 import aws.sdk.kotlin.crt.Allocator
+import aws.sdk.kotlin.crt.LogLevel
 import aws.sdk.kotlin.crt.io.MutableBuffer
+import aws.sdk.kotlin.crt.log
 import kotlinx.cinterop.*
 import libcrt.*
 
@@ -23,6 +25,7 @@ private fun streamSeek(
             result = AWS_OP_ERR
         }
     } catch (ex: Exception) {
+        log(LogLevel.Error, "streamSeek: $ex")
         return aws_raise_error(AWS_ERROR_HTTP_CALLBACK_FAILURE.toInt())
     }
 
@@ -45,6 +48,7 @@ private fun streamRead(
         val buffer = MutableBuffer(dest)
         handler.khandler.sendRequestBody(buffer)
     } catch (ex: Exception) {
+        log(LogLevel.Error, "streamRead: $ex")
         return aws_raise_error(AWS_ERROR_HTTP_CALLBACK_FAILURE.toInt())
     }
 
@@ -80,6 +84,7 @@ private fun streamRelease(
     if (stream == null) return
     val refCnt = aws_ref_count_release(stream.pointed.ref_count.ptr)
     if (refCnt.toInt() == 0) {
+        log(LogLevel.Trace, "releasing RequestBodyStream")
         val stableRef = stream.pointed.impl?.asStableRef<RequestBodyStream>() ?: return
         stableRef.dispose()
         Allocator.Default.free(stream)

aws-crt-kotlin/native/src/aws/sdk/kotlin/crt/util/StringUtils.kt

@@ -49,10 +49,10 @@ public fun String.toAwsString(): CPointer<aws_string> =
  */
 public fun Pinned<ByteArray>.asAwsByteCursor(): CValue<aws_byte_cursor> {
     val arr = get()
-    val addr = addressOf(0)
+    val addr = if (arr.isNotEmpty()) addressOf(0) else null
     return cValue<aws_byte_cursor> {
         len = arr.size.convert()
-        ptr = addr.reinterpret()
+        ptr = addr?.reinterpret()
     }
 }