clang-tools 19.0.0git
BitcodeReader.cpp
Go to the documentation of this file.
1//===-- BitcodeReader.cpp - ClangDoc Bitcode Reader ------------*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8
9#include "BitcodeReader.h"
10#include "llvm/ADT/IndexedMap.h"
11#include "llvm/Support/Error.h"
12#include "llvm/Support/raw_ostream.h"
13#include <optional>
14
15namespace clang {
16namespace doc {
17
18using Record = llvm::SmallVector<uint64_t, 1024>;
19
20// This implements decode for SmallString.
21llvm::Error decodeRecord(const Record &R, llvm::SmallVectorImpl<char> &Field,
22 llvm::StringRef Blob) {
23 Field.assign(Blob.begin(), Blob.end());
24 return llvm::Error::success();
25}
26
27llvm::Error decodeRecord(const Record &R, SymbolID &Field,
28 llvm::StringRef Blob) {
30 return llvm::createStringError(llvm::inconvertibleErrorCode(),
31 "incorrect USR size");
32
33 // First position in the record is the length of the following array, so we
34 // copy the following elements to the field.
35 for (int I = 0, E = R[0]; I < E; ++I)
36 Field[I] = R[I + 1];
37 return llvm::Error::success();
38}
39
40llvm::Error decodeRecord(const Record &R, bool &Field, llvm::StringRef Blob) {
41 Field = R[0] != 0;
42 return llvm::Error::success();
43}
44
45llvm::Error decodeRecord(const Record &R, int &Field, llvm::StringRef Blob) {
46 if (R[0] > INT_MAX)
47 return llvm::createStringError(llvm::inconvertibleErrorCode(),
48 "integer too large to parse");
49 Field = (int)R[0];
50 return llvm::Error::success();
51}
52
53llvm::Error decodeRecord(const Record &R, AccessSpecifier &Field,
54 llvm::StringRef Blob) {
55 switch (R[0]) {
56 case AS_public:
57 case AS_private:
58 case AS_protected:
59 case AS_none:
60 Field = (AccessSpecifier)R[0];
61 return llvm::Error::success();
62 default:
63 return llvm::createStringError(llvm::inconvertibleErrorCode(),
64 "invalid value for AccessSpecifier");
65 }
66}
67
68llvm::Error decodeRecord(const Record &R, TagTypeKind &Field,
69 llvm::StringRef Blob) {
70 switch (static_cast<TagTypeKind>(R[0])) {
71 case TagTypeKind::Struct:
72 case TagTypeKind::Interface:
73 case TagTypeKind::Union:
74 case TagTypeKind::Class:
75 case TagTypeKind::Enum:
76 Field = static_cast<TagTypeKind>(R[0]);
77 return llvm::Error::success();
78 }
79 return llvm::createStringError(llvm::inconvertibleErrorCode(),
80 "invalid value for TagTypeKind");
81}
82
83llvm::Error decodeRecord(const Record &R, std::optional<Location> &Field,
84 llvm::StringRef Blob) {
85 if (R[0] > INT_MAX)
86 return llvm::createStringError(llvm::inconvertibleErrorCode(),
87 "integer too large to parse");
88 Field.emplace((int)R[0], Blob, (bool)R[1]);
89 return llvm::Error::success();
90}
91
92llvm::Error decodeRecord(const Record &R, InfoType &Field,
93 llvm::StringRef Blob) {
94 switch (auto IT = static_cast<InfoType>(R[0])) {
101 Field = IT;
102 return llvm::Error::success();
103 }
104 return llvm::createStringError(llvm::inconvertibleErrorCode(),
105 "invalid value for InfoType");
106}
107
108llvm::Error decodeRecord(const Record &R, FieldId &Field,
109 llvm::StringRef Blob) {
110 switch (auto F = static_cast<FieldId>(R[0])) {
114 case FieldId::F_type:
118 Field = F;
119 return llvm::Error::success();
120 }
121 return llvm::createStringError(llvm::inconvertibleErrorCode(),
122 "invalid value for FieldId");
123}
124
125llvm::Error decodeRecord(const Record &R,
126 llvm::SmallVectorImpl<llvm::SmallString<16>> &Field,
127 llvm::StringRef Blob) {
128 Field.push_back(Blob);
129 return llvm::Error::success();
130}
131
132llvm::Error decodeRecord(const Record &R,
134 llvm::StringRef Blob) {
135 if (R[0] > INT_MAX)
136 return llvm::createStringError(llvm::inconvertibleErrorCode(),
137 "integer too large to parse");
138 Field.emplace_back((int)R[0], Blob, (bool)R[1]);
139 return llvm::Error::success();
140}
141
142llvm::Error parseRecord(const Record &R, unsigned ID, llvm::StringRef Blob,
143 const unsigned VersionNo) {
144 if (ID == VERSION && R[0] == VersionNo)
145 return llvm::Error::success();
146 return llvm::createStringError(llvm::inconvertibleErrorCode(),
147 "mismatched bitcode version number");
148}
149
150llvm::Error parseRecord(const Record &R, unsigned ID, llvm::StringRef Blob,
151 NamespaceInfo *I) {
152 switch (ID) {
153 case NAMESPACE_USR:
154 return decodeRecord(R, I->USR, Blob);
155 case NAMESPACE_NAME:
156 return decodeRecord(R, I->Name, Blob);
157 case NAMESPACE_PATH:
158 return decodeRecord(R, I->Path, Blob);
159 default:
160 return llvm::createStringError(llvm::inconvertibleErrorCode(),
161 "invalid field for NamespaceInfo");
162 }
163}
164
165llvm::Error parseRecord(const Record &R, unsigned ID, llvm::StringRef Blob,
166 RecordInfo *I) {
167 switch (ID) {
168 case RECORD_USR:
169 return decodeRecord(R, I->USR, Blob);
170 case RECORD_NAME:
171 return decodeRecord(R, I->Name, Blob);
172 case RECORD_PATH:
173 return decodeRecord(R, I->Path, Blob);
175 return decodeRecord(R, I->DefLoc, Blob);
176 case RECORD_LOCATION:
177 return decodeRecord(R, I->Loc, Blob);
178 case RECORD_TAG_TYPE:
179 return decodeRecord(R, I->TagType, Blob);
181 return decodeRecord(R, I->IsTypeDef, Blob);
182 default:
183 return llvm::createStringError(llvm::inconvertibleErrorCode(),
184 "invalid field for RecordInfo");
185 }
186}
187
188llvm::Error parseRecord(const Record &R, unsigned ID, llvm::StringRef Blob,
189 BaseRecordInfo *I) {
190 switch (ID) {
191 case BASE_RECORD_USR:
192 return decodeRecord(R, I->USR, Blob);
193 case BASE_RECORD_NAME:
194 return decodeRecord(R, I->Name, Blob);
195 case BASE_RECORD_PATH:
196 return decodeRecord(R, I->Path, Blob);
198 return decodeRecord(R, I->TagType, Blob);
200 return decodeRecord(R, I->IsVirtual, Blob);
202 return decodeRecord(R, I->Access, Blob);
204 return decodeRecord(R, I->IsParent, Blob);
205 default:
206 return llvm::createStringError(llvm::inconvertibleErrorCode(),
207 "invalid field for BaseRecordInfo");
208 }
209}
210
211llvm::Error parseRecord(const Record &R, unsigned ID, llvm::StringRef Blob,
212 EnumInfo *I) {
213 switch (ID) {
214 case ENUM_USR:
215 return decodeRecord(R, I->USR, Blob);
216 case ENUM_NAME:
217 return decodeRecord(R, I->Name, Blob);
218 case ENUM_DEFLOCATION:
219 return decodeRecord(R, I->DefLoc, Blob);
220 case ENUM_LOCATION:
221 return decodeRecord(R, I->Loc, Blob);
222 case ENUM_SCOPED:
223 return decodeRecord(R, I->Scoped, Blob);
224 default:
225 return llvm::createStringError(llvm::inconvertibleErrorCode(),
226 "invalid field for EnumInfo");
227 }
228}
229
230llvm::Error parseRecord(const Record &R, unsigned ID, llvm::StringRef Blob,
231 TypedefInfo *I) {
232 switch (ID) {
233 case TYPEDEF_USR:
234 return decodeRecord(R, I->USR, Blob);
235 case TYPEDEF_NAME:
236 return decodeRecord(R, I->Name, Blob);
238 return decodeRecord(R, I->DefLoc, Blob);
239 case TYPEDEF_IS_USING:
240 return decodeRecord(R, I->IsUsing, Blob);
241 default:
242 return llvm::createStringError(llvm::inconvertibleErrorCode(),
243 "invalid field for TypedefInfo");
244 }
245}
246
247llvm::Error parseRecord(const Record &R, unsigned ID, llvm::StringRef Blob,
248 EnumValueInfo *I) {
249 switch (ID) {
250 case ENUM_VALUE_NAME:
251 return decodeRecord(R, I->Name, Blob);
252 case ENUM_VALUE_VALUE:
253 return decodeRecord(R, I->Value, Blob);
254 case ENUM_VALUE_EXPR:
255 return decodeRecord(R, I->ValueExpr, Blob);
256 default:
257 return llvm::createStringError(llvm::inconvertibleErrorCode(),
258 "invalid field for EnumValueInfo");
259 }
260}
261
262llvm::Error parseRecord(const Record &R, unsigned ID, llvm::StringRef Blob,
263 FunctionInfo *I) {
264 switch (ID) {
265 case FUNCTION_USR:
266 return decodeRecord(R, I->USR, Blob);
267 case FUNCTION_NAME:
268 return decodeRecord(R, I->Name, Blob);
270 return decodeRecord(R, I->DefLoc, Blob);
272 return decodeRecord(R, I->Loc, Blob);
273 case FUNCTION_ACCESS:
274 return decodeRecord(R, I->Access, Blob);
276 return decodeRecord(R, I->IsMethod, Blob);
277 default:
278 return llvm::createStringError(llvm::inconvertibleErrorCode(),
279 "invalid field for FunctionInfo");
280 }
281}
282
283llvm::Error parseRecord(const Record &R, unsigned ID, llvm::StringRef Blob,
284 TypeInfo *I) {
285 return llvm::Error::success();
286}
287
288llvm::Error parseRecord(const Record &R, unsigned ID, llvm::StringRef Blob,
289 FieldTypeInfo *I) {
290 switch (ID) {
291 case FIELD_TYPE_NAME:
292 return decodeRecord(R, I->Name, Blob);
294 return decodeRecord(R, I->DefaultValue, Blob);
295 default:
296 return llvm::createStringError(llvm::inconvertibleErrorCode(),
297 "invalid field for TypeInfo");
298 }
299}
300
301llvm::Error parseRecord(const Record &R, unsigned ID, llvm::StringRef Blob,
302 MemberTypeInfo *I) {
303 switch (ID) {
304 case MEMBER_TYPE_NAME:
305 return decodeRecord(R, I->Name, Blob);
307 return decodeRecord(R, I->Access, Blob);
308 default:
309 return llvm::createStringError(llvm::inconvertibleErrorCode(),
310 "invalid field for MemberTypeInfo");
311 }
312}
313
314llvm::Error parseRecord(const Record &R, unsigned ID, llvm::StringRef Blob,
315 CommentInfo *I) {
316 switch (ID) {
317 case COMMENT_KIND:
318 return decodeRecord(R, I->Kind, Blob);
319 case COMMENT_TEXT:
320 return decodeRecord(R, I->Text, Blob);
321 case COMMENT_NAME:
322 return decodeRecord(R, I->Name, Blob);
324 return decodeRecord(R, I->Direction, Blob);
326 return decodeRecord(R, I->ParamName, Blob);
328 return decodeRecord(R, I->CloseName, Blob);
329 case COMMENT_ATTRKEY:
330 return decodeRecord(R, I->AttrKeys, Blob);
331 case COMMENT_ATTRVAL:
332 return decodeRecord(R, I->AttrValues, Blob);
333 case COMMENT_ARG:
334 return decodeRecord(R, I->Args, Blob);
336 return decodeRecord(R, I->SelfClosing, Blob);
337 case COMMENT_EXPLICIT:
338 return decodeRecord(R, I->Explicit, Blob);
339 default:
340 return llvm::createStringError(llvm::inconvertibleErrorCode(),
341 "invalid field for CommentInfo");
342 }
343}
344
345llvm::Error parseRecord(const Record &R, unsigned ID, llvm::StringRef Blob,
346 Reference *I, FieldId &F) {
347 switch (ID) {
348 case REFERENCE_USR:
349 return decodeRecord(R, I->USR, Blob);
350 case REFERENCE_NAME:
351 return decodeRecord(R, I->Name, Blob);
353 return decodeRecord(R, I->QualName, Blob);
354 case REFERENCE_TYPE:
355 return decodeRecord(R, I->RefType, Blob);
356 case REFERENCE_PATH:
357 return decodeRecord(R, I->Path, Blob);
358 case REFERENCE_FIELD:
359 return decodeRecord(R, F, Blob);
360 default:
361 return llvm::createStringError(llvm::inconvertibleErrorCode(),
362 "invalid field for Reference");
363 }
364}
365
366llvm::Error parseRecord(const Record &R, unsigned ID, llvm::StringRef Blob,
367 TemplateInfo *I) {
368 // Currently there are no child records of TemplateInfo (only child blocks).
369 return llvm::createStringError(llvm::inconvertibleErrorCode(),
370 "invalid field for TemplateParamInfo");
371}
372
373llvm::Error parseRecord(const Record &R, unsigned ID, llvm::StringRef Blob,
376 return decodeRecord(R, I->SpecializationOf, Blob);
377 return llvm::createStringError(llvm::inconvertibleErrorCode(),
378 "invalid field for TemplateParamInfo");
379}
380
381llvm::Error parseRecord(const Record &R, unsigned ID, llvm::StringRef Blob,
384 return decodeRecord(R, I->Contents, Blob);
385 return llvm::createStringError(llvm::inconvertibleErrorCode(),
386 "invalid field for TemplateParamInfo");
387}
388
389template <typename T> llvm::Expected<CommentInfo *> getCommentInfo(T I) {
390 return llvm::createStringError(llvm::inconvertibleErrorCode(),
391 "invalid type cannot contain CommentInfo");
392}
393
394template <> llvm::Expected<CommentInfo *> getCommentInfo(FunctionInfo *I) {
395 return &I->Description.emplace_back();
396}
397
398template <> llvm::Expected<CommentInfo *> getCommentInfo(NamespaceInfo *I) {
399 return &I->Description.emplace_back();
400}
401
402template <> llvm::Expected<CommentInfo *> getCommentInfo(RecordInfo *I) {
403 return &I->Description.emplace_back();
404}
405
406template <> llvm::Expected<CommentInfo *> getCommentInfo(MemberTypeInfo *I) {
407 return &I->Description.emplace_back();
408}
409
410template <> llvm::Expected<CommentInfo *> getCommentInfo(EnumInfo *I) {
411 return &I->Description.emplace_back();
412}
413
414template <> llvm::Expected<CommentInfo *> getCommentInfo(TypedefInfo *I) {
415 return &I->Description.emplace_back();
416}
417
418template <> llvm::Expected<CommentInfo *> getCommentInfo(CommentInfo *I) {
419 I->Children.emplace_back(std::make_unique<CommentInfo>());
420 return I->Children.back().get();
421}
422
423template <>
424llvm::Expected<CommentInfo *> getCommentInfo(std::unique_ptr<CommentInfo> &I) {
425 return getCommentInfo(I.get());
426}
427
428// When readSubBlock encounters a TypeInfo sub-block, it calls addTypeInfo on
429// the parent block to set it. The template specializations define what to do
430// for each supported parent block.
431template <typename T, typename TTypeInfo>
432llvm::Error addTypeInfo(T I, TTypeInfo &&TI) {
433 return llvm::createStringError(llvm::inconvertibleErrorCode(),
434 "invalid type cannot contain TypeInfo");
435}
436
437template <> llvm::Error addTypeInfo(RecordInfo *I, MemberTypeInfo &&T) {
438 I->Members.emplace_back(std::move(T));
439 return llvm::Error::success();
440}
441
442template <> llvm::Error addTypeInfo(BaseRecordInfo *I, MemberTypeInfo &&T) {
443 I->Members.emplace_back(std::move(T));
444 return llvm::Error::success();
445}
446
447template <> llvm::Error addTypeInfo(FunctionInfo *I, TypeInfo &&T) {
448 I->ReturnType = std::move(T);
449 return llvm::Error::success();
450}
451
452template <> llvm::Error addTypeInfo(FunctionInfo *I, FieldTypeInfo &&T) {
453 I->Params.emplace_back(std::move(T));
454 return llvm::Error::success();
455}
456
457template <> llvm::Error addTypeInfo(EnumInfo *I, TypeInfo &&T) {
458 I->BaseType = std::move(T);
459 return llvm::Error::success();
460}
461
462template <> llvm::Error addTypeInfo(TypedefInfo *I, TypeInfo &&T) {
463 I->Underlying = std::move(T);
464 return llvm::Error::success();
465}
466
467template <typename T> llvm::Error addReference(T I, Reference &&R, FieldId F) {
468 return llvm::createStringError(llvm::inconvertibleErrorCode(),
469 "invalid type cannot contain Reference");
470}
471
472template <> llvm::Error addReference(TypeInfo *I, Reference &&R, FieldId F) {
473 switch (F) {
474 case FieldId::F_type:
475 I->Type = std::move(R);
476 return llvm::Error::success();
477 default:
478 return llvm::createStringError(llvm::inconvertibleErrorCode(),
479 "invalid type cannot contain Reference");
480 }
481}
482
483template <>
485 switch (F) {
486 case FieldId::F_type:
487 I->Type = std::move(R);
488 return llvm::Error::success();
489 default:
490 return llvm::createStringError(llvm::inconvertibleErrorCode(),
491 "invalid type cannot contain Reference");
492 }
493}
494
495template <>
497 switch (F) {
498 case FieldId::F_type:
499 I->Type = std::move(R);
500 return llvm::Error::success();
501 default:
502 return llvm::createStringError(llvm::inconvertibleErrorCode(),
503 "invalid type cannot contain Reference");
504 }
505}
506
507template <> llvm::Error addReference(EnumInfo *I, Reference &&R, FieldId F) {
508 switch (F) {
510 I->Namespace.emplace_back(std::move(R));
511 return llvm::Error::success();
512 default:
513 return llvm::createStringError(llvm::inconvertibleErrorCode(),
514 "invalid type cannot contain Reference");
515 }
516}
517
518template <> llvm::Error addReference(TypedefInfo *I, Reference &&R, FieldId F) {
519 switch (F) {
521 I->Namespace.emplace_back(std::move(R));
522 return llvm::Error::success();
523 default:
524 return llvm::createStringError(llvm::inconvertibleErrorCode(),
525 "invalid type cannot contain Reference");
526 }
527}
528
529template <>
531 switch (F) {
533 I->Namespace.emplace_back(std::move(R));
534 return llvm::Error::success();
536 I->Children.Namespaces.emplace_back(std::move(R));
537 return llvm::Error::success();
539 I->Children.Records.emplace_back(std::move(R));
540 return llvm::Error::success();
541 default:
542 return llvm::createStringError(llvm::inconvertibleErrorCode(),
543 "invalid type cannot contain Reference");
544 }
545}
546
547template <>
549 switch (F) {
551 I->Namespace.emplace_back(std::move(R));
552 return llvm::Error::success();
554 I->Parent = std::move(R);
555 return llvm::Error::success();
556 default:
557 return llvm::createStringError(llvm::inconvertibleErrorCode(),
558 "invalid type cannot contain Reference");
559 }
560}
561
562template <> llvm::Error addReference(RecordInfo *I, Reference &&R, FieldId F) {
563 switch (F) {
565 I->Namespace.emplace_back(std::move(R));
566 return llvm::Error::success();
568 I->Parents.emplace_back(std::move(R));
569 return llvm::Error::success();
571 I->VirtualParents.emplace_back(std::move(R));
572 return llvm::Error::success();
574 I->Children.Records.emplace_back(std::move(R));
575 return llvm::Error::success();
576 default:
577 return llvm::createStringError(llvm::inconvertibleErrorCode(),
578 "invalid type cannot contain Reference");
579 }
580}
581
582template <typename T, typename ChildInfoType>
583void addChild(T I, ChildInfoType &&R) {
584 llvm::errs() << "invalid child type for info";
585 exit(1);
586}
587
588// Namespace children:
589template <> void addChild(NamespaceInfo *I, FunctionInfo &&R) {
590 I->Children.Functions.emplace_back(std::move(R));
591}
592template <> void addChild(NamespaceInfo *I, EnumInfo &&R) {
593 I->Children.Enums.emplace_back(std::move(R));
594}
595template <> void addChild(NamespaceInfo *I, TypedefInfo &&R) {
596 I->Children.Typedefs.emplace_back(std::move(R));
597}
598
599// Record children:
600template <> void addChild(RecordInfo *I, FunctionInfo &&R) {
601 I->Children.Functions.emplace_back(std::move(R));
602}
603template <> void addChild(RecordInfo *I, EnumInfo &&R) {
604 I->Children.Enums.emplace_back(std::move(R));
605}
606template <> void addChild(RecordInfo *I, TypedefInfo &&R) {
607 I->Children.Typedefs.emplace_back(std::move(R));
608}
609
610// Other types of children:
611template <> void addChild(EnumInfo *I, EnumValueInfo &&R) {
612 I->Members.emplace_back(std::move(R));
613}
614template <> void addChild(RecordInfo *I, BaseRecordInfo &&R) {
615 I->Bases.emplace_back(std::move(R));
616}
617template <> void addChild(BaseRecordInfo *I, FunctionInfo &&R) {
618 I->Children.Functions.emplace_back(std::move(R));
619}
620
621// TemplateParam children. These go into either a TemplateInfo (for template
622// parameters) or TemplateSpecializationInfo (for the specialization's
623// parameters).
624template <typename T> void addTemplateParam(T I, TemplateParamInfo &&P) {
625 llvm::errs() << "invalid container for template parameter";
626 exit(1);
627}
629 I->Params.emplace_back(std::move(P));
630}
631template <>
633 I->Params.emplace_back(std::move(P));
634}
635
636// Template info. These apply to either records or functions.
637template <typename T> void addTemplate(T I, TemplateInfo &&P) {
638 llvm::errs() << "invalid container for template info";
639 exit(1);
640}
641template <> void addTemplate(RecordInfo *I, TemplateInfo &&P) {
642 I->Template.emplace(std::move(P));
643}
644template <> void addTemplate(FunctionInfo *I, TemplateInfo &&P) {
645 I->Template.emplace(std::move(P));
646}
647
648// Template specializations go only into template records.
649template <typename T>
651 llvm::errs() << "invalid container for template specialization info";
652 exit(1);
653}
654template <>
657 I->Specialization.emplace(std::move(TSI));
658}
659
660// Read records from bitcode into a given info.
661template <typename T>
662llvm::Error ClangDocBitcodeReader::readRecord(unsigned ID, T I) {
663 Record R;
664 llvm::StringRef Blob;
665 llvm::Expected<unsigned> MaybeRecID = Stream.readRecord(ID, R, &Blob);
666 if (!MaybeRecID)
667 return MaybeRecID.takeError();
668 return parseRecord(R, MaybeRecID.get(), Blob, I);
669}
670
671template <>
672llvm::Error ClangDocBitcodeReader::readRecord(unsigned ID, Reference *I) {
673 Record R;
674 llvm::StringRef Blob;
675 llvm::Expected<unsigned> MaybeRecID = Stream.readRecord(ID, R, &Blob);
676 if (!MaybeRecID)
677 return MaybeRecID.takeError();
678 return parseRecord(R, MaybeRecID.get(), Blob, I, CurrentReferenceField);
679}
680
681// Read a block of records into a single info.
682template <typename T>
683llvm::Error ClangDocBitcodeReader::readBlock(unsigned ID, T I) {
684 if (llvm::Error Err = Stream.EnterSubBlock(ID))
685 return Err;
686
687 while (true) {
688 unsigned BlockOrCode = 0;
689 Cursor Res = skipUntilRecordOrBlock(BlockOrCode);
690
691 switch (Res) {
692 case Cursor::BadBlock:
693 return llvm::createStringError(llvm::inconvertibleErrorCode(),
694 "bad block found");
695 case Cursor::BlockEnd:
696 return llvm::Error::success();
697 case Cursor::BlockBegin:
698 if (llvm::Error Err = readSubBlock(BlockOrCode, I)) {
699 if (llvm::Error Skipped = Stream.SkipBlock())
700 return joinErrors(std::move(Err), std::move(Skipped));
701 return Err;
702 }
703 continue;
704 case Cursor::Record:
705 break;
706 }
707 if (auto Err = readRecord(BlockOrCode, I))
708 return Err;
709 }
710}
711
712template <typename T>
713llvm::Error ClangDocBitcodeReader::readSubBlock(unsigned ID, T I) {
714 switch (ID) {
715 // Blocks can only have certain types of sub blocks.
716 case BI_COMMENT_BLOCK_ID: {
717 auto Comment = getCommentInfo(I);
718 if (!Comment)
719 return Comment.takeError();
720 if (auto Err = readBlock(ID, Comment.get()))
721 return Err;
722 return llvm::Error::success();
723 }
724 case BI_TYPE_BLOCK_ID: {
725 TypeInfo TI;
726 if (auto Err = readBlock(ID, &TI))
727 return Err;
728 if (auto Err = addTypeInfo(I, std::move(TI)))
729 return Err;
730 return llvm::Error::success();
731 }
733 FieldTypeInfo TI;
734 if (auto Err = readBlock(ID, &TI))
735 return Err;
736 if (auto Err = addTypeInfo(I, std::move(TI)))
737 return Err;
738 return llvm::Error::success();
739 }
741 MemberTypeInfo TI;
742 if (auto Err = readBlock(ID, &TI))
743 return Err;
744 if (auto Err = addTypeInfo(I, std::move(TI)))
745 return Err;
746 return llvm::Error::success();
747 }
749 Reference R;
750 if (auto Err = readBlock(ID, &R))
751 return Err;
752 if (auto Err = addReference(I, std::move(R), CurrentReferenceField))
753 return Err;
754 return llvm::Error::success();
755 }
757 FunctionInfo F;
758 if (auto Err = readBlock(ID, &F))
759 return Err;
760 addChild(I, std::move(F));
761 return llvm::Error::success();
762 }
764 BaseRecordInfo BR;
765 if (auto Err = readBlock(ID, &BR))
766 return Err;
767 addChild(I, std::move(BR));
768 return llvm::Error::success();
769 }
770 case BI_ENUM_BLOCK_ID: {
771 EnumInfo E;
772 if (auto Err = readBlock(ID, &E))
773 return Err;
774 addChild(I, std::move(E));
775 return llvm::Error::success();
776 }
778 EnumValueInfo EV;
779 if (auto Err = readBlock(ID, &EV))
780 return Err;
781 addChild(I, std::move(EV));
782 return llvm::Error::success();
783 }
785 TemplateInfo TI;
786 if (auto Err = readBlock(ID, &TI))
787 return Err;
788 addTemplate(I, std::move(TI));
789 return llvm::Error::success();
790 }
792 TemplateSpecializationInfo TSI;
793 if (auto Err = readBlock(ID, &TSI))
794 return Err;
795 addTemplateSpecialization(I, std::move(TSI));
796 return llvm::Error::success();
797 }
799 TemplateParamInfo TPI;
800 if (auto Err = readBlock(ID, &TPI))
801 return Err;
802 addTemplateParam(I, std::move(TPI));
803 return llvm::Error::success();
804 }
805 case BI_TYPEDEF_BLOCK_ID: {
806 TypedefInfo TI;
807 if (auto Err = readBlock(ID, &TI))
808 return Err;
809 addChild(I, std::move(TI));
810 return llvm::Error::success();
811 }
812 default:
813 return llvm::createStringError(llvm::inconvertibleErrorCode(),
814 "invalid subblock type");
815 }
816}
817
818ClangDocBitcodeReader::Cursor
819ClangDocBitcodeReader::skipUntilRecordOrBlock(unsigned &BlockOrRecordID) {
820 BlockOrRecordID = 0;
821
822 while (!Stream.AtEndOfStream()) {
823 Expected<unsigned> MaybeCode = Stream.ReadCode();
824 if (!MaybeCode) {
825 // FIXME this drops the error on the floor.
826 consumeError(MaybeCode.takeError());
827 return Cursor::BadBlock;
828 }
829
830 unsigned Code = MaybeCode.get();
831 if (Code >= static_cast<unsigned>(llvm::bitc::FIRST_APPLICATION_ABBREV)) {
832 BlockOrRecordID = Code;
833 return Cursor::Record;
834 }
835 switch (static_cast<llvm::bitc::FixedAbbrevIDs>(Code)) {
836 case llvm::bitc::ENTER_SUBBLOCK:
837 if (Expected<unsigned> MaybeID = Stream.ReadSubBlockID())
838 BlockOrRecordID = MaybeID.get();
839 else {
840 // FIXME this drops the error on the floor.
841 consumeError(MaybeID.takeError());
842 }
843 return Cursor::BlockBegin;
844 case llvm::bitc::END_BLOCK:
845 if (Stream.ReadBlockEnd())
846 return Cursor::BadBlock;
847 return Cursor::BlockEnd;
848 case llvm::bitc::DEFINE_ABBREV:
849 if (llvm::Error Err = Stream.ReadAbbrevRecord()) {
850 // FIXME this drops the error on the floor.
851 consumeError(std::move(Err));
852 }
853 continue;
854 case llvm::bitc::UNABBREV_RECORD:
855 return Cursor::BadBlock;
856 case llvm::bitc::FIRST_APPLICATION_ABBREV:
857 llvm_unreachable("Unexpected abbrev id.");
858 }
859 }
860 llvm_unreachable("Premature stream end.");
861}
862
863llvm::Error ClangDocBitcodeReader::validateStream() {
864 if (Stream.AtEndOfStream())
865 return llvm::createStringError(llvm::inconvertibleErrorCode(),
866 "premature end of stream");
867
868 // Sniff for the signature.
869 for (int Idx = 0; Idx != 4; ++Idx) {
870 Expected<llvm::SimpleBitstreamCursor::word_t> MaybeRead = Stream.Read(8);
871 if (!MaybeRead)
872 return MaybeRead.takeError();
873 else if (MaybeRead.get() != BitCodeConstants::Signature[Idx])
874 return llvm::createStringError(llvm::inconvertibleErrorCode(),
875 "invalid bitcode signature");
876 }
877 return llvm::Error::success();
878}
879
880llvm::Error ClangDocBitcodeReader::readBlockInfoBlock() {
881 Expected<std::optional<llvm::BitstreamBlockInfo>> MaybeBlockInfo =
882 Stream.ReadBlockInfoBlock();
883 if (!MaybeBlockInfo)
884 return MaybeBlockInfo.takeError();
885 else
886 BlockInfo = MaybeBlockInfo.get();
887 if (!BlockInfo)
888 return llvm::createStringError(llvm::inconvertibleErrorCode(),
889 "unable to parse BlockInfoBlock");
890 Stream.setBlockInfo(&*BlockInfo);
891 return llvm::Error::success();
892}
893
894template <typename T>
895llvm::Expected<std::unique_ptr<Info>>
896ClangDocBitcodeReader::createInfo(unsigned ID) {
897 std::unique_ptr<Info> I = std::make_unique<T>();
898 if (auto Err = readBlock(ID, static_cast<T *>(I.get())))
899 return std::move(Err);
900 return std::unique_ptr<Info>{std::move(I)};
901}
902
903llvm::Expected<std::unique_ptr<Info>>
904ClangDocBitcodeReader::readBlockToInfo(unsigned ID) {
905 switch (ID) {
907 return createInfo<NamespaceInfo>(ID);
909 return createInfo<RecordInfo>(ID);
910 case BI_ENUM_BLOCK_ID:
911 return createInfo<EnumInfo>(ID);
913 return createInfo<TypedefInfo>(ID);
915 return createInfo<FunctionInfo>(ID);
916 default:
917 return llvm::createStringError(llvm::inconvertibleErrorCode(),
918 "cannot create info");
919 }
920}
921
922// Entry point
923llvm::Expected<std::vector<std::unique_ptr<Info>>>
925 std::vector<std::unique_ptr<Info>> Infos;
926 if (auto Err = validateStream())
927 return std::move(Err);
928
929 // Read the top level blocks.
930 while (!Stream.AtEndOfStream()) {
931 Expected<unsigned> MaybeCode = Stream.ReadCode();
932 if (!MaybeCode)
933 return MaybeCode.takeError();
934 if (MaybeCode.get() != llvm::bitc::ENTER_SUBBLOCK)
935 return llvm::createStringError(llvm::inconvertibleErrorCode(),
936 "no blocks in input");
937 Expected<unsigned> MaybeID = Stream.ReadSubBlockID();
938 if (!MaybeID)
939 return MaybeID.takeError();
940 unsigned ID = MaybeID.get();
941 switch (ID) {
942 // NamedType and Comment blocks should not appear at the top level
943 case BI_TYPE_BLOCK_ID:
948 return llvm::createStringError(llvm::inconvertibleErrorCode(),
949 "invalid top level block");
952 case BI_ENUM_BLOCK_ID:
955 auto InfoOrErr = readBlockToInfo(ID);
956 if (!InfoOrErr)
957 return InfoOrErr.takeError();
958 Infos.emplace_back(std::move(InfoOrErr.get()));
959 continue;
960 }
962 if (auto Err = readBlock(ID, VersionNumber))
963 return std::move(Err);
964 continue;
965 case llvm::bitc::BLOCKINFO_BLOCK_ID:
966 if (auto Err = readBlockInfoBlock())
967 return std::move(Err);
968 continue;
969 default:
970 if (llvm::Error Err = Stream.SkipBlock()) {
971 // FIXME this drops the error on the floor.
972 consumeError(std::move(Err));
973 }
974 continue;
975 }
976 }
977 return std::move(Infos);
978}
979
980} // namespace doc
981} // namespace clang
const Expr * E
QualType TypeInfo
std::string Code
const FieldDecl * Field
llvm::Expected< std::vector< std::unique_ptr< Info > > > readBitcode()
llvm::SmallVector< uint64_t, 1024 > Record
llvm::Error addReference(T I, Reference &&R, FieldId F)
void addTemplateSpecialization(T I, TemplateSpecializationInfo &&TSI)
void addTemplateParam(T I, TemplateParamInfo &&P)
@ FIELD_DEFAULT_VALUE
Definition: BitcodeWriter.h:96
@ TEMPLATE_SPECIALIZATION_OF
@ BASE_RECORD_TAG_TYPE
@ COMMENT_SELFCLOSING
Definition: BitcodeWriter.h:90
@ FUNCTION_DEFLOCATION
Definition: BitcodeWriter.h:80
@ FUNCTION_IS_METHOD
Definition: BitcodeWriter.h:83
@ MEMBER_TYPE_ACCESS
Definition: BitcodeWriter.h:98
@ BASE_RECORD_IS_PARENT
@ TEMPLATE_PARAM_CONTENTS
@ BASE_RECORD_IS_VIRTUAL
void addTemplate(T I, TemplateInfo &&P)
llvm::Expected< CommentInfo * > getCommentInfo(T I)
static const unsigned VersionNumber
Definition: BitcodeWriter.h:33
llvm::Error parseRecord(const Record &R, unsigned ID, llvm::StringRef Blob, const unsigned VersionNo)
llvm::Error decodeRecord(const Record &R, llvm::SmallVectorImpl< char > &Field, llvm::StringRef Blob)
void addChild(T I, ChildInfoType &&R)
llvm::Error addTypeInfo(T I, TTypeInfo &&TI)
std::array< uint8_t, 20 > SymbolID
@ BI_RECORD_BLOCK_ID
Definition: BitcodeWriter.h:61
@ BI_FUNCTION_BLOCK_ID
Definition: BitcodeWriter.h:63
@ BI_ENUM_VALUE_BLOCK_ID
Definition: BitcodeWriter.h:57
@ BI_TEMPLATE_SPECIALIZATION_BLOCK_ID
Definition: BitcodeWriter.h:67
@ BI_VERSION_BLOCK_ID
Definition: BitcodeWriter.h:54
@ BI_COMMENT_BLOCK_ID
Definition: BitcodeWriter.h:64
@ BI_TEMPLATE_BLOCK_ID
Definition: BitcodeWriter.h:66
@ BI_TYPEDEF_BLOCK_ID
Definition: BitcodeWriter.h:69
@ BI_NAMESPACE_BLOCK_ID
Definition: BitcodeWriter.h:55
@ BI_TEMPLATE_PARAM_BLOCK_ID
Definition: BitcodeWriter.h:68
@ BI_MEMBER_TYPE_BLOCK_ID
Definition: BitcodeWriter.h:60
@ BI_BASE_RECORD_BLOCK_ID
Definition: BitcodeWriter.h:62
@ BI_FIELD_TYPE_BLOCK_ID
Definition: BitcodeWriter.h:59
@ BI_REFERENCE_BLOCK_ID
Definition: BitcodeWriter.h:65
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
static constexpr unsigned char Signature[4]
Definition: BitcodeWriter.h:47
static constexpr int USRHashSize
Definition: BitcodeWriter.h:48
SmallString< 8 > Direction
SmallString< 16 > Kind
std::vector< std::unique_ptr< CommentInfo > > Children
llvm::SmallVector< SmallString< 16 >, 4 > AttrValues
SmallString< 16 > CloseName
SmallString< 16 > Name
SmallString< 64 > Text
llvm::SmallVector< SmallString< 16 >, 4 > AttrKeys
llvm::SmallVector< SmallString< 16 >, 4 > Args
SmallString< 16 > ParamName
llvm::SmallVector< EnumValueInfo, 4 > Members
std::optional< TypeInfo > BaseType
SmallString< 16 > Value
SmallString< 16 > Name
SmallString< 16 > ValueExpr
SmallString< 16 > Name
SmallString< 16 > DefaultValue
llvm::SmallVector< FieldTypeInfo, 4 > Params
std::optional< TemplateInfo > Template
SmallString< 16 > Name
std::vector< CommentInfo > Description
llvm::SmallString< 128 > Path
llvm::SmallVector< Reference, 4 > Namespace
std::vector< CommentInfo > Description
llvm::SmallVector< MemberTypeInfo, 4 > Members
std::optional< TemplateInfo > Template
llvm::SmallVector< Reference, 4 > VirtualParents
llvm::SmallVector< Reference, 4 > Parents
std::vector< BaseRecordInfo > Bases
SmallString< 16 > QualName
llvm::SmallString< 128 > Path
SmallString< 16 > Name
std::vector< Reference > Records
std::vector< TypedefInfo > Typedefs
std::vector< FunctionInfo > Functions
std::vector< Reference > Namespaces
std::vector< EnumInfo > Enums
llvm::SmallVector< Location, 2 > Loc
std::optional< Location > DefLoc
std::vector< TemplateParamInfo > Params
std::optional< TemplateSpecializationInfo > Specialization
std::vector< TemplateParamInfo > Params