Skip to contentSkip to conversation

sanity.bbclass: check TMPDIR is not too long

PATCH In review Robert Yang 2 participants 6 messages May 8, 2012 – May 22, 2012

lore
Share & tools
lore
#0 lore raw

cover sanity.bbclass: check TMPDIR is not too long

Here are the output message:
* When the length of TMPDIR is longer than 180:
The path length of TMPDIR is too long, this would cause the "Argument list too long" error, please use a shorter path.

// Robert

The following changes since commit 2929e7d590862d9649458c90804e79a1dce40423:

glib-2.0: Fix issues with libelf dependency creeping in (2012-05-07 10:53:24 +0100)

are available in the git repository at:
git://git.pokylinux.org/poky-contrib robert/tmpdir
http://git.pokylinux.org/cgit.cgi/poky-contrib/log/?h=robert/tmpdir

Robert Yang (1):
sanity.bbclass: check TMPDIR is not too long

 meta/classes/sanity.bbclass |   11 +++++++++++
 1 files changed, 11 insertions(+), 0 deletions(-)
#1 lore raw

PATCH 1/1 sanity.bbclass: check TMPDIR is not too long

When the length of TMPDIR is longer than a threshold, there would be an "Argument list too long" error when building gcc-cross, this is the error from the exec(), the maximum length of argument is defined in /usr/include/linux/limits.h:

  #define ARG_MAX       131072    /* # bytes of args + environ for exec() */

It's hard to determine the threshold of the TMPDIR, here is the experimental value:
len(TMPDIR) = 182 Success
len(TMPDIR) = 192 Failed

So set the maximum length of TMPDIR to 180 seems proper.

