summaryrefslogtreecommitdiffstats
path: root/build/moz.configure/old.configure
blob: a37fd265a274a0d8d837821211b9047de3ee1c65 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
# -*- Mode: python; indent-tabs-mode: nil; tab-width: 40 -*-
# vim: set filetype=python:
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.


m4 = check_prog(
    "M4",
    (
        "gm4",
        "m4",
    ),
    paths=prefer_mozillabuild_path,
)


@depends(mozconfig)
def prepare_mozconfig(mozconfig):
    if mozconfig["path"]:
        items = {}
        for key, value in mozconfig["vars"]["added"].items():
            items[key] = (value, "added")
        for key, (old, value) in mozconfig["vars"]["modified"].items():
            items[key] = (value, "modified")
        for t in ("env", "vars"):
            for key in mozconfig[t]["removed"].keys():
                items[key] = (None, "removed " + t)
        return items


@depends("OLD_CONFIGURE", build_project)
def old_configure(old_configure, build_project):
    if not old_configure:
        die("The OLD_CONFIGURE environment variable must be set")

    # os.path.abspath in the sandbox will ensure forward slashes on Windows,
    # which is actually necessary because this path actually ends up literally
    # as $0, and backslashes there breaks autoconf's detection of the source
    # directory.
    old_configure = os.path.abspath(old_configure[0])
    if build_project == "js":
        old_configure_dir = os.path.dirname(old_configure)
        if not old_configure_dir.endswith("/js/src"):
            old_configure = os.path.join(
                old_configure_dir, "js", "src", os.path.basename(old_configure)
            )
    return old_configure


@depends(prepare_mozconfig, old_configure_assignments)
@imports(_from="__builtin__", _import="open")
@imports(_from="__builtin__", _import="print")
@imports(_from="mozbuild.shellutil", _import="quote")
def prepare_configure(mozconfig, old_configure_assignments):
    assignments = {}

    with open("old-configure.vars", "w") as out:
        log.debug("Injecting the following to old-configure:")

        def inject(command):
            print(command, file=out)  # noqa Python 2vs3
            log.debug("| %s", command)

        if mozconfig:
            inject("# start of mozconfig values")
            for key, (value, action) in sorted(mozconfig.items()):
                if action.startswith("removed "):
                    inject("unset %s # from %s" % (key, action[len("removed ") :]))
                else:
                    inject("%s=%s # %s" % (key, quote(value), action))
                    assignments[key] = value

            inject("# end of mozconfig values")

        for k, v in old_configure_assignments:
            inject("%s=%s" % (k, quote(v)))
            assignments[k] = v

    return namespace(assignments=assignments)


@template
def old_configure_options(*options):
    for opt in options:
        option(opt, nargs="*", help="Help missing for old configure options")

    @dependable
    def all_options():
        return list(options)

    return depends(
        host_for_sub_configure, target_for_sub_configure, all_options, *options
    )


@old_configure_options(
    "--cache-file",
    "--datadir",
    "--enable-official-branding",
    "--includedir",
    "--libdir",
    "--prefix",
    "--with-branding",
    "--with-distribution-id",
    "--with-macbundlename-prefix",
    "--x-includes",
    "--x-libraries",
)
def prepare_configure_options(host, target, all_options, *options):
    # old-configure only supports the options listed in @old_configure_options
    # so we don't need to pass it every single option we've been passed. Only
    # the ones that are not supported by python configure need to.
    options = [
        value.format(name)
        for name, value in zip(all_options, options)
        if value.origin != "default"
    ] + [host, target]

    return namespace(options=options, all_options=all_options)


