[v2,1/5] glibcextract.py: Add compile_c_snippet

Message ID 20220810172447.1502169-2-adhemerval.zanella@linaro.org
State Superseded
Headers
Series Fix sys/mount.h and kernel header tests |

Checks

Context Check Description
dj/TryBot-apply_patch success Patch applied to master at the time it was sent

Commit Message

Adhemerval Zanella Netto Aug. 10, 2022, 5:24 p.m. UTC
  It might be used on tests to check if a snippet build with the provided
compiler and flags.
---
 scripts/glibcextract.py | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)
  

Comments

Florian Weimer Aug. 10, 2022, 5:35 p.m. UTC | #1
* Adhemerval Zanella:

> It might be used on tests to check if a snippet build with the provided
> compiler and flags.
> ---
>  scripts/glibcextract.py | 20 ++++++++++++++++++++
>  1 file changed, 20 insertions(+)
>
> diff --git a/scripts/glibcextract.py b/scripts/glibcextract.py
> index 43ab58ffe2..71d9ea1acc 100644
> --- a/scripts/glibcextract.py
> +++ b/scripts/glibcextract.py
> @@ -21,6 +21,7 @@ import os.path
>  import re
>  import subprocess
>  import tempfile
> +import collections

Please keep the imports sorted.

>  def compute_c_consts(sym_data, cc):
> @@ -173,3 +174,22 @@ def compare_macro_consts(source_1, source_2, cc, macro_re, exclude_re=None,
>              if not allow_extra_2:
>                  ret = 1
>      return ret
> +
> +CompileResult = collections.namedtuple("CompileResult", "returncode output")
> +
> +def compile_c_snippet(snippet, cc, extra_cc_args=""):
> +    """Compile and return whether the SNIPPET can be build with CC along
> +       EXTRA_CC_ARGS compiler flags.  Return a CompileResult with RETURNCODE
> +       being 0 for success, or the failure value and the compiler output.
> +    """
> +    with tempfile.TemporaryDirectory() as temp_dir:
> +        c_file_name = os.path.join(temp_dir, 'test.c')
> +        obj_file_name = os.path.join(temp_dir, 'test.o')
> +        with open(c_file_name, 'w') as c_file:
> +            c_file.write(snippet)
> +        # Compilation has to be from stdin to avoid the temporary file
> +        # name being written into the generated dependencies.
> +        cmd = ('%s %s -c -o %s -x c - < %s' % (cc, extra_cc_args,
> +            obj_file_name, c_file_name))
> +        r = subprocess.run(cmd, shell=True, capture_output=True)
> +        return CompileResult(r.returncode, r.stderr)

I think you can avoid shell=True and the direction if you just compile
c_file_name directly.  Sorry, missed that earlier.

Thanks,
Florian
  
Florian Weimer Aug. 10, 2022, 5:38 p.m. UTC | #2
* Adhemerval Zanella:

> It might be used on tests to check if a snippet build with the provided
> compiler and flags.
> ---
>  scripts/glibcextract.py | 20 ++++++++++++++++++++
>  1 file changed, 20 insertions(+)
>
> diff --git a/scripts/glibcextract.py b/scripts/glibcextract.py
> index 43ab58ffe2..71d9ea1acc 100644
> --- a/scripts/glibcextract.py
> +++ b/scripts/glibcextract.py
> @@ -21,6 +21,7 @@ import os.path
>  import re
>  import subprocess
>  import tempfile
> +import collections
>  
>  
>  def compute_c_consts(sym_data, cc):
> @@ -173,3 +174,22 @@ def compare_macro_consts(source_1, source_2, cc, macro_re, exclude_re=None,
>              if not allow_extra_2:
>                  ret = 1
>      return ret
> +
> +CompileResult = collections.namedtuple("CompileResult", "returncode output")
> +
> +def compile_c_snippet(snippet, cc, extra_cc_args=""):
> +    """Compile and return whether the SNIPPET can be build with CC along
> +       EXTRA_CC_ARGS compiler flags.  Return a CompileResult with RETURNCODE
> +       being 0 for success, or the failure value and the compiler output.
> +    """
> +    with tempfile.TemporaryDirectory() as temp_dir:
> +        c_file_name = os.path.join(temp_dir, 'test.c')
> +        obj_file_name = os.path.join(temp_dir, 'test.o')
> +        with open(c_file_name, 'w') as c_file:
> +            c_file.write(snippet)

Sorry, one more thing: Please write '\n' at the end because “snippet”
sometimes does not have a newline at the end (which can trigger warnings
in some cases, IIRC).

Thanks,
Florian
  
Adhemerval Zanella Netto Aug. 10, 2022, 7 p.m. UTC | #3
On 10/08/22 14:35, Florian Weimer wrote:
> * Adhemerval Zanella:
> 
>> It might be used on tests to check if a snippet build with the provided
>> compiler and flags.
>> ---
>>  scripts/glibcextract.py | 20 ++++++++++++++++++++
>>  1 file changed, 20 insertions(+)
>>
>> diff --git a/scripts/glibcextract.py b/scripts/glibcextract.py
>> index 43ab58ffe2..71d9ea1acc 100644
>> --- a/scripts/glibcextract.py
>> +++ b/scripts/glibcextract.py
>> @@ -21,6 +21,7 @@ import os.path
>>  import re
>>  import subprocess
>>  import tempfile
>> +import collections
> 
> Please keep the imports sorted.

Ack.

> 
>>  def compute_c_consts(sym_data, cc):
>> @@ -173,3 +174,22 @@ def compare_macro_consts(source_1, source_2, cc, macro_re, exclude_re=None,
>>              if not allow_extra_2:
>>                  ret = 1
>>      return ret
>> +
>> +CompileResult = collections.namedtuple("CompileResult", "returncode output")
>> +
>> +def compile_c_snippet(snippet, cc, extra_cc_args=""):
>> +    """Compile and return whether the SNIPPET can be build with CC along
>> +       EXTRA_CC_ARGS compiler flags.  Return a CompileResult with RETURNCODE
>> +       being 0 for success, or the failure value and the compiler output.
>> +    """
>> +    with tempfile.TemporaryDirectory() as temp_dir:
>> +        c_file_name = os.path.join(temp_dir, 'test.c')
>> +        obj_file_name = os.path.join(temp_dir, 'test.o')
>> +        with open(c_file_name, 'w') as c_file:
>> +            c_file.write(snippet)
>> +        # Compilation has to be from stdin to avoid the temporary file
>> +        # name being written into the generated dependencies.
>> +        cmd = ('%s %s -c -o %s -x c - < %s' % (cc, extra_cc_args,
>> +            obj_file_name, c_file_name))
>> +        r = subprocess.run(cmd, shell=True, capture_output=True)
>> +        return CompileResult(r.returncode, r.stderr)
> 
> I think you can avoid shell=True and the direction if you just compile
> c_file_name directly.  Sorry, missed that earlier.

Right, I will do it.
  

Patch

diff --git a/scripts/glibcextract.py b/scripts/glibcextract.py
index 43ab58ffe2..71d9ea1acc 100644
--- a/scripts/glibcextract.py
+++ b/scripts/glibcextract.py
@@ -21,6 +21,7 @@  import os.path
 import re
 import subprocess
 import tempfile
+import collections
 
 
 def compute_c_consts(sym_data, cc):
@@ -173,3 +174,22 @@  def compare_macro_consts(source_1, source_2, cc, macro_re, exclude_re=None,
             if not allow_extra_2:
                 ret = 1
     return ret
+
+CompileResult = collections.namedtuple("CompileResult", "returncode output")
+
+def compile_c_snippet(snippet, cc, extra_cc_args=""):
+    """Compile and return whether the SNIPPET can be build with CC along
+       EXTRA_CC_ARGS compiler flags.  Return a CompileResult with RETURNCODE
+       being 0 for success, or the failure value and the compiler output.
+    """
+    with tempfile.TemporaryDirectory() as temp_dir:
+        c_file_name = os.path.join(temp_dir, 'test.c')
+        obj_file_name = os.path.join(temp_dir, 'test.o')
+        with open(c_file_name, 'w') as c_file:
+            c_file.write(snippet)
+        # Compilation has to be from stdin to avoid the temporary file
+        # name being written into the generated dependencies.
+        cmd = ('%s %s -c -o %s -x c - < %s' % (cc, extra_cc_args,
+            obj_file_name, c_file_name))
+        r = subprocess.run(cmd, shell=True, capture_output=True)
+        return CompileResult(r.returncode, r.stderr)