Skip to contentSkip to conversation

sanity.bbclass: warn on .cargo/config.toml outside the build tree

PATCH Superseded [email protected] 2 participants 3 messages Jun 24 – Jun 25

v1 of 3 Superseded Latest is v3 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 sanity.bbclass: warn on .cargo/config.toml outside the build tree

From: Hemanth Kumar M D <[email protected]>

Cargo walks from CWD up to the filesystem root merging every .cargo/config.toml it finds. Any such file above TOPDIR is silently picked up and can override Yocto's linker, registry or compiler settings, leading to build failures.

Until cargo provides a proper fix upstream, add a warning so users get a clear diagnostic instead of a build error.

Upstream meta-issue: https://github.com/rust-lang/cargo/issues/9769

[YOCTO #15637]

---
 meta/classes-global/sanity.bbclass | 33 ++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)
meta/classes-global/sanity.bbclass +33 -0
index bdfa7f059d..c67c7b8f03 100644
@@ -854,6 +854,38 @@ def sanity_check_locale(d):
     except locale.Error:
         raise_sanity_error("Your system needs to support the en_US.UTF-8 locale.", d)
 
+def check_cargo_config(d):
+    # Cargo merges .cargo/config.toml from every directory between CWD and
+    # the filesystem root. Warn for anything found in ancestor directories
+    # above TOPDIR that Cargo would pick up silently.
+    import os
+
+    topdir = d.getVar('TOPDIR')
+    ancestor = os.path.dirname(topdir)
+    found = []
+    last_ancestor = None
+    while True:
+        for name in ('config.toml', 'config'):
+            cfg = os.path.join(ancestor, '.cargo', name)
+            if os.path.exists(cfg):
+                found.append(cfg)
+                last_ancestor = ancestor
+                break
+        parent = os.path.dirname(ancestor)
+        if parent == ancestor:
+            break
+        ancestor = parent
+
+    if found:
+        bb.warn("Cargo config file(s) found at %s which is/are outside the build "
+                "directory. Cargo will silently apply their settings during the "
+                "rust/cargo build and can override Yocto's settings like linker, "
+                "registry or compiler settings causing build failures. You can "
+                "either remove these file(s) or move your build directory outside "
+                "of %s to fix this. "
+                "See https://bugzilla.yoctoproject.org/show_bug.cgi?id=15637 for more details."
+                % (', '.join(found), last_ancestor))
+
 def check_sanity_everybuild(status, d):
     import os, stat
     # Sanity tests which test the users environment so need to run at each build (or are so cheap
@@ -873,6 +905,7 @@ def check_sanity_everybuild(status, d):
         status.addresult('Bitbake version %s is required and version %s was found\n' % (minversion, bb.__version__))
 
     sanity_check_locale(d)
+    check_cargo_config(d)
 
     paths = d.getVar('PATH').split(":")
     if "." in paths or "./" in paths or "" in paths:
Signature · 1 line
2.49.0
#1 lore raw
Quoted 24 lines · Hemanth Kumar M D via lists.openembedded.org

From: Hemanth Kumar M D <[email protected]>

Cargo walks from CWD up to the filesystem root merging every .cargo/config.toml it finds. Any such file above TOPDIR is silently picked up and can override Yocto's linker, registry or compiler settings, leading to build failures.

Until cargo provides a proper fix upstream, add a warning so users get a clear diagnostic instead of a build error.

Upstream meta-issue: https://github.com/rust-lang/cargo/issues/9769

[YOCTO #15637]

---
 meta/classes-global/sanity.bbclass | 33 ++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)
meta/classes-global/sanity.bbclass +0 -0
index bdfa7f059d..c67c7b8f03 100644

meta/classes-global/sanity.bbclass def sanity_check_locale(d): · line 863

Quoted 10 lines
meta/classes-global/sanity.bbclass +7 -0
@@ -854,6 +854,38 @@ def sanity_check_locale(d):
     except locale.Error:
         raise_sanity_error("Your system needs to support the en_US.UTF-8 locale.", d)
 
