SCons 依赖于编译时生成的文件

Question

我正在尝试设置 SCons 以遵循在构建过程中自动生成的文件的依赖项，并在多线程构建中正常工作。

我正在生成的项目是一个 CIM 提供程序，由定义数据结构的 MOF 文件、来自 MOF 文件的自动生成的源文件和头文件以及引用自动生成文件的手写源文件和头文件组成。 为了使生成成功，自动生成步骤必须在编译任何手写文件之前运行完成，否则手写文件所依赖的标头将尚不存在，并且将失败。 还必须将自动生成步骤创建的.cpp文件添加到源列表中，并在最终版本中编译。

运行单线程构建时，一切正常，因为自动生成步骤始终在编译步骤之前完成，因此生成的标头就位。 但是，当以多线程方式运行生成时，它会尝试在自动生成步骤完成之前编译手写文件，并且生成失败。 我已经指定了一个明确的依赖项，但 SCons 没有遵循它。

这是我的 SConscript 文件的相关部分，我从 cim_targets[] 中删除了单个文件名，因为列表很长，但总而言之，cim_targets[] 是自动生成步骤的目标输出文件列表，provider_sources[] 是 autogen 步骤完成后返回的源列表，sources[] 是手写源文件的列表， GenProvider（） 是一个外部定义的命令生成器，用于执行自动生成步骤，而 SharedLibrary（） 是一个外部定义的构建器，它听起来像什么，使用 SCons 库生成器和一些扩展

# Define directory paths for the CIM schema
cim_dir = 'cim-schema-2.26.0'
var_smis_dir   = Dir('.').abspath # src/lib/XXX in variant
cim_sources = [
    Glob(os.path.join(cim_dir, '*qualifiers*.mof')),
    Glob(os.path.join(cim_dir, 'Core')     + '/CIM_*.mof'),
    Glob(os.path.join(cim_dir, 'Device')   + '/CIM_*.mof'),
    Glob(os.path.join(cim_dir, 'Event')    + '/CIM_*.mof'),
    Glob(os.path.join(cim_dir, 'XXXXXX')   + '/XXX_*.mof'),
    Glob(os.path.join(cim_dir, 'Interop')  + '/CIM_*.mof'),
    Glob(os.path.join(cim_dir, 'Physical') + '/CIM_*.mof'),
    Glob(os.path.join(cim_dir, 'System')   + '/CIM_*.mof'),
]
cim_sources_flat = []
for cim in cim_sources:
    for src in cim:
        cim_sources_flat.append(src)
cim_targets = [
    ......
]
sources = [
    'driver.cpp',
    'device.cpp',
    'cim_static_data.cpp',
    'module.cpp',
    'diag_log.cpp',
    'profile_element.cpp',
]
staticlibs = [
    ......
    ]

dynamiclibs = [
    .....
    ]
var_cim_sources = this_env.Install(var_smis_dir, cim_sources_flat)
cim_mof = 'cimv226.mof'
cim_linux_mof = os.path.join(cim_dir, 'cimv226-gen-flat.mof')
var_cim_sources.extend(this_env.Command(cim_mof, cim_linux_mof, Copy('$TARGET', '$SOURCE')))
# first generate the provider infrastructure using cimple
provider_sources = this_env.GenProvider(cim_targets, var_cim_sources, name, var_smis_dir)
# make sure these files don't build until AFTER the provider files have been created
this_env.Depends(sources, provider_sources)
sources_full = provider_sources + sources
# now we can compile the provider
this_env.SharedLibrary(libname, source=sources_full, staticlibs=staticlibs, dynamiclibs=dynamiclibs, installpath=install_dir)

我尝试设置显式依赖项，以便在创建所有生成的源之前不会编译手写源（this_env。依赖（源，provider_sources）），但是当运行多线程时，SCons 会忽略此依赖关系，并尝试在自动生成步骤完成之前编译手写文件。

Answer 1

您是否尝试过使用此处定义的 SideEffect（） 函数：

SCons Wiki： SideEffect

我不确定它是否完全是为了您的需要而创建的，但可能会有所帮助。

Answer 2

我能够通过使生成的文件成为Command的目标来解决这个问题。例如，假设您有一个文件foo.c：

#include <stdio.h>
#include "foo.h"
int main() {}

并说在构建foo.c之前需要生成foo.h。你可以这样做：

import time
def build_foo(target, source, env):
    print("Generating foo source files")
    time.sleep(5)
    with open("foo.h", "w") as f:
        f.write("")
    # Generate bar.so, which we need later for X, blah blah blah
    print("Done generating")
env = Environment()
env.Command(['foo.h', 'bar.so'], 'foo.in', build_foo)
env.Program('foo', 'foo.c')

生成输出如下所示：

$ scons -Q -j4
build_foo(["foo.h", "foo.so"], ["foo.in"])
Generating foo source files
Done generating
gcc -o foo.o -c foo.c
gcc -o foo foo.o

如果省略foo.h作为目标（即 env.Command(['bar.so'], 'foo.in', build_foo)，构建输出如下所示：

$ scons -Q -j4
gcc -o foo.o -c foo.c
build_foo(["foo.so"], ["foo.in"])
Generating foo source files
foo.c:2:10: fatal error: foo.h: No such file or directory
 #include "foo.h"
          ^~~~~~~
compilation terminated.
scons: *** [foo.o] Error 1
Done generating