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
|
//===-- APINotesWriter.h - API Notes Writer ---------------------*- C++ -*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
#ifndef LLVM_CLANG_LIB_APINOTES_APINOTESFORMAT_H
#define LLVM_CLANG_LIB_APINOTES_APINOTESFORMAT_H
#include "llvm/ADT/PointerEmbeddedInt.h"
#include "llvm/Bitcode/BitcodeConvenience.h"
namespace clang {
namespace api_notes {
/// Magic number for API notes files.
const unsigned char API_NOTES_SIGNATURE[] = {0xE2, 0x9C, 0xA8, 0x01};
/// API notes file major version number.
const uint16_t VERSION_MAJOR = 0;
/// API notes file minor version number.
///
/// When the format changes IN ANY WAY, this number should be incremented.
const uint16_t VERSION_MINOR = 24; // EnumExtensibility + FlagEnum
using IdentifierID = llvm::PointerEmbeddedInt<unsigned, 31>;
using IdentifierIDField = llvm::BCVBR<16>;
using SelectorID = llvm::PointerEmbeddedInt<unsigned, 31>;
using SelectorIDField = llvm::BCVBR<16>;
/// The various types of blocks that can occur within a API notes file.
///
/// These IDs must \em not be renumbered or reordered without incrementing
/// VERSION_MAJOR.
enum BlockID {
/// The control block, which contains all of the information that needs to
/// be validated prior to committing to loading the API notes file.
///
/// \sa control_block
CONTROL_BLOCK_ID = llvm::bitc::FIRST_APPLICATION_BLOCKID,
/// The identifier data block, which maps identifier strings to IDs.
IDENTIFIER_BLOCK_ID,
/// The Objective-C context data block, which contains information about
/// Objective-C classes and protocols.
OBJC_CONTEXT_BLOCK_ID,
/// The Objective-C property data block, which maps Objective-C
/// (class name, property name) pairs to information about the
/// property.
OBJC_PROPERTY_BLOCK_ID,
/// The Objective-C property data block, which maps Objective-C
/// (class name, selector, is_instance_method) tuples to information
/// about the method.
OBJC_METHOD_BLOCK_ID,
/// The Objective-C selector data block, which maps Objective-C
/// selector names (# of pieces, identifier IDs) to the selector ID
/// used in other tables.
OBJC_SELECTOR_BLOCK_ID,
/// The global variables data block, which maps global variable names to
/// information about the global variable.
GLOBAL_VARIABLE_BLOCK_ID,
/// The (global) functions data block, which maps global function names to
/// information about the global function.
GLOBAL_FUNCTION_BLOCK_ID,
/// The tag data block, which maps tag names to information about
/// the tags.
TAG_BLOCK_ID,
/// The typedef data block, which maps typedef names to information about
/// the typedefs.
TYPEDEF_BLOCK_ID,
/// The enum constant data block, which maps enumerator names to
/// information about the enumerators.
ENUM_CONSTANT_BLOCK_ID,
};
namespace control_block {
// These IDs must \em not be renumbered or reordered without incrementing
// VERSION_MAJOR.
enum {
METADATA = 1,
MODULE_NAME = 2,
MODULE_OPTIONS = 3,
SOURCE_FILE = 4,
};
using MetadataLayout =
llvm::BCRecordLayout<METADATA, // ID
llvm::BCFixed<16>, // Module format major version
llvm::BCFixed<16> // Module format minor version
>;
using ModuleNameLayout = llvm::BCRecordLayout<MODULE_NAME,
llvm::BCBlob // Module name
>;
using ModuleOptionsLayout =
llvm::BCRecordLayout<MODULE_OPTIONS,
llvm::BCFixed<1> // SwiftInferImportAsMember
>;
using SourceFileLayout = llvm::BCRecordLayout<SOURCE_FILE,
llvm::BCVBR<16>, // file size
llvm::BCVBR<16> // creation time
>;
} // namespace control_block
namespace identifier_block {
enum {
IDENTIFIER_DATA = 1,
};
using IdentifierDataLayout = llvm::BCRecordLayout<
IDENTIFIER_DATA, // record ID
llvm::BCVBR<16>, // table offset within the blob (see below)
llvm::BCBlob // map from identifier strings to decl kinds / decl IDs
>;
} // namespace identifier_block
namespace objc_context_block {
enum {
OBJC_CONTEXT_ID_DATA = 1,
OBJC_CONTEXT_INFO_DATA = 2,
};
using ObjCContextIDLayout =
llvm::BCRecordLayout<OBJC_CONTEXT_ID_DATA, // record ID
llvm::BCVBR<16>, // table offset within the blob (see
// below)
llvm::BCBlob // map from ObjC class names/protocol (as
// IDs) to context IDs
>;
using ObjCContextInfoLayout = llvm::BCRecordLayout<
OBJC_CONTEXT_INFO_DATA, // record ID
llvm::BCVBR<16>, // table offset within the blob (see below)
llvm::BCBlob // map from ObjC context IDs to context information.
>;
} // namespace objc_context_block
namespace objc_property_block {
enum {
OBJC_PROPERTY_DATA = 1,
};
using ObjCPropertyDataLayout = llvm::BCRecordLayout<
OBJC_PROPERTY_DATA, // record ID
llvm::BCVBR<16>, // table offset within the blob (see below)
llvm::BCBlob // map from ObjC (class name, property name) pairs to
// ObjC property information
>;
} // namespace objc_property_block
namespace objc_method_block {
enum {
OBJC_METHOD_DATA = 1,
};
using ObjCMethodDataLayout =
llvm::BCRecordLayout<OBJC_METHOD_DATA, // record ID
llvm::BCVBR<16>, // table offset within the blob (see
// below)
llvm::BCBlob // map from ObjC (class names, selector,
// is-instance-method) tuples to ObjC
// method information
>;
} // namespace objc_method_block
namespace objc_selector_block {
enum {
OBJC_SELECTOR_DATA = 1,
};
using ObjCSelectorDataLayout =
llvm::BCRecordLayout<OBJC_SELECTOR_DATA, // record ID
llvm::BCVBR<16>, // table offset within the blob (see
// below)
llvm::BCBlob // map from (# pieces, identifier IDs) to
// Objective-C selector ID.
>;
} // namespace objc_selector_block
namespace global_variable_block {
enum { GLOBAL_VARIABLE_DATA = 1 };
using GlobalVariableDataLayout = llvm::BCRecordLayout<
GLOBAL_VARIABLE_DATA, // record ID
llvm::BCVBR<16>, // table offset within the blob (see below)
llvm::BCBlob // map from name to global variable information
>;
} // namespace global_variable_block
namespace global_function_block {
enum { GLOBAL_FUNCTION_DATA = 1 };
using GlobalFunctionDataLayout = llvm::BCRecordLayout<
GLOBAL_FUNCTION_DATA, // record ID
llvm::BCVBR<16>, // table offset within the blob (see below)
llvm::BCBlob // map from name to global function information
>;
} // namespace global_function_block
namespace tag_block {
enum { TAG_DATA = 1 };
using TagDataLayout =
llvm::BCRecordLayout<TAG_DATA, // record ID
llvm::BCVBR<16>, // table offset within the blob (see
// below)
llvm::BCBlob // map from name to tag information
>;
}; // namespace tag_block
namespace typedef_block {
enum { TYPEDEF_DATA = 1 };
using TypedefDataLayout =
llvm::BCRecordLayout<TYPEDEF_DATA, // record ID
llvm::BCVBR<16>, // table offset within the blob (see
// below)
llvm::BCBlob // map from name to typedef information
>;
}; // namespace typedef_block
namespace enum_constant_block {
enum { ENUM_CONSTANT_DATA = 1 };
using EnumConstantDataLayout =
llvm::BCRecordLayout<ENUM_CONSTANT_DATA, // record ID
llvm::BCVBR<16>, // table offset within the blob (see
// below)
llvm::BCBlob // map from name to enumerator information
>;
} // namespace enum_constant_block
/// A stored Objective-C selector.
struct StoredObjCSelector {
unsigned NumPieces;
llvm::SmallVector<IdentifierID, 2> Identifiers;
};
} // namespace api_notes
} // namespace clang
#endif
|
