aboutsummaryrefslogtreecommitdiff
path: root/build2/cc/module.cxx
blob: 067aea3006be62590a93370c24929d738f0e033f (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
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
// file      : build2/cc/module.cxx -*- C++ -*-
// copyright : Copyright (c) 2014-2017 Code Synthesis Ltd
// license   : MIT; see accompanying LICENSE file

#include <build2/cc/module>

#include <iomanip> // left, setw()

#include <build2/scope>
#include <build2/context>
#include <build2/diagnostics>

#include <build2/bin/target>

#include <build2/config/utility>
#include <build2/install/utility>

#include <build2/cc/guess>

using namespace std;
using namespace butl;

namespace build2
{
  namespace cc
  {
    void config_module::
    init (scope& rs, const location& loc, const variable_map&)
    {
      tracer trace (x, "config_init");

      bool cc_loaded (cast_false<bool> (rs["cc.core.config.loaded"]));

      // Configure.
      //
      compiler_info ci; // For program patterns.

      // Adjust module priority (compiler). Also order cc module before us
      // (we don't want to use priorities for that in case someone manages
      // to slot in-between).
      //
      if (!cc_loaded)
        config::save_module (rs, "cc", 250);

      config::save_module (rs, x, 250);

      const variable& config_c_coptions (var_pool["config.cc.coptions"]);

      // config.x
      //

      // Normally we will have a persistent configuration and computing the
      // default value every time will be a waste. So try without a default
      // first.
      //
      auto p (config::omitted (rs, config_x));

      if (p.first == nullptr)
      {
        // If someone already loaded cc.core.config then use its toolchain
        // id and (optional) pattern to guess an appropriate default (e.g.,
        // for {gcc, *-4.9} we will get g++-4.9).
        //
        path d (cc_loaded
                ? guess_default (x_lang,
                                 cast<string> (rs["cc.id"]),
                                 cast_null<string> (rs["cc.pattern"]))
                : path (x_default));

        // If this value was hinted, save it as commented out so that if the
        // user changes the source of the pattern, this one will get updated
        // as well.
        //
        auto p1 (config::required (rs,
                                   config_x,
                                   d,
                                   false,
                                   cc_loaded ? config::save_commented : 0));
        p.first = &p1.first.get ();
        p.second = p1.second;
      }

      // Figure out which compiler we are dealing with, its target, etc.
      //
      const path& xc (cast<path> (*p.first));
      ci = guess (x_lang,
                  xc,
                  cast_null<strings> (rs[config_c_coptions]),
                  cast_null<strings> (rs[config_x_coptions]));

      // Split/canonicalize the target. First see if the user asked us to
      // use config.sub.
      //
      target_triplet tt;
      {
        string ct;

        if (ops.config_sub_specified ())
        {
          ct = run<string> (ops.config_sub (),
                            ci.target.c_str (),
                            [] (string& l) {return move (l);});
          l5 ([&]{trace << "config.sub target: '" << ct << "'";});
        }

        try
        {
          tt = target_triplet (ct.empty () ? ci.target : ct);
          l5 ([&]{trace << "canonical target: '" << tt.string () << "'; "
                        << "class: " << tt.class_;});
        }
        catch (const invalid_argument& e)
        {
          // This is where we suggest that the user specifies --config-sub to
          // help us out.
          //
          fail << "unable to parse " << x_lang << " compiler target '"
               << ci.target << "': " << e.what () <<
            info << "consider using the --config-sub option";
        }
      }

      // Translate x_std value (if any) to the compiler option (if any).
      //
      if (auto l = rs[x_std])
        tstd = translate_std (ci, rs, cast<string> (*l));

      // Extract system library search paths from the compiler and determine
      // additional system include search paths.
      //
      dir_paths lib_dirs;
      dir_paths inc_dirs;

      if (ci.id.type == "msvc")
        lib_dirs = msvc_library_search_paths (ci.path, rs);
      else
      {
        lib_dirs = gcc_library_search_paths (ci.path, rs);

#ifndef _WIN32
        // Many platforms don't search in /usr/local/lib by default (but do
        // for headers in /usr/local/include). So add it as the last option.
        //
        lib_dirs.push_back (dir_path ("/usr/local/lib"));

        // FreeBSD is at least consistent: it searches in neither. Quoting its
        // wiki: "FreeBSD can't even find libraries that it installed." So
        // let's help it a bit. Note that we don't add it for all the
        // platforms for good measure because this will actually appear as
        // usually unnecessary noise on the command line.
        //
        if (tt.system == "freebsd")
          inc_dirs.push_back (dir_path ("/usr/local/include"));
#endif
      }

      // If this is a new value (e.g., we are configuring), then print the
      // report at verbosity level 2 and up (-v).
      //
      if (verb >= (p.second ? 2 : 3))
      {
        diag_record dr (text);

        {
          dr << x << ' ' << project (rs) << '@' << rs.out_path () << '\n'
             << "  " << left << setw (11) << x << ci.path << '\n'
             << "  id         " << ci.id << '\n'
             << "  version    " << ci.version.string << '\n'
             << "  major      " << ci.version.major << '\n'
             << "  minor      " << ci.version.minor << '\n'
             << "  patch      " << ci.version.patch << '\n';
        }

        if (!ci.version.build.empty ())
        {
          dr << "  build      " << ci.version.build << '\n';
        }

        {
          const string& ct (tt.string ()); // Canonical target.

          dr << "  signature  " << ci.signature << '\n'
             << "  target     " << ct;

          if (ct != ci.target)
            dr << " (" << ci.target << ")";

          dr << '\n';
        }

        if (!tstd.empty ())
        {
          dr << "  std        " << tstd << '\n';
        }

        if (!ci.cc_pattern.empty ()) // bin_pattern printed by bin
        {
          dr << "  pattern    " << ci.cc_pattern << '\n';
        }

        if (verb >= 3 && !inc_dirs.empty ())
        {
          dr << "  inc dirs\n";
          for (const dir_path& d: inc_dirs)
            dr << "    " << d << '\n';
        }

        if (verb >= 3 && !lib_dirs.empty ())
        {
          dr << "  lib dirs\n";
          for (const dir_path& d: lib_dirs)
            dr << "    " << d << '\n';
        }

        {
          dr << "  checksum   " << ci.checksum;
        }
      }

      rs.assign (x_path) = move (ci.path);
      rs.assign (x_sys_lib_dirs) = move (lib_dirs);
      rs.assign (x_sys_inc_dirs) = move (inc_dirs);

      rs.assign (x_id) = ci.id.string ();
      rs.assign (x_id_type) = move (ci.id.type);
      rs.assign (x_id_variant) = move (ci.id.variant);

      rs.assign (x_version) = move (ci.version.string);
      rs.assign (x_version_major) = ci.version.major;
      rs.assign (x_version_minor) = ci.version.minor;
      rs.assign (x_version_patch) = ci.version.patch;
      rs.assign (x_version_build) = move (ci.version.build);

      rs.assign (x_signature) = move (ci.signature);
      rs.assign (x_checksum) = move (ci.checksum);

      // Also enter as x.target.{cpu,vendor,system,version,class} for
      // convenience of access.
      //
      rs.assign (x_target_cpu)     = tt.cpu;
      rs.assign (x_target_vendor)  = tt.vendor;
      rs.assign (x_target_system)  = tt.system;
      rs.assign (x_target_version) = tt.version;
      rs.assign (x_target_class)   = tt.class_;

      rs.assign (x_target) = move (tt);

      // config.x.{p,c,l}options
      // config.x.libs
      //
      // These are optional. We also merge them into the corresponding
      // x.* variables.
      //
      // The merging part gets a bit tricky if this module has already
      // been loaded in one of the outer scopes. By doing the straight
      // append we would just be repeating the same options over and
      // over. So what we are going to do is only append to a value if
      // it came from this scope. Then the usage for merging becomes:
      //
      // x.coptions = <overridable options> # Note: '='.
      // using x
      // x.coptions += <overriding options> # Note: '+='.
      //
      rs.assign (x_poptions) += cast_null<strings> (
        config::optional (rs, config_x_poptions));

      rs.assign (x_coptions) += cast_null<strings> (
        config::optional (rs, config_x_coptions));

      rs.assign (x_loptions) += cast_null<strings> (
        config::optional (rs, config_x_loptions));

      rs.assign (x_libs) += cast_null<strings> (
        config::optional (rs, config_x_libs));

      // Load cc.core.config.
      //
      if (!cc_loaded)
      {
        // Prepare configuration hints.
        //
        variable_map h;

        h.assign ("config.cc.id") = cast<string> (rs[x_id]);
        h.assign ("config.cc.target") = cast<target_triplet> (rs[x_target]);

        if (!ci.cc_pattern.empty ())
          h.assign ("config.cc.pattern") = move (ci.cc_pattern);

        if (!ci.bin_pattern.empty ())
          h.assign ("config.bin.pattern") = move (ci.bin_pattern);

        load_module ("cc.core.config", rs, rs, loc, false, h);
      }
      else
      {
        // If cc.core.config is already loaded, verify its configuration
        // matched ours since it could have been loaded by another c-family
        // module.
        //
        // Note that we don't require that patterns match. Presumably, if the
        // toolchain id and target are the same, then where exactly the tools
        // come from doesn't really matter.
        //
        {
          const auto& cv (cast<string> (rs["cc.id"]));
          const auto& xv (cast<string> (rs[x_id]));

          if (cv != xv)
            fail (loc) << "cc and " << x << " module toolchain mismatch" <<
              info << "cc.id is " << cv <<
              info << x_id.name << " is " << xv;
        }

        {
          const auto& cv (cast<target_triplet> (rs["cc.target"]));
          const auto& xv (cast<target_triplet> (rs[x_target]));

          if (cv != xv)
            fail (loc) << "cc and " << x << " module target mismatch" <<
              info << "cc.target is " << cv <<
              info << x_target.name << " is " << xv;
        }
      }
    }

    void module::
    init (scope& rs, const location& loc, const variable_map&)
    {
      tracer trace (x, "init");

      // Load cc.core. Besides other things, this will load bin (core) plus
      // extra bin.* modules we may need.
      //
      if (!cast_false<bool> (rs["cc.core.loaded"]))
        load_module ("cc.core", rs, rs, loc);

      // Register target types and configure their "installability".
      //
      {
        using namespace install;

        auto& t (rs.target_types);

        t.insert (x_src);

        // Install headers into install.include.
        //
        for (const target_type* const* ht (x_hdr); *ht != nullptr; ++ht)
        {
          t.insert (**ht);
          install_path (**ht, rs, dir_path ("include"));
        }
      }

      // Register rules.
      //
      {
        using namespace bin;

        auto& r (rs.rules);

        // We register for configure so that we detect unresolved imports
        // during configuration rather that later, e.g., during update.
        //
        // @@ Should we check if install module was loaded (see bin)?
        //
        compile& cr (*this);
        link&    lr (*this);
        install& ir (*this);

        r.insert<obje> (perform_update_id,    x_compile, cr);
        r.insert<obje> (perform_clean_id,     x_compile, cr);
        r.insert<obje> (configure_update_id,  x_compile, cr);

        r.insert<exe>  (perform_update_id,    x_link, lr);
        r.insert<exe>  (perform_clean_id,     x_link, lr);
        r.insert<exe>  (configure_update_id,  x_link, lr);

        r.insert<exe>  (perform_install_id,   x_install, ir);
        r.insert<exe>  (perform_uninstall_id, x_uninstall, ir);

        // Only register static object/library rules if the bin.ar module is
        // loaded (by us or by the user).
        //
        if (cast_false<bool> (rs["bin.ar.loaded"]))
        {
          r.insert<obja> (perform_update_id,    x_compile, cr);
          r.insert<obja> (perform_clean_id,     x_compile, cr);
          r.insert<obja> (configure_update_id,  x_compile, cr);

          r.insert<liba> (perform_update_id,    x_link, lr);
          r.insert<liba> (perform_clean_id,     x_link, lr);
          r.insert<liba> (configure_update_id,  x_link, lr);

          r.insert<liba> (perform_install_id,   x_install, ir);
          r.insert<liba> (perform_uninstall_id, x_uninstall, ir);
        }

        r.insert<objs> (perform_update_id,   x_compile, cr);
        r.insert<objs> (perform_clean_id,    x_compile, cr);
        r.insert<objs> (configure_update_id, x_compile, cr);

        r.insert<libs> (perform_update_id,   x_link, lr);
        r.insert<libs> (perform_clean_id,    x_link, lr);
        r.insert<libs> (configure_update_id, x_link, lr);

        r.insert<libs> (perform_install_id,   x_install, ir);
        r.insert<libs> (perform_uninstall_id, x_uninstall, ir);
      }
    }
  }
}