@template
def old_configure_for(old_configure_path, extra_env=None):
    if extra_env is None:
        extra_env = dependable(None)

    @depends(
        prepare_configure,
        prepare_configure_options,
        prefer_mozillabuild_path,
        altered_path,
        extra_env,
        build_environment,
        old_configure_path,
        awk,
        m4,
        shell,
        "--cache-file",
    )
    @imports(_from="__builtin__", _import="compile")
    @imports(_from="__builtin__", _import="open")
    @imports(_from="__builtin__", _import="OSError")
    @imports("glob")
    @imports("itertools")
    @imports("logging")
    @imports("os")
    @imports("re")
    @imports("subprocess")
    @imports("sys")
    @imports(_from="mozbuild.shellutil", _import="quote")
    @imports(_from="mozbuild.shellutil", _import="split")
    @imports(_from="tempfile", _import="NamedTemporaryFile")
    @imports(_from="subprocess", _import="CalledProcessError")
    @imports(_from="__builtin__", _import="exec")
    def old_configure(
        prepare_configure,
        prepare_configure_options,
        prefer_mozillabuild_path,
        altered_path,
        extra_env,
        build_env,
        old_configure,
        awk,
        m4,
        shell,
        cache_file_option,
    ):
        if altered_path:
            path = altered_path
        else:
            path = os.pathsep.join(prefer_mozillabuild_path)

        cxx = prepare_configure.assignments.get("CXX")
        cc = prepare_configure.assignments.get("CC")

        if cc and cxx:
            if cache_file_option:
                config_cache = cache_file_option[0]
            else:
                config_cache = "config.cache"

            if os.path.exists(config_cache):
                remove = False
                with open(config_cache, "r") as cfg_cache:
                    cxx_pattern = re.compile(
                        r"^ac_cv_prog_CXX=\${ac_cv_prog_CXX='(.*)'}$"
                    )
                    cc_pattern = re.compile(r"^ac_cv_prog_CC=\${ac_cv_prog_CC='(.*)'}$")
                    for line in cfg_cache:
                        m = cc_pattern.match(line)
                        if m and m.group(1) != cc:
                            remove = True
                            break
                        m = cxx_pattern.match(line)
                        if m and m.group(1) != cxx:
                            remove = True
                            break

                if remove:
                    log.info("invalidating config.cache")
                    os.remove(config_cache)

        refresh = True
        if os.path.exists(old_configure):
            mtime = os.path.getmtime(old_configure)
            aclocal = os.path.join(build_env.topsrcdir, "build", "autoconf", "*.m4")
            for input in itertools.chain(
                (
                    old_configure + ".in",
                    os.path.join(os.path.dirname(old_configure), "aclocal.m4"),
                ),
                glob.iglob(aclocal),
            ):
                if os.path.getmtime(input) > mtime:
                    break
            else:
                refresh = False

        if refresh:
            autoconf = os.path.join(
                build_env.topsrcdir, "build", "autoconf", "autoconf.sh"
            )
            log.info("Refreshing %s with %s", old_configure, autoconf)
            env = dict(os.environ)
            env["M4"] = m4
            env["AWK"] = awk
            env["AC_MACRODIR"] = os.path.join(build_env.topsrcdir, "build", "autoconf")
            env["PATH"] = path

            try:
                script = subprocess.check_output(
                    [
                        shell,
                        autoconf,
                        "--localdir=%s" % os.path.dirname(old_configure),
                        old_configure + ".in",
                    ],
                    # Fix the working directory, so that when m4 is called, that
                    # includes of relative paths are deterministically resolved
                    # relative to the directory containing old-configure.
                    cwd=os.path.dirname(old_configure),
                    env=env,
                )
            except CalledProcessError as exc:
                die("autoconf exited with return code {}".format(exc.returncode))

            if not script:
                die(
                    "Generated old-configure is empty! Check that your autoconf 2.13 program works!"
                )

            # Make old-configure append to config.log, where we put our own log.
            # This could be done with a m4 macro, but it's way easier this way
            script = script.replace(b">./config.log", b">>${CONFIG_LOG=./config.log}")

            with NamedTemporaryFile(
                mode="wb",
                prefix=os.path.basename(old_configure),
                dir=os.path.dirname(old_configure),
                delete=False,
            ) as fh:
                fh.write(script)

            try:
                os.rename(fh.name, old_configure)
            except OSError:
                try:
                    # Likely the file already existed (on Windows). Retry after removing it.
                    os.remove(old_configure)
                    os.rename(fh.name, old_configure)
                except OSError as e:
                    die("Failed re-creating old-configure: %s" % e.message)

        cmd = [shell, old_configure] + prepare_configure_options.options

        env = dict(os.environ)

        # For debugging purpose, in case it's not what we'd expect.
        log.debug("Running %s", quote(*cmd))

        # Our logging goes to config.log, the same file old.configure uses.
        # We can't share the handle on the file, so close it.
        logger = logging.getLogger("moz.configure")
        config_log = None
        for handler in logger.handlers:
            if isinstance(handler, logging.FileHandler):
                config_log = handler
                config_log.close()
                logger.removeHandler(config_log)
                env["CONFIG_LOG"] = config_log.baseFilename
                log_size = os.path.getsize(config_log.baseFilename)
                break

        env["PATH"] = path

        if extra_env:
            env.update(extra_env)

        env["OLD_CONFIGURE_VARS"] = os.path.join(
            build_env.topobjdir, "old-configure.vars"
        )
        proc = subprocess.Popen(
            cmd, stdout=subprocess.PIPE, stderr=subprocess.STDOUT, env=env
        )
        while True:
            line = proc.stdout.readline()
            if not line:
                break
            log.info(line.rstrip())

        ret = proc.wait()
        if ret:
            with log.queue_debug():
                if config_log:
                    with open(config_log.baseFilename, "r") as fh:
                        fh.seek(log_size)
                        for line in fh:
                            log.debug(line.rstrip())
                log.error("old-configure failed")
            sys.exit(ret)

        if config_log:
            # Create a new handler in append mode
            handler = logging.FileHandler(config_log.baseFilename, mode="a", delay=True)
            handler.setFormatter(config_log.formatter)
            logger.addHandler(handler)

        raw_config = {
            "split": split,
            "unique_list": unique_list,
        }
        with open("config.data", "r") as fh:
            code = compile(fh.read(), "config.data", "exec")
            exec(code, raw_config)

        # Ensure all the flags known to old-configure appear in the
        # @old_configure_options above.
        all_options = set(prepare_configure_options.all_options)
        for flag in raw_config["flags"]:
            if flag not in all_options:
                die(
                    "Missing option in `@old_configure_options` in %s: %s",
                    __file__,
                    flag,
                )

        # If the code execution above fails, we want to keep the file around for
        # debugging.
        os.remove("config.data")

        return namespace(
            **{
                c: [
                    (k[1:-1], v[1:-1] if isinstance(v, str) else v)
                    for k, v in raw_config[c]
                    # Eventually we'll want to filter out all lowercase keys. (bug 1869127)
                    # For now, we only filter out the most problematic one that
                    # we know is unused.
                    if k != " target_cpu "
                ]
                for c in ("substs", "defines")
            }
        )

    return old_configure


old_configure = old_configure_for(old_configure)
set_config("OLD_CONFIGURE_SUBSTS", old_configure.substs)
set_config("OLD_CONFIGURE_DEFINES", old_configure.defines)


# Assuming no other option is declared after this function, handle the
# env options that were injected by mozconfig_options by creating dummy
# Option instances and having the sandbox's CommandLineHelper handle
# them. We only do so for options that haven't been declared so far,
# which should be a proxy for the options that old-configure handles
# and that we don't know anything about.
@depends("--help")
@imports("__sandbox__")
@imports(_from="mozbuild.configure.options", _import="Option")
def remaining_mozconfig_options(_):
    helper = __sandbox__._helper
    for arg in list(helper):
        if helper._origins[arg] != "mozconfig":
            continue
        name = arg.split("=", 1)[0]
        if name.isupper() and name not in __sandbox__._options:
            option = Option(env=name, nargs="*", help=name)
            helper.handle(option)


# Please do not add anything after remaining_mozconfig_options()