LIEF: Library to Instrument Executable Formats Version 1.0.0
Loading...
Searching...
No Matches
FatBinary.hpp
Go to the documentation of this file.
1/* Copyright 2017 - 2026 R. Thomas
2 * Copyright 2017 - 2026 Quarkslab
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16#ifndef LIEF_MACHO_FAT_BINARY_H
17#define LIEF_MACHO_FAT_BINARY_H
18#include <string>
19#include <vector>
20#include <memory>
21
22#include "LIEF/visibility.h"
23#include "LIEF/iterators.hpp"
24#include "LIEF/MachO/Header.hpp"
25
26namespace LIEF {
27class Parser;
28namespace MachO {
29
30class Parser;
31class Builder;
32class Binary;
33
37 friend class LIEF::Parser;
38 friend class Parser;
39 friend class Builder;
40
41 public:
42
44 using binaries_t = std::vector<std::unique_ptr<Binary>>;
45
48
51
52 FatBinary(const FatBinary&) = delete;
53 FatBinary& operator=(const FatBinary&) = delete;
54
55 virtual ~FatBinary();
56
58 size_t size() const {
59 return binaries_.size();
60 }
61
63 bool empty() const {
64 return binaries_.empty();
65 }
66
68 return binaries_;
69 }
71 return binaries_;
72 }
73
75 return it_binaries(binaries_).end();
76 }
77
79 return it_const_binaries(binaries_).end();
80 }
81
83 for (auto& bin : binaries_) {
84 bin.release(); // NOLINT(bugprone-unused-return-value)
85 }
86 }
87
90 std::unique_ptr<Binary> pop_back();
91
94 Binary* at(size_t index) {
95 return const_cast<Binary*>(static_cast<const FatBinary*>(this)->at(index));
96 }
97
98 const Binary* at(size_t index) const {
99 if (index >= size()) {
100 return nullptr;
101 }
102 return binaries_[index].get();
103 }
104
106 return const_cast<Binary*>(static_cast<const FatBinary*>(this)->back());
107 }
108 const Binary* back() const {
109 return binaries_.empty() ? nullptr : binaries_.back().get();
110 }
111
113 return const_cast<Binary*>(static_cast<const FatBinary*>(this)->front());
114 }
115
116 const Binary* front() const {
117 return binaries_.empty() ? nullptr : binaries_.front().get();
118 }
119
120 Binary* operator[](size_t index) {
121 return at(index);
122 }
123 const Binary* operator[](size_t index) const {
124 return at(index);
125 }
126
131 std::unique_ptr<Binary> take(size_t index);
132
135 std::unique_ptr<Binary> take(Header::CPU_TYPE cpu);
136
139 void write(const std::string& filename);
140
142 std::vector<uint8_t> raw();
143
145 return const_cast<Binary*>(static_cast<const FatBinary*>(this)->get(cpu));
146 }
147
149 const Binary* get(Header::CPU_TYPE cpu) const;
150
152 return get(cpu);
153 }
154
156 return get(cpu);
157 }
158
159 LIEF_API friend std::ostream& operator<<(std::ostream& os, const FatBinary& fatbinary);
160
161 private:
164 binaries_t binaries_;
165};
166
167} // namespace MachO
168} // namespace LIEF
169#endif
Class which represents a MachO binary.
Definition MachO/Binary.hpp:88
const LoadCommand * get(LoadCommand::TYPE type) const
Return the LoadCommand associated with the given LoadCommand::TYPE or a nullptr if the command can't ...
Class used to rebuild a Mach-O file.
Definition MachO/Builder.hpp:63
it_binaries end()
Definition FatBinary.hpp:74
Binary * front()
Definition FatBinary.hpp:112
std::unique_ptr< Binary > pop_back()
Get a pointer to the last MachO::Binary object presents in this Fat Binary. It returns a nullptr if n...
bool empty() const
Checks whether this object contains MachO::Binary.
Definition FatBinary.hpp:63
std::unique_ptr< Binary > take(Header::CPU_TYPE cpu)
Take the underlying MachO::Binary that matches the given architecture If no binary with the architect...
std::vector< uint8_t > raw()
Reconstruct the Fat binary object and return his content as bytes.
FatBinary(const FatBinary &)=delete
friend std::ostream & operator<<(std::ostream &os, const FatBinary &fatbinary)
const Binary * operator[](Header::CPU_TYPE cpu) const
Definition FatBinary.hpp:155
ref_iterator< binaries_t &, Binary * > it_binaries
Iterator that outputs Binary&.
Definition FatBinary.hpp:47
std::unique_ptr< Binary > take(size_t index)
Extract a MachO::Binary object. Gives ownership to the caller, and remove it from this FatBinary obje...
const Binary * at(size_t index) const
Definition FatBinary.hpp:98
const Binary * back() const
Definition FatBinary.hpp:108
Binary * operator[](size_t index)
Definition FatBinary.hpp:120
it_binaries begin()
Definition FatBinary.hpp:67
Binary * get(Header::CPU_TYPE cpu)
Definition FatBinary.hpp:144
friend class Builder
Definition FatBinary.hpp:39
it_const_binaries begin() const
Definition FatBinary.hpp:70
std::vector< std::unique_ptr< Binary > > binaries_t
Internal container used to store Binary objects within a Fat Mach-O.
Definition FatBinary.hpp:44
const Binary * get(Header::CPU_TYPE cpu) const
Gets a pointer to the MachO::Binary that matches the given architecture.
Binary * back()
Definition FatBinary.hpp:105
const Binary * front() const
Definition FatBinary.hpp:116
void write(const std::string &filename)
Reconstruct the Fat binary object and write it in filename.
FatBinary & operator=(const FatBinary &)=delete
friend class LIEF::Parser
Definition FatBinary.hpp:37
it_const_binaries end() const
Definition FatBinary.hpp:78
const_ref_iterator< const binaries_t &, Binary * > it_const_binaries
Iterator that outputs const Binary&.
Definition FatBinary.hpp:50
Binary * at(size_t index)
Get a pointer to the MachO::Binary specified by the index. It returns a nullptr if the binary does no...
Definition FatBinary.hpp:94
Binary * operator[](Header::CPU_TYPE cpu)
Definition FatBinary.hpp:151
size_t size() const
Number of MachO::Binary wrapped by this object.
Definition FatBinary.hpp:58
const Binary * operator[](size_t index) const
Definition FatBinary.hpp:123
void release_all_binaries()
Definition FatBinary.hpp:82
CPU_TYPE
Definition MachO/Header.hpp:101
The main interface to parse a Mach-O binary.
Definition MachO/Parser.hpp:42
Main interface to parse an executable regardless of its format.
Definition Abstract/Parser.hpp:30
Iterator which returns reference on container's values.
Definition iterators.hpp:46
Namespace related to the LIEF's Mach-O module.
Definition Abstract/Header.hpp:36
LIEF namespace.
Definition Abstract/Binary.hpp:40
ref_iterator< CT, U, typename decay_t< CT >::const_iterator > const_ref_iterator
Iterator which return const ref on container's values.
Definition iterators.hpp:257
#define LIEF_API
Definition visibility.h:41
#define LIEF_LOCAL
Definition visibility.h:42