-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathgenerate_ndk.cpp
1594 lines (1434 loc) · 64.5 KB
/
generate_ndk.cpp
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 (C) 2018, The Android Open Source Project
*
* 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.
*/
#include "generate_ndk.h"
#include "aidl.h"
#include "aidl_language.h"
#include "aidl_to_common.h"
#include "aidl_to_cpp_common.h"
#include "aidl_to_ndk.h"
#include "logging.h"
#include <android-base/stringprintf.h>
namespace android {
namespace aidl {
namespace ndk {
static constexpr const char* kDescriptor = "descriptor";
static constexpr const char* kVersion = "version";
static constexpr const char* kHash = "hash";
static constexpr const char* kCachedVersion = "_aidl_cached_version";
static constexpr const char* kCachedHash = "_aidl_cached_hash";
static constexpr const char* kCachedHashMutex = "_aidl_cached_hash_mutex";
static constexpr const char* kFunctionNames = "code_to_function";
static constexpr size_t kMaxSkip = 10;
namespace internals {
// 4 outputs for NDK for each type: Header, BpHeader, BnHeader, Source
void GenerateHeader(CodeWriter& out, const AidlTypenames& types,
const AidlDefinedType& defined_type, const Options& options);
void GenerateClientHeader(CodeWriter& out, const AidlTypenames& types,
const AidlDefinedType& defined_type, const Options& options);
void GenerateServerHeader(CodeWriter& out, const AidlTypenames& types,
const AidlDefinedType& defined_type, const Options& options);
void GenerateSource(CodeWriter& out, const AidlTypenames& types,
const AidlDefinedType& defined_type, const Options& options);
// Header contains ClassDecl of a root type
void GenerateInterfaceClassDecl(CodeWriter& out, const AidlTypenames& types,
const AidlInterface& iface, const Options& options);
void GenerateParcelClassDecl(CodeWriter& out, const AidlTypenames& types,
const AidlStructuredParcelable& parcelable, const Options& options);
void GenerateParcelClassDecl(CodeWriter& out, const AidlTypenames& types,
const AidlUnionDecl& union_decl, const Options& options);
void GenerateEnumClassDecl(CodeWriter& out, const AidlTypenames& types,
const AidlEnumDeclaration& enum_decl, const Options& options);
// BpHeader/BnHeader for interface
void GenerateClientHeader(CodeWriter& out, const AidlTypenames& types,
const AidlInterface& defined_type, const Options& options);
void GenerateServerHeader(CodeWriter& out, const AidlTypenames& types,
const AidlInterface& defined_type, const Options& options);
// Source for interface
void GenerateSource(CodeWriter& out, const AidlTypenames& types, const AidlInterface& iface,
const Options& options);
void GenerateClassSource(CodeWriter& out, const AidlTypenames& types,
const AidlInterface& defined_type, const Options& options);
void GenerateClientSource(CodeWriter& out, const AidlTypenames& types,
const AidlInterface& defined_type, const Options& options);
void GenerateServerSource(CodeWriter& out, const AidlTypenames& types,
const AidlInterface& defined_type, const Options& options);
void GenerateInterfaceSource(CodeWriter& out, const AidlTypenames& types,
const AidlInterface& defined_type, const Options& options);
// Source for structured parcelable
void GenerateParcelSource(CodeWriter& out, const AidlTypenames& types,
const AidlStructuredParcelable& defined_type, const Options& options);
// Source for union
void GenerateParcelSource(CodeWriter& out, const AidlTypenames& types,
const AidlUnionDecl& defined_type, const Options& options);
// Compare headers so that <android/..> and <aidl/..> comes after other (probably) std headers.
struct HeaderComp {
static int rank(const string& a) {
return base::StartsWith(a, "aidl/") ? 2 : base::StartsWith(a, "android/") ? 1 : 0;
}
bool operator()(const string& a, const string& b) const {
return std::make_tuple(rank(a), a) < std::make_tuple(rank(b), b);
}
};
} // namespace internals
using namespace internals;
using cpp::ClassNames;
using cpp::GetQualifiedName;
void GenerateNdk(const string& output_file, const Options& options, const AidlTypenames& types,
const AidlDefinedType& defined_type, const IoDelegate& io_delegate) {
using GenFn = void (*)(CodeWriter & out, const AidlTypenames& types,
const AidlDefinedType& defined_type, const Options& options);
// Wrap Generate* function to handle CodeWriter for a file.
auto gen = [&](auto file, GenFn fn) {
unique_ptr<CodeWriter> writer(io_delegate.GetCodeWriter(file));
GenerateAutoGenHeader(*writer, options);
fn(*writer, types, defined_type, options);
AIDL_FATAL_IF(!writer->Close(), defined_type) << "I/O Error!";
};
gen(options.OutputHeaderDir() + NdkHeaderFile(defined_type, ClassNames::RAW), &GenerateHeader);
gen(options.OutputHeaderDir() + NdkHeaderFile(defined_type, ClassNames::CLIENT),
&GenerateClientHeader);
gen(options.OutputHeaderDir() + NdkHeaderFile(defined_type, ClassNames::SERVER),
&GenerateServerHeader);
gen(output_file, &GenerateSource);
}
namespace internals {
void EnterNdkNamespace(CodeWriter& out, const AidlDefinedType& defined_type) {
out << "namespace aidl {\n";
cpp::EnterNamespace(out, defined_type);
}
void LeaveNdkNamespace(CodeWriter& out, const AidlDefinedType& defined_type) {
cpp::LeaveNamespace(out, defined_type);
out << "} // namespace aidl\n";
}
static void StatusCheckGoto(CodeWriter& out) {
out << "if (_aidl_ret_status != STATUS_OK) goto _aidl_error;\n\n";
}
static void StatusCheckBreak(CodeWriter& out) {
out << "if (_aidl_ret_status != STATUS_OK) break;\n\n";
}
static void StatusCheckReturn(CodeWriter& out) {
out << "if (_aidl_ret_status != STATUS_OK) return _aidl_ret_status;\n\n";
}
void GenerateHeaderIncludes(CodeWriter& out, const AidlTypenames& types,
const AidlDefinedType& defined_type, const Options& options);
void GenerateClassDecl(CodeWriter& out, const AidlTypenames& types,
const AidlDefinedType& defined_type, const Options& options);
void GenerateNestedTypeDecls(CodeWriter& out, const AidlTypenames& types,
const AidlDefinedType& defined_type, const Options& options) {
auto visit = [&](const auto& nested) { GenerateClassDecl(out, types, nested, options); };
AIDL_FATAL_IF(!TopologicalVisit(defined_type.GetNestedTypes(), visit), defined_type)
<< "Cycle detected.";
}
void GenerateHeaderDefinitions(CodeWriter& out, const AidlTypenames& types,
const AidlDefinedType& defined_type, const Options& options) {
struct Visitor : AidlVisitor {
CodeWriter& out;
const AidlTypenames& types;
const Options& options;
Visitor(CodeWriter& out, const AidlTypenames& types, const Options& options)
: out(out), types(types), options(options) {}
void Visit(const AidlEnumDeclaration& enum_decl) override {
const auto backing_type = NdkNameOf(types, enum_decl.GetBackingType(), StorageMode::STACK);
EnterNdkNamespace(out, enum_decl);
out << cpp::GenerateEnumToString(enum_decl, backing_type);
LeaveNdkNamespace(out, enum_decl);
out << "namespace ndk {\n";
out << "namespace internal {\n";
out << cpp::GenerateEnumValues(enum_decl, {"aidl"});
out << "} // namespace internal\n";
out << "} // namespace ndk\n";
}
void Visit(const AidlStructuredParcelable& parcelable) override {
if (parcelable.IsGeneric()) {
GenerateParcelSource(out, types, parcelable, options);
}
}
void Visit(const AidlUnionDecl& union_decl) override {
if (union_decl.IsGeneric()) {
GenerateParcelSource(out, types, union_decl, options);
}
}
} v(out, types, options);
VisitTopDown(v, defined_type);
}
void GenerateHeader(CodeWriter& out, const AidlTypenames& types,
const AidlDefinedType& defined_type, const Options& options) {
out << "#pragma once\n\n";
GenerateHeaderIncludes(out, types, defined_type, options);
cpp::GenerateForwardDecls(out, defined_type, true);
EnterNdkNamespace(out, defined_type);
GenerateClassDecl(out, types, defined_type, options);
LeaveNdkNamespace(out, defined_type);
GenerateHeaderDefinitions(out, types, defined_type, options);
}
void GenerateClientHeader(CodeWriter& out, const AidlTypenames& types,
const AidlDefinedType& defined_type, const Options& options) {
if (auto iface = AidlCast<AidlInterface>(defined_type); iface) {
GenerateClientHeader(out, types, *iface, options);
} else if (auto parcelable = AidlCast<AidlStructuredParcelable>(defined_type); parcelable) {
out << "#error TODO(b/111362593) defined_types do not have bp classes\n";
} else if (auto union_decl = AidlCast<AidlUnionDecl>(defined_type); union_decl) {
out << "#error TODO(b/111362593) defined_types do not have bp classes\n";
} else if (auto enum_decl = AidlCast<AidlEnumDeclaration>(defined_type); enum_decl) {
out << "#error TODO(b/111362593) enums do not have bp classes\n";
} else {
AIDL_FATAL(defined_type) << "Unrecognized type sent for NDK generation.";
}
}
void GenerateServerHeader(CodeWriter& out, const AidlTypenames& types,
const AidlDefinedType& defined_type, const Options& options) {
if (auto iface = AidlCast<AidlInterface>(defined_type); iface) {
GenerateServerHeader(out, types, *iface, options);
} else if (auto parcelable = AidlCast<AidlStructuredParcelable>(defined_type); parcelable) {
out << "#error TODO(b/111362593) defined_types do not have bn classes\n";
} else if (auto union_decl = AidlCast<AidlUnionDecl>(defined_type); union_decl) {
out << "#error TODO(b/111362593) defined_types do not have bn classes\n";
} else if (auto enum_decl = AidlCast<AidlEnumDeclaration>(defined_type); enum_decl) {
out << "#error TODO(b/111362593) enums do not have bn classes\n";
} else {
AIDL_FATAL(defined_type) << "Unrecognized type sent for CPP generation.";
}
}
void GenerateSource(CodeWriter& out, const AidlTypenames& types,
const AidlDefinedType& defined_type, const Options& options) {
struct Visitor : AidlVisitor {
CodeWriter& out;
const AidlTypenames& types;
const Options& options;
Visitor(CodeWriter& out, const AidlTypenames& types, const Options& options)
: out(out), types(types), options(options) {}
void Visit(const AidlInterface& interface) override {
GenerateSource(out, types, interface, options);
}
void Visit(const AidlStructuredParcelable& parcelable) override {
if (!parcelable.IsGeneric()) {
GenerateParcelSource(out, types, parcelable, options);
}
}
void Visit(const AidlUnionDecl& union_decl) override {
if (!union_decl.IsGeneric()) {
GenerateParcelSource(out, types, union_decl, options);
}
}
void Visit(const AidlEnumDeclaration& enum_decl) override {
if (!enum_decl.GetParentType()) {
out << "// This file is intentionally left blank as placeholder for enum declaration.\n";
}
}
} v(out, types, options);
VisitTopDown(v, defined_type);
}
void GenerateHeaderIncludes(CodeWriter& out, const AidlTypenames& types,
const AidlDefinedType& defined_type, const Options& options) {
// Collect implementation related headers and referenced defined types by recursivly visiting
// nested types
struct Visitor : AidlVisitor {
const AidlTypenames& types;
const Options& options;
std::set<std::string, HeaderComp> includes;
Visitor(const AidlTypenames& types, const Options& options) : types(types), options(options) {}
// Collect includes for each type reference
void Visit(const AidlTypeSpecifier& type) override {
auto defined = type.GetDefinedType();
if (!defined) return;
includes.insert(NdkHeaderFile(*defined, ClassNames::RAW, false /*use_os_sep*/));
}
// Collect implementation-specific includes for each type definition
void Visit(const AidlInterface& interface) override {
AddCommonHeaders(interface);
includes.insert("android/binder_interface_utils.h");
if (options.GenLog()) {
includes.insert("functional");
includes.insert("chrono");
includes.insert("sstream");
}
// For nested interfaces client/server classes are defined in the same header.
// So we need includes for client/server class as well.
if (interface.GetParentType()) {
includes.insert("android/binder_ibinder.h");
}
}
void Visit(const AidlStructuredParcelable& parcelable) override {
AddCommonHeaders(parcelable);
includes.insert("android/binder_interface_utils.h");
includes.insert("android/binder_parcelable_utils.h");
includes.insert("android/binder_to_string.h"); // used by toString()
}
void Visit(const AidlUnionDecl& union_decl) override {
AddCommonHeaders(union_decl);
includes.insert("android/binder_interface_utils.h");
includes.insert("android/binder_parcelable_utils.h");
includes.insert("android/binder_to_string.h"); // used by toString()
auto union_headers = cpp::UnionWriter::GetHeaders(union_decl);
includes.insert(std::begin(union_headers), std::end(union_headers));
}
void Visit(const AidlEnumDeclaration& enum_decl) override {
AddCommonHeaders(enum_decl);
includes.insert("array");
includes.insert("android/binder_enums.h");
}
void AddCommonHeaders(const AidlDefinedType& defined_type) {
includes.insert("cstdint");
includes.insert("memory");
includes.insert("optional");
includes.insert("string");
includes.insert("vector");
if (defined_type.IsSensitiveData()) {
includes.insert("android/binder_parcel_platform.h");
includes.insert("android/binder_ibinder_platform.h");
}
}
} v(types, options);
VisitTopDown(v, defined_type);
for (const auto& path : v.includes) {
out << "#include <" << path << ">\n";
}
out << "#ifdef BINDER_STABILITY_SUPPORT\n";
out << "#include <android/binder_stability.h>\n";
out << "#endif // BINDER_STABILITY_SUPPORT\n";
out << "\n";
if (v.includes.count("cassert")) {
// TODO(b/31559095) bionic on host should define __assert2
out << "#ifndef __BIONIC__\n#define __assert2(a,b,c,d) ((void)0)\n#endif\n\n";
}
}
void GenerateClassDecl(CodeWriter& out, const AidlTypenames& types,
const AidlDefinedType& defined_type, const Options& options) {
if (auto iface = AidlCast<AidlInterface>(defined_type); iface) {
GenerateInterfaceClassDecl(out, types, *iface, options);
} else if (auto parcelable = AidlCast<AidlStructuredParcelable>(defined_type); parcelable) {
GenerateParcelClassDecl(out, types, *parcelable, options);
} else if (auto union_decl = AidlCast<AidlUnionDecl>(defined_type); union_decl) {
GenerateParcelClassDecl(out, types, *union_decl, options);
} else if (auto enum_decl = AidlCast<AidlEnumDeclaration>(defined_type); enum_decl) {
GenerateEnumClassDecl(out, types, *enum_decl, options);
} else {
AIDL_FATAL(defined_type) << "Unrecognized type sent for NDK generation.";
}
}
static void GenerateSourceIncludes(CodeWriter& out, const AidlTypenames& types,
const AidlDefinedType& defined_type, const Options& options) {
// Once in a .cpp file
if (defined_type.GetParentType() != nullptr) {
return;
}
const string self_header = NdkHeaderFile(defined_type, ClassNames::RAW, false /*use_os_sep*/);
out << "#include \"" << self_header << "\"\n";
out << "\n";
std::set<std::string, HeaderComp> includes = {self_header};
includes.insert("android/binder_parcel_utils.h");
types.IterateTypes([&](const AidlDefinedType& a_defined_type) {
if (a_defined_type.AsInterface() != nullptr) {
includes.insert(NdkHeaderFile(a_defined_type, ClassNames::CLIENT, false /*use_os_sep*/));
includes.insert(NdkHeaderFile(a_defined_type, ClassNames::SERVER, false /*use_os_sep*/));
includes.insert(NdkHeaderFile(a_defined_type, ClassNames::RAW, false /*use_os_sep*/));
}
});
struct Visitor : AidlVisitor {
bool has_interface = false;
void Visit(const AidlInterface&) override { has_interface = true; }
} v;
VisitTopDown(v, defined_type);
if (v.has_interface && options.GenLog()) {
includes.insert("android/binder_to_string.h");
}
// Emit includes except self_header
includes.erase(includes.find(self_header));
for (const auto& inc : includes) {
out << "#include <" << inc << ">\n";
}
out << "\n";
}
static void GenerateConstantDeclarations(CodeWriter& out, const AidlTypenames& types,
const AidlDefinedType& type) {
for (const auto& constant : type.GetConstantDeclarations()) {
const AidlTypeSpecifier& type = constant->GetType();
if (type.Signature() == "String") {
out << "static const char*";
cpp::GenerateDeprecated(out, *constant);
out << " " << constant->GetName() << ";\n";
} else if (type.Signature() == "float" || type.Signature() == "double") {
out << "static constexpr " << NdkNameOf(types, type, StorageMode::STACK) << " ";
out << constant->GetName();
cpp::GenerateDeprecated(out, *constant);
out << " = " << constant->ValueString(ConstantValueDecorator) << ";\n";
} else {
out << "enum : " << NdkNameOf(types, type, StorageMode::STACK) << " { ";
out << constant->GetName();
cpp::GenerateDeprecated(out, *constant);
out << " = " << constant->ValueString(ConstantValueDecorator) << " };\n";
}
}
}
static void GenerateConstantDefinitions(CodeWriter& out, const AidlDefinedType& interface,
const std::string& clazz,
const std::string& tmpl_decl = "") {
for (const auto& constant : interface.GetConstantDeclarations()) {
const AidlConstantValue& value = constant->GetValue();
AIDL_FATAL_IF(value.GetType() == AidlConstantValue::Type::UNARY ||
value.GetType() == AidlConstantValue::Type::BINARY,
value);
if (value.GetType() == AidlConstantValue::Type::STRING) {
out << tmpl_decl;
out << "const char* " << clazz << "::" << constant->GetName() << " = "
<< constant->ValueString(ConstantValueDecorator) << ";\n";
}
}
}
void GenerateSource(CodeWriter& out, const AidlTypenames& types, const AidlInterface& defined_type,
const Options& options) {
GenerateSourceIncludes(out, types, defined_type, options);
EnterNdkNamespace(out, defined_type);
GenerateClassSource(out, types, defined_type, options);
GenerateClientSource(out, types, defined_type, options);
GenerateServerSource(out, types, defined_type, options);
GenerateInterfaceSource(out, types, defined_type, options);
LeaveNdkNamespace(out, defined_type);
}
static std::string MethodId(const AidlMethod& m) {
return "(FIRST_CALL_TRANSACTION + " + std::to_string(m.GetId()) + " /*" + m.GetName() + "*/)";
}
static void GenerateClientMethodDefinition(CodeWriter& out, const AidlTypenames& types,
const AidlInterface& defined_type,
const AidlMethod& method, const Options& options) {
const std::string q_name = GetQualifiedName(defined_type, ClassNames::CLIENT);
const std::string clazz = ClassName(defined_type, ClassNames::CLIENT);
out << NdkMethodDecl(types, method, q_name) << " {\n";
out.Indent();
out << "binder_status_t _aidl_ret_status = STATUS_OK;\n";
out << "::ndk::ScopedAStatus _aidl_status;\n";
if (method.GetName() == kGetInterfaceHash && !options.Hash().empty()) {
out << "const std::lock_guard<std::mutex> lock(" << kCachedHashMutex << ");\n";
out << "if (" << kCachedHash << " != \"-1\") {\n";
out.Indent();
out << "*_aidl_return = " << kCachedHash << ";\n"
<< "_aidl_status.set(AStatus_fromStatus(_aidl_ret_status));\n"
<< "return _aidl_status;\n";
out.Dedent();
out << "}\n";
} else if (method.GetName() == kGetInterfaceVersion && options.Version() > 0) {
out << "if (" << kCachedVersion << " != -1) {\n";
out.Indent();
out << "*_aidl_return = " << kCachedVersion << ";\n"
<< "_aidl_status.set(AStatus_fromStatus(_aidl_ret_status));\n"
<< "return _aidl_status;\n";
out.Dedent();
out << "}\n";
}
out << "::ndk::ScopedAParcel _aidl_in;\n";
out << "::ndk::ScopedAParcel _aidl_out;\n";
out << "\n";
if (options.GenLog()) {
out << cpp::GenLogBeforeExecute(q_name, method, false /* isServer */, true /* isNdk */);
}
if (method.IsNew() && ShouldForceDowngradeFor(CommunicationSide::WRITE) &&
method.IsUserDefined()) {
out << "if (true) {\n";
out << " _aidl_ret_status = STATUS_UNKNOWN_TRANSACTION;\n";
out << " goto _aidl_error;\n";
out << "}\n";
}
out << "_aidl_ret_status = AIBinder_prepareTransaction(asBinderReference().get(), "
"_aidl_in.getR());\n";
if (defined_type.IsSensitiveData()) {
out << "AParcel_markSensitive(_aidl_in.get());\n";
}
StatusCheckGoto(out);
for (const auto& arg : method.GetArguments()) {
const std::string var_name = cpp::BuildVarName(*arg);
if (arg->IsIn()) {
out << "_aidl_ret_status = ";
const std::string prefix = (arg->IsOut() ? "*" : "");
WriteToParcelFor({out, types, arg->GetType(), "_aidl_in.get()", prefix + var_name});
out << ";\n";
StatusCheckGoto(out);
} else if (arg->IsOut() && arg->GetType().IsDynamicArray()) {
out << "_aidl_ret_status = ::ndk::AParcel_writeVectorSize(_aidl_in.get(), *" << var_name
<< ");\n";
StatusCheckGoto(out);
}
}
out << "_aidl_ret_status = AIBinder_transact(\n";
out.Indent();
out << "asBinderReference().get(),\n";
out << MethodId(method) << ",\n";
out << "_aidl_in.getR(),\n";
out << "_aidl_out.getR(),\n";
std::vector<std::string> flags;
if (method.IsOneway()) flags.push_back("FLAG_ONEWAY");
if (defined_type.IsSensitiveData()) flags.push_back("FLAG_CLEAR_BUF");
out << (flags.empty() ? "0" : base::Join(flags, " | ")) << "\n";
out << "#ifdef BINDER_STABILITY_SUPPORT\n";
out << "| static_cast<int>(FLAG_PRIVATE_LOCAL)\n";
out << "#endif // BINDER_STABILITY_SUPPORT\n";
out << ");\n";
out.Dedent();
// If the method is not implmented in the server side but the client has
// provided the default implementation, call it instead of failing hard.
const std::string iface = ClassName(defined_type, ClassNames::INTERFACE);
out << "if (_aidl_ret_status == STATUS_UNKNOWN_TRANSACTION && ";
out << iface << "::getDefaultImpl()) {\n";
out.Indent();
out << "_aidl_status = " << iface << "::getDefaultImpl()->" << method.GetName() << "(";
out << NdkArgList(types, method, FormatArgNameOnly) << ");\n";
out << "goto _aidl_status_return;\n";
out.Dedent();
out << "}\n";
StatusCheckGoto(out);
if (!method.IsOneway()) {
out << "_aidl_ret_status = AParcel_readStatusHeader(_aidl_out.get(), _aidl_status.getR());\n";
StatusCheckGoto(out);
out << "if (!AStatus_isOk(_aidl_status.get())) goto _aidl_status_return;\n";
}
if (method.GetType().GetName() != "void") {
out << "_aidl_ret_status = ";
ReadFromParcelFor({out, types, method.GetType(), "_aidl_out.get()", "_aidl_return"});
out << ";\n";
StatusCheckGoto(out);
if (method.GetName() == kGetInterfaceHash && !options.Hash().empty()) {
out << kCachedHash << " = *_aidl_return;\n";
} else if (method.GetName() == kGetInterfaceVersion && options.Version() > 0) {
out << kCachedVersion << " = *_aidl_return;\n";
}
}
for (const AidlArgument* arg : method.GetOutArguments()) {
out << "_aidl_ret_status = ";
ReadFromParcelFor({out, types, arg->GetType(), "_aidl_out.get()", cpp::BuildVarName(*arg)});
out << ";\n";
StatusCheckGoto(out);
}
out << "_aidl_error:\n";
out << "_aidl_status.set(AStatus_fromStatus(_aidl_ret_status));\n";
out << "_aidl_status_return:\n";
if (options.GenLog()) {
out << cpp::GenLogAfterExecute(q_name, defined_type, method, "_aidl_status", "_aidl_return",
false /* isServer */, true /* isNdk */);
}
out << "return _aidl_status;\n";
out.Dedent();
out << "}\n";
}
static void GenerateServerCaseDefinition(CodeWriter& out, const AidlTypenames& types,
const AidlInterface& defined_type,
const AidlMethod& method, const Options& options) {
const string q_name = GetQualifiedName(defined_type, ClassNames::SERVER);
out << "case " << MethodId(method) << ": {\n";
out.Indent();
if (defined_type.EnforceExpression() || method.GetType().EnforceExpression()) {
out.Write("#error Permission checks not implemented for the ndk backend\n");
}
if (method.IsNew() && ShouldForceDowngradeFor(CommunicationSide::READ) &&
method.IsUserDefined()) {
out << "if (true) break;\n";
}
for (const auto& arg : method.GetArguments()) {
out << NdkNameOf(types, arg->GetType(), StorageMode::STACK) << " " << cpp::BuildVarName(*arg)
<< ";\n";
}
if (method.GetType().GetName() != "void") {
out << NdkNameOf(types, method.GetType(), StorageMode::STACK) << " _aidl_return;\n";
}
out << "\n";
for (const auto& arg : method.GetArguments()) {
const std::string var_name = cpp::BuildVarName(*arg);
if (arg->IsIn()) {
out << "_aidl_ret_status = ";
ReadFromParcelFor({out, types, arg->GetType(), "_aidl_in", "&" + var_name});
out << ";\n";
StatusCheckBreak(out);
} else if (arg->IsOut() && arg->GetType().IsDynamicArray()) {
out << "_aidl_ret_status = ::ndk::AParcel_resizeVector(_aidl_in, &" << var_name << ");\n";
StatusCheckBreak(out);
}
}
if (options.GenLog()) {
out << cpp::GenLogBeforeExecute(q_name, method, true /* isServer */, true /* isNdk */);
}
out << "::ndk::ScopedAStatus _aidl_status = _aidl_impl->" << method.GetName() << "("
<< NdkArgList(types, method, FormatArgForCall) << ");\n";
if (options.GenLog()) {
out << cpp::GenLogAfterExecute(q_name, defined_type, method, "_aidl_status", "_aidl_return",
true /* isServer */, true /* isNdk */);
}
if (method.IsOneway()) {
// For a oneway transaction, the kernel will have already returned a result. This is for the
// in-process case when a oneway transaction is parceled/unparceled in the same process.
out << "_aidl_ret_status = STATUS_OK;\n";
} else {
out << "_aidl_ret_status = AParcel_writeStatusHeader(_aidl_out, _aidl_status.get());\n";
StatusCheckBreak(out);
out << "if (!AStatus_isOk(_aidl_status.get())) break;\n\n";
if (method.GetType().GetName() != "void") {
out << "_aidl_ret_status = ";
WriteToParcelFor({out, types, method.GetType(), "_aidl_out", "_aidl_return"});
out << ";\n";
StatusCheckBreak(out);
}
for (const AidlArgument* arg : method.GetOutArguments()) {
out << "_aidl_ret_status = ";
WriteToParcelFor({out, types, arg->GetType(), "_aidl_out", cpp::BuildVarName(*arg)});
out << ";\n";
StatusCheckBreak(out);
}
}
out << "break;\n";
out.Dedent();
out << "}\n";
}
static string OnTransactFuncName(const AidlInterface& interface) {
string name = interface.GetCanonicalName();
std::replace(name.begin(), name.end(), '.', '_');
return "_aidl_" + name + "_onTransact";
}
static string GlobalClassVarName(const AidlInterface& interface) {
string name = interface.GetCanonicalName();
std::replace(name.begin(), name.end(), '.', '_');
return "_g_aidl_" + name + "_clazz";
}
int GetMaxId(const AidlInterface& defined_type) {
std::vector<int> ids;
for (const auto& method : defined_type.GetMethods()) ids.push_back(method->GetId());
std::sort(ids.begin(), ids.end());
int last_id = -1;
size_t total_skipped = 0;
for (int id : ids) {
if (id > kMaxUserSetMethodId) break;
AIDL_FATAL_IF(id <= last_id, defined_type) << id << last_id;
total_skipped += last_id == -1 ? 0 : id - last_id - 1;
if (total_skipped > kMaxSkip) return last_id;
last_id = id;
}
return last_id;
}
void GenerateClassSource(CodeWriter& out, const AidlTypenames& types,
const AidlInterface& defined_type, const Options& options) {
const std::string i_name = GetQualifiedName(defined_type, ClassNames::INTERFACE);
const std::string q_name = GetQualifiedName(defined_type, ClassNames::SERVER);
const string on_transact = OnTransactFuncName(defined_type);
bool deprecated = defined_type.IsDeprecated() ||
std::any_of(defined_type.GetMethods().begin(), defined_type.GetMethods().end(),
[](const auto& m) { return m->IsDeprecated(); });
if (deprecated) {
out << "#pragma clang diagnostic push\n";
out << "#pragma clang diagnostic ignored \"-Wdeprecated\"\n";
}
out << "static binder_status_t " << on_transact
<< "(AIBinder* _aidl_binder, transaction_code_t _aidl_code, const AParcel* _aidl_in, "
"AParcel* _aidl_out) {\n";
out.Indent();
out << "(void)_aidl_in;\n";
out << "(void)_aidl_out;\n";
out << "binder_status_t _aidl_ret_status = STATUS_UNKNOWN_TRANSACTION;\n";
if (!defined_type.GetMethods().empty()) {
// we know this cast is valid because this method is only called by the ICInterface
// AIBinder_Class object which is associated with this class.
out << "std::shared_ptr<" << q_name << "> _aidl_impl = std::static_pointer_cast<" << q_name
<< ">(::ndk::ICInterface::asInterface(_aidl_binder));\n";
out << "switch (_aidl_code) {\n";
out.Indent();
for (const auto& method : defined_type.GetMethods()) {
GenerateServerCaseDefinition(out, types, defined_type, *method, options);
}
out.Dedent();
out << "}\n";
} else {
out << "(void)_aidl_binder;\n";
out << "(void)_aidl_code;\n";
}
out << "return _aidl_ret_status;\n";
out.Dedent();
out << "}\n\n";
// Find the maxId used for AIDL method. If methods use skipped ids, only support till kMaxSkip.
int maxId = GetMaxId(defined_type);
int functionCount = maxId + 1;
std::string codeToFunction = GlobalClassVarName(defined_type) + "_" + kFunctionNames;
out << "static const char* " << codeToFunction << "[] = { ";
// If tracing is off, don't populate this array. libbinder_ndk will still add traces based on
// transaction code
vector<std::string> functionNames;
if (options.GenTraces() && maxId != -1) {
functionNames.resize(functionCount);
// Assign method names to the proper places in array
for (const auto& method : defined_type.GetMethods()) {
if (method->GetId() >= functionCount) {
continue;
}
functionNames[method->GetId()] = method->GetName();
}
for (const auto& method : functionNames) {
out << "\"" << method << "\",";
}
}
out << "};\n";
out << "static AIBinder_Class* " << GlobalClassVarName(defined_type)
<< " = ::ndk::ICInterface::defineClass(" << i_name << "::" << kDescriptor << ", "
<< on_transact << ", " << codeToFunction << ", " << std::to_string(functionNames.size())
<< ");\n\n";
if (deprecated) {
out << "#pragma clang diagnostic pop\n";
}
}
void GenerateClientSource(CodeWriter& out, const AidlTypenames& types,
const AidlInterface& defined_type, const Options& options) {
const std::string q_name = GetQualifiedName(defined_type, ClassNames::CLIENT);
const std::string clazz = ClassName(defined_type, ClassNames::CLIENT);
out << q_name << "::" << clazz << "(const ::ndk::SpAIBinder& binder) : BpCInterface(binder) {}\n";
out << q_name << "::~" << clazz << "() {}\n";
if (options.GenLog()) {
out << "std::function<void(const " << q_name << "::TransactionLog&)> " << q_name
<< "::logFunc;\n";
}
out << "\n";
for (const auto& method : defined_type.GetMethods()) {
GenerateClientMethodDefinition(out, types, defined_type, *method, options);
}
}
void GenerateServerSource(CodeWriter& out, const AidlTypenames& types,
const AidlInterface& defined_type, const Options& options) {
const std::string q_name = GetQualifiedName(defined_type, ClassNames::SERVER);
const std::string clazz = ClassName(defined_type, ClassNames::SERVER);
const std::string iface = ClassName(defined_type, ClassNames::INTERFACE);
out << "// Source for " << clazz << "\n";
out << q_name << "::" << clazz << "() {}\n";
out << q_name << "::~" << clazz << "() {}\n";
if (options.GenLog()) {
out << "std::function<void(const " << q_name << "::TransactionLog&)> " << q_name
<< "::logFunc;\n";
}
out << "::ndk::SpAIBinder " << q_name << "::createBinder() {\n";
out.Indent();
out << "AIBinder* binder = AIBinder_new(" << GlobalClassVarName(defined_type)
<< ", static_cast<void*>(this));\n";
out << "#ifdef BINDER_STABILITY_SUPPORT\n";
if (defined_type.IsVintfStability()) {
out << "AIBinder_markVintfStability(binder);\n";
} else {
out << "AIBinder_markCompilationUnitStability(binder);\n";
}
out << "#endif // BINDER_STABILITY_SUPPORT\n";
out << "return ::ndk::SpAIBinder(binder);\n";
out.Dedent();
out << "}\n";
// Implement the meta methods
for (const auto& method : defined_type.GetMethods()) {
if (method->IsUserDefined()) {
continue;
}
if (method->GetName() == kGetInterfaceVersion && options.Version() > 0) {
out << NdkMethodDecl(types, *method, q_name) << " {\n";
out.Indent();
out << "*_aidl_return = " << iface << "::" << kVersion << ";\n";
out << "return ::ndk::ScopedAStatus(AStatus_newOk());\n";
out.Dedent();
out << "}\n";
}
if (method->GetName() == kGetInterfaceHash && (!options.Hash().empty())) {
out << NdkMethodDecl(types, *method, q_name) << " {\n";
out.Indent();
out << "*_aidl_return = " << iface << "::" << kHash << ";\n";
out << "return ::ndk::ScopedAStatus(AStatus_newOk());\n";
out.Dedent();
out << "}\n";
}
}
}
void GenerateInterfaceSource(CodeWriter& out, const AidlTypenames& types,
const AidlInterface& defined_type, const Options& options) {
const std::string q_name = GetQualifiedName(defined_type, ClassNames::INTERFACE);
const std::string clazz = ClassName(defined_type, ClassNames::INTERFACE);
const std::string bp_clazz = ClassName(defined_type, ClassNames::CLIENT);
out << "// Source for " << clazz << "\n";
out << "const char* " << q_name << "::" << kDescriptor << " = \"" << defined_type.GetDescriptor()
<< "\";\n";
out << q_name << "::" << clazz << "() {}\n";
out << q_name << "::~" << clazz << "() {}\n";
out << "\n";
GenerateConstantDefinitions(out, defined_type, q_name);
out << "\n";
out << "std::shared_ptr<" << q_name << "> " << q_name
<< "::fromBinder(const ::ndk::SpAIBinder& binder) {\n";
out.Indent();
out << "if (!AIBinder_associateClass(binder.get(), " << GlobalClassVarName(defined_type)
<< ")) {\n";
out.Indent();
// since NDK users don't use weak symbol support, we don't check builtin available. We could
// optionally check it if __ANDROID_UNAVAILABLE_SYMBOLS_ARE_WEAK__ is defined, but this would
// also mean that app developers relying on this behavior would be missing test parity, and if
// local transactions aren't supported, due to missing the descriptor API, they will need to
// work around it a different way, so it's best to check based on __ANDROID_API__
out << "#if __ANDROID_API__ >= 31\n";
out << "const AIBinder_Class* originalClass = AIBinder_getClass(binder.get());\n";
out << "if (originalClass == nullptr) return nullptr;\n";
out << "if (0 == strcmp(AIBinder_Class_getDescriptor(originalClass), descriptor)) {\n";
out.Indent();
// parcel transactions in process, e.g. NDK<->Rust (okay..)
out << "return ::ndk::SharedRefBase::make<" << GetQualifiedName(defined_type, ClassNames::CLIENT)
<< ">(binder);\n";
out.Dedent();
out << "}\n";
out << "#endif\n";
out << "return nullptr;\n";
out.Dedent();
out << "}\n";
out << "std::shared_ptr<::ndk::ICInterface> interface = "
"::ndk::ICInterface::asInterface(binder.get());\n";
out << "if (interface) {\n";
out.Indent();
out << "return std::static_pointer_cast<" << clazz << ">(interface);\n";
out.Dedent();
out << "}\n";
out << "return ::ndk::SharedRefBase::make<" << GetQualifiedName(defined_type, ClassNames::CLIENT)
<< ">(binder);\n";
out.Dedent();
out << "}\n\n";
out << "binder_status_t " << q_name << "::writeToParcel(AParcel* parcel, const std::shared_ptr<"
<< clazz << ">& instance) {\n";
out.Indent();
out << "return AParcel_writeStrongBinder(parcel, instance ? instance->asBinder().get() : "
"nullptr);\n";
out.Dedent();
out << "}\n";
out << "binder_status_t " << q_name << "::readFromParcel(const AParcel* parcel, std::shared_ptr<"
<< clazz << ">* instance) {\n";
out.Indent();
out << "::ndk::SpAIBinder binder;\n";
out << "binder_status_t status = AParcel_readStrongBinder(parcel, binder.getR());\n";
out << "if (status != STATUS_OK) return status;\n";
out << "*instance = " << clazz << "::fromBinder(binder);\n";
out << "return STATUS_OK;\n";
out.Dedent();
out << "}\n";
// defintion for static member setDefaultImpl
out << "bool " << q_name << "::setDefaultImpl(const std::shared_ptr<" << clazz << ">& impl) {\n";
out.Indent();
out << "// Only one user of this interface can use this function\n";
out << "// at a time. This is a heuristic to detect if two different\n";
out << "// users in the same process use this function.\n";
out << "assert(!" << clazz << "::default_impl);\n";
out << "if (impl) {\n";
out.Indent();
out << clazz << "::default_impl = impl;\n";
out << "return true;\n";
out.Dedent();
out << "}\n";
out << "return false;\n";
out.Dedent();
out << "}\n";
// definition for static member getDefaultImpl
out << "const std::shared_ptr<" << q_name << ">& " << q_name << "::getDefaultImpl() {\n";
out.Indent();
out << "return " << clazz << "::default_impl;\n";
out.Dedent();
out << "}\n";
// definition for the static field default_impl
out << "std::shared_ptr<" << q_name << "> " << q_name << "::default_impl = nullptr;\n";
// default implementation for the <Name>Default class members
const std::string defaultClazz = q_name + "Default";
for (const auto& method : defined_type.GetMethods()) {
if (method->IsUserDefined()) {
out << "::ndk::ScopedAStatus " << defaultClazz << "::" << method->GetName() << "("
<< NdkArgList(types, *method, FormatArgNameUnused) << ") {\n";
out.Indent();
out << "::ndk::ScopedAStatus _aidl_status;\n";
out << "_aidl_status.set(AStatus_fromStatus(STATUS_UNKNOWN_TRANSACTION));\n";
out << "return _aidl_status;\n";
out.Dedent();
out << "}\n";
} else {
if (method->GetName() == kGetInterfaceVersion && options.Version() > 0) {
out << "::ndk::ScopedAStatus " << defaultClazz << "::" << method->GetName() << "("
<< "int32_t* _aidl_return) {\n";
out.Indent();
out << "*_aidl_return = 0;\n";
out << "return ::ndk::ScopedAStatus(AStatus_newOk());\n";
out.Dedent();
out << "}\n";
}
if (method->GetName() == kGetInterfaceHash && !options.Hash().empty()) {
out << "::ndk::ScopedAStatus " << defaultClazz << "::" << method->GetName() << "("
<< "std::string* _aidl_return) {\n";
out.Indent();
out << "*_aidl_return = \"\";\n";
out << "return ::ndk::ScopedAStatus(AStatus_newOk());\n";
out.Dedent();
out << "}\n";
}
}
}
out << "::ndk::SpAIBinder " << defaultClazz << "::asBinder() {\n";
out.Indent();
out << "return ::ndk::SpAIBinder();\n";
out.Dedent();
out << "}\n";
out << "bool " << defaultClazz << "::isRemote() {\n";
out.Indent();
out << "return false;\n";
out.Dedent();
out << "}\n";
}
void GenerateClientClassDecl(CodeWriter& out, const AidlTypenames& types,
const AidlInterface& defined_type, const Options& options) {
const std::string clazz = ClassName(defined_type, ClassNames::CLIENT);
out << "class";
cpp::GenerateDeprecated(out, defined_type);
out << " " << clazz << " : public ::ndk::BpCInterface<"