[YOCTO #2434]

---
 meta/classes/sanity.bbclass |   11 +++++++++++
 1 files changed, 11 insertions(+), 0 deletions(-)
meta/classes/sanity.bbclass +11 -0
index 687ddeb..6aaac1e 100644
@@ -30,6 +30,7 @@ def check_sanity_sstate_dir_change(sstate_dir, data):
     testmsg = ""
     if sstate_dir != "":
         testmsg = check_create_long_filename(sstate_dir, "SSTATE_DIR")
+
     return testmsg
 
 def check_sanity_tmpdir_change(tmpdir, data):
@@ -83,6 +84,12 @@ def check_create_long_filename(filepath, pathname):
             return "Failed to create a file in %s: %s" % (pathname, strerror)
     return ""
 
+def check_long_path(filepath, pathname):
+    # The 180 is just an empirical value
+    if len(filepath) > 180:
+	return "The path length of %s is too long, this would cause the \"Argument list too long\" error, please use a shorter path.\n" % pathname
+    return ""
+
 def check_connectivity(d):
     # URI's to check can be set in the CONNECTIVITY_CHECK_URIS variable
     # using the same syntax as for SRC_URI. If the variable is not set
@@ -353,6 +360,10 @@ def check_sanity(e):
     tmpdir = data.getVar('TMPDIR', e.data, True)
     sstate_dir = data.getVar('SSTATE_DIR', e.data, True)
 
+    # Check whether the length of TMPDIR is too long to cause the
+    # argument list too long error
+    messages = messages + check_long_path(tmpdir, "TMPDIR")
+
     # Check saved sanity info
     last_sanity_version = 0
     last_tmpdir = ""
Signature · 1 line
1.7.1
#2 lore raw
Quoted 26 lines · Robert Yang

When the length of TMPDIR is longer than a threshold, there would be an "Argument list too long" error when building gcc-cross, this is the error from the exec(), the maximum length of argument is defined in /usr/include/linux/limits.h:

   #define ARG_MAX       131072    /* # bytes of args + environ for exec() */

It's hard to determine the threshold of the TMPDIR, here is the experimental value:
len(TMPDIR) = 182 Success
len(TMPDIR) = 192 Failed

So set the maximum length of TMPDIR to 180 seems proper.

[YOCTO #2434]

---
  meta/classes/sanity.bbclass |   11 +++++++++++
  1 files changed, 11 insertions(+), 0 deletions(-)
meta/classes/sanity.bbclass +0 -0
index 687ddeb..6aaac1e 100644

meta/classes/sanity.bbclass def check_sanity_sstate_dir_change(sstate_dir, data): · line 33

Quoted 4 lines
meta/classes/sanity.bbclass +1 -0
@@ -30,6 +30,7 @@ def check_sanity_sstate_dir_change(sstate_dir, data):
      testmsg = ""
      if sstate_dir != "":
          testmsg = check_create_long_filename(sstate_dir, "SSTATE_DIR")
+

Sorry, here has a unexpected blank line, I've removed it and pushed to:

git://git.pokylinux.org/poky-contrib robert/tmpdir

// Robert

Quoted 27 lines
meta/classes/sanity.bbclass +10 -0
      return testmsg
 
  def check_sanity_tmpdir_change(tmpdir, data):
@@ -83,6 +84,12 @@ def check_create_long_filename(filepath, pathname):
              return "Failed to create a file in %s: %s" % (pathname, strerror)
      return ""
 
+def check_long_path(filepath, pathname):
+    # The 180 is just an empirical value
+    if len(filepath)>  180:
+	return "The path length of %s is too long, this would cause the \"Argument list too long\" error, please use a shorter path.\n" % pathname
+    return ""
+
  def check_connectivity(d):
      # URI's to check can be set in the CONNECTIVITY_CHECK_URIS variable
      # using the same syntax as for SRC_URI. If the variable is not set
@@ -353,6 +360,10 @@ def check_sanity(e):
      tmpdir = data.getVar('TMPDIR', e.data, True)
      sstate_dir = data.getVar('SSTATE_DIR', e.data, True)
 
+    # Check whether the length of TMPDIR is too long to cause the
+    # argument list too long error
+    messages = messages + check_long_path(tmpdir, "TMPDIR")
+
      # Check saved sanity info
      last_sanity_version = 0
      last_tmpdir = ""
#3 lore raw
In reply to Robert Yang
Quoted 5 lines · Robert Yang

When the length of TMPDIR is longer than a threshold, there would be an "Argument list too long" error when building gcc-cross, this is the error from the exec(), the maximum length of argument is defined in /usr/include/linux/limits.h:

Quoted 8 lines
  #define ARG_MAX       131072    /* # bytes of args + environ for exec() */

It's hard to determine the threshold of the TMPDIR, here is the experimental value:
len(TMPDIR) = 182 Success
len(TMPDIR) = 192 Failed

So set the maximum length of TMPDIR to 180 seems proper.

It seems a bit lame for paths to be restricted to such a short length. How does a 192-byte TMPDIR end up causing more than 131072 bytes of arguments and environment? Can anything be done to reduce that? For example, can you use "gcc @..." to remove common options from the command line? Can you eliminate garbage from the environment that doesn't need to be there?

p.

#4 lore raw

Hi Phil,

Thanks for your reply, please see my comments inline ...

Quoted 13 lines · Phil Blundell
Quoted 12 lines · Robert Yang

When the length of TMPDIR is longer than a threshold, there would be an "Argument list too long" error when building gcc-cross, this is the error from the exec(), the maximum length of argument is defined in /usr/include/linux/limits.h:

   #define ARG_MAX       131072    /* # bytes of args + environ for exec() */

It's hard to determine the threshold of the TMPDIR, here is the experimental value:
len(TMPDIR) = 182 Success
len(TMPDIR) = 192 Failed

Quoted 6 lines
Quoted 1 line

So set the maximum length of TMPDIR to 180 seems proper.

It seems a bit lame for paths to be restricted to such a short length. How does a 192-byte TMPDIR end up causing more than 131072 bytes of arguments and environment? Can anything be done to reduce that? For example, can you use "gcc @..." to remove common options from the

It doesn't error at the compile stage, but at the install stage, this is caused by:

gcc-cross-4.6.3+svnr184847-r24/gcc-4_6-branch/build.x86_64-linux.arm-poky-linux-gnueabi/gcc/Makefile:

install-plugin: installdirs lang.install-plugin s-header-vars # We keep the directory structure for files in config and .def files. All

# other files are flattened to a single directory.
        $(mkinstalldirs) $(DESTDIR)$(plugin_includedir)
        headers=`echo $(PLUGIN_HEADERS) | tr ' ' '\012' | sort -u`; \
        srcdirstrip=`echo "$(srcdir)" | sed 's/[].[^$$\\*|]/\\\\&/g'`; \
        for file in $$headers; do \
	...

The error will happen at the "for" loop when there are many files in $headers, we can fix the Makefile, but if we don't limit the length of TMPDIR, the similar error would come out sooner or later since other pkgs may have the similar issue, so I think that limit the length of TMPDIR may be a better choice. It seems that seldom people will use a TMPDIR longer than 180 characters, this is just a prevention.

// Robert

Quoted 12 lines

command line? Can you eliminate garbage from the environment that doesn't need to be there?

p.

_______________________________________________
Openembedded-core mailing list
[email protected]
http://lists.linuxtogo.org/cgi-bin/mailman/listinfo/openembedded-core

#5 lore raw
In reply to Robert Yang

I've rebased the code to the up-to-date master branch, and pushed to:

git://git.pokylinux.org/poky-contrib robert/tmpdir
http://git.pokylinux.org/cgit.cgi/poky-contrib/log/?h=robert/tmpdir

// Robert

Quoted 57 lines · Robert Yang

When the length of TMPDIR is longer than a threshold, there would be an "Argument list too long" error when building gcc-cross, this is the error from the exec(), the maximum length of argument is defined in /usr/include/linux/limits.h:

   #define ARG_MAX       131072    /* # bytes of args + environ for exec() */

It's hard to determine the threshold of the TMPDIR, here is the experimental value:
len(TMPDIR) = 182 Success
len(TMPDIR) = 192 Failed

So set the maximum length of TMPDIR to 180 seems proper.

[YOCTO #2434]

---
  meta/classes/sanity.bbclass |   11 +++++++++++
  1 files changed, 11 insertions(+), 0 deletions(-)
meta/classes/sanity.bbclass +11 -0
index 687ddeb..6aaac1e 100644
@@ -30,6 +30,7 @@ def check_sanity_sstate_dir_change(sstate_dir, data):
      testmsg = ""
      if sstate_dir != "":
          testmsg = check_create_long_filename(sstate_dir, "SSTATE_DIR")
+
      return testmsg
 
  def check_sanity_tmpdir_change(tmpdir, data):
@@ -83,6 +84,12 @@ def check_create_long_filename(filepath, pathname):
              return "Failed to create a file in %s: %s" % (pathname, strerror)
      return ""
 
+def check_long_path(filepath, pathname):
+    # The 180 is just an empirical value
+    if len(filepath)>  180:
+	return "The path length of %s is too long, this would cause the \"Argument list too long\" error, please use a shorter path.\n" % pathname
+    return ""
+
  def check_connectivity(d):
      # URI's to check can be set in the CONNECTIVITY_CHECK_URIS variable
      # using the same syntax as for SRC_URI. If the variable is not set
@@ -353,6 +360,10 @@ def check_sanity(e):
      tmpdir = data.getVar('TMPDIR', e.data, True)
      sstate_dir = data.getVar('SSTATE_DIR', e.data, True)
 
+    # Check whether the length of TMPDIR is too long to cause the
+    # argument list too long error
+    messages = messages + check_long_path(tmpdir, "TMPDIR")
+
      # Check saved sanity info
      last_sanity_version = 0
      last_tmpdir = ""