Restrict platforms to x86_64 and arm64, simplify build-jni-lib.sh, throw UnknownPlatformException if arch is not supported

Author: carlzogh

aws-lambda-java-runtime-interface-client/README.md

@@ -13,7 +13,7 @@ You can include this package in your preferred base image to make that base imag
 
 Choose a preferred base image. The Runtime Interface Client is tested on Amazon Linux, Alpine, Ubuntu, Debian, and CentOS. The requirements are that the image is:
 
-* built for x86_64 and ARM
+* built for x86_64 and ARM64
 * contains Java >= 8
 * contains glibc >= 2.17 or musl
 

aws-lambda-java-runtime-interface-client/RELEASE.CHANGELOG.md

@@ -1,6 +1,6 @@
-### Dec 30, 2021
+### January 07, 2022
 `2.1.0`
-- Added support for ARM64 architecture
+- fix: Added support for ARM64 architecture
 
 ### Sept 29, 2021
 `2.0.0`

aws-lambda-java-runtime-interface-client/src/main/java/com/amazonaws/services/lambda/runtime/api/client/runtimeapi/NativeClient.java

@@ -22,8 +22,7 @@ class NativeClient {
     static {
             boolean loaded = false;
             for (int i = 0; !loaded && i < libsToTry.length; ++i) {
-                try (InputStream lib = NativeClient.class.getResourceAsStream(
-                        Paths.get(architecturePathSuffix, libsToTry[i]).toString())) {
+                try (InputStream lib = NativeClient.class.getResourceAsStream(Paths.get(architecturePathSuffix, libsToTry[i]).toString())) {
                     Files.copy(lib, Paths.get(nativeLibPath), StandardCopyOption.REPLACE_EXISTING);
                     System.load(nativeLibPath);
                     loaded = true;
@@ -47,19 +46,20 @@ class NativeClient {
     }
 
     /**
+     * Implementation based on AWS CRT (ref. https://github.com/awslabs/aws-crt-java/blob/0e9c3db8b07258b57c2503cfc47c787ccef10670/src/main/java/software/amazon/awssdk/crt/CRT.java#L106-L134)
      * @return a string describing the detected architecture the RIC is executing on
-     * @throws RuntimeException
+     * @throws UnknownPlatformException if the architecture is not known to the RIC
      */
     static String getArchIdentifier() {
         String arch = System.getProperty("os.arch");
 
-        if (arch.matches("^(x8664|amd64|ia32e|em64t|x64|x86_64|x8632|x86|i[3-6]86|ia32|x32)$")) {
-            return "x86";
-        } else if (arch.matches("^(armeabi.*|arm64.*|aarch64.*|arm)$")) {
-            return "arm";
+        if (arch.matches("^(x8664|amd64|ia32e|em64t|x64|x86_64)$")) {
+            return "x86_64";
+        } else if (arch.startsWith("arm64") || arch.startsWith("aarch64")) {
+            return "arm64";
         }
 
-        throw new RuntimeException("architecture not supported: " + arch);
+        throw new UnknownPlatformException("Lambda Java RIC: architecture not supported: " + arch);
     }
 
     static native void initializeClient(byte[] userAgent);

aws-lambda-java-runtime-interface-client/src/main/java/com/amazonaws/services/lambda/runtime/api/client/runtimeapi/UnknownPlatformException.java

@@ -0,0 +1,10 @@
+package com.amazonaws.services.lambda.runtime.api.client.runtimeapi;
+
+/**
+ * Copyright (c) 2019 Amazon. All rights reserved.
+ */
+public class UnknownPlatformException extends RuntimeException {
+    public UnknownPlatformException(String message) {
+        super(message);
+    }
+}

aws-lambda-java-runtime-interface-client/src/main/jni/build-jni-lib.sh

@@ -7,18 +7,25 @@ SRC_DIR=$(dirname "$0")
 DST_DIR=${1}
 CURL_VERSION=7.77.0
 
-# compile the native library for x86
-mkdir "${DST_DIR}"/classes/x86
-docker build --platform=linux/amd64 -f "${SRC_DIR}/Dockerfile.glibc" --build-arg CURL_VERSION=${CURL_VERSION} -t lambda-java-jni-lib-glibc-x86 "${SRC_DIR}"
-docker run --rm --entrypoint /bin/cat lambda-java-jni-lib-glibc-x86 /src/aws-lambda-runtime-interface-client.so > "${DST_DIR}"/classes/x86/aws-lambda-runtime-interface-client.glibc.so
+# Not using associative arrays to maintain bash 3 compatibility with building on MacOS
+# MacOS ships with bash 3 and associative arrays require bash 4+
+# Declaring a map as an array with the column character as a separator :
+declare -a ARCHITECTURES_TO_PLATFORM=(
+    "x86_64:linux/amd64"
+    "arm64:linux/arm64/v8"
+)
 
-docker build --platform=linux/amd64 -f "${SRC_DIR}/Dockerfile.musl" --build-arg CURL_VERSION=${CURL_VERSION} -t lambda-java-jni-lib-musl-x86 "${SRC_DIR}"
-docker run --rm --entrypoint /bin/cat lambda-java-jni-lib-musl-x86 /src/aws-lambda-runtime-interface-client.so > "${DST_DIR}"/classes/x86/aws-lambda-runtime-interface-client.musl.so
+declare -a TARGETS=("glibc" "musl")
 
-# compile the native library for ARM
-mkdir "${DST_DIR}"/classes/arm
-docker build --platform=linux/arm64/v8 -f "${SRC_DIR}/Dockerfile.glibc" --build-arg CURL_VERSION=${CURL_VERSION} -t lambda-java-jni-lib-glibc-arm "${SRC_DIR}"
-docker run --rm --entrypoint /bin/cat lambda-java-jni-lib-glibc-arm /src/aws-lambda-runtime-interface-client.so > "${DST_DIR}"/classes/arm/aws-lambda-runtime-interface-client.glibc.so
+for pair in "${ARCHITECTURES_TO_PLATFORM[@]}"; do
+    arch=${pair%%:*}
+    platform=${pair#*:}
 
-docker build --platform=linux/arm64/v8 -f "${SRC_DIR}/Dockerfile.musl" --build-arg CURL_VERSION=${CURL_VERSION} -t lambda-java-jni-lib-musl-arm "${SRC_DIR}"
-docker run --rm --entrypoint /bin/cat lambda-java-jni-lib-musl-arm /src/aws-lambda-runtime-interface-client.so > "${DST_DIR}"/classes/arm/aws-lambda-runtime-interface-client.musl.so
+    mkdir -p "${DST_DIR}"/classes/"${arch}"
+
+    for target in "${TARGETS[@]}"; do
+        echo "Compiling the native library for target ${target} on architecture ${arch} using Docker platform ${platform}"
+        docker build --platform="${platform}" -f "${SRC_DIR}"/Dockerfile."${target}" --build-arg CURL_VERSION=${CURL_VERSION} -t lambda-java-jni-lib-"${target}"-"${arch}" "${SRC_DIR}"
+        docker run --rm --entrypoint /bin/cat lambda-java-jni-lib-"${target}"-"${arch}" /src/aws-lambda-runtime-interface-client.so > "${DST_DIR}"/classes/"${arch}"/aws-lambda-runtime-interface-client."${target}".so
+    done
+done