-
Notifications
You must be signed in to change notification settings - Fork 688
/
BundleSaver.cpp
766 lines (709 loc) · 29.3 KB
/
BundleSaver.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
/**
* Copyright (c) Glow Contributors. See CONTRIBUTORS file.
*
* 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 "glow/LLVMIRCodeGen/CommandLine.h"
#include "glow/LLVMIRCodeGen/BundleSaver.h"
#include "glow/LLVMIRCodeGen/LLVMBackend.h"
#include "glow/Graph/Graph.h"
#include "glow/Graph/PlaceholderBindings.h"
#include "glow/IR/Instrs.h"
#include "glow/Support/Debug.h"
#include "llvm/ADT/SmallVector.h"
#include "llvm/Bitcode/BitcodeWriter.h"
#include "llvm/IR/LLVMContext.h"
#include "llvm/IR/LegacyPassManager.h"
#include "llvm/IR/Module.h"
#include "llvm/Object/Archive.h"
#include "llvm/Object/ArchiveWriter.h"
#include "llvm/Support/Casting.h"
#include "llvm/Support/Debug.h"
#include "llvm/Support/FileSystem.h"
#include "llvm/Support/raw_ostream.h"
#include <glog/logging.h>
#define DEBUG_TYPE "jit"
using namespace glow;
using llvm::cast;
using llvm::dyn_cast;
using llvm::isa;
/// Header file string template.
static const char *headerFileTemplate =
R"RAW(%s
#ifndef _GLOW_BUNDLE_%s_H
#define _GLOW_BUNDLE_%s_H
#include <stdint.h>
// ---------------------------------------------------------------
// Common definitions
// ---------------------------------------------------------------
#ifndef _GLOW_BUNDLE_COMMON_DEFS
#define _GLOW_BUNDLE_COMMON_DEFS
// Glow bundle error code for correct execution.
#define GLOW_SUCCESS 0
%s
#endif
// ---------------------------------------------------------------
// Bundle API
// ---------------------------------------------------------------
%s
// NOTE: Placeholders are allocated within the "mutableWeight"
// buffer and are identified using an offset relative to base.
// ---------------------------------------------------------------
#ifdef __cplusplus
extern "C" {
#endif
%s%s
#ifdef __cplusplus
}
#endif
#endif
)RAW";
/// Function to print the header file using the template.
static void printHeader(llvm::StringRef headerFileName,
llvm::StringRef bundleName,
llvm::StringRef commonDefines,
llvm::StringRef modelInfo, llvm::StringRef modelApi,
llvm::StringRef headerExtra) {
std::error_code EC;
llvm::raw_fd_ostream headerFile(headerFileName, EC,
llvm::sys::fs::OpenFlags::F_Text);
CHECK(!EC) << "Could not open header file!";
std::string header;
header += "// Bundle API auto-generated header file. Do not edit!\n";
#ifdef GLOW_VERSION
header += "// Glow Tools version: " + std::string(GLOW_VERSION) + "\n";
#endif
headerFile << strFormat(headerFileTemplate, header.c_str(),
bundleName.upper().data(), bundleName.upper().data(),
commonDefines.data(), modelInfo.data(),
modelApi.data(), headerExtra.data());
headerFile.close();
}
/// Header file common definitions for dynamic API.
static const char *dynamicApiCommonDefines = R"RAW(
// Type describing a symbol table entry of a generated bundle.
struct SymbolTableEntry {
// Name of a variable.
const char *name;
// Offset of the variable inside the memory area.
uint64_t offset;
// The number of elements inside this variable.
uint64_t size;
// Variable kind: 1 if it is a mutable variable, 0 otherwise.
char kind;
};
// Type describing the config of a generated bundle.
struct BundleConfig {
// Size of the constant weight variables memory area.
uint64_t constantWeightVarsMemSize;
// Size of the mutable weight variables memory area.
uint64_t mutableWeightVarsMemSize;
// Size of the activations memory area.
uint64_t activationsMemSize;
// Alignment to be used for weights and activations.
uint64_t alignment;
// Number of symbols in the symbol table.
uint64_t numSymbols;
// Symbol table.
const SymbolTableEntry *symbolTable;
};
)RAW";
/// Header file common definitions for static API.
static const char *staticApiCommonDefines = R"RAW(
// Memory alignment definition with given alignment size
// for static allocation of memory.
#define GLOW_MEM_ALIGN(size) __attribute__((aligned(size)))
// Macro function to get the absolute address of a
// placeholder using the base address of the mutable
// weight buffer and placeholder offset definition.
#define GLOW_GET_ADDR(mutableBaseAddr, placeholderOff) (((uint8_t*)(mutableBaseAddr)) + placeholderOff)
)RAW";
/// Utility function to serialize a binary file to text file as a C array.
static void serializeBinaryToText(llvm::StringRef binFileName,
llvm::StringRef txtFileName) {
FILE *inpFile = fopen(binFileName.str().c_str(), "rb");
CHECK(inpFile) << "Could not open binary input file: " << binFileName.str();
FILE *outFile = fopen(txtFileName.str().c_str(), "w");
CHECK(outFile) << "Could not open text output file: " << txtFileName.str();
const size_t numBytesPerLine = 20;
for (size_t i = 0;; i++) {
int ch = fgetc(inpFile);
if (ch == EOF) {
break;
}
fprintf(outFile, " 0X%02X,", ch);
if ((i % numBytesPerLine) == (numBytesPerLine - 1)) {
fprintf(outFile, "\n");
}
}
fprintf(outFile, "\n");
fclose(inpFile);
fclose(outFile);
}
BundleSaver::BundleSaver(const LLVMBackend &llvmBackend,
llvm::StringRef outputDir, llvm::StringRef bundleName)
: irgen_(llvmBackend.createIRGen(nullptr, allocationsInfo_)),
bundleAPI_(llvmBackend.getOptions().getBundleAPI()) {
llvm::SmallVector<std::string, 8> targetFeatures(llvmTargetFeatures.begin(),
llvmTargetFeatures.end());
irgen_->setBundleName(bundleName.str());
irgen_->setOutputDir(outputDir);
irgen_->setObjectRegistry(llvmBackend.getObjectRegistry());
// Use the bundle code model as a code model for the TargetMachine.
auto opts = llvmBackend.getOptions();
opts.setCodeModel(opts.getBundleCodeModel());
irgen_->initTargetMachine(opts);
irgen_->initCodeGen();
}
void BundleSaver::setIRFunction(llvm::StringRef mainEntryName,
const IRFunction *F) {
irgen_->setIRFunction(F);
if (F) {
savedIRFunctions_.push_back(SavedIRFunction{mainEntryName.str(), F});
}
}
bool BundleSaver::WeightAddrComparator::operator()(
const WeightInfo &LHS, const WeightInfo &RHS) const {
auto lhsAddr =
bundleSaver_->allocationsInfo_.allocatedAddress_.lookup(LHS.first);
auto rhsAddr =
bundleSaver_->allocationsInfo_.allocatedAddress_.lookup(RHS.first);
return lhsAddr < rhsAddr;
}
std::set<BundleSaver::WeightInfo, BundleSaver::WeightAddrComparator>
BundleSaver::findConstantWeights() const {
std::set<BundleSaver::WeightInfo, BundleSaver::WeightAddrComparator>
constants(WeightAddrComparator(*const_cast<BundleSaver *>(this)));
for (auto &savedIRFunction : savedIRFunctions_) {
for (auto *c : savedIRFunction.savedF->findConstants()) {
auto *w = cast<WeightVar>(savedIRFunction.savedF->getWeightForNode(c));
constants.insert({w, c});
}
}
return constants;
}
std::set<const Placeholder *> BundleSaver::findPlaceholders() const {
std::set<const Placeholder *> placeholders;
for (auto &savedIRFunction : savedIRFunctions_) {
for (auto *ph : savedIRFunction.savedF->findPlaceholders()) {
placeholders.insert(ph);
}
}
return placeholders;
}
Value *BundleSaver::getWeightForNode(const Storage *V) const {
for (auto &savedIRFunction : savedIRFunctions_) {
if (auto *W = savedIRFunction.savedF->getWeightForNode(V)) {
return W;
}
}
return nullptr;
}
void BundleSaver::saveWeights(llvm::StringRef weightsFileName) {
std::error_code EC;
llvm::raw_fd_ostream weightsFile(weightsFileName, EC, llvm::sys::fs::F_None);
CHECK(!EC) << "Could not open the output file for saving the bundle weights "
"with file name: "
<< weightsFileName.str();
// Serialize only constant weights.
// Do not serialize mutable weights representing inputs and outputs, because
// it should be configurable and set by the client.
size_t pos = 0;
size_t maxPos = 0;
for (auto &weightInfo : findConstantWeights()) {
auto *w = weightInfo.first;
auto *c = weightInfo.second;
auto numBytes = w->getSizeInBytes();
auto payload = c->getPayload().getUnsafePtr();
auto addr = allocationsInfo_.allocatedAddress_[weightInfo.first];
if (addr < pos) {
// The payload was written already. It aliases something we have seen
// already.
continue;
}
weightsFile.seek(addr);
CHECK(!weightsFile.has_error()) << "Could not set file write position";
weightsFile.write(payload, numBytes);
CHECK(!weightsFile.has_error()) << "Could not write bytes";
pos = addr + numBytes;
maxPos = std::max(pos, maxPos);
}
// Make sure that the file is as long as the constantWeightVarsMemSize_.
// This is needed to properly handle alignments.
weightsFile.seek(maxPos);
for (size_t endPos = irgen_->getAllocationsInfo().constantWeightVarsMemSize_;
maxPos < endPos; maxPos++) {
weightsFile.write(0);
}
weightsFile.close();
}
void BundleSaver::saveHeader(llvm::StringRef headerFileName) {
auto bundleName = irgen_->getBundleName();
auto bundleNameUpper = llvm::StringRef(bundleName).upper();
auto constMemSize = irgen_->getAllocationsInfo().constantWeightVarsMemSize_;
auto mutableMemSize = irgen_->getAllocationsInfo().mutableWeightVarsMemSize_;
auto activationsMemSize = irgen_->getAllocationsInfo().activationsMemSize_;
auto memAlignSize = TensorAlignment;
auto totMemSize = constMemSize + mutableMemSize + activationsMemSize;
// Format common bundle definitions.
auto commonDefines = (bundleAPI_ == BundleApiType::Dynamic)
? dynamicApiCommonDefines
: staticApiCommonDefines;
// Format model description.
std::string modelInfo = strFormat("// Model name: \"%s\"\n"
"// Total data size: %lu (bytes)\n",
bundleName.data(), totMemSize);
// Print placeholders (mandatory).
modelInfo += "// Placeholders:\n";
auto placeholders = findPlaceholders();
for (auto &v : placeholders) {
auto *w = cast<WeightVar>(getWeightForNode(v));
// Get placeholder properties.
auto name = w->getName();
auto type = w->getType();
auto typeName = type->toString();
auto sizeElem = type->size();
auto sizeByte = type->getSizeInBytes();
auto offset = allocationsInfo_.allocatedAddress_[w];
modelInfo += strFormat("//\n"
"// Name: \"%s\"\n"
"// Type: %s\n"
"// Size: %" PRIuDIM " (elements)\n"
"// Size: %zu (bytes)\n"
"// Offset: %lu (bytes)\n",
name.data(), typeName.c_str(), sizeElem, sizeByte,
(unsigned long)offset);
}
// Print constants (optional).
if (bundleAPIVerbose) {
modelInfo += "//\n"
"// Constants:\n";
auto constantWeights = findConstantWeights();
for (auto &weightInfo : constantWeights) {
auto *w = weightInfo.first;
// Get constant properties.
auto name = w->getName();
auto type = w->getType();
auto typeName = type->toString();
auto sizeElem = type->size();
auto sizeByte = type->getSizeInBytes();
auto offset = allocationsInfo_.allocatedAddress_[w];
modelInfo += strFormat("//\n"
"// Name: \"%s\"\n"
"// Type: %s\n"
"// Size: %" PRIuDIM " (elements)\n"
"// Size: %zu (bytes)\n"
"// Offset: %lu (bytes)\n",
name.data(), typeName.c_str(), sizeElem, sizeByte,
(unsigned long)offset);
}
}
modelInfo += "//";
std::string modelApi = "\n";
if (bundleAPI_ == BundleApiType::Dynamic) {
// Print bundle memory configuration.
modelApi += strFormat("// Bundle memory configuration (memory layout).\n"
"extern BundleConfig %s_config;\n"
"\n",
bundleName.data());
} else {
// Get placeholder names and offsets. Compute also the maximum placeholder
// name length for print purposes.
unsigned nameMaxLen = 0;
std::vector<std::pair<llvm::StringRef, unsigned>> nameAddrPairs;
for (auto &v : placeholders) {
auto *w = cast<WeightVar>(getWeightForNode(v));
auto name = w->getName();
auto addr = allocationsInfo_.allocatedAddress_[w];
nameMaxLen = name.size() > nameMaxLen ? name.size() : nameMaxLen;
nameAddrPairs.push_back(std::pair<llvm::StringRef, unsigned>(name, addr));
}
// Print placeholder address offsets.
modelApi +=
"// Placeholder address offsets within mutable buffer (bytes).\n";
for (auto &pair : nameAddrPairs) {
modelApi += strFormat(
"#define %s_%s%s %u\n", bundleNameUpper.data(), pair.first.data(),
std::string(nameMaxLen - pair.first.size(), ' ').c_str(),
pair.second);
}
modelApi += "\n";
// Print memory sizes and memory alignment.
modelApi +=
strFormat("// Memory sizes (bytes).\n"
"#define %s_CONSTANT_MEM_SIZE %lu\n"
"#define %s_MUTABLE_MEM_SIZE %lu\n"
"#define %s_ACTIVATIONS_MEM_SIZE %lu\n"
"\n"
"// Memory alignment (bytes).\n"
"#define %s_MEM_ALIGN %d\n"
"\n",
bundleNameUpper.data(), constMemSize, bundleNameUpper.data(),
mutableMemSize, bundleNameUpper.data(), activationsMemSize,
bundleNameUpper.data(), memAlignSize);
}
// Print bundle entry functions.
for (auto &savedIRFunction : savedIRFunctions_) {
modelApi +=
strFormat("// Bundle entry point (inference function). Returns 0\n"
"// for correct execution or some error code otherwise.\n"
"int %s("
"uint8_t *constantWeight, "
"uint8_t *mutableWeight, "
"uint8_t *activations"
");\n",
savedIRFunction.entryName.c_str());
}
// Get bundle header extra content.
std::string headerExtra = irgen_->getBundleHeaderExtra();
// Print header file.
printHeader(headerFileName, bundleName, commonDefines, modelInfo, modelApi,
headerExtra);
}
void BundleSaver::emitSymbolTable() {
// Define a struct for symbol table entries:
// struct SymbolTableEntry {
// const char *name;
// uint64_t offset;
// uint64_t size;
// char kind;
// };
auto *charTy = llvm::Type::getInt8Ty(irgen_->getLLVMContext());
auto *uint64TTy =
llvm::Type::getIntNTy(irgen_->getLLVMContext(), sizeof(uint64_t) * 8);
auto symbolTableEntryTy = llvm::StructType::get(
irgen_->getLLVMContext(),
{charTy->getPointerTo(), uint64TTy, uint64TTy, charTy});
// Set of entries in the symbol table.
llvm::SmallVector<llvm::Constant *, 128> entries;
// Iterate over all Placeholders and record information about their names,
// offset, size and kind.
for (auto &v : findPlaceholders()) {
auto *w = cast<WeightVar>(getWeightForNode(v));
auto size = w->getType()->size();
auto addr = allocationsInfo_.allocatedAddress_[w];
// Create an SymbolTableEntry.
auto *entry = llvm::ConstantStruct::get(
symbolTableEntryTy,
{// name.
dyn_cast<llvm::Constant>(irgen_->getBuilder().CreateBitCast(
irgen_->emitStringConst(irgen_->getBuilder(), w->getName()),
charTy->getPointerTo())),
// offset.
llvm::ConstantInt::get(uint64TTy, addr),
// size.
llvm::ConstantInt::get(uint64TTy, size),
// 1 for Mutable Kind
llvm::ConstantInt::get(charTy, 1)});
entries.push_back(entry);
}
// Create a constant array with these entries.
auto *arr = llvm::ConstantArray::get(
llvm::ArrayType::get(symbolTableEntryTy, entries.size()), entries);
// Create a global variable and initialize it with the constructed array.
new llvm::GlobalVariable(irgen_->getModule(), arr->getType(), true,
llvm::GlobalValue::InternalLinkage, arr,
irgen_->getBundleName() + "SymbolTable");
}
void BundleSaver::createBundleArchive(
llvm::StringRef bundlePath,
llvm::ArrayRef<llvm::MemoryBufferRef> bundleObjectRegistry,
const std::vector<std::string> &bundleObjects) {
// If we do not have extra object files then return early.
if (bundleObjects.empty()) {
return;
}
// Read original bundle object file as archive member.
std::vector<llvm::NewArchiveMember> newMembers;
llvm::Expected<llvm::NewArchiveMember> newMember =
llvm::NewArchiveMember::getFile(bundlePath.str(),
/* Deterministic */ true);
newMembers.push_back(std::move(*newMember));
// Add other object files as archive members.
for (const auto &objectName : bundleObjects) {
// If this object was already added then we skip it.
bool objectAdded = false;
for (const auto &member : newMembers) {
if (member.MemberName.str() == objectName) {
objectAdded = true;
break;
}
}
if (objectAdded) {
continue;
}
// Find current object and add it as archive member.
bool objectFound = false;
for (const auto &memBuffRef : bundleObjectRegistry) {
if (memBuffRef.getBufferIdentifier().str() == objectName) {
llvm::NewArchiveMember newMember(memBuffRef);
newMembers.push_back(std::move(newMember));
objectFound = true;
break;
}
}
// If object is not found (not registered) then throw error.
if (!objectFound) {
std::string errMsg;
errMsg += "Object '" + objectName + "' is not registered in Glow and ";
errMsg += "cannot be archived into the bundle. The following objects ";
errMsg += "are available for archiving:\n";
for (const auto &memBuffRef : bundleObjectRegistry) {
errMsg += " - " + memBuffRef.getBufferIdentifier().str() + "\n";
}
CHECK(false) << errMsg;
}
}
// Write the new bundle as archive.
llvm::Error err =
llvm::writeArchive(bundlePath.str(), newMembers, /* WriteSymtab */ true,
llvm::object::Archive::K_GNU,
/* Deterministic */ true, /* Thin */ false,
/* OldArchiveBuf */ std::move(nullptr));
CHECK(!err) << "Could not add extra objects to bundle " << bundlePath.str();
}
void BundleSaver::produceBundle() {
DCHECK(!isSaved_) << "produceBundle can be invoked only once";
isSaved_ = true;
// Emit entry functions.
for (auto &savedFunction : savedIRFunctions_) {
emitBundleEntryFunction(savedFunction);
}
// Finish code generation.
irgen_->finishCodeGen();
setIRFunction("<noname>", nullptr);
// Emit symbol table and bundle config only for dynamic API
if (bundleAPI_ == BundleApiType::Dynamic) {
// Emit the symbol table for weight variables.
emitSymbolTable();
// Emit the config for the bundle.
emitBundleConfig();
}
auto &M = irgen_->getModule();
auto outputDir = irgen_->getOutputDir();
auto bundleName = irgen_->getBundleName();
auto savedBundleName = irgen_->getSavedBundleName().empty()
? bundleName
: irgen_->getSavedBundleName();
std::string extension = (llvmCompiler.empty()) ? ".o" : ".bc";
std::string bundleCodeOutput;
bundleCodeOutput = (outputDir + "/" + savedBundleName + extension).str();
auto bundleWeightsBinOut =
(outputDir + "/" + savedBundleName + ".weights.bin").str();
auto bundleHeaderOutput = (outputDir + "/" + savedBundleName + ".h").str();
DEBUG_GLOW(llvm::dbgs() << "Producing a bundle:\n"
<< "saved bundle name: " << savedBundleName << "\n"
<< "bundle name: " << bundleName << "\n"
<< "bundle code: " << bundleCodeOutput << "\n"
<< "bundle weights:" << bundleWeightsBinOut << "\n"
<< "header file: " << bundleHeaderOutput << "\n");
llvm::StringRef fileName = bundleCodeOutput;
std::error_code EC;
llvm::raw_fd_ostream outputFile(fileName, EC, llvm::sys::fs::F_None);
CHECK(!EC) << "Could not open the output file for saving the bundle "
"code with file name: "
<< fileName.str();
if (fileName.endswith(".bc")) {
// Emit the bitcode file.
llvm::WriteBitcodeToFile(M, outputFile);
outputFile.flush();
if (!llvmCompiler.empty()) {
// Compile bitcode using an external LLVM compiler.
// The code is optimized twice with the external opt tool.
std::string cmd = llvmCompiler;
for (auto option : llvmCompilerOptions) {
cmd += " " + option + " ";
}
cmd += " " + bundleCodeOutput;
std::string bundleObjectCodeOutputOpt;
if (!llvmOpt.empty()) {
bundleObjectCodeOutputOpt =
" -emit-llvm -o " +
(outputDir + "/" + savedBundleName + ".beforeopt.bc").str();
} else {
bundleObjectCodeOutputOpt =
" -o " + (outputDir + "/" + savedBundleName + ".o").str();
}
cmd += bundleObjectCodeOutputOpt;
CHECK(!system(cmd.c_str()))
<< "Error running external LLVM compiler: " << cmd;
// Running opt tool to optimize a second time.
// TODO: Only run the appropriate passes as needed.
if (!llvmOpt.empty()) {
cmd.clear();
cmd = llvmOpt;
cmd +=
" " + (outputDir + "/" + savedBundleName + ".beforeopt.bc").str();
cmd +=
" -O3 -o " + (outputDir + "/" + savedBundleName + ".opt.bc").str();
CHECK(!system(cmd.c_str()))
<< "Error running external opt compiler: " << cmd;
cmd.clear();
cmd = llvmCompiler;
for (auto option : llvmCompilerOptions) {
cmd += " " + option + " ";
}
cmd += " " + (outputDir + "/" + savedBundleName + ".opt.bc").str();
cmd += " -o " + (outputDir + "/" + savedBundleName + ".o").str();
CHECK(!system(cmd.c_str()))
<< "Error running external LLVM compiler: " << cmd;
}
}
} else if (fileName.endswith(".o")) {
// Emit the object file.
llvm::legacy::PassManager PM;
auto &TM = irgen_->getTargetMachine();
#if FACEBOOK_INTERNAL && LLVM_VERSION_MAJOR < 8
TM.addPassesToEmitFile(
PM, outputFile, llvm::TargetMachine::CodeGenFileType::CGFT_ObjectFile);
#elif LLVM_VERSION_MAJOR < 10
TM.addPassesToEmitFile(
PM, outputFile, nullptr,
llvm::TargetMachine::CodeGenFileType::CGFT_ObjectFile);
#else
TM.addPassesToEmitFile(PM, outputFile, nullptr, llvm::CGFT_ObjectFile);
#endif
PM.run(M);
}
outputFile.close();
// Create bundle archive with additional object files.
createBundleArchive(fileName, irgen_->getObjectRegistry(),
irgen_->getBundleObjects());
// Output weights.
if (saveWeights_) {
saveWeights(bundleWeightsBinOut);
}
// Header file.
if (saveHeader_) {
saveHeader(bundleHeaderOutput);
}
// Save weights also in text format for Static API.
if (saveWeightsAsText_) {
if (bundleAPI_ == BundleApiType::Static) {
auto bundleWeightsTxtOut =
(outputDir + "/" + savedBundleName + ".weights.txt").str();
serializeBinaryToText(bundleWeightsBinOut, bundleWeightsTxtOut);
}
}
}
/// Emit the entry function for the bundle. It simply calls the main entry of
/// the module and forwards its arguments to it. As the last argument it
/// provides the constant array of offsets. Since these offsets are constants,
/// the LLVM optimizer will constant propagate them into relative addressing
/// computations and the like and produce a very efficient code that uses
/// absolute addressing whenever possible.
void BundleSaver::emitBundleEntryFunction(
BundleSaver::SavedIRFunction &savedF) {
// The bundle entry point has the following API:
// int entry(uint8_t *constantWeight,
// uint8_t *mutableWeight,
// uint8_t *activations);
auto int8PtrTy = llvm::Type::getInt8PtrTy(irgen_->getLLVMContext());
llvm::Type *retTy = llvm::Type::getIntNTy(irgen_->getLLVMContext(),
irgen_->getLibjitIntWidth());
llvm::FunctionType *bundleFuncTy =
llvm::FunctionType::get(retTy, {int8PtrTy, int8PtrTy, int8PtrTy}, false);
auto *func =
llvm::Function::Create(bundleFuncTy, llvm::Function::ExternalLinkage,
savedF.entryName, &irgen_->getModule());
llvm::BasicBlock *entry_bb =
llvm::BasicBlock::Create(irgen_->getLLVMContext(), "entry", func);
llvm::IRBuilder<> builder(entry_bb);
// Add a provisional terminator to make the function well-formed.
auto *zero = builder.getIntN(irgen_->getLibjitIntWidth(), 0);
auto *ret = builder.CreateRet(zero);
builder.SetInsertPoint(ret);
// Prepare arguments for the "main" function.
llvm::SmallVector<llvm::Value *, 4> initFunctionCallArgs;
initFunctionCallArgs.push_back(func->args().begin());
initFunctionCallArgs.push_back(func->args().begin() + 1);
initFunctionCallArgs.push_back(func->args().begin() + 2);
// Now form the offsets array and pass it as the last argument.
auto offsetsArray = irgen_->emitConstOffsetsArray(builder, allocationsInfo_);
initFunctionCallArgs.push_back(offsetsArray);
// Invoke the main entry with constant arguments and let LLVM optimizer make
// use of it.
auto *entryF = savedF.llvmF;
entryF->setLinkage(llvm::Function::InternalLinkage);
auto *result = irgen_->createCall(builder, entryF, initFunctionCallArgs);
// Terminate the function.
builder.CreateRet(result);
// Remove the provisional terminator.
ret->eraseFromParent();
// Create the debug info for the bundle entry point function.
irgen_->generateFunctionDebugInfo(func);
}
// Create a config for this network. It will be exposed to the clients,
// so that they know how much memory they need to allocate, etc.
// Config consists of the following fields:
// struct BundleConfig {
// uint64_t constantWeightVarsMemSize;
// uint64_t mutableWeightVarsMemSize;
// uint64_t activationsMemSize;
// uint64_t alignment;
// uint64_t numSymbols;
// SymbolTableEntry *symbolTable;
// };
void BundleSaver::emitBundleConfig() {
auto symbolTableName = irgen_->getBundleName().str() + "SymbolTable";
auto symbolTable =
irgen_->getModule().getGlobalVariable(symbolTableName, true);
CHECK(symbolTable)
<< "Expected to find a symbol table for the AOT bundle with name: "
<< symbolTableName;
// Get the integer type having the same size in bits as uint64_t.
auto *uint64TType = irgen_->getBuilder().getIntNTy(sizeof(uint64_t) * 8);
auto symbolTableEntryTy = symbolTable->getType()->getPointerElementType();
auto *bundleConfigTy =
llvm::StructType::get(irgen_->getLLVMContext(),
{uint64TType, uint64TType, uint64TType, uint64TType,
uint64TType, symbolTableEntryTy->getPointerTo()});
auto config = new llvm::GlobalVariable(
irgen_->getModule(), bundleConfigTy, /* isConst */ true,
llvm::GlobalValue::LinkageTypes::ExternalLinkage, nullptr,
irgen_->getBundleName().str() + "_config");
config->setInitializer(llvm::ConstantStruct::get(
bundleConfigTy,
llvm::ConstantInt::get(
uint64TType, irgen_->getAllocationsInfo().constantWeightVarsMemSize_),
llvm::ConstantInt::get(
uint64TType, irgen_->getAllocationsInfo().mutableWeightVarsMemSize_),
llvm::ConstantInt::get(uint64TType,
irgen_->getAllocationsInfo().activationsMemSize_),
llvm::ConstantInt::get(uint64TType, TensorAlignment),
llvm::ConstantInt::get(uint64TType, findPlaceholders().size()),
symbolTable));
}
void BundleSaver::performBundleMemoryAllocation() {
// Perform memory allocation for the current function.
auto *F = savedIRFunctions_.back().savedF;
allocationsInfo_.numberValues(F);
// Tell the allocateWeightVars to not reuse any existing addresses for
// weights and to assign new ones.
allocationsInfo_.allocateWeightVars(F);
allocationsInfo_.allocateActivations(F);
allocationsInfo_.allocateTensorViews(F);
}
void BundleSaver::save(llvm::StringRef mainEntryName, const IRFunction *F) {
// Object files generation works properly only in small mode.
irgen_->setMainEntryName(mainEntryName.str());
// Set current IRFunction using the legalized name.
setIRFunction(irgen_->getMainEntryName(), F);
// irgen_->initCodeGen();
// Perform the address assignment for activations and WeightVars.
performBundleMemoryAllocation();
// Emit the code for the body of the entry function.
irgen_->performCodeGen();
savedIRFunctions_.back().llvmF = irgen_->getLLVMFunction();
}
LLVMIRGen *BundleSaver::getLLVMIRGen() { return irgen_.get(); }