Skip to content

Commit 16492a6

Browse files
committed
[BOLT][NFC] Rename {MachO,}RewriteInstance::create methods
Follow the code style of fallible constructors in [LLVM Programmer's Manual] (https://llvm.org/docs/ProgrammersManual.html#fallible-constructors) and rename `RewriteInstance::createRewriteInstance` to `RewriteInstance::create` Reviewed By: #bolt, rafauler Differential Revision: https://reviews.llvm.org/D143119
1 parent 0be684e commit 16492a6

File tree

7 files changed

+15
-23
lines changed

7 files changed

+15
-23
lines changed

bolt/include/bolt/Rewrite/MachORewriteInstance.h

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,13 +68,12 @@ class MachORewriteInstance {
6868
public:
6969
// This constructor has complex initialization that can fail during
7070
// construction. Constructors can’t return errors, so clients must test \p Err
71-
// after the object is constructed. Use createMachORewriteInstance instead.
71+
// after the object is constructed. Use `create` method instead.
7272
MachORewriteInstance(object::MachOObjectFile *InputFile, StringRef ToolPath,
7373
Error &Err);
7474

7575
static Expected<std::unique_ptr<MachORewriteInstance>>
76-
createMachORewriteInstance(object::MachOObjectFile *InputFile,
77-
StringRef ToolPath);
76+
create(object::MachOObjectFile *InputFile, StringRef ToolPath);
7877
~MachORewriteInstance();
7978

8079
Error setProfile(StringRef FileName);

bolt/include/bolt/Rewrite/RewriteInstance.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,13 +43,13 @@ class RewriteInstance {
4343
public:
4444
// This constructor has complex initialization that can fail during
4545
// construction. Constructors can’t return errors, so clients must test \p Err
46-
// after the object is constructed. Use createRewriteInstance instead.
46+
// after the object is constructed. Use `create` method instead.
4747
RewriteInstance(llvm::object::ELFObjectFileBase *File, const int Argc,
4848
const char *const *Argv, StringRef ToolPath, Error &Err);
4949

5050
static Expected<std::unique_ptr<RewriteInstance>>
51-
createRewriteInstance(llvm::object::ELFObjectFileBase *File, const int Argc,
52-
const char *const *Argv, StringRef ToolPath);
51+
create(llvm::object::ELFObjectFileBase *File, const int Argc,
52+
const char *const *Argv, StringRef ToolPath);
5353
~RewriteInstance();
5454

5555
/// Assign profile from \p Filename to this instance.

bolt/lib/Rewrite/MachORewriteInstance.cpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,8 +85,8 @@ MCPlusBuilder *createMCPlusBuilder(const Triple::ArchType Arch,
8585
#define DEBUG_TYPE "bolt"
8686

8787
Expected<std::unique_ptr<MachORewriteInstance>>
88-
MachORewriteInstance::createMachORewriteInstance(
89-
object::MachOObjectFile *InputFile, StringRef ToolPath) {
88+
MachORewriteInstance::create(object::MachOObjectFile *InputFile,
89+
StringRef ToolPath) {
9090
Error Err = Error::success();
9191
auto MachORI =
9292
std::make_unique<MachORewriteInstance>(InputFile, ToolPath, Err);

bolt/lib/Rewrite/RewriteInstance.cpp

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -311,9 +311,8 @@ bool refersToReorderedSection(ErrorOr<BinarySection &> Section) {
311311
} // anonymous namespace
312312

313313
Expected<std::unique_ptr<RewriteInstance>>
314-
RewriteInstance::createRewriteInstance(ELFObjectFileBase *File, const int Argc,
315-
const char *const *Argv,
316-
StringRef ToolPath) {
314+
RewriteInstance::create(ELFObjectFileBase *File, const int Argc,
315+
const char *const *Argv, StringRef ToolPath) {
317316
Error Err = Error::success();
318317
auto RI = std::make_unique<RewriteInstance>(File, Argc, Argv, ToolPath, Err);
319318
if (Err)

bolt/tools/driver/llvm-bolt.cpp

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -216,8 +216,7 @@ int main(int argc, char **argv) {
216216
Binary &Binary = *BinaryOrErr.get().getBinary();
217217

218218
if (auto *e = dyn_cast<ELFObjectFileBase>(&Binary)) {
219-
auto RIOrErr =
220-
RewriteInstance::createRewriteInstance(e, argc, argv, ToolPath);
219+
auto RIOrErr = RewriteInstance::create(e, argc, argv, ToolPath);
221220
if (Error E = RIOrErr.takeError())
222221
report_error(opts::InputFilename, std::move(E));
223222
RewriteInstance &RI = *RIOrErr.get();
@@ -244,8 +243,7 @@ int main(int argc, char **argv) {
244243
if (Error E = RI.run())
245244
report_error(opts::InputFilename, std::move(E));
246245
} else if (auto *O = dyn_cast<MachOObjectFile>(&Binary)) {
247-
auto MachORIOrErr =
248-
MachORewriteInstance::createMachORewriteInstance(O, ToolPath);
246+
auto MachORIOrErr = MachORewriteInstance::create(O, ToolPath);
249247
if (Error E = MachORIOrErr.takeError())
250248
report_error(opts::InputFilename, std::move(E));
251249
MachORewriteInstance &MachORI = *MachORIOrErr.get();
@@ -275,15 +273,13 @@ int main(int argc, char **argv) {
275273
Binary &Binary2 = *BinaryOrErr2.get().getBinary();
276274
if (auto *ELFObj1 = dyn_cast<ELFObjectFileBase>(&Binary1)) {
277275
if (auto *ELFObj2 = dyn_cast<ELFObjectFileBase>(&Binary2)) {
278-
auto RI1OrErr =
279-
RewriteInstance::createRewriteInstance(ELFObj1, argc, argv, ToolPath);
276+
auto RI1OrErr = RewriteInstance::create(ELFObj1, argc, argv, ToolPath);
280277
if (Error E = RI1OrErr.takeError())
281278
report_error(opts::InputFilename, std::move(E));
282279
RewriteInstance &RI1 = *RI1OrErr.get();
283280
if (Error E = RI1.setProfile(opts::InputDataFilename))
284281
report_error(opts::InputDataFilename, std::move(E));
285-
auto RI2OrErr =
286-
RewriteInstance::createRewriteInstance(ELFObj2, argc, argv, ToolPath);
282+
auto RI2OrErr = RewriteInstance::create(ELFObj2, argc, argv, ToolPath);
287283
if (Error E = RI2OrErr.takeError())
288284
report_error(opts::InputFilename2, std::move(E));
289285
RewriteInstance &RI2 = *RI2OrErr.get();

bolt/tools/heatmap/heatmap.cpp

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,8 +85,7 @@ int main(int argc, char **argv) {
8585
Binary &Binary = *BinaryOrErr.get().getBinary();
8686

8787
if (auto *e = dyn_cast<ELFObjectFileBase>(&Binary)) {
88-
auto RIOrErr =
89-
RewriteInstance::createRewriteInstance(e, argc, argv, ToolPath);
88+
auto RIOrErr = RewriteInstance::create(e, argc, argv, ToolPath);
9089
if (Error E = RIOrErr.takeError())
9190
report_error("RewriteInstance", std::move(E));
9291

bolt/tools/llvm-bolt-fuzzer/llvm-bolt-fuzzer.cpp

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,7 @@ extern "C" int LLVMFuzzerTestOneInput(const char *Data, size_t Size) {
4545
return 0;
4646

4747
// Fuzz RewriteInstance.
48-
auto RIOrErr =
49-
RewriteInstance::createRewriteInstance(E, argc, argv, "llvm-bolt");
48+
auto RIOrErr = RewriteInstance::create(E, argc, argv, "llvm-bolt");
5049
if (Error E = RIOrErr.takeError()) {
5150
consumeError(std::move(E));
5251
return 0;

0 commit comments

Comments
 (0)