xref: /aosp_15_r20/external/sandboxed-api/sandboxed_api/rpcchannel.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 #ifndef SANDBOXED_API_RPCCHANNEL_H_
16*ec63e07aSXin Li #define SANDBOXED_API_RPCCHANNEL_H_
17*ec63e07aSXin Li 
18*ec63e07aSXin Li #include <cstddef>
19*ec63e07aSXin Li #include <cstdint>
20*ec63e07aSXin Li 
21*ec63e07aSXin Li #include "absl/status/status.h"
22*ec63e07aSXin Li #include "absl/status/statusor.h"
23*ec63e07aSXin Li #include "absl/synchronization/mutex.h"
24*ec63e07aSXin Li #include "sandboxed_api/call.h"
25*ec63e07aSXin Li #include "sandboxed_api/sandbox2/comms.h"
26*ec63e07aSXin Li #include "sandboxed_api/var_type.h"
27*ec63e07aSXin Li 
28*ec63e07aSXin Li namespace sapi {
29*ec63e07aSXin Li 
30*ec63e07aSXin Li // This class exposes functions which provide primitives operating over the
31*ec63e07aSXin Li // Comms channel.
32*ec63e07aSXin Li class RPCChannel {
33*ec63e07aSXin Li  public:
RPCChannel(sandbox2::Comms * comms)34*ec63e07aSXin Li   explicit RPCChannel(sandbox2::Comms* comms) : comms_(comms) {}
35*ec63e07aSXin Li 
36*ec63e07aSXin Li   // Calls a function.
37*ec63e07aSXin Li   absl::Status Call(const FuncCall& call, uint32_t tag, FuncRet* ret,
38*ec63e07aSXin Li                     v::Type exp_type);
39*ec63e07aSXin Li 
40*ec63e07aSXin Li   // Allocates memory.
41*ec63e07aSXin Li   absl::Status Allocate(size_t size, void** addr);
42*ec63e07aSXin Li 
43*ec63e07aSXin Li   // Reallocates memory.
44*ec63e07aSXin Li   absl::Status Reallocate(void* old_addr, size_t size, void** new_addr);
45*ec63e07aSXin Li 
46*ec63e07aSXin Li   // Frees memory.
47*ec63e07aSXin Li   absl::Status Free(void* addr);
48*ec63e07aSXin Li 
49*ec63e07aSXin Li   // Returns address of a symbol.
50*ec63e07aSXin Li   absl::Status Symbol(const char* symname, void** addr);
51*ec63e07aSXin Li 
52*ec63e07aSXin Li   // Makes the remote part exit.
53*ec63e07aSXin Li   absl::Status Exit();
54*ec63e07aSXin Li 
55*ec63e07aSXin Li   // Transfers fd to sandboxee.
56*ec63e07aSXin Li   absl::Status SendFD(int local_fd, int* remote_fd);
57*ec63e07aSXin Li 
58*ec63e07aSXin Li   // Retrieves fd from sandboxee.
59*ec63e07aSXin Li   absl::Status RecvFD(int remote_fd, int* local_fd);
60*ec63e07aSXin Li 
61*ec63e07aSXin Li   // Closes fd in sandboxee.
62*ec63e07aSXin Li   absl::Status Close(int remote_fd);
63*ec63e07aSXin Li 
64*ec63e07aSXin Li   // Returns length of a null-terminated c-style string (invokes strlen).
65*ec63e07aSXin Li   absl::StatusOr<size_t> Strlen(void* str);
66*ec63e07aSXin Li 
comms()67*ec63e07aSXin Li   sandbox2::Comms* comms() const { return comms_; }
68*ec63e07aSXin Li 
69*ec63e07aSXin Li  private:
70*ec63e07aSXin Li   // Receives the result after a call.
71*ec63e07aSXin Li   absl::StatusOr<FuncRet> Return(v::Type exp_type);
72*ec63e07aSXin Li 
73*ec63e07aSXin Li   sandbox2::Comms* comms_;  // Owned by sandbox2;
74*ec63e07aSXin Li   absl::Mutex mutex_;
75*ec63e07aSXin Li };
76*ec63e07aSXin Li 
77*ec63e07aSXin Li }  // namespace sapi
78*ec63e07aSXin Li 
79*ec63e07aSXin Li #endif  // SANDBOXED_API_RPCCHANNEL_H_
80