builder-options: Set RUSTFLAGS in builder environment

This inherits the SDK provided rustflags by default

Fixes: #693

Author: bbhtt

NEWS

@@ -11,7 +11,7 @@ TBD
 * Support setting state-dir for run
 * Default to builddir true for cmake and cmake-ninja buildsystems
 * Handle case-insensitive YAML boolean and null scalars
-* Support setting CGO buildflags in builder environment
+* Support setting CGO buildflags and RUSTFLAGS in builder environment
 
 Changes in 1.4.6
 ================

data/flatpak-manifest.schema.json

@@ -74,6 +74,14 @@
           "description": "If this is true, clear cgo-ldflags from previous build options before adding it from these options. If set without cgo-ldflags, CGO_LDFLAGS will not be set.",
           "type": "boolean"
         },
+        "rustflags": {
+          "description": "This is set in the environment variable RUSTFLAGS during the build. Multiple specifications of this (in e.g. per-arch area) are concatenated, separated by spaces.",
+          "type": "string"
+        },
+        "rustflags-override": {
+          "description": "If this is true, clear rustflags from previous build options before adding it from these options.",
+          "type": "boolean"
+        },
         "prefix": {
           "description": "The build prefix for the modules (defaults to /app for applications and /usr for runtimes).",
           "type": "string"

doc/flatpak-manifest.xml

@@ -364,6 +364,14 @@
                     <term><option>cgo-ldflags-override</option> (boolean)</term>
                     <listitem><para>If this is true, clear cgo-ldflags from previous build options before adding it from these options. If set without cgo-ldflags, CGO_LDFLAGS will not be set.</para></listitem>
                 </varlistentry>
+                <varlistentry>
+                    <term><option>rustflags</option> (string)</term>
+                    <listitem><para>This is set in the environment variable RUSTFLAGS during the build. Multiple specifications of this (in e.g. per-arch area) are concatenated, separated by spaces.</para></listitem>
+                </varlistentry>
+                <varlistentry>
+                    <term><option>rustflags-override</option> (boolean)</term>
+                    <listitem><para>If this is true, clear rustflags from previous build options before adding it from these options.</para></listitem>
+                </varlistentry>
                 <varlistentry>
                     <term><option>prefix</option> (string)</term>
                     <listitem><para>The build prefix for the modules (defaults to <filename>/app</filename> for

src/builder-options.c

@@ -53,6 +53,8 @@ struct BuilderOptions
   gboolean    ldflags_override;
   char       *cgo_ldflags;
   gboolean    cgo_ldflags_override;
+  char       *rustflags;
+  gboolean    rustflags_override;
   char       *append_path;
   char       *prepend_path;
   char       *append_ld_library_path;
@@ -98,6 +100,8 @@ enum {
   PROP_LDFLAGS_OVERRIDE,
   PROP_CGO_LDFLAGS,
   PROP_CGO_LDFLAGS_OVERRIDE,
+  PROP_RUSTFLAGS,
+  PROP_RUSTFLAGS_OVERRIDE,
   PROP_PREFIX,
   PROP_LIBDIR,
   PROP_ENV,
@@ -134,6 +138,7 @@ builder_options_finalize (GObject *object)
   g_free (self->cppflags);
   g_free (self->ldflags);
   g_free (self->cgo_ldflags);
+  g_free (self->rustflags);
   g_free (self->append_path);
   g_free (self->prepend_path);
   g_free (self->append_ld_library_path);
@@ -221,6 +226,14 @@ builder_options_get_property (GObject    *object,
       g_value_set_boolean (value, self->cgo_ldflags_override);
       break;
 
+    case PROP_RUSTFLAGS:
+      g_value_set_string (value, self->rustflags);
+      break;
+
+    case PROP_RUSTFLAGS_OVERRIDE:
+      g_value_set_boolean (value, self->rustflags_override);
+      break;
+
     case PROP_APPEND_PATH:
       g_value_set_string (value, self->append_path);
       break;
@@ -380,6 +393,15 @@ builder_options_set_property (GObject      *object,
       self->cgo_ldflags_override = g_value_get_boolean (value);
       break;
 
+    case PROP_RUSTFLAGS:
+      g_clear_pointer (&self->rustflags, g_free);
+      self->rustflags = g_value_dup_string (value);
+      break;
+
+    case PROP_RUSTFLAGS_OVERRIDE:
+      self->rustflags_override = g_value_get_boolean (value);
+      break;
+
     case PROP_APPEND_PATH:
       g_clear_pointer (&self->append_path, g_free);
       self->append_path = g_value_dup_string (value);
@@ -598,6 +620,20 @@ builder_options_class_init (BuilderOptionsClass *klass)
                                                          "",
                                                          FALSE,
                                                          G_PARAM_READWRITE));
+  g_object_class_install_property (object_class,
+                                   PROP_RUSTFLAGS,
+                                   g_param_spec_string ("rustflags",
+                                                        "",
+                                                        "",
+                                                        NULL,
+                                                        G_PARAM_READWRITE));
+  g_object_class_install_property (object_class,
+                                   PROP_RUSTFLAGS_OVERRIDE,
+                                   g_param_spec_boolean ("rustflags-override",
+                                                         "",
+                                                         "",
+                                                         FALSE,
+                                                         G_PARAM_READWRITE));
   g_object_class_install_property (object_class,
                                    PROP_APPEND_PATH,
                                    g_param_spec_string ("append-path",
@@ -1087,6 +1123,15 @@ builder_options_get_cgo_ldflags (BuilderOptions *self, BuilderContext *context)
                                     ldflags);
 }
 
+char *
+builder_options_get_rustflags (BuilderOptions *self, BuilderContext *context)
+{
+  return builder_options_get_flags (self, context,
+                                    G_STRUCT_OFFSET (BuilderOptions, rustflags),
+                                    G_STRUCT_OFFSET (BuilderOptions, rustflags_override),
+                                    get_sdk_flags (self, context, builder_sdk_config_get_rustflags));
+}
+
 static char *
 builder_options_get_appended_path (BuilderOptions *self, BuilderContext *context, const char *initial_value, size_t append_field_offset, size_t prepend_field_offset)
 {
@@ -1283,6 +1328,7 @@ builder_options_get_env (BuilderOptions *self, BuilderContext *context)
   g_autofree char *cgo_cxxflags = NULL;
   g_autofree char *ldflags = NULL;
   g_autofree char *cgo_ldflags = NULL;
+  g_autofree char *rustflags = NULL;
 
   envp = builder_context_extend_env_pre (context, envp);
 
@@ -1314,6 +1360,10 @@ builder_options_get_env (BuilderOptions *self, BuilderContext *context)
   if (cgo_ldflags)
     envp = g_environ_setenv (envp, "CGO_LDFLAGS", cgo_ldflags, FALSE);
 
+  rustflags = builder_options_get_rustflags (self, context);
+  if (rustflags)
+    envp = g_environ_setenv (envp, "RUSTFLAGS", rustflags, FALSE);
+
   /* We traverse in reverse order because the list is "last first" */
   for (l = g_list_last (options); l != NULL; l = l->prev)
     {
@@ -1561,6 +1611,8 @@ builder_options_checksum (BuilderOptions *self,
   builder_cache_checksum_compat_boolean (cache, self->ldflags_override);
   builder_cache_checksum_str (cache, self->cgo_ldflags);
   builder_cache_checksum_compat_boolean (cache, self->cgo_ldflags_override);
+  builder_cache_checksum_str (cache, self->rustflags);
+  builder_cache_checksum_compat_boolean (cache, self->rustflags_override);
   builder_cache_checksum_str (cache, self->prefix);
   builder_cache_checksum_compat_str (cache, self->libdir);
   builder_cache_checksum_strv (cache, self->env);

src/builder-options.h

@@ -51,6 +51,8 @@ char *builder_options_get_ldflags (BuilderOptions *self,
                                    BuilderContext *context);
 char *builder_options_get_cgo_ldflags (BuilderOptions *self,
                                        BuilderContext *context);
+char *builder_options_get_rustflags (BuilderOptions *self,
+                                     BuilderContext *context);
 const char *builder_options_get_prefix (BuilderOptions *self,
                                         BuilderContext *context);
 const char *builder_options_get_libdir (BuilderOptions *self,

src/builder-sdk-config.c

@@ -30,6 +30,7 @@ struct BuilderSdkConfig {
   char         *cflags;
   char         *cxxflags;
   char         *ldflags;
+  char         *rustflags;
 };
 
 typedef struct
@@ -49,6 +50,7 @@ builder_sdk_config_finalize (GObject *object)
   g_free (self->cflags);
   g_free (self->cxxflags);
   g_free (self->ldflags);
+  g_free (self->rustflags);
 
   G_OBJECT_CLASS (builder_sdk_config_parent_class)->finalize (object);
 }
@@ -60,6 +62,7 @@ enum {
   PROP_CFLAGS,
   PROP_CXXFLAGS,
   PROP_LDFLAGS,
+  PROP_RUSTFLAGS,
   LAST_PROP
 };
 
@@ -93,6 +96,10 @@ builder_sdk_config_get_property (GObject    *object,
       g_value_set_string (value, self->ldflags);
       break;
 
+    case PROP_RUSTFLAGS:
+      g_value_set_string (value, self->rustflags);
+      break;
+
     default:
       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
     }
@@ -132,6 +139,11 @@ builder_sdk_config_set_property (GObject      *object,
       g_free (self->ldflags);
       self->ldflags = g_value_dup_string(value);
       break ;
+
+    case PROP_RUSTFLAGS:
+      g_free (self->rustflags);
+      self->rustflags = g_value_dup_string(value);
+      break ;
     default:
       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
     }
@@ -181,6 +193,13 @@ builder_sdk_config_class_init (BuilderSdkConfigClass *klass)
                                                         "",
                                                         NULL,
                                                         G_PARAM_READWRITE));
+  g_object_class_install_property (object_class,
+                                   PROP_RUSTFLAGS,
+                                   g_param_spec_string ("rustflags",
+                                                        "",
+                                                        "",
+                                                        NULL,
+                                                        G_PARAM_READWRITE));
 }
 
 static void
@@ -219,6 +238,12 @@ builder_sdk_config_get_ldflags (BuilderSdkConfig *self)
   return self->ldflags;
 }
 
+const char *
+builder_sdk_config_get_rustflags (BuilderSdkConfig *self)
+{
+  return self->rustflags;
+}
+
 BuilderSdkConfig *
 builder_sdk_config_from_file (GFile    *file,
                               GError  **error)

src/builder-sdk-config.h

@@ -38,6 +38,7 @@ const char *      builder_sdk_config_get_cppflags (BuilderSdkConfig  *self);
 const char *      builder_sdk_config_get_cflags   (BuilderSdkConfig  *self);
 const char *      builder_sdk_config_get_cxxflags (BuilderSdkConfig  *self);
 const char *      builder_sdk_config_get_ldflags  (BuilderSdkConfig  *self);
+const char *      builder_sdk_config_get_rustflags  (BuilderSdkConfig  *self);
 
 BuilderSdkConfig *builder_sdk_config_from_file    (GFile             *file,
                                                    GError           **error);

tests/test-builder-flags.sh

@@ -23,7 +23,7 @@ set -euo pipefail
 
 skip_without_fuse
 
-echo "1..4"
+echo "1..7"
 
 setup_repo
 install_repo
@@ -145,3 +145,88 @@ run_build test-cgo-only-override.json
 assert_file_has_content appdir/files/cgo_cflags_out '^unset$'
 
 echo "ok only cgo-cflags-override clears CGO_CFLAGS"
+
+# Default: RUSTFLAGS should be passed. The test SDK does not ship with
+# defaults so it is set here via rustflags explicitly.
+cat > test-rustflags-set.json <<'EOF'
+{
+    "app-id": "org.test.RustflagsSet",
+    "runtime": "org.test.Platform",
+    "sdk": "org.test.Sdk",
+    "build-options": {
+        "rustflags": "-C opt-level=2"
+    },
+    "modules": [{
+        "name": "test",
+        "buildsystem": "simple",
+        "build-commands": [
+            "echo ${RUSTFLAGS} > /app/rustflags_out"
+        ]
+    }]
+}
+EOF
+
+run_build test-rustflags-set.json
+
+assert_file_has_content appdir/files/rustflags_out '\-C opt\-level=2'
+
+echo "ok rustflags is passed by default"
+
+# rustflags-override at module level clears manifest-level rustflags
+# or equivalently clears SDK rustflags
+cat > test-rustflags-override.json <<'EOF'
+{
+    "app-id": "org.test.RustflagsOverride",
+    "runtime": "org.test.Platform",
+    "sdk": "org.test.Sdk",
+    "build-options": {
+        "rustflags": "-C debuginfo=0"
+    },
+    "modules": [{
+        "name": "test",
+        "buildsystem": "simple",
+        "build-options": {
+            "rustflags": "-C opt-level=3",
+            "rustflags-override": true
+        },
+        "build-commands": [
+            "echo ${RUSTFLAGS} > /app/rustflags_out"
+        ]
+    }]
+}
+EOF
+
+run_build test-rustflags-override.json
+
+assert_file_has_content appdir/files/rustflags_out '\-C opt\-level=3'
+assert_not_file_has_content appdir/files/rustflags_out 'debuginfo'
+
+echo "ok rustflags-override at module level clears manifest-level rustflags"
+
+# Only rustflags-override is set, rustflags should be cleared
+cat > test-rustflags-only-override.json <<'EOF'
+{
+    "app-id": "org.test.RustflagsOnlyOverride",
+    "runtime": "org.test.Platform",
+    "sdk": "org.test.Sdk",
+    "build-options": {
+        "rustflags": "-C debuginfo=0"
+    },
+    "modules": [{
+        "name": "test",
+        "buildsystem": "simple",
+        "build-options": {
+            "rustflags-override": true
+        },
+        "build-commands": [
+            "echo ${RUSTFLAGS:-unset} > /app/rustflags_out"
+        ]
+    }]
+}
+EOF
+
+run_build test-rustflags-only-override.json
+
+assert_file_has_content appdir/files/rustflags_out '^unset$'
+
+echo "ok only rustflags-override clears rustflags"