-
-
Notifications
You must be signed in to change notification settings - Fork 738
/
clang.lua
921 lines (830 loc) · 39.1 KB
/
clang.lua
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
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
--!A cross-platform build utility based on Lua
--
-- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License.
-- You may obtain a copy of the License at
--
-- http://www.apache.org/licenses/LICENSE-2.0
--
-- Unless required by applicable law or agreed to in writing, software
-- distributed under the License is distributed on an "AS IS" BASIS,
-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-- See the License for the specific language governing permissions and
-- limitations under the License.
--
-- Copyright (C) 2015-present, TBOOX Open Source Group.
--
-- @author ruki
-- @file clang.lua
--
-- imports
import("core.base.option")
import("core.base.json")
import("core.base.semver")
import("core.tool.compiler")
import("core.project.project")
import("core.project.depend")
import("core.project.config")
import("lib.detect.find_tool")
import("utils.progress")
import("private.action.build.object", {alias = "objectbuilder"})
import("common")
import("stl_headers")
-- get clang version
function _get_clang_version(target)
local clang_version = _g.clang_version
if not clang_version then
local program, toolname = target:tool("cxx")
if program and (toolname == "clang" or toolname == "clangxx") then
local clang = find_tool("clang", {program = program, version = true})
if clang then
clang_version = clang.version
end
end
clang_version = clang_version or false
_g.clang_version = clang_version
end
return clang_version or nil
end
-- get clang-scan-deps
function _get_clang_scan_deps(target)
local clang_scan_deps = _g.clang_scan_deps
if not clang_scan_deps then
local program, toolname = target:tool("cxx")
if program and (toolname == "clang" or toolname == "clangxx") then
local dir = path.directory(program)
local basename = path.basename(program)
local extension = path.extension(program)
program = (basename:gsub("clang", "clang-scan-deps")) .. extension
if os.isdir(dir) then
program = path.join(dir, program)
end
local result = find_tool("clang-scan-deps", {program = program, version = true})
if result then
clang_scan_deps = result.program
end
end
clang_scan_deps = clang_scan_deps or false
_g.clang_scan_deps = clang_scan_deps
end
return clang_scan_deps or nil
end
-- add a module or an header unit into the mapper
--
-- e.g
-- -fmodule-file=build/.gens/Foo/rules/modules/cache/foo.pcm
-- -fmodule-file=build/.gens/Foo/rules/modules/cache/iostream.pcm
-- -fmodule-file=build/.gens/Foo/rules/modules/cache/bar.hpp.pcm
-- on LLVM >= 16
-- -fmodule-file=foo=build/.gens/Foo/rules/modules/cache/foo.pcm
-- -fmodule-file=build/.gens/Foo/rules/modules/cache/iostream.pcm
-- -fmodule-file=build/.gens/Foo/rules/modules/cache/bar.hpp.pcm
--
function _add_module_to_mapper(target, name, bmifile, opt)
opt = opt or {}
local modulemap = _get_modulemap_from_mapper(target, name)
if modulemap then
return
end
local clang_version = _get_clang_version(target)
local namedmodule = opt.namedmodule and semver.compare(clang_version, "16.0") >= 0
local modulefileflag = get_modulefileflag(target)
local mapflag = namedmodule and format("%s%s=%s", modulefileflag, name, bmifile) or modulefileflag .. bmifile
modulemap = {flag = mapflag, deps = opt.deps}
common.localcache():set2(_mapper_cachekey(target), "modulemap" .. name, modulemap)
end
function _mapper_cachekey(target)
local mode = config.mode()
return target:name() .. "_modulemap_" .. (mode or "")
end
-- flush modulemap to mapper file cache
function _flush_mapper(target)
-- not using set2/get2 to flush only current target mapper
common.localcache():save(_mapper_cachekey(target))
end
-- get modulemap from mapper
function _get_modulemap_from_mapper(target, name)
return common.localcache():get2(_mapper_cachekey(target), "modulemap" .. name) or nil
end
-- use the given stdlib? e.g. libc++ or libstdc++
function _use_stdlib(target, name)
local stdlib = target:data("cxx.modules.stdlib") or "libstdc++"
return stdlib == name
end
-- set stdlib flags, it will use libstdc++ if we do not set `-stdlib=`
function _set_stdlib_flags(target)
if _use_stdlib(target, "libc++") then
target:add("cxxflags", "-stdlib=libc++")
target:add("ldflags", "-stdlib=libc++")
target:add("shflags", "-stdlib=libc++")
end
end
-- load module support for the current target
function load(target)
local clangmodulesflag, modulestsflag, withoutflag = get_modulesflag(target)
-- add module flags
if not withoutflag then
target:add("cxxflags", modulestsflag)
end
-- enable clang modules to emulate std modules
if target:policy("build.c++.clang.stdmodules") then
target:add("cxxflags", clangmodulesflag)
end
-- fix default visibility for functions and variables [-fvisibility] differs in PCH file vs. current file
-- module.pcm cannot be loaded due to a configuration mismatch with the current compilation.
--
-- it will happen in binary target depend on library target with modules, and enable release mode at same time.
--
-- @see https://github.com/xmake-io/xmake/issues/3358#issuecomment-1432586767
local dep_symbols
local has_library_deps = false
for _, dep in ipairs(target:orderdeps()) do
if dep:is_shared() or dep:is_static() or dep:is_object() then
dep_symbols = dep:get("symbols")
has_library_deps = true
break
end
end
if has_library_deps then
target:set("symbols", dep_symbols and dep_symbols or "none")
end
-- if use libc++, we need install libc++ and libc++abi
--
-- on ubuntu:
-- sudo apt install libc++-dev libc++abi-15-dev
--
local flags = table.join(target:get("cxxflags") or {}, get_config("cxxflags") or {})
if table.contains(flags, "-stdlib=libc++", "clang::-stdlib=libc++") then
target:data_set("cxx.modules.stdlib", "libc++")
elseif table.contains(flags, "-stdlib=libstdc++", "clang::-stdlib=libstdc++") then
target:data_set("cxx.modules.stdlib", "libstdc++")
end
_set_stdlib_flags(target)
end
-- get includedirs for stl headers
--
-- $ echo '#include <vector>' | clang -x c++ -E - | grep '/vector"'
-- # 1 "/usr/include/c++/11/vector" 1 3
-- # 58 "/usr/include/c++/11/vector" 3
-- # 59 "/usr/include/c++/11/vector" 3
--
function _get_toolchain_includedirs_for_stlheaders(target, includedirs, clang)
local tmpfile = os.tmpfile() .. ".cc"
io.writefile(tmpfile, "#include <vector>")
local argv = {"-E", "-x", "c++", tmpfile}
if _use_stdlib(target, "libc++") then
table.insert(argv, 1, "-stdlib=libc++")
end
local result = try {function () return os.iorunv(clang, argv) end}
if result then
for _, line in ipairs(result:split("\n", {plain = true})) do
line = line:trim()
if line:startswith("#") and line:find("/vector\"", 1, true) then
local includedir = line:match("\"(.+)/vector\"")
if includedir and os.isdir(includedir) then
table.insert(includedirs, path.normalize(includedir))
break
end
end
end
end
os.tryrm(tmpfile)
end
-- do compile for batchcmds
-- @note we need use batchcmds:compilev to translate paths in compflags for generator, e.g. -Ixx
function _batchcmds_compile(batchcmds, target, sourcefile, flags)
local compinst = target:compiler("cxx")
local compflags = compinst:compflags({sourcefile = sourcefile, target = target})
batchcmds:compilev(table.join(compflags or {}, flags), {compiler = compinst, sourcekind = "cxx"})
end
-- build module file
function _build_modulefile(target, sourcefile, opt)
local objectfile = opt.objectfile
local dependfile = opt.dependfile
local compinst = compiler.load("cxx", {target = target})
local compflags = compinst:compflags({sourcefile = sourcefile, target = target})
local dependinfo = option.get("rebuild") and {} or (depend.load(dependfile) or {})
-- need build this object?
local dryrun = option.get("dry-run")
local depvalues = {compinst:program(), compflags}
local lastmtime = os.isfile(objectfile) and os.mtime(dependfile) or 0
if not dryrun and not depend.is_changed(dependinfo, {lastmtime = lastmtime, values = depvalues}) then
return
end
-- init flags
local common_args = opt.common_args
local requiresflags = opt.requiresflags
local moduleoutputflag = get_moduleoutputflag(target)
-- trace
progress.show(opt.progress, "${color.build.object}compiling.module.$(mode) %s", opt.provide and opt.provide.name or sourcefile)
local bmifile
local compileflags = {}
local bmiflags
if opt.provide then
bmifile = opt.provide.bmifile
if moduleoutputflag then
compileflags = table.join("-x", "c++-module", moduleoutputflag .. bmifile, requiresflags)
else
bmiflags = table.join("-x", "c++-module", "--precompile", compflags, common_args, requiresflags)
end
else
compileflags = {"-x", "c++"}
end
if bmiflags then
vprint(compinst:compcmd(sourcefile, bmifile, {compflags = bmiflags, rawargs = true}))
end
compileflags = table.join2(compileflags, compflags, common_args, requiresflags or {})
vprint(compinst:compcmd(bmiflags and bmifile or sourcefile, objectfile, {compflags = compileflags, rawargs = true}))
if not dryrun then
-- do compile
dependinfo.files = {}
if bmiflags then
assert(compinst:compile(sourcefile, bmifile, {dependinfo = dependinfo, compflags = bmiflags}))
end
assert(compinst:compile(bmiflags and bmifile or sourcefile, objectfile, {compflags = compileflags}))
-- update files and values to the dependent file
dependinfo.values = depvalues
table.join2(dependinfo.files, sourcefile)
depend.save(dependinfo, dependfile)
end
end
-- provide toolchain include directories for stl headerunit when p1689 is not supported
function toolchain_includedirs(target)
local includedirs = _g.includedirs
if includedirs == nil then
includedirs = {}
local clang, toolname = target:tool("cxx")
assert(toolname:startswith("clang"))
_get_toolchain_includedirs_for_stlheaders(target, includedirs, clang)
local _, result = try {function () return os.iorunv(clang, {"-E", "-stdlib=libc++", "-Wp,-v", "-xc", os.nuldev()}) end}
if result then
for _, line in ipairs(result:split("\n", {plain = true})) do
line = line:trim()
if os.isdir(line) then
table.insert(includedirs, path.normalize(line))
elseif line:startswith("End") then
break
end
end
end
_g.includedirs = includedirs
end
return includedirs
end
-- generate dependency files
function generate_dependencies(target, sourcebatch, opt)
local changed = false
for _, sourcefile in ipairs(sourcebatch.sourcefiles) do
local dependfile = target:dependfile(sourcefile)
depend.on_changed(function()
if opt.progress then
progress.show(opt.progress, "${color.build.object}generating.module.deps %s", sourcefile)
end
local outputdir = common.get_outputdir(target, sourcefile)
local jsonfile = path.translate(path.join(outputdir, path.filename(sourcefile) .. ".json"))
if has_clangscandepssupport(target) and not target:policy("build.c++.clang.fallbackscanner") then
local clangscandeps = _get_clang_scan_deps(target)
local compinst = target:compiler("cxx")
local compflags = compinst:compflags({sourcefile = sourcefile, target = target})
local flags = table.join("--format=p1689", "--",
compinst:program(), "-x", "c++", "-c", sourcefile, "-o", target:objectfile(sourcefile),
compflags)
vprint(table.concat(table.join(clangscandeps, flags), " "))
local outdata, errdata = os.iorunv(clangscandeps, flags)
assert(errdata, errdata)
io.writefile(jsonfile, outdata)
else
common.fallback_generate_dependencies(target, jsonfile, sourcefile, function(file)
local compinst = target:compiler("cxx")
local compflags = compinst:compflags({sourcefile = file, target = target})
-- exclude -fmodule* and -std=c++/gnu++* flags because, when they are set clang try to find bmi of imported modules but they don't exists a this point of compilation
table.remove_if(compflags, function(_, flag)
return flag:startswith("-fmodule") or flag:startswith("-std=c++") or flag:startswith("-std=gnu++")
end)
local ifile = path.translate(path.join(outputdir, path.filename(file) .. ".i"))
os.vrunv(compinst:program(), table.join(compflags, {"-E", "-x", "c++", file, "-o", ifile}))
local content = io.readfile(ifile)
os.rm(ifile)
return content
end)
end
changed = true
local rawdependinfo = io.readfile(jsonfile)
if rawdependinfo then
local dependinfo = json.decode(rawdependinfo)
if target:data("cxx.modules.stdlib") == nil then
local has_std_modules = false
for _, r in ipairs(dependinfo.rules) do
for _, required in ipairs(r.requires) do
-- it may be `std:utility`, ..
-- @see https://github.com/xmake-io/xmake/issues/3373
local logical_name = required["logical-name"]
if logical_name and (logical_name == "std" or logical_name:startswith("std.") or logical_name:startswith("std:")) then
has_std_modules = true
break
end
end
if has_std_modules then
break
end
end
if has_std_modules then
-- we need clang >= 17.0 or use clang stdmodules if the current target contains std module
local clang_version = _get_clang_version(target)
assert((clang_version and semver.compare(clang_version, "17.0") >= 0) or target:policy("build.c++.clang.stdmodules"),
[[On llvm <= 16 standard C++ modules are not supported ;
they can be emulated through clang modules and supported only on libc++ ;
please add -stdlib=libc++ cxx flag or disable strict mode]])
-- we use libc++ by default if we do not explicitly specify -stdlib:libstdc++
target:data_set("cxx.modules.stdlib", "libc++")
_set_stdlib_flags(target)
end
end
end
return {moduleinfo = rawdependinfo}
end, {dependfile = dependfile, files = {sourcefile}})
end
return changed
end
-- generate target stl header units for batchjobs
function generate_stl_headerunits_for_batchjobs(target, batchjobs, headerunits, opt)
local compinst = target:compiler("cxx")
local stlcachedir = common.stlmodules_cachedir(target, {mkdir = true})
local modulecachepathflag = get_modulecachepathflag(target)
assert(has_headerunitsupport(target), "compiler(clang): does not support c++ header units!")
-- flush job
local flushjob = batchjobs:addjob(target:name() .. "_stl_headerunits_flush_mapper", function(index, total)
_flush_mapper(target)
end, {rootjob = opt.rootjob})
-- build headerunits
for _, headerunit in ipairs(headerunits) do
local bmifile = path.join(stlcachedir, headerunit.name .. get_bmi_extension())
if not os.isfile(bmifile) then
batchjobs:addjob(headerunit.name, function (index, total)
depend.on_changed(function()
-- don't build same header unit at the same time
if not common.memcache():get2(headerunit.name, "building") then
common.memcache():set2(headerunit.name, "building", true)
progress.show((index * 100) / total, "${color.build.object}compiling.headerunit.$(mode) %s", headerunit.name)
local args = {modulecachepathflag .. stlcachedir, "-c", "-Wno-everything", "-o", bmifile, "-x", "c++-system-header", headerunit.name}
os.vrunv(compinst:program(), table.join(compinst:compflags({target = target}), args))
end
end, {dependfile = target:dependfile(bmifile), files = {headerunit.path}})
-- libc++ have a builtin module mapper
if not _use_stdlib(target, "libc++") then
_add_module_to_mapper(target, headerunit.name, bmifile)
end
end, {rootjob = flushjob})
end
end
end
-- generate target stl header units for batchcmds
function generate_stl_headerunits_for_batchcmds(target, batchcmds, headerunits, opt)
local stlcachedir = common.stlmodules_cachedir(target, {mkdir = true})
local modulecachepathflag = get_modulecachepathflag(target)
assert(has_headerunitsupport(target), "compiler(clang): does not support c++ header units!")
-- build headerunits
local depmtime = 0
for _, headerunit in ipairs(headerunits) do
local bmifile = path.join(stlcachedir, headerunit.name .. get_bmi_extension())
-- don't build same header unit at the same time
if not common.memcache():get2(headerunit.name, "building") then
common.memcache():set2(headerunit.name, "building", true)
local flags = {
path(stlcachedir, function (p) return modulecachepathflag .. p end),
"-c", "-o", path(bmifile), "-x", "c++-system-header", headerunit.name}
batchcmds:show_progress(opt.progress, "${color.build.object}compiling.headerunit.$(mode) %s", headerunit.name)
_batchcmds_compile(batchcmds, target, flags)
end
-- libc++ have a builtin module mapper
if not _use_stdlib(target, "libc++") then
_add_module_to_mapper(target, headerunit.name, bmifile)
end
depmtime = math.max(depmtime, os.mtime(bmifile))
end
batchcmds:set_depmtime(depmtime)
_flush_mapper(target)
end
-- generate target user header units for batchjobs
function generate_user_headerunits_for_batchjobs(target, batchjobs, headerunits, opt)
local compinst = target:compiler("cxx")
assert(has_headerunitsupport(target), "compiler(clang): does not support c++ header units!")
-- get cachedirs
local cachedir = common.modules_cachedir(target, {mkdir = true})
local modulecachepathflag = get_modulecachepathflag(target)
-- flush job
local flushjob = batchjobs:addjob(target:name() .. "_user_headerunits_flush_mapper", function(index, total)
_flush_mapper(target)
end, {rootjob = opt.rootjob})
-- build headerunits
for _, headerunit in ipairs(headerunits) do
local file = path.relative(headerunit.path, target:scriptdir())
local objectfile = target:objectfile(file)
local outputdir = common.get_outputdir(target, headerunit.path)
local bmifilename = path.basename(objectfile) .. get_bmi_extension()
local bmifile = path.join(outputdir, bmifilename)
batchjobs:addjob(headerunit.name, function (index, total)
depend.on_changed(function()
progress.show((index * 100) / total, "${color.build.object}compiling.headerunit.$(mode) %s", headerunit.name)
local objectdir = path.directory(objectfile)
if not os.isdir(objectdir) then
os.mkdir(objectdir)
end
if not os.isdir(outputdir) then
os.mkdir(outputdir)
end
-- generate headerunit
local args = { modulecachepathflag .. cachedir, "-c", "-o", bmifile}
if headerunit.type == ":quote" then
table.join2(args, {"-I", path.directory(headerunit.path), "-x", "c++-user-header", headerunit.path})
elseif headerunit.type == ":angle" then
table.join2(args, {"-x", "c++-system-header", headerunit.name})
end
os.vrunv(compinst:program(), table.join(compinst:compflags({target = target}), args))
end, {dependfile = target:dependfile(bmifile), files = {headerunit.path}})
_add_module_to_mapper(target, headerunit.name, bmifile)
end, {rootjob = flushjob})
end
end
-- generate target user header units for batchcmds
function generate_user_headerunits_for_batchcmds(target, batchcmds, headerunits, opt)
assert(has_headerunitsupport(target), "compiler(clang): does not support c++ header units!")
-- get cachedirs
local cachedir = common.modules_cachedir(target, {mkdir = true})
local modulecachepathflag = get_modulecachepathflag(target)
-- build headerunits
local depmtime = 0
for _, headerunit in ipairs(headerunits) do
local file = path.relative(headerunit.path, target:scriptdir())
local objectfile = target:objectfile(file)
local outputdir = common.get_outputdir(target, headerunit.path)
batchcmds:mkdir(outputdir)
local bmifilename = path.basename(objectfile) .. get_bmi_extension()
local bmifile = (outputdir and path.join(outputdir, bmifilename) or bmifilename)
batchcmds:mkdir(path.directory(objectfile))
local flags = {path(cachedir, function (p) return modulecachepathflag .. p end), "-c", "-o", path(bmifile)}
if headerunit.type == ":quote" then
table.join2(flags, {"-I", path(headerunit.path):directory(), "-x", "c++-user-header", path(headerunit.path)})
elseif headerunit.type == ":angle" then
table.join2(flags, {"-x", "c++-system-header", headerunit.name})
end
batchcmds:show_progress(opt.progress, "${color.build.object}compiling.headerunit.$(mode) %s", headerunit.name)
_batchcmds_compile(batchcmds, target, flags)
batchcmds:add_depfiles(headerunit.path)
_add_module_to_mapper(target, headerunit.name, bmifile)
depmtime = math.max(depmtime, os.mtime(bmifile))
end
batchcmds:set_depmtime(depmtime)
_flush_mapper(target)
end
-- build module files for batchjobs
function build_modules_for_batchjobs(target, batchjobs, objectfiles, modules, opt)
-- get flags
local cachedir = common.modules_cachedir(target, {mkdir = true})
local modulecachepathflag = get_modulecachepathflag(target)
-- flush job
local flushjob = batchjobs:addjob(target:name() .. "_modules", function(index, total)
_flush_mapper(target)
end, {rootjob = opt.rootjob})
-- build modules
local common_args = {modulecachepathflag .. cachedir}
local modulesjobs = {}
for _, objectfile in ipairs(objectfiles) do
local module = modules[objectfile]
if module then
local cppfile = module.cppfile
local name, provide
if module.provides then
-- assume there that provides is only one, until we encounter the case
local length = 0
for k, v in pairs(module.provides) do
length = length + 1
name = k
provide = v
cppfile = provide.sourcefile
if length > 1 then
raise("multiple provides are not supported now!")
end
break
end
end
local moduleinfo = table.copy(provide) or {}
if provide then
local fileconfig = target:fileconfig(cppfile)
if fileconfig and fileconfig.install then
batchjobs:addjob(name .. "_metafile", function(index, total)
local outputdir = common.get_outputdir(target, cppfile)
local metafilepath = path.join(outputdir, path.filename(cppfile) .. ".meta-info")
depend.on_changed(function()
progress.show(opt.progress, "${color.build.object}generating.module.metadata %s", name)
local metadata = common.generate_meta_module_info(target, name, cppfile, module.requires)
json.savefile(metafilepath, metadata)
end, {dependfile = target:dependfile(metafilepath), files = {cppfile}})
end, {rootjob = flushjob})
end
end
table.join2(moduleinfo, {
name = name or cppfile,
deps = table.keys(module.requires or {}),
sourcefile = cppfile,
job = batchjobs:newjob(name or cppfile, function(index, total)
-- @note we add it at the end to ensure that the full modulemap are already stored in the mapper
local requiresflags
if module.requires then
requiresflags = get_requiresflags(target, module.requires)
end
if provide or common.has_module_extension(cppfile) then
local bmifile = provide and provide.bmi
if not common.memcache():get2(name or cppfile, "compiling") then
if name and module.external then
common.memcache():set2(name or cppfile, "compiling", true)
end
_build_modulefile(target, provide and provide.sourcefile or cppfile, {
objectfile = objectfile,
dependfile = target:dependfile(bmifile or objectfile),
provide = provide and {bmifile = bmifile, name = name},
common_args = common_args,
requiresflags = requiresflags,
progress = (index * 100) / total})
end
target:add("objectfiles", objectfile)
if provide then
_add_module_to_mapper(target, name, bmifile, {deps = requiresflags, namedmodule = true})
end
elseif requiresflags then
local cxxflags = {}
for _, flag in ipairs(requiresflags) do
-- we need wrap flag to support flag with space
if type(flag) == "string" and flag:find(" ", 1, true) then
table.insert(cxxflags, {flag})
else
table.insert(cxxflags, flag)
end
end
target:fileconfig_add(cppfile, {force = {cxxflags = cxxflags}})
end
end)})
modulesjobs[name or cppfile] = moduleinfo
end
end
-- build batchjobs for modules
common.build_batchjobs_for_modules(modulesjobs, batchjobs, flushjob)
end
-- build module files for batchcmds
function build_modules_for_batchcmds(target, batchcmds, objectfiles, modules, opt)
local cachedir = common.modules_cachedir(target, {mkdir = true})
local modulecachepathflag = get_modulecachepathflag(target)
-- build modules
local depmtime = 0
for _, objectfile in ipairs(objectfiles) do
local module = modules[objectfile]
if module then
local cppfile = module.cppfile
local name, provide
if module.provides then
local length = 0
for k, v in pairs(module.provides) do
length = length + 1
name = k
provide = v
cppfile = provide.sourcefile
if length > 1 then
raise("multiple provides are not supported now!")
end
break
end
end
local requiresflags
if module.requires then
requiresflags = get_requiresflags(target, module.requires)
end
local flags = table.join({path(cachedir, function (p) return modulecachepathflag .. p end)}, requiresflags or {})
if provide or common.has_module_extension(cppfile) then
local file = provide and path(provide.bmi) or path(cppfile)
batchcmds:show_progress(opt.progress, "${color.build.object}compiling.module.$(mode) %s", name or cppfile)
batchcmds:mkdir(path.directory(objectfile))
if provide then
_batchcmds_compile(batchcmds, target, table.join(flags,
{"-x", "c++-module", "--precompile", "-c", path(cppfile), "-o", path(provide.bmi)}))
_add_module_to_mapper(target, name, provide.bmi, {namedmodule = true})
end
_batchcmds_compile(batchcmds, target, file, table.join(flags,
not provide and {"-x", "c++"} or {}, {"-c", file, "-o", path(objectfile)}))
target:add("objectfiles", objectfile)
elseif requiresflags then
local cxxflags = {}
for _, flag in ipairs(requiresflags) do
-- we need wrap flag to support flag with space
if type(flag) == "string" and flag:find(" ", 1, true) then
table.insert(cxxflags, {flag})
else
table.insert(cxxflags, flag)
end
end
target:fileconfig_add(cppfile, {force = {cxxflags = cxxflags}})
end
batchcmds:add_depfiles(cppfile)
depmtime = math.max(depmtime, os.mtime(objectfile))
end
end
batchcmds:set_depmtime(depmtime)
_flush_mapper(target)
end
-- not supported atm
function get_stdmodules(target)
local modules = {}
return modules
end
function get_bmi_extension()
return ".pcm"
end
function get_modulesflag(target)
local clangmodulesflag = _g.clangmodulesflag
local modulestsflag = _g.modulestsflag
local withoutflag = _g.withoutflag
if clangmodulesflag == nil and modulestsflag == nil then
local compinst = target:compiler("cxx")
if compinst:has_flags("-fmodules", "cxxflags", {flagskey = "clang_modules"}) then
clangmodulesflag = "-fmodules"
end
if compinst:has_flags("-fmodules-ts", "cxxflags", {flagskey = "clang_modules_ts"}) then
modulestsflag = "-fmodules-ts"
end
local clang_version = _get_clang_version(target)
withoutflag = semver.compare(clang_version, "16.0") >= 0
assert(withoutflag or modulestsflag, "compiler(clang): does not support c++ module!")
_g.clangmodulesflag = clangmodulesflag or false
_g.modulestsflag = modulestsflag or false
_g.withoutflag = withoutflag or false
end
return clangmodulesflag or nil, modulestsflag or nil, withoutflag or nil
end
function get_builtinmodulemapflag(target)
local builtinmodulemapflag = _g.builtinmodulemapflag
if builtinmodulemapflag == nil then
-- this flag seems clang on mingw doesn't distribute it
-- @see https://github.com/xmake-io/xmake/pull/2833
if not target:is_plat("mingw") then
local compinst = target:compiler("cxx")
if compinst:has_flags("-fbuiltin-module-map", "cxxflags", {flagskey = "clang_builtin_module_map"}) then
builtinmodulemapflag = "-fbuiltin-module-map"
end
assert(builtinmodulemapflag, "compiler(clang): does not support c++ module!")
end
_g.builtinmodulemapflag = builtinmodulemapflag or false
end
return builtinmodulemapflag or nil
end
function get_implicitmodulesflag(target)
local implicitmodulesflag = _g.implicitmodulesflag
if implicitmodulesflag == nil then
local compinst = target:compiler("cxx")
if compinst:has_flags("-fimplicit-modules", "cxxflags", {flagskey = "clang_implicit_modules"}) then
implicitmodulesflag = "-fimplicit-modules"
end
assert(implicitmodulesflag, "compiler(clang): does not support c++ module!")
_g.implicitmodulesflag = implicitmodulesflag or false
end
return implicitmodulesflag or nil
end
function get_implicitmodulemapsflag(target)
local implicitmodulemapsflag = _g.implicitmodulemapsflag
if implicitmodulemapsflag == nil then
local compinst = target:compiler("cxx")
if compinst:has_flags("-fimplicit-module-maps", "cxxflags", {flagskey = "clang_implicit_module_map"}) then
implicitmodulemapsflag = "-fimplicit-module-maps"
end
assert(implicitmodulemapsflag, "compiler(clang): does not support c++ module!")
_g.implicitmodulemapsflag = implicitmodulemapsflag or false
end
return implicitmodulemapsflag or nil
end
function get_noimplicitmodulemapsflag(target)
local noimplicitmodulemapsflag = _g.noimplicitmodulemapsflag
if noimplicitmodulemapsflag == nil then
local compinst = target:compiler("cxx")
if compinst:has_flags("-fno-implicit-module-maps", "cxxflags", {flagskey = "clang_no_implicit_module_maps"}) then
noimplicitmodulemapsflag = "-fno-implicit-module-maps"
end
assert(noimplicitmodulemapsflag, "compiler(clang): does not support c++ module!")
_g.noimplicitmodulemapsflag = noimplicitmodulemapsflag or false
end
return noimplicitmodulemapsflag or nil
end
function get_prebuiltmodulepathflag(target)
local prebuiltmodulepathflag = _g.prebuiltmodulepathflag
if prebuiltmodulepathflag == nil then
local compinst = target:compiler("cxx")
if compinst:has_flags("-fprebuilt-module-path=" .. os.tmpdir(), "cxxflags", {flagskey = "clang_prebuild_module_path"}) then
prebuiltmodulepathflag = "-fprebuilt-module-path="
end
assert(prebuiltmodulepathflag, "compiler(clang): does not support c++ module!")
_g.prebuiltmodulepathflag = prebuiltmodulepathflag or false
end
return prebuiltmodulepathflag or nil
end
function get_modulecachepathflag(target)
local modulecachepathflag = _g.modulecachepathflag
if modulecachepathflag == nil then
local compinst = target:compiler("cxx")
if compinst:has_flags("-fmodules-cache-path=" .. os.tmpdir(), "cxxflags", {flagskey = "clang_modules_cache_path"}) then
modulecachepathflag = "-fmodules-cache-path="
end
assert(modulecachepathflag, "compiler(clang): does not support c++ module!")
_g.modulecachepathflag = modulecachepathflag or false
end
return modulecachepathflag or nil
end
function get_modulefileflag(target)
local modulefileflag = _g.modulefileflag
if modulefileflag == nil then
local compinst = target:compiler("cxx")
if compinst:has_flags("-fmodule-file=" .. os.tmpfile() .. get_bmi_extension(), "cxxflags", {flagskey = "clang_module_file"}) then
modulefileflag = "-fmodule-file="
end
assert(modulefileflag, "compiler(clang): does not support c++ module!")
_g.modulefileflag = modulefileflag or false
end
return modulefileflag or nil
end
function has_headerunitsupport(target)
local support_headerunits = _g.support_headerunits
if support_headerunits == nil then
local compinst = target:compiler("cxx")
local _, modulestsflag, withoutflag = get_modulesflag(target)
modulestsflag = withoutflag and "" or modulestsflag
if compinst:has_flags(modulestsflag .. " -std=c++20 -x c++-user-header", "cxxflags", {
snippet = "inline int foo() { return 0; }",
flagskey = "clang_user_header_unit_support",
tryrun = true}) and
compinst:has_flags(modulestsflag .. " -std=c++20 -x c++-system-header", "cxxflags", {
snippet = "inline int foo() { return 0; }",
flagskey = "clang_system_header_unit_support",
tryrun = true}) then
support_headerunits = true
end
_g.support_headerunits = support_headerunits or false
end
return support_headerunits or nil
end
function has_clangscandepssupport(target)
local support_clangscandeps = _g.support_clangscandeps
if support_clangscandeps == nil then
local clangscandeps = _get_clang_scan_deps(target)
local clang_version = _get_clang_version(target)
if clangscandeps and clang_version and semver.compare(clang_version, "16.0") >= 0 then
support_clangscandeps = true
end
_g.support_clangscandeps = support_clangscandeps or false
end
return support_clangscandeps or nil
end
function get_moduleoutputflag(target)
local moduleoutputflag = _g.moduleoutputflag
if moduleoutputflag == nil then
local compinst = target:compiler("cxx")
local clang_version = _get_clang_version(target)
if compinst:has_flags("-fmodule-output=", "cxxflags", {flagskey = "clang_module_output", tryrun = true}) and
semver.compare(clang_version, "16.0") >= 0 then
moduleoutputflag = "-fmodule-output="
end
_g.moduleoutputflag = moduleoutputflag or false
end
return moduleoutputflag or nil
end
function get_requiresflags(target, requires)
local flags = {}
-- add deps required module flags
local already_mapped_modules = {}
for name, _ in pairs(requires) do
-- if already in flags, continue
if already_mapped_modules[name] then
goto continue
end
for _, dep in ipairs(target:orderdeps()) do
local modulemap_ = _get_modulemap_from_mapper(dep, name)
if modulemap_ then
already_mapped_modules[name] = true
table.insert(flags, modulemap_.flag)
if modulemap_.deps then
table.join2(flags, modulemap_.deps)
end
goto continue
end
end
-- append target required module mapper flags
local modulemap = _get_modulemap_from_mapper(target, name)
if modulemap then
already_mapped_modules[name] = true
table.insert(flags, modulemap.flag)
if modulemap.deps then
table.join2(flags, modulemap.deps)
end
goto continue
end
::continue::
end
if #flags > 0 then
return table.unique(flags)
end
end