-
Notifications
You must be signed in to change notification settings - Fork 4k
/
StarlarkRuleClassFunctions.java
1069 lines (1003 loc) · 47.6 KB
/
StarlarkRuleClassFunctions.java
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
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright 2014 The Bazel Authors. All rights reserved.
//
// 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.
package com.google.devtools.build.lib.analysis.starlark;
import static com.google.devtools.build.lib.analysis.BaseRuleClasses.RUN_UNDER;
import static com.google.devtools.build.lib.analysis.BaseRuleClasses.TEST_RUNNER_EXEC_GROUP;
import static com.google.devtools.build.lib.analysis.BaseRuleClasses.TIMEOUT_DEFAULT;
import static com.google.devtools.build.lib.analysis.BaseRuleClasses.getTestRuntimeLabelList;
import static com.google.devtools.build.lib.packages.Attribute.attr;
import static com.google.devtools.build.lib.packages.BuildType.LABEL;
import static com.google.devtools.build.lib.packages.BuildType.LABEL_LIST;
import static com.google.devtools.build.lib.packages.BuildType.LICENSE;
import static com.google.devtools.build.lib.packages.Type.BOOLEAN;
import static com.google.devtools.build.lib.packages.Type.INTEGER;
import static com.google.devtools.build.lib.packages.Type.STRING;
import static com.google.devtools.build.lib.packages.Type.STRING_LIST;
import com.github.benmanes.caffeine.cache.CacheLoader;
import com.github.benmanes.caffeine.cache.Caffeine;
import com.github.benmanes.caffeine.cache.LoadingCache;
import com.google.common.base.Preconditions;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableSet;
import com.google.devtools.build.lib.actions.Artifact;
import com.google.devtools.build.lib.analysis.Allowlist;
import com.google.devtools.build.lib.analysis.BaseRuleClasses;
import com.google.devtools.build.lib.analysis.RuleDefinitionEnvironment;
import com.google.devtools.build.lib.analysis.TemplateVariableInfo;
import com.google.devtools.build.lib.analysis.config.ConfigAwareRuleClassBuilder;
import com.google.devtools.build.lib.analysis.config.HostTransition;
import com.google.devtools.build.lib.analysis.config.StarlarkDefinedConfigTransition;
import com.google.devtools.build.lib.analysis.config.transitions.PatchTransition;
import com.google.devtools.build.lib.analysis.config.transitions.StarlarkExposedRuleTransitionFactory;
import com.google.devtools.build.lib.analysis.config.transitions.TransitionFactory;
import com.google.devtools.build.lib.analysis.config.transitions.TransitionFactory.TransitionType;
import com.google.devtools.build.lib.analysis.platform.ConstraintValueInfo;
import com.google.devtools.build.lib.analysis.starlark.StarlarkAttrModule.Descriptor;
import com.google.devtools.build.lib.analysis.test.TestConfiguration;
import com.google.devtools.build.lib.cmdline.Label;
import com.google.devtools.build.lib.cmdline.LabelSyntaxException;
import com.google.devtools.build.lib.cmdline.LabelValidator;
import com.google.devtools.build.lib.cmdline.PackageIdentifier;
import com.google.devtools.build.lib.events.Event;
import com.google.devtools.build.lib.events.EventHandler;
import com.google.devtools.build.lib.events.EventKind;
import com.google.devtools.build.lib.events.StoredEventHandler;
import com.google.devtools.build.lib.packages.AllowlistChecker;
import com.google.devtools.build.lib.packages.Attribute;
import com.google.devtools.build.lib.packages.Attribute.StarlarkComputedDefaultTemplate;
import com.google.devtools.build.lib.packages.AttributeValueSource;
import com.google.devtools.build.lib.packages.BazelModuleContext;
import com.google.devtools.build.lib.packages.BazelStarlarkContext;
import com.google.devtools.build.lib.packages.BuildSetting;
import com.google.devtools.build.lib.packages.BuildType;
import com.google.devtools.build.lib.packages.BuildType.LabelConversionContext;
import com.google.devtools.build.lib.packages.ConfigurationFragmentPolicy.MissingFragmentPolicy;
import com.google.devtools.build.lib.packages.ExecGroup;
import com.google.devtools.build.lib.packages.FunctionSplitTransitionAllowlist;
import com.google.devtools.build.lib.packages.ImplicitOutputsFunction.StarlarkImplicitOutputsFunctionWithCallback;
import com.google.devtools.build.lib.packages.ImplicitOutputsFunction.StarlarkImplicitOutputsFunctionWithMap;
import com.google.devtools.build.lib.packages.Package.NameConflictException;
import com.google.devtools.build.lib.packages.PackageFactory.PackageContext;
import com.google.devtools.build.lib.packages.PredicateWithMessage;
import com.google.devtools.build.lib.packages.Provider;
import com.google.devtools.build.lib.packages.RuleClass;
import com.google.devtools.build.lib.packages.RuleClass.Builder.RuleClassType;
import com.google.devtools.build.lib.packages.RuleClass.ToolchainTransitionMode;
import com.google.devtools.build.lib.packages.RuleFactory;
import com.google.devtools.build.lib.packages.RuleFactory.BuildLangTypedAttributeValuesMap;
import com.google.devtools.build.lib.packages.RuleFactory.InvalidRuleException;
import com.google.devtools.build.lib.packages.RuleFunction;
import com.google.devtools.build.lib.packages.RuleTransitionData;
import com.google.devtools.build.lib.packages.StarlarkAspect;
import com.google.devtools.build.lib.packages.StarlarkCallbackHelper;
import com.google.devtools.build.lib.packages.StarlarkDefinedAspect;
import com.google.devtools.build.lib.packages.StarlarkExportable;
import com.google.devtools.build.lib.packages.StarlarkProvider;
import com.google.devtools.build.lib.packages.StarlarkProviderIdentifier;
import com.google.devtools.build.lib.packages.TargetUtils;
import com.google.devtools.build.lib.packages.Type;
import com.google.devtools.build.lib.packages.Type.ConversionException;
import com.google.devtools.build.lib.skyframe.serialization.autocodec.SerializationConstant;
import com.google.devtools.build.lib.starlarkbuildapi.StarlarkRuleFunctionsApi;
import com.google.devtools.build.lib.util.FileType;
import com.google.devtools.build.lib.util.FileTypeSet;
import com.google.devtools.build.lib.util.Pair;
import com.google.errorprone.annotations.FormatMethod;
import java.util.Collection;
import java.util.Map;
import java.util.Objects;
import javax.annotation.Nullable;
import net.starlark.java.eval.Debug;
import net.starlark.java.eval.Dict;
import net.starlark.java.eval.EvalException;
import net.starlark.java.eval.Module;
import net.starlark.java.eval.Printer;
import net.starlark.java.eval.Sequence;
import net.starlark.java.eval.Starlark;
import net.starlark.java.eval.StarlarkCallable;
import net.starlark.java.eval.StarlarkFunction;
import net.starlark.java.eval.StarlarkInt;
import net.starlark.java.eval.StarlarkThread;
import net.starlark.java.eval.Tuple;
import net.starlark.java.syntax.Identifier;
import net.starlark.java.syntax.Location;
/** A helper class to provide an easier API for Starlark rule definitions. */
public class StarlarkRuleClassFunctions implements StarlarkRuleFunctionsApi<Artifact> {
// TODO(bazel-team): Copied from ConfiguredRuleClassProvider for the transition from built-in
// rules to Starlark extensions. Using the same instance would require a large refactoring.
// If we don't want to support old built-in rules and Starlark simultaneously
// (except for transition phase) it's probably OK.
private static final LoadingCache<String, Label> labelCache =
Caffeine.newBuilder()
.build(
new CacheLoader<String, Label>() {
@Override
public Label load(String from) throws Exception {
try {
return Label.parseAbsolute(
from,
/* defaultToMain=*/ false,
/* repositoryMapping= */ ImmutableMap.of());
} catch (LabelSyntaxException e) {
throw new Exception(from);
}
}
});
// TODO(bazel-team): Remove the code duplication (BaseRuleClasses and this class).
/** Parent rule class for non-executable non-test Starlark rules. */
public static final RuleClass baseRule =
BaseRuleClasses.commonCoreAndStarlarkAttributes(
new RuleClass.Builder("$base_rule", RuleClassType.ABSTRACT, true)
.add(attr("expect_failure", STRING)))
// TODO(skylark-team): Allow Starlark rules to extend native rules and remove duplication.
.add(
attr("toolchains", LABEL_LIST)
.allowedFileTypes(FileTypeSet.NO_FILE)
.mandatoryProviders(ImmutableList.of(TemplateVariableInfo.PROVIDER.id()))
.dontCheckConstraints())
.add(attr(RuleClass.EXEC_PROPERTIES_ATTR, Type.STRING_DICT).value(ImmutableMap.of()))
.add(
attr(RuleClass.EXEC_COMPATIBLE_WITH_ATTR, BuildType.LABEL_LIST)
.allowedFileTypes()
.nonconfigurable("Used in toolchain resolution")
.tool(
"exec_compatible_with exists for constraint checking, not to create an"
+ " actual dependency")
.value(ImmutableList.of()))
.add(
attr(RuleClass.TARGET_COMPATIBLE_WITH_ATTR, LABEL_LIST)
.mandatoryProviders(ConstraintValueInfo.PROVIDER.id())
// This should be configurable to allow for complex types of restrictions.
.tool(
"target_compatible_with exists for constraint checking, not to create an"
+ " actual dependency")
.allowedFileTypes(FileTypeSet.NO_FILE))
.build();
/** Parent rule class for executable non-test Starlark rules. */
public static final RuleClass binaryBaseRule =
new RuleClass.Builder("$binary_base_rule", RuleClassType.ABSTRACT, true, baseRule)
.add(attr("args", STRING_LIST))
.add(attr("output_licenses", LICENSE))
.build();
/** Parent rule class for test Starlark rules. */
public static RuleClass getTestBaseRule(RuleDefinitionEnvironment env) {
String toolsRepository = env.getToolsRepository();
RuleClass.Builder builder =
new RuleClass.Builder("$test_base_rule", RuleClassType.ABSTRACT, true, baseRule)
.requiresConfigurationFragments(TestConfiguration.class)
// TestConfiguration only needed to create TestAction and TestProvider
// Only necessary at top-level and can be skipped if trimmed.
.setMissingFragmentPolicy(TestConfiguration.class, MissingFragmentPolicy.IGNORE)
.add(
attr("size", STRING)
.value("medium")
.taggable()
.nonconfigurable("used in loading phase rule validation logic"))
.add(
attr("timeout", STRING)
.taggable()
.nonconfigurable("policy decision: should be consistent across configurations")
.value(TIMEOUT_DEFAULT))
.add(
attr("flaky", BOOLEAN)
.value(false)
.taggable()
.nonconfigurable("taggable - called in Rule.getRuleTags"))
.add(attr("shard_count", INTEGER).value(StarlarkInt.of(-1)))
.add(
attr("local", BOOLEAN)
.value(false)
.taggable()
.nonconfigurable(
"policy decision: this should be consistent across configurations"))
.add(attr("args", STRING_LIST))
// Input files for every test action
.add(
attr("$test_wrapper", LABEL)
.cfg(HostTransition.createFactory())
.singleArtifact()
.value(labelCache.get(toolsRepository + "//tools/test:test_wrapper")))
.add(
attr("$xml_writer", LABEL)
.cfg(HostTransition.createFactory())
.singleArtifact()
.value(labelCache.get(toolsRepository + "//tools/test:xml_writer")))
.add(
attr("$test_runtime", LABEL_LIST)
.cfg(HostTransition.createFactory())
// Getting this default value through the getTestRuntimeLabelList helper ensures
// we reuse the same ImmutableList<Label> instance for each $test_runtime attr.
.value(getTestRuntimeLabelList(env)))
.add(
attr("$test_setup_script", LABEL)
.cfg(HostTransition.createFactory())
.singleArtifact()
.value(labelCache.get(toolsRepository + "//tools/test:test_setup")))
.add(
attr("$xml_generator_script", LABEL)
.cfg(HostTransition.createFactory())
.singleArtifact()
.value(labelCache.get(toolsRepository + "//tools/test:test_xml_generator")))
.add(
attr("$collect_coverage_script", LABEL)
.cfg(HostTransition.createFactory())
.singleArtifact()
.value(labelCache.get(toolsRepository + "//tools/test:collect_coverage")))
// Input files for test actions collecting code coverage
.add(
attr(":coverage_support", LABEL)
.cfg(HostTransition.createFactory())
.value(
BaseRuleClasses.coverageSupportAttribute(
labelCache.get(
toolsRepository + BaseRuleClasses.DEFAULT_COVERAGE_SUPPORT_VALUE))))
// Used in the one-per-build coverage report generation action.
.add(
attr(":coverage_report_generator", LABEL)
.cfg(HostTransition.createFactory())
.value(
BaseRuleClasses.coverageReportGeneratorAttribute(
labelCache.get(
toolsRepository
+ BaseRuleClasses.DEFAULT_COVERAGE_REPORT_GENERATOR_VALUE))))
.add(attr(":run_under", LABEL).value(RUN_UNDER));
env.getNetworkAllowlistForTests()
.ifPresent(
label ->
builder.add(
Allowlist.getAttributeFromAllowlistName("external_network").value(label)));
return builder.build();
}
@Override
public Provider provider(String doc, Object fields, StarlarkThread thread) throws EvalException {
Collection<String> fieldNames =
fields instanceof Sequence
? Sequence.cast(fields, String.class, "fields")
: fields instanceof Dict
? Dict.cast(fields, String.class, String.class, "fields").keySet()
: null;
return StarlarkProvider.createUnexportedSchemaful(fieldNames, thread.getCallerLocation());
}
// TODO(bazel-team): implement attribute copy and other rule properties
@Override
public StarlarkRuleFunction rule(
StarlarkFunction implementation,
Boolean test,
Object attrs,
Object implicitOutputs,
Boolean executable,
Boolean outputToGenfiles,
Sequence<?> fragments,
Sequence<?> hostFragments,
Boolean starlarkTestable,
Sequence<?> toolchains,
boolean useToolchainTransition,
String doc,
Sequence<?> providesArg,
Sequence<?> execCompatibleWith,
Object analysisTest,
Object buildSetting,
Object cfg,
Object execGroups,
Object compileOneFiletype,
Object name,
StarlarkThread thread)
throws EvalException {
return createRule(
implementation,
test,
attrs,
implicitOutputs,
executable,
outputToGenfiles,
fragments,
hostFragments,
starlarkTestable,
toolchains,
useToolchainTransition,
providesArg,
execCompatibleWith,
analysisTest,
buildSetting,
cfg,
execGroups,
compileOneFiletype,
name,
thread);
}
public static StarlarkRuleFunction createRule(
StarlarkFunction implementation,
boolean test,
Object attrs,
Object implicitOutputs,
boolean executable,
boolean outputToGenfiles,
Sequence<?> fragments,
Sequence<?> hostFragments,
boolean starlarkTestable,
Sequence<?> toolchains,
boolean useToolchainTransition,
Sequence<?> providesArg,
Sequence<?> execCompatibleWith,
Object analysisTest,
Object buildSetting,
Object cfg,
Object execGroups,
Object compileOneFiletype,
Object name,
StarlarkThread thread)
throws EvalException {
BazelStarlarkContext bazelContext = BazelStarlarkContext.from(thread);
bazelContext.checkLoadingOrWorkspacePhase("rule");
// analysis_test=true implies test=true.
test |= Boolean.TRUE.equals(analysisTest);
RuleClassType type = test ? RuleClassType.TEST : RuleClassType.NORMAL;
RuleClass parent =
test ? getTestBaseRule(bazelContext) : (executable ? binaryBaseRule : baseRule);
// We'll set the name later, pass the empty string for now.
RuleClass.Builder builder = new RuleClass.Builder("", type, true, parent);
ImmutableList<StarlarkThread.CallStackEntry> callstack = thread.getCallStack();
builder.setCallStack(callstack.subList(0, callstack.size() - 1)); // pop 'rule' itself
ImmutableList<Pair<String, StarlarkAttrModule.Descriptor>> attributes =
attrObjectToAttributesList(attrs);
if (starlarkTestable) {
builder.setStarlarkTestable();
}
if (Boolean.TRUE.equals(analysisTest)) {
builder.setIsAnalysisTest();
}
if (executable || test) {
builder.addAttribute(
attr("$is_executable", BOOLEAN)
.value(true)
.nonconfigurable("Called from RunCommand.isExecutable, which takes a Target")
.build());
builder.setExecutableStarlark();
}
if (implicitOutputs != Starlark.NONE) {
if (implicitOutputs instanceof StarlarkFunction) {
// TODO(brandjon): Embedding bazelContext in a callback is not thread safe! Instead
// construct a new BazelStarlarkContext with copies of the relevant fields that are safe to
// share. Maybe create a method on BazelStarlarkContext for safely constructing a child
// context.
StarlarkCallbackHelper callback =
new StarlarkCallbackHelper(
(StarlarkFunction) implicitOutputs, thread.getSemantics(), bazelContext);
builder.setImplicitOutputsFunction(
new StarlarkImplicitOutputsFunctionWithCallback(callback));
} else {
builder.setImplicitOutputsFunction(
new StarlarkImplicitOutputsFunctionWithMap(
ImmutableMap.copyOf(
Dict.cast(
implicitOutputs,
String.class,
String.class,
"implicit outputs of the rule class"))));
}
}
if (outputToGenfiles) {
builder.setOutputToGenfiles();
}
builder.requiresConfigurationFragmentsByStarlarkModuleName(
Sequence.cast(fragments, String.class, "fragments"));
ConfigAwareRuleClassBuilder.of(builder)
.requiresHostConfigurationFragmentsByStarlarkBuiltinName(
Sequence.cast(hostFragments, String.class, "host_fragments"));
builder.setConfiguredTargetFunction(implementation);
// Obtain the rule definition environment (RDE) from the .bzl module being initialized by the
// calling thread -- the label and transitive source digest of the .bzl module of the outermost
// function in the call stack.
//
// If this thread is initializing a BUILD file, then the toplevel function's Module has
// no BazelModuleContext. Such rules cannot be instantiated, so it's ok to use a
// dummy label and RDE in that case (but not to crash).
BazelModuleContext bzlModule =
BazelModuleContext.of(getModuleOfOutermostStarlarkFunction(thread));
builder.setRuleDefinitionEnvironmentLabelAndDigest(
bzlModule != null
? bzlModule.label()
: Label.createUnvalidated(PackageIdentifier.EMPTY_PACKAGE_ID, "dummy_label"),
bzlModule != null ? bzlModule.bzlTransitiveDigest() : new byte[0]);
builder.addRequiredToolchains(parseToolchains(toolchains, thread));
if (useToolchainTransition) {
builder.useToolchainTransition(ToolchainTransitionMode.ENABLED);
}
if (execGroups != Starlark.NONE) {
Map<String, ExecGroup> execGroupDict =
Dict.cast(execGroups, String.class, ExecGroup.class, "exec_group");
for (String group : execGroupDict.keySet()) {
// TODO(b/151742236): document this in the param documentation.
if (!StarlarkExecGroupCollection.isValidGroupName(group)) {
throw Starlark.errorf("Exec group name '%s' is not a valid name.", group);
}
}
builder.addExecGroups(execGroupDict);
}
if (test && !builder.hasExecGroup(TEST_RUNNER_EXEC_GROUP)) {
builder.addExecGroup(TEST_RUNNER_EXEC_GROUP);
}
if (!buildSetting.equals(Starlark.NONE) && !cfg.equals(Starlark.NONE)) {
throw Starlark.errorf(
"Build setting rules cannot use the `cfg` param to apply transitions to themselves.");
}
if (!buildSetting.equals(Starlark.NONE)) {
builder.setBuildSetting((BuildSetting) buildSetting);
}
if (!cfg.equals(Starlark.NONE)) {
if (cfg instanceof StarlarkDefinedConfigTransition) {
StarlarkDefinedConfigTransition starlarkDefinedConfigTransition =
(StarlarkDefinedConfigTransition) cfg;
builder.cfg(new StarlarkRuleTransitionProvider(starlarkDefinedConfigTransition));
builder.setHasStarlarkRuleTransition();
} else if (cfg instanceof PatchTransition) {
builder.cfg((PatchTransition) cfg);
} else if (cfg instanceof StarlarkExposedRuleTransitionFactory) {
StarlarkExposedRuleTransitionFactory transition =
(StarlarkExposedRuleTransitionFactory) cfg;
builder.cfg(transition);
transition.addToStarlarkRule(bazelContext, builder);
} else if (cfg instanceof TransitionFactory) {
// This may be redundant with StarlarkExposedRuleTransitionFactory infra
TransitionFactory<? extends TransitionFactory.Data> transitionFactory =
(TransitionFactory<? extends TransitionFactory.Data>) cfg;
if (transitionFactory.transitionType().isCompatibleWith(TransitionType.RULE)) {
@SuppressWarnings("unchecked") // Actually checked due to above isCompatibleWith call.
TransitionFactory<RuleTransitionData> ruleTransitionFactory =
(TransitionFactory<RuleTransitionData>) transitionFactory;
builder.cfg(ruleTransitionFactory);
} else {
throw Starlark.errorf(
"`cfg` must be set to a transition appropriate for a rule, not an attribute-specific"
+ " transition.");
}
} else {
throw Starlark.errorf(
"`cfg` must be set to a transition object initialized by the transition() function.");
}
}
for (Object o : providesArg) {
if (!StarlarkAttrModule.isProvider(o)) {
throw Starlark.errorf(
"Illegal argument: element in 'provides' is of unexpected type. "
+ "Should be list of providers, but got item of type %s.",
Starlark.type(o));
}
}
for (StarlarkProviderIdentifier starlarkProvider :
StarlarkAttrModule.getStarlarkProviderIdentifiers(providesArg)) {
builder.advertiseStarlarkProvider(starlarkProvider);
}
if (!execCompatibleWith.isEmpty()) {
builder.addExecutionPlatformConstraints(parseExecCompatibleWith(execCompatibleWith, thread));
}
if (compileOneFiletype instanceof Sequence) {
if (!bzlModule.label().getRepository().getName().equals("@_builtins")) {
throw Starlark.errorf(
"Rule in '%s' cannot use private API", bzlModule.label().getPackageName());
}
ImmutableList<String> filesTypes =
Sequence.cast(compileOneFiletype, String.class, "compile_one_filetype")
.getImmutableList();
builder.setPreferredDependencyPredicate(FileType.of(filesTypes));
}
StarlarkRuleFunction starlarkRuleFunction =
new StarlarkRuleFunction(builder, type, attributes, thread.getCallerLocation());
// If a name= parameter is supplied (and we're currently initializing a .bzl module), export the
// rule immediately under that name; otherwise the rule will be exported by the postAssignHook
// set up in BzlLoadFunction.
//
// Because exporting can raise multiple errors, we need to accumulate them here into a single
// EvalException. This is a code smell because any non-ERROR events will be lost, and any
// location
// information in the events will be overwritten by the location of this rule's definition.
// However, this is currently fine because StarlarkRuleFunction#export only creates events that
// are ERRORs and that have the rule definition as their location.
// TODO(brandjon): Instead of accumulating events here, consider registering the rule in the
// BazelStarlarkContext, and exporting such rules after module evaluation in
// BzlLoadFunction#execAndExport.
if (name != Starlark.NONE && bzlModule != null) {
StoredEventHandler handler = new StoredEventHandler();
starlarkRuleFunction.export(handler, bzlModule.label(), (String) name);
if (handler.hasErrors()) {
StringBuilder errors =
handler.getEvents().stream()
.filter(e -> e.getKind() == EventKind.ERROR)
.reduce(
new StringBuilder(),
(sb, ev) -> sb.append("\n").append(ev.getMessage()),
StringBuilder::append);
throw Starlark.errorf("Errors in exporting %s: %s", name, errors.toString());
}
}
return starlarkRuleFunction;
}
/**
* Returns the module (file) of the outermost enclosing Starlark function on the call stack or
* null if none of the active calls are functions defined in Starlark.
*/
@Nullable
private static Module getModuleOfOutermostStarlarkFunction(StarlarkThread thread) {
for (Debug.Frame fr : Debug.getCallStack(thread)) {
if (fr.getFunction() instanceof StarlarkFunction) {
return ((StarlarkFunction) fr.getFunction()).getModule();
}
}
return null;
}
private static void checkAttributeName(String name) throws EvalException {
if (!Identifier.isValid(name)) {
throw Starlark.errorf("attribute name `%s` is not a valid identifier.", name);
}
}
private static ImmutableList<Pair<String, StarlarkAttrModule.Descriptor>>
attrObjectToAttributesList(Object attrs) throws EvalException {
ImmutableList.Builder<Pair<String, StarlarkAttrModule.Descriptor>> attributes =
ImmutableList.builder();
if (attrs != Starlark.NONE) {
for (Map.Entry<String, Descriptor> attr :
Dict.cast(attrs, String.class, Descriptor.class, "attrs").entrySet()) {
Descriptor attrDescriptor = attr.getValue();
AttributeValueSource source = attrDescriptor.getValueSource();
checkAttributeName(attr.getKey());
String attrName = source.convertToNativeName(attr.getKey());
attributes.add(Pair.of(attrName, attrDescriptor));
}
}
return attributes.build();
}
/**
* Parses a sequence of label strings with a repo mapping.
*
* @param inputs sequence of input strings
* @param thread repository mapping
* @param adjective describes the purpose of the label; used for errors
* @throws EvalException if the label can't be parsed
*/
private static ImmutableList<Label> parseLabels(
Iterable<String> inputs, StarlarkThread thread, String adjective) throws EvalException {
ImmutableList.Builder<Label> parsedLabels = new ImmutableList.Builder<>();
BazelStarlarkContext bazelStarlarkContext = BazelStarlarkContext.from(thread);
BazelModuleContext moduleContext =
BazelModuleContext.of(Module.ofInnermostEnclosingStarlarkFunction(thread));
LabelConversionContext context =
new LabelConversionContext(
moduleContext.label(),
moduleContext.repoMapping(),
bazelStarlarkContext.getConvertedLabelsInPackage());
for (String input : inputs) {
try {
Label label = context.convert(input);
parsedLabels.add(label);
} catch (LabelSyntaxException e) {
throw Starlark.errorf(
"Unable to parse %s label '%s': %s", adjective, input, e.getMessage());
}
}
return parsedLabels.build();
}
private static ImmutableList<Label> parseToolchains(Sequence<?> inputs, StarlarkThread thread)
throws EvalException {
return parseLabels(Sequence.cast(inputs, String.class, "toolchains"), thread, "toolchain");
}
private static ImmutableList<Label> parseExecCompatibleWith(
Sequence<?> inputs, StarlarkThread thread) throws EvalException {
return parseLabels(
Sequence.cast(inputs, String.class, "exec_compatible_with"), thread, "constraint");
}
@Override
public StarlarkAspect aspect(
StarlarkFunction implementation,
Sequence<?> attributeAspects,
Object attrs,
Sequence<?> requiredProvidersArg,
Sequence<?> requiredAspectProvidersArg,
Sequence<?> providesArg,
Sequence<?> requiredAspects,
Sequence<?> fragments,
Sequence<?> hostFragments,
Sequence<?> toolchains,
boolean useToolchainTransition,
String doc,
Boolean applyToGeneratingRules,
StarlarkThread thread)
throws EvalException {
ImmutableList.Builder<String> attrAspects = ImmutableList.builder();
for (Object attributeAspect : attributeAspects) {
String attrName = STRING.convert(attributeAspect, "attr_aspects");
if (attrName.equals("*") && attributeAspects.size() != 1) {
throw new EvalException("'*' must be the only string in 'attr_aspects' list");
}
if (!attrName.startsWith("_")) {
attrAspects.add(attrName);
} else {
// Implicit attribute names mean either implicit or late-bound attributes
// (``$attr`` or ``:attr``). Depend on both.
attrAspects.add(AttributeValueSource.COMPUTED_DEFAULT.convertToNativeName(attrName));
attrAspects.add(AttributeValueSource.LATE_BOUND.convertToNativeName(attrName));
}
}
ImmutableList<Pair<String, StarlarkAttrModule.Descriptor>> descriptors =
attrObjectToAttributesList(attrs);
ImmutableList.Builder<Attribute> attributes = ImmutableList.builder();
ImmutableSet.Builder<String> requiredParams = ImmutableSet.builder();
for (Pair<String, Descriptor> nameDescriptorPair : descriptors) {
String nativeName = nameDescriptorPair.first;
boolean hasDefault = nameDescriptorPair.second.hasDefault();
Attribute attribute = nameDescriptorPair.second.build(nameDescriptorPair.first);
if (attribute.getType() == Type.STRING
&& ((String) attribute.getDefaultValue(null)).isEmpty()) {
hasDefault = false; // isValueSet() is always true for attr.string.
}
if (!Attribute.isImplicit(nativeName) && !Attribute.isLateBound(nativeName)) {
if (!attribute.checkAllowedValues() || attribute.getType() != Type.STRING) {
throw Starlark.errorf(
"Aspect parameter attribute '%s' must have type 'string' and use the 'values'"
+ " restriction.",
nativeName);
}
if (!hasDefault) {
requiredParams.add(nativeName);
} else {
PredicateWithMessage<Object> allowed = attribute.getAllowedValues();
Object defaultVal = attribute.getDefaultValue(null);
if (!allowed.apply(defaultVal)) {
throw Starlark.errorf(
"Aspect parameter attribute '%s' has a bad default value: %s",
nativeName, allowed.getErrorReason(defaultVal));
}
}
} else if (!hasDefault) { // Implicit or late bound attribute
String starlarkName = "_" + nativeName.substring(1);
throw Starlark.errorf("Aspect attribute '%s' has no default value.", starlarkName);
}
if (attribute.getDefaultValueUnchecked() instanceof StarlarkComputedDefaultTemplate) {
// Attributes specifying dependencies using computed value are currently not supported.
// The limitation is in place because:
// - blaze query requires that all possible values are knowable without BuildConguration
// - aspects can attach to any rule
// Current logic in StarlarkComputedDefault is not enough,
// however {Conservative,Precise}AspectResolver can probably be improved to make that work.
String starlarkName = "_" + nativeName.substring(1);
throw Starlark.errorf(
"Aspect attribute '%s' (%s) with computed default value is unsupported.",
starlarkName, attribute.getType());
}
attributes.add(attribute);
}
for (Object o : providesArg) {
if (!StarlarkAttrModule.isProvider(o)) {
throw Starlark.errorf(
"Illegal argument: element in 'provides' is of unexpected type. "
+ "Should be list of providers, but got item of type %s. ",
Starlark.type(o));
}
}
if (applyToGeneratingRules && !requiredProvidersArg.isEmpty()) {
throw Starlark.errorf(
"An aspect cannot simultaneously have required providers and apply to generating rules.");
}
return new StarlarkDefinedAspect(
implementation,
attrAspects.build(),
attributes.build(),
StarlarkAttrModule.buildProviderPredicate(requiredProvidersArg, "required_providers"),
StarlarkAttrModule.buildProviderPredicate(
requiredAspectProvidersArg, "required_aspect_providers"),
StarlarkAttrModule.getStarlarkProviderIdentifiers(providesArg),
requiredParams.build(),
ImmutableSet.copyOf(Sequence.cast(requiredAspects, StarlarkAspect.class, "requires")),
ImmutableSet.copyOf(Sequence.cast(fragments, String.class, "fragments")),
HostTransition.INSTANCE,
ImmutableSet.copyOf(Sequence.cast(hostFragments, String.class, "host_fragments")),
parseToolchains(toolchains, thread),
useToolchainTransition,
applyToGeneratingRules);
}
/**
* The implementation for the magic function "rule" that creates Starlark rule classes.
*
* <p>Exactly one of {@link #builder} or {@link #ruleClass} is null except inside {@link #export}.
*/
public static final class StarlarkRuleFunction implements StarlarkExportable, RuleFunction {
private RuleClass.Builder builder;
private RuleClass ruleClass;
private final RuleClassType type;
private ImmutableList<Pair<String, StarlarkAttrModule.Descriptor>> attributes;
private final Location definitionLocation;
private Label starlarkLabel;
// TODO(adonovan): merge {Starlark,Builtin}RuleFunction and RuleClass,
// making the latter a callable, StarlarkExportable value.
// (Making RuleClasses first-class values will help us to build a
// rich query output mode that includes values from loaded .bzl files.)
public StarlarkRuleFunction(
RuleClass.Builder builder,
RuleClassType type,
ImmutableList<Pair<String, StarlarkAttrModule.Descriptor>> attributes,
Location definitionLocation) {
this.builder = builder;
this.type = type;
this.attributes = attributes;
this.definitionLocation = definitionLocation;
}
/** This is for post-export reconstruction for serialization. */
private StarlarkRuleFunction(
RuleClass ruleClass, RuleClassType type, Location definitionLocation, Label starlarkLabel) {
Preconditions.checkNotNull(
ruleClass,
"RuleClass must be non-null as this StarlarkRuleFunction should have been exported.");
Preconditions.checkNotNull(
starlarkLabel,
"Label must be non-null as this StarlarkRuleFunction should have been exported.");
this.ruleClass = ruleClass;
this.type = type;
this.definitionLocation = definitionLocation;
this.starlarkLabel = starlarkLabel;
}
@Override
public String getName() {
return ruleClass != null ? ruleClass.getName() : "unexported rule";
}
@Override
public Object call(StarlarkThread thread, Tuple args, Dict<String, Object> kwargs)
throws EvalException, InterruptedException, ConversionException {
if (!args.isEmpty()) {
throw new EvalException("unexpected positional arguments");
}
BazelStarlarkContext.from(thread).checkLoadingPhase(getName());
if (ruleClass == null) {
throw new EvalException("Invalid rule class hasn't been exported by a bzl file");
}
for (Attribute attribute : ruleClass.getAttributes()) {
// TODO(dslomov): If a Starlark parameter extractor is specified for this aspect, its
// attributes may not be required.
for (Map.Entry<String, ImmutableSet<String>> attrRequirements :
attribute.getRequiredAspectParameters().entrySet()) {
for (String required : attrRequirements.getValue()) {
if (!ruleClass.hasAttr(required, Type.STRING)) {
throw Starlark.errorf(
"Aspect %s requires rule %s to specify attribute '%s' with type string.",
attrRequirements.getKey(), ruleClass.getName(), required);
}
}
}
}
BuildLangTypedAttributeValuesMap attributeValues =
new BuildLangTypedAttributeValuesMap(kwargs);
try {
PackageContext pkgContext = thread.getThreadLocal(PackageContext.class);
if (pkgContext == null) {
throw new EvalException(
"Cannot instantiate a rule when loading a .bzl file. "
+ "Rules may be instantiated only in a BUILD thread.");
}
RuleFactory.createAndAddRule(
pkgContext.getBuilder(),
ruleClass,
attributeValues,
pkgContext.getEventHandler(),
thread.getSemantics(),
thread.getCallStack());
} catch (InvalidRuleException | NameConflictException e) {
throw new EvalException(e);
}
return Starlark.NONE;
}
/** Export a RuleFunction from a Starlark file with a given name. */
// To avoid losing event information in the case where the rule was defined with an explicit
// name= arg, all events should be created using errorf(). See the comment in rule() above for
// details.
@Override
public void export(EventHandler handler, Label starlarkLabel, String ruleClassName) {
Preconditions.checkState(ruleClass == null && builder != null);
this.starlarkLabel = starlarkLabel;
if (type == RuleClassType.TEST != TargetUtils.isTestRuleName(ruleClassName)) {
errorf(
handler,
"Invalid rule class name '%s', test rule class names must end with '_test' and other"
+ " rule classes must not",
ruleClassName);
return;
}
// Thus far, we only know if we have a rule transition. While iterating through attributes,
// check if we have an attribute transition.
boolean hasStarlarkDefinedTransition = builder.hasStarlarkRuleTransition();
boolean hasFunctionTransitionAllowlist = false;
for (Pair<String, StarlarkAttrModule.Descriptor> attribute : attributes) {
String name = attribute.getFirst();
StarlarkAttrModule.Descriptor descriptor = attribute.getSecond();
Attribute attr = descriptor.build(name);
hasStarlarkDefinedTransition |= attr.hasStarlarkDefinedTransition();
if (attr.hasAnalysisTestTransition()) {
if (!builder.isAnalysisTest()) {
errorf(
handler,
"Only rule definitions with analysis_test=True may have attributes with"
+ " analysis_test_transition transitions");
continue;
}
builder.setHasAnalysisTestTransition();
}
// Check for existence of the function transition allowlist attribute.
// TODO(b/121385274): remove when we stop allowlisting starlark transitions
if (name.equals(FunctionSplitTransitionAllowlist.ATTRIBUTE_NAME)
|| name.equals(FunctionSplitTransitionAllowlist.LEGACY_ATTRIBUTE_NAME)) {
if (!BuildType.isLabelType(attr.getType())) {
errorf(handler, "_allowlist_function_transition attribute must be a label type");
continue;
}
if (attr.getDefaultValueUnchecked() == null) {
errorf(handler, "_allowlist_function_transition attribute must have a default value");
continue;
}
Label defaultLabel = (Label) attr.getDefaultValueUnchecked();
// Check the label value for package and target name, to make sure this works properly
// in Bazel where it is expected to be found under @bazel_tools.
if (!(defaultLabel
.getPackageName()
.equals(FunctionSplitTransitionAllowlist.LABEL.getPackageName())
&& defaultLabel
.getName()
.equals(FunctionSplitTransitionAllowlist.LABEL.getName()))
&& !(defaultLabel
.getPackageName()
.equals(FunctionSplitTransitionAllowlist.LEGACY_LABEL.getPackageName())
&& defaultLabel
.getName()
.equals(FunctionSplitTransitionAllowlist.LEGACY_LABEL.getName()))) {
errorf(
handler,
"_allowlist_function_transition attribute (%s) does not have the expected value %s",
defaultLabel,
FunctionSplitTransitionAllowlist.LABEL);
continue;
}
hasFunctionTransitionAllowlist = true;
}
try {
builder.addAttribute(attr);
} catch (IllegalStateException ex) {
// TODO(bazel-team): stop using unchecked exceptions in this way.
errorf(handler, "cannot add attribute: %s", ex.getMessage());
}
}
// TODO(b/121385274): remove when we stop allowlisting starlark transitions
if (hasStarlarkDefinedTransition) {
if (!starlarkLabel.getRepository().getName().equals("@_builtins")) {
if (!hasFunctionTransitionAllowlist) {
errorf(
handler,
"Use of Starlark transition without allowlist attribute"
+ " '_allowlist_function_transition'. See Starlark transitions documentation"
+ " for details and usage: %s %s",
builder.getRuleDefinitionEnvironmentLabel(),
builder.getType());
return;
}
builder.addAllowlistChecker(FUNCTION_TRANSITION_ALLOWLIST_CHECKER);
}
} else {
if (hasFunctionTransitionAllowlist) {
errorf(
handler,
"Unused function-based split transition allowlist: %s %s",
builder.getRuleDefinitionEnvironmentLabel(),
builder.getType());
return;
}
}
try {
this.ruleClass = builder.build(ruleClassName, starlarkLabel + "%" + ruleClassName);
} catch (IllegalArgumentException | IllegalStateException ex) {
// TODO(adonovan): this catch statement is an abuse of exceptions. Be more specific.
String msg = ex.getMessage();
errorf(handler, "%s", msg != null ? msg : ex.toString());
}
this.builder = null;
this.attributes = null;
}
@FormatMethod
private void errorf(EventHandler handler, String format, Object... args) {
handler.handle(Event.error(definitionLocation, String.format(format, args)));
}
@Override
public RuleClass getRuleClass() {
Preconditions.checkState(ruleClass != null && builder == null);
return ruleClass;
}
@Override
public boolean isExported() {
return starlarkLabel != null;
}
@Override
public void repr(Printer printer) {
printer.append("<rule>");
}
@Override
public String toString() {
return "rule(...)";
}
@Override
public boolean isImmutable() {
return true;
}
}
@SerializationConstant