xref: /aosp_15_r20/external/google-breakpad/src/common/mac/arch_utilities.h (revision 9712c20fc9bbfbac4935993a2ca0b3958c5adad2)
1 // Copyright 2012 Google LLC
2 //
3 // Redistribution and use in source and binary forms, with or without
4 // modification, are permitted provided that the following conditions are
5 // met:
6 //
7 //     * Redistributions of source code must retain the above copyright
8 // notice, this list of conditions and the following disclaimer.
9 //     * Redistributions in binary form must reproduce the above
10 // copyright notice, this list of conditions and the following disclaimer
11 // in the documentation and/or other materials provided with the
12 // distribution.
13 //     * Neither the name of Google LLC nor the names of its
14 // contributors may be used to endorse or promote products derived from
15 // this software without specific prior written permission.
16 //
17 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 
29 // arch_utilities.h: Utilities for architecture introspection for Mac platform.
30 
31 #ifndef COMMON_MAC_ARCH_UTILITIES_H__
32 #define COMMON_MAC_ARCH_UTILITIES_H__
33 
34 #include <mach/machine.h>
35 
36 #include <optional>
37 
38 static constexpr const char* kUnknownArchName = "<Unknown architecture>";
39 
40 struct ArchInfo {
41   cpu_type_t cputype;
42   cpu_subtype_t cpusubtype;
43 };
44 
45 // Returns architecture info if `arch_name` corresponds to a valid, known
46 // architecture, and std::nullopt otherwise.
47 std::optional<ArchInfo> GetArchInfoFromName(const char* arch_name);
48 
49 // Returns the name of the architecture specified by `cpu_type` and
50 // `cpu_subtype`, or `kUnknownArchName` if it's unknown or invalid.
51 const char* GetNameFromCPUType(cpu_type_t cpu_type, cpu_subtype_t cpu_subtype);
52 
53 // Returns the architecture of the machine this code is running on.
54 ArchInfo GetLocalArchInfo();
55 
56 #endif  // COMMON_MAC_ARCH_UTILITIES_H__
57