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
|
#include "CpuArch.h"
#include "Interface.h"
#include "FileUtils.h"
#include "Log.h"
#ifdef _WIN32
# ifndef NOMINMAX
# define NOMINMAX
# endif
# include <windows.h>
// IMAGE_FILE_MACHINE_ARM64 is only defined on Windows 8.1 and above
# ifndef IMAGE_FILE_MACHINE_ARM64
#define IMAGE_FILE_MACHINE_ARM64 0xaa64
# endif
#endif // _WIN32
#ifdef __APPLE__
# include <mach-o/dyld.h>
# include <unistd.h>
# include <mach/machine.h>
# include <mach-o/loader.h>
# include <mach-o/fat.h>
#endif
#if defined(__linux__)
# include <elf.h>
#endif
#if USE_WINE
// avoid including Wine headers just for a few defines
# define IMAGE_FILE_MACHINE_AMD64 0x8664
# define IMAGE_FILE_MACHINE_I386 0x014c
# define IMAGE_FILE_MACHINE_POWERPC 0x01f0
# define IMAGE_FILE_MACHINE_ARM 0x01c0
# define IMAGE_FILE_MACHINE_ARM64 0xaa64
# define IMAGE_FILE_DLL 0x2000
#endif // USE_WINE
#include <sstream>
#include <cstring>
#include <unordered_map>
namespace vst {
CpuArch getHostCpuArchitecture(){
#if defined(__i386__) || defined(_M_IX86)
return CpuArch::i386;
#elif defined(__x86_64__) || defined(_M_X64)
return CpuArch::amd64;
#elif defined(__arm__) || defined(_M_ARM)
return CpuArch::arm;
#elif defined(__aarch64__)
return CpuArch::aarch64;
#elif defined(__ppc__)
return CpuArch::ppc;
#elif defined(__ppc64__)
return CpuArch::ppc64;
#else
return CpuArch::unknown;
#endif
}
const char * cpuArchToString(CpuArch arch){
switch (arch){
case CpuArch::i386:
return "i386";
case CpuArch::amd64:
return "amd64";
case CpuArch::arm:
return "arm";
case CpuArch::aarch64:
return "aarch64";
case CpuArch::ppc:
return "ppc";
case CpuArch::ppc64:
return "ppc64";
#ifndef _WIN32
case CpuArch::pe_i386:
return "pe_i386";
case CpuArch::pe_amd64:
return "pe_amd64";
#endif
default:
return "unknown";
}
}
static std::unordered_map<std::string_view, CpuArch> gCpuArchMap = {
{ "i386", CpuArch::i386 },
{ "amd64", CpuArch::amd64 },
{ "arm", CpuArch::arm },
{ "aarch64", CpuArch::aarch64 },
{ "ppc", CpuArch::ppc },
{ "ppc64", CpuArch::ppc64 },
#ifndef _WIN32
// PE executables (for Wine support)
{ "pe_i386", CpuArch::pe_i386 },
{ "pe_amd64", CpuArch::pe_amd64 },
#endif
};
CpuArch cpuArchFromString(std::string_view name){
auto it = gCpuArchMap.find(name);
if (it != gCpuArchMap.end()){
return it->second;
} else {
return CpuArch::unknown;
}
}
template<typename T>
static void swap_bytes(T& i){
const auto n = sizeof(T);
char a[n];
char b[n];
memcpy(a, &i, n);
for (int i = 0, j = n-1; i < n; ++i, --j){
b[i] = a[j];
}
memcpy(&i, b, n);
}
#if defined(_WIN32) || USE_WINE
CpuArch readPE(vst::File& file, bool onlyPlugins){
// read PE header
// note: we don't have to worry about byte order (always LE)
const uint16_t dos_signature = 0x5A4D;
const char pe_signature[] = { 'P', 'E', 0, 0 };
const auto header_size = 24; // PE signature + COFF header
char data[1024]; // should be large enough for DOS stub
file.read(data, sizeof(data));
int nbytes = file.gcount();
// check DOS signature
if (nbytes > sizeof(dos_signature) && !memcmp(data, &dos_signature, sizeof(dos_signature))){
int32_t offset;
// get the file offset to the PE signature
memcpy(&offset, &data[0x3C], sizeof(offset));
if (offset < (sizeof(data) - header_size)){
const char *header = data + offset;
if (!memcmp(header, pe_signature, sizeof(pe_signature))){
header += sizeof(pe_signature);
// check if it is a DLL
uint16_t flags;
memcpy(&flags, &header[18], sizeof(flags));
if (!(flags & IMAGE_FILE_DLL) && onlyPlugins){
throw Error(Error::ModuleError, "not a DLL");
}
// get CPU architecture
uint16_t arch;
memcpy(&arch, &header[0], sizeof(arch));
switch (arch){
case IMAGE_FILE_MACHINE_AMD64:
#ifdef _WIN32
return CpuArch::amd64;
#else
return CpuArch::pe_amd64;
#endif
case IMAGE_FILE_MACHINE_I386:
#ifdef _WIN32
return CpuArch::i386;
#else
return CpuArch::pe_i386;
#endif
case IMAGE_FILE_MACHINE_POWERPC:
return CpuArch::ppc;
case IMAGE_FILE_MACHINE_ARM:
return CpuArch::arm;
case IMAGE_FILE_MACHINE_ARM64:
return CpuArch::aarch64;
default:
return CpuArch::unknown;
}
} else {
throw Error(Error::ModuleError, "bad PE signature");
}
} else {
throw Error(Error::ModuleError, "DOS stub too large");
}
} else {
#if USE_WINE
throw Error(Error::NoError); // HACK!
#else
if (onlyPlugins) {
throw Error(Error::ModuleError, "not a DLL");
} else {
throw Error(Error::ModuleError, "not a PE file");
}
#endif
}
}
#endif
#if !defined(_WIN32) && !defined(__APPLE__) // Linux, OpenBSD, FreeBSD, etc. (TODO handle Android?)
CpuArch readELF(vst::File& file, bool onlyPlugins){
// read ELF header
// check magic number
char data[64]; // ELF header size
if (file.read(data, sizeof(data)) && !memcmp(data, ELFMAG, SELFMAG)){
char endian = data[0x05];
int byteorder;
if (endian == ELFDATA2LSB){
byteorder = LITTLE_ENDIAN;
} else if (endian == ELFDATA2MSB){
byteorder = BIG_ENDIAN;
} else {
throw Error(Error::ModuleError, "invalid data encoding in ELF header");
}
// check file type
uint16_t filetype;
memcpy(&filetype, &data[0x10], sizeof(filetype));
if (BYTE_ORDER != byteorder){
swap_bytes(filetype);
}
// check if it is a shared object
if (filetype != ET_DYN && onlyPlugins){
throw Error(Error::ModuleError, "not a shared object");
}
// read CPU architecture
uint16_t arch;
memcpy(&arch, &data[0x12], sizeof(arch));
if (BYTE_ORDER != byteorder){
swap_bytes(arch);
}
switch (arch){
case EM_386:
return CpuArch::i386;
case EM_X86_64:
return CpuArch::amd64;
case EM_PPC:
return CpuArch::ppc;
case EM_PPC64:
return CpuArch::ppc64;
case EM_ARM:
return CpuArch::arm;
case EM_AARCH64:
return CpuArch::aarch64;
default:
return CpuArch::unknown;
}
} else {
if (onlyPlugins) {
throw Error(Error::ModuleError, "not a shared object");
} else {
throw Error(Error::ModuleError, "not an ELF file");
}
}
}
#endif
#ifdef __APPLE__ // macOS (TODO handle iOS?)
std::vector<CpuArch> readMach(vst::File& file, bool onlyPlugins){
// read Mach-O header
auto read_uint32 = [](std::fstream& f, bool swap){
uint32_t i;
if (!f.read((char *)&i, sizeof(i))){
throw Error(Error::ModuleError, "end of file reached");
}
if (swap){
swap_bytes(i);
}
return i;
};
auto getCpuArch = [](cpu_type_t arch){
switch (arch){
// case CPU_TYPE_I386:
case CPU_TYPE_X86:
return CpuArch::i386;
case CPU_TYPE_X86_64:
return CpuArch::amd64;
case CPU_TYPE_ARM:
return CpuArch::arm;
case CPU_TYPE_ARM64:
return CpuArch::aarch64;
case CPU_TYPE_POWERPC:
return CpuArch::ppc;
case CPU_TYPE_POWERPC64:
return CpuArch::ppc64;
default:
return CpuArch::unknown;
}
};
auto readMachHeader = [&](std::fstream& f, bool swap, bool wide){
LOG_DEBUG("reading mach-o header");
cpu_type_t cputype = read_uint32(f, swap);
uint32_t cpusubtype = read_uint32(f, swap); // ignored
uint32_t filetype = read_uint32(f, swap);
// check if it is a dylib or Mach-bundle
if (filetype != MH_DYLIB && filetype != MH_BUNDLE && onlyPlugins){
throw Error(Error::ModuleError, "not a plugin");
}
return getCpuArch(cputype);
};
auto readFatArchive = [&](std::fstream& f, bool swap, bool wide){
LOG_DEBUG("reading fat archive");
std::vector<CpuArch> archs;
auto count = read_uint32(f, swap);
for (auto i = 0; i < count; ++i){
// fat_arch is 20 bytes and fat_arch_64 is 32 bytes
// read CPU type
cpu_type_t arch = read_uint32(f, swap);
// the archive should contain only plugins, so we don't
// catch exepctions thrown by readMachHeader()
archs.push_back(getCpuArch(arch));
// skip remaining bytes. LATER also check file type.
if (wide){
char dummy[28];
f.read(dummy, sizeof(dummy));
} else {
char dummy[16];
f.read(dummy, sizeof(dummy));
}
}
return archs;
};
uint32_t magic = 0;
file.read((char *)&magic, sizeof(magic));
// *_CIGAM tells us to swap endianess
switch (magic){
case MH_MAGIC:
return { readMachHeader(file, false, false) };
case MH_CIGAM:
return { readMachHeader(file, true, false) };
#ifdef MH_MAGIC_64
case MH_MAGIC_64:
return { readMachHeader(file, false, true) };
case MH_CIGAM_64:
return { readMachHeader(file, true, true) };
#endif
case FAT_MAGIC:
return readFatArchive(file, false, false);
case FAT_CIGAM:
return readFatArchive(file, true, false);
#ifdef FAT_MAGIC_64
case FAT_MAGIC_64:
return readFatArchive(file, false, true);
case FAT_CIGAM_64:
return readFatArchive(file, true, true);
#endif
default:
return {};
}
}
#endif
static const std::vector<const char *> gBundleBinaryPaths = {
#if defined(_WIN32) || USE_WINE
"Contents/x86-win", "Contents/x86_64-win",
#endif
#if defined(__APPLE__)
"Contents/MacOS",
#endif
#if defined(__linux__)
#if defined(__i386__) || defined(__x86_64__)
// Intel
"Contents/i386-linux", "Contents/x86_64-linux"
#elif defined(__arm__) || defined(__aarch64__)
// ARM - no bit bridging
getBundleBinaryPath()
#endif
#endif
};
static const std::vector<const char *> gBundleBinaryExtensions = {
#if defined(_WIN32) || USE_WINE
// bundles are only used by VST3 plugins
".vst3",
#endif
#if defined(__APPLE__)
"",
#endif
#if defined(__linux__)
".so"
#endif
};
// try to get CPU architecture(s) from a file
std::vector<CpuArch> doGetCpuArchitectures(const std::string& path, bool onlyPlugins){
std::vector<CpuArch> results;
vst::File file(path);
if (file.is_open()){
#if USE_WINE
try {
#endif
#if defined(_WIN32) // Windows
results.push_back(readPE(file, onlyPlugins));
#elif defined(__APPLE__)
auto archs = readMach(file, onlyPlugins);
results.insert(results.end(), archs.begin(), archs.end());
#else
results.push_back(readELF(file, onlyPlugins));
#endif
#if USE_WINE
} catch (const Error& e) {
// rewind file!
file.clear();
file.seekg(0);
try {
// try to read as PE
results.push_back(readPE(file, onlyPlugins));
} catch (const Error& e2) {
if (e2.code() == Error::NoError){
// not a PE, keep original error
throw e;
} else {
// bad PE
throw e2;
}
}
}
#endif
}
return results;
}
// Check a file path or bundle for contained CPU architectures
// If 'path' is a file, we throw an exception if it is not a library,
// but if 'path' is a bundle (= directory), we ignore any non-library files
// in the 'Contents' subfolder (so the resulting list might be empty).
std::vector<CpuArch> getPluginCpuArchitectures(const std::string& path){
if (isDirectory(path)){
// plugin bundle
std::vector<CpuArch> results;
auto hasExtension = [](const std::string& path){
#ifdef __APPLE__
// On macOS, the actual binary in a VST plugin bundle shouldn't have
// a file extension, but some plugin vendors don't seem to care...
// As a workaround we simply don't filter at all.
return true;
#else
auto e1 = fileExtension(path);
for (auto& e2 : gBundleBinaryExtensions){
if (e1 == e2){
return true;
}
}
return false;
#endif
};
// '/Contents' might contain additional subfolders, such as '/Resources',
// or '/Frameworks' on macOS, so we should restrict our search to the folders
// that contain the actual binaries. This is especially relevant on macOS,
// because we can't filter by extension (see hasExtension()).
for (auto& binaryPath : gBundleBinaryPaths){
vst::search(path + "/" + binaryPath, [&](const std::string& file){
// ignore files in a bundle that are not plugins
if (hasExtension(file)){
try {
auto res = doGetCpuArchitectures(file, true); // bundle!
results.insert(results.end(), res.begin(), res.end());
} catch (const Error& e){
LOG_ERROR(path << ": " << e.what());
}
}
}, false); // don't filter
}
if (results.empty()) {
throw Error(Error::ModuleError, "bundle doesn't contain any plugins");
}
return results;
} else {
// plugin file
return doGetCpuArchitectures(path, true);
}
}
std::vector<CpuArch> getFileCpuArchitectures(const std::string &path) {
return doGetCpuArchitectures(path, false);
}
void printCpuArchitectures(const std::string& path){
auto archs = getFileCpuArchitectures(path);
if (!archs.empty()){
std::stringstream ss;
for (auto& arch : archs){
ss << cpuArchToString(arch) << " ";
}
LOG_INFO("CPU architectures: " << ss.str());
} else {
LOG_INFO("CPU architectures: none");
}
}
} // vst
|