xref: /aosp_15_r20/external/sandboxed-api/sandboxed_api/sandbox2/syscall.h (revision ec63e07ab9515d95e79c211197c445ef84cefa6a)
1*ec63e07aSXin Li // Copyright 2019 Google LLC
2*ec63e07aSXin Li //
3*ec63e07aSXin Li // Licensed under the Apache License, Version 2.0 (the "License");
4*ec63e07aSXin Li // you may not use this file except in compliance with the License.
5*ec63e07aSXin Li // You may obtain a copy of the License at
6*ec63e07aSXin Li //
7*ec63e07aSXin Li //     https://www.apache.org/licenses/LICENSE-2.0
8*ec63e07aSXin Li //
9*ec63e07aSXin Li // Unless required by applicable law or agreed to in writing, software
10*ec63e07aSXin Li // distributed under the License is distributed on an "AS IS" BASIS,
11*ec63e07aSXin Li // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12*ec63e07aSXin Li // See the License for the specific language governing permissions and
13*ec63e07aSXin Li // limitations under the License.
14*ec63e07aSXin Li 
15*ec63e07aSXin Li // The sandbox2::Syscalls class defines mostly static helper methods which
16*ec63e07aSXin Li // are used to analyze the status of the sandboxed process.
17*ec63e07aSXin Li 
18*ec63e07aSXin Li #ifndef SANDBOXED_API_SANDBOX2_SYSCALL_H__
19*ec63e07aSXin Li #define SANDBOXED_API_SANDBOX2_SYSCALL_H__
20*ec63e07aSXin Li 
21*ec63e07aSXin Li #include <sys/types.h>
22*ec63e07aSXin Li 
23*ec63e07aSXin Li #include <array>
24*ec63e07aSXin Li #include <cstddef>
25*ec63e07aSXin Li #include <cstdint>
26*ec63e07aSXin Li #include <string>
27*ec63e07aSXin Li #include <vector>
28*ec63e07aSXin Li 
29*ec63e07aSXin Li #include "sandboxed_api/config.h"  // IWYU pragma: export
30*ec63e07aSXin Li 
31*ec63e07aSXin Li namespace sandbox2 {
32*ec63e07aSXin Li 
33*ec63e07aSXin Li class Syscall {
34*ec63e07aSXin Li  public:
35*ec63e07aSXin Li   // Maximum number of syscall arguments
36*ec63e07aSXin Li   static constexpr size_t kMaxArgs = 6;
37*ec63e07aSXin Li   using Args = std::array<uint64_t, kMaxArgs>;
38*ec63e07aSXin Li 
39*ec63e07aSXin Li   // Returns the host architecture, according to CpuArch.
GetHostArch()40*ec63e07aSXin Li   static constexpr sapi::cpu::Architecture GetHostArch() {
41*ec63e07aSXin Li     return sapi::host_cpu::Architecture();
42*ec63e07aSXin Li   }
43*ec63e07aSXin Li 
44*ec63e07aSXin Li   // Returns the host architecture, according to <linux/audit.h>.
45*ec63e07aSXin Li   static uint32_t GetHostAuditArch();
46*ec63e07aSXin Li 
47*ec63e07aSXin Li   // Returns a description of the architecture.
48*ec63e07aSXin Li   static std::string GetArchDescription(sapi::cpu::Architecture arch);
49*ec63e07aSXin Li 
50*ec63e07aSXin Li   Syscall() = default;
51*ec63e07aSXin Li   Syscall(sapi::cpu::Architecture arch, uint64_t nr, Args args = {})
arch_(arch)52*ec63e07aSXin Li       : arch_(arch), nr_(nr), args_(args) {}
53*ec63e07aSXin Li 
pid()54*ec63e07aSXin Li   pid_t pid() const { return pid_; }
nr()55*ec63e07aSXin Li   uint64_t nr() const { return nr_; }
arch()56*ec63e07aSXin Li   sapi::cpu::Architecture arch() const { return arch_; }
args()57*ec63e07aSXin Li   const Args& args() const { return args_; }
stack_pointer()58*ec63e07aSXin Li   uint64_t stack_pointer() const { return sp_; }
instruction_pointer()59*ec63e07aSXin Li   uint64_t instruction_pointer() const { return ip_; }
60*ec63e07aSXin Li 
61*ec63e07aSXin Li   std::string GetName() const;
62*ec63e07aSXin Li 
63*ec63e07aSXin Li   std::vector<std::string> GetArgumentsDescription() const;
64*ec63e07aSXin Li   std::string GetDescription() const;
65*ec63e07aSXin Li 
66*ec63e07aSXin Li  private:
67*ec63e07aSXin Li   friend class Regs;
68*ec63e07aSXin Li   friend class UnotifyMonitor;
69*ec63e07aSXin Li 
Syscall(pid_t pid)70*ec63e07aSXin Li   explicit Syscall(pid_t pid) : pid_(pid) {}
Syscall(sapi::cpu::Architecture arch,uint64_t nr,Args args,pid_t pid,uint64_t sp,uint64_t ip)71*ec63e07aSXin Li   Syscall(sapi::cpu::Architecture arch, uint64_t nr, Args args, pid_t pid,
72*ec63e07aSXin Li           uint64_t sp, uint64_t ip)
73*ec63e07aSXin Li       : arch_(arch), nr_(nr), args_(args), pid_(pid), sp_(sp), ip_(ip) {}
74*ec63e07aSXin Li 
75*ec63e07aSXin Li   sapi::cpu::Architecture arch_ = sapi::cpu::kUnknown;
76*ec63e07aSXin Li   uint64_t nr_ = -1;
77*ec63e07aSXin Li   Args args_ = {};
78*ec63e07aSXin Li   pid_t pid_ = -1;
79*ec63e07aSXin Li   uint64_t sp_ = 0;
80*ec63e07aSXin Li   uint64_t ip_ = 0;
81*ec63e07aSXin Li };
82*ec63e07aSXin Li 
83*ec63e07aSXin Li }  // namespace sandbox2
84*ec63e07aSXin Li 
85*ec63e07aSXin Li #endif  // SANDBOXED_API_SANDBOX2_SYSCALL_H__
86