+def check_cargo_config(d):
+    # Cargo merges .cargo/config.toml from every directory between CWD and
+    # the filesystem root. Warn for anything found in ancestor directories
+    # above TOPDIR that Cargo would pick up silently.
+    import os
+
+    topdir = d.getVar('TOPDIR')

TMPDIR and each package's WORKDIR are under TOPDIR by default, but this can be overridden. Perhaps we should be checking ancestors of BASE_WORKDIR instead.

meta/classes-global/sanity.bbclass def sanity_check_locale(d): · line 873

Quoted 10 lines
meta/classes-global/sanity.bbclass +10 -0
+    ancestor = os.path.dirname(topdir)
+    found = []
+    last_ancestor = None
+    while True:
+        for name in ('config.toml', 'config'):
+            cfg = os.path.join(ancestor, '.cargo', name)
+            if os.path.exists(cfg):
+                found.append(cfg)
+                last_ancestor = ancestor
+                break

This break should be dropped so that we tell the user about all offending Cargo config files.

The rest of this patch LGTM, thanks!

Best regards,

Signature · 1 line
Paul Barker
#2 lore raw
Quoted 29 lines · Paul Barker
Quoted 27 lines · Hemanth Kumar M D via lists.openembedded.org

From: Hemanth Kumar M D <[email protected]>

Cargo walks from CWD up to the filesystem root merging every .cargo/config.toml it finds. Any such file above TOPDIR is silently picked up and can override Yocto's linker, registry or compiler settings, leading to build failures.

Until cargo provides a proper fix upstream, add a warning so users get a clear diagnostic instead of a build error.

Upstream meta-issue: https://github.com/rust-lang/cargo/issues/9769

[YOCTO #15637]

---
  meta/classes-global/sanity.bbclass | 33 ++++++++++++++++++++++++++++++
  1 file changed, 33 insertions(+)
meta/classes-global/sanity.bbclass +0 -0
index bdfa7f059d..c67c7b8f03 100644
@@ -854,6 +854,38 @@ def sanity_check_locale(d):
      except locale.Error:
          raise_sanity_error("Your system needs to support the en_US.UTF-8 locale.", d)
 
Quoted 7 lines

meta/classes-global/sanity.bbclass def sanity_check_locale(d): · line 863

Quoted 7 lines
meta/classes-global/sanity.bbclass +7 -0
+def check_cargo_config(d):
+    # Cargo merges .cargo/config.toml from every directory between CWD and
+    # the filesystem root. Warn for anything found in ancestor directories
+    # above TOPDIR that Cargo would pick up silently.
+    import os
+
+    topdir = d.getVar('TOPDIR')

Hi Paul,

Thanks for the review!

please find the v2 - https://lists.openembedded.org/g/openembedded-core/topic/patch_v2_sanity_bbclass/119970000

Quoted 3 lines

TMPDIR and each package's WORKDIR are under TOPDIR by default, but this can be overridden. Perhaps we should be checking ancestors of BASE_WORKDIR instead.

Agreed, updated to use BASE_WORKDIR in v2.

Quoted 10 lines

meta/classes-global/sanity.bbclass def sanity_check_locale(d): · line 873

Quoted 10 lines
meta/classes-global/sanity.bbclass +10 -0
+    ancestor = os.path.dirname(topdir)
+    found = []
+    last_ancestor = None
+    while True:
+        for name in ('config.toml', 'config'):
+            cfg = os.path.join(ancestor, '.cargo', name)
+            if os.path.exists(cfg):
+                found.append(cfg)
+                last_ancestor = ancestor
+                break
Quoted 2 lines

This break should be dropped so that we tell the user about all offending Cargo config files.

Keeping the break ,
  Cargo docs say if both 'config' and 'config.toml'
  exist in the same directory, only 'config' is read. So only one file per directory is ever active. I've also fixed the probe order to check 'config' before 'config.toml' to match this.
  Ref: https://doc.rust-lang.org/cargo/reference/config.html

Quoted 4 lines

The rest of this patch LGTM, thanks!

Best regards,

Signature · 2 lines
Regards,
Hemanth Kumar M D