Open Menu / mach_o / Architecture.h
Loading...
  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
/*
 * Copyright (c) 2017-2021 Apple Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 *
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this
 * file.
 *
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 *
 * @APPLE_LICENSE_HEADER_END@
 */


#ifndef mach_o_Architecture_h
#define mach_o_Architecture_h

#include <stdint.h>
#include <mach/machine.h>
#include <mach-o/loader.h>
#include <mach-o/fat.h>

#include "Defines.h"

namespace mach_o {

/*!
 * @class Architecture
 *
 * @abstract
 *      Encapsulates <cpu-type,cpu-subtype> pair.
 *      Has methods to convert to and from architecture name string.
 */
class VIS_HIDDEN Architecture
{
public:
                  constexpr Architecture(cpu_type_t type, cpu_subtype_t subtype) :  _cputype(type), _cpusubtype(subtype) { }
                            Architecture(const mach_header*);
                            Architecture(const fat_arch*);
                            Architecture(const fat_arch_64*);
                            Architecture() : _cputype(0), _cpusubtype(0) { }
                            Architecture(const Architecture& other) : _cputype(other._cputype), _cpusubtype(other._cpusubtype) { }

#if BUILDING_UNIT_TESTS
                            Architecture(const char* name) { *this = byName(name); }
#endif

    bool                    operator==(const Architecture& other) const;
    bool                    operator!=(const Architecture& other) const { return !operator==(other); }

    bool                    sameCpu(const Architecture& other) const { return (_cputype == other._cputype); }
    bool                    is64() const;
    bool                    isBigEndian() const;
    const char*             name() const; // returns static string
    void                    set(mach_header&) const;
    void                    set(fat_arch&) const;
    void                    set(fat_arch_64&) const;
    bool                    usesArm64Instructions() const;
    bool                    usesArm64AuthPointers() const;
    bool                    usesx86_64Instructions() const;

    static Architecture current();
    static Architecture byName(const char* name);

    // prebuilt values for known architectures
    static constinit const Architecture ppc;
    static constinit const Architecture i386;
    static constinit const Architecture x86_64;
    static constinit const Architecture x86_64h;
    static constinit const Architecture arm64;
    static constinit const Architecture arm64e;
    static constinit const Architecture arm64e_v1;  // wrong ABI version (for testing)
    static constinit const Architecture arm64e_old; // pre-ABI versioned (for testing)
    static constinit const Architecture arm64e_kernel;
    static constinit const Architecture arm64_32;
    static constinit const Architecture armv6m;
    static constinit const Architecture armv7k;
    static constinit const Architecture armv7s;
    static constinit const Architecture armv7;
    static constinit const Architecture armv7m;
    static constinit const Architecture armv7em;
    static constinit const Architecture arm64_alt;
    static constinit const Architecture arm64_32_alt;
    static constinit const Architecture invalid;

private:
    cpu_type_t      _cputype;
    cpu_subtype_t   _cpusubtype;
};




} // namespace mach_o

#endif /* mach_o_Architecture_h */