blob: 171550e620c142e392c27203671a418ca084123f [file] [log] [blame]
Steven Moreland5553ac42020-11-11 02:14:45 +00001/*
2 * Copyright (C) 2020 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16#pragma once
17
18namespace android {
19
20#pragma clang diagnostic push
21#pragma clang diagnostic error "-Wpadded"
22
Steven Moreland826367f2021-09-10 14:05:31 -070023constexpr uint8_t RPC_CONNECTION_OPTION_INCOMING = 0x1; // default is outgoing
Steven Moreland659416d2021-05-11 00:47:50 +000024
Steven Moreland5623d1a2021-09-10 15:45:34 -070025constexpr uint32_t RPC_WIRE_ADDRESS_OPTION_CREATED = 1 << 0; // distinguish from '0' address
26constexpr uint32_t RPC_WIRE_ADDRESS_OPTION_FOR_SERVER = 1 << 1;
Steven Moreland01a6bad2021-06-11 00:59:20 +000027
28struct RpcWireAddress {
Steven Moreland5623d1a2021-09-10 15:45:34 -070029 uint32_t options;
30 uint32_t address;
31
32 static inline RpcWireAddress fromRaw(uint64_t raw) {
33 return *reinterpret_cast<RpcWireAddress*>(&raw);
34 }
35 static inline uint64_t toRaw(RpcWireAddress addr) {
36 return *reinterpret_cast<uint64_t*>(&addr);
37 }
Steven Moreland01a6bad2021-06-11 00:59:20 +000038};
Steven Moreland5623d1a2021-09-10 15:45:34 -070039static_assert(sizeof(RpcWireAddress) == sizeof(uint64_t));
Steven Moreland01a6bad2021-06-11 00:59:20 +000040
Steven Morelandc88b7fc2021-06-10 00:40:39 +000041/**
42 * This is sent to an RpcServer in order to request a new connection is created,
43 * either as part of a new session or an existing session
44 */
Steven Moreland659416d2021-05-11 00:47:50 +000045struct RpcConnectionHeader {
Steven Morelandbf57bce2021-07-26 15:26:12 -070046 uint32_t version; // maximum supported by caller
Steven Moreland659416d2021-05-11 00:47:50 +000047 uint8_t options;
Steven Moreland826367f2021-09-10 14:05:31 -070048 uint8_t reservered[9];
49 // Follows is sessionIdSize bytes.
50 // if size is 0, this is requesting a new session.
51 uint16_t sessionIdSize;
Steven Morelandbf57bce2021-07-26 15:26:12 -070052};
Steven Moreland826367f2021-09-10 14:05:31 -070053static_assert(sizeof(RpcConnectionHeader) == 16);
Steven Morelandbf57bce2021-07-26 15:26:12 -070054
55/**
56 * In response to an RpcConnectionHeader which corresponds to a new session,
57 * this returns information to the server.
58 */
59struct RpcNewSessionResponse {
60 uint32_t version; // maximum supported by callee <= maximum supported by caller
61 uint8_t reserved[4];
Steven Moreland659416d2021-05-11 00:47:50 +000062};
Steven Moreland14cd3fe2021-09-02 16:18:14 -070063static_assert(sizeof(RpcNewSessionResponse) == 8);
Steven Moreland659416d2021-05-11 00:47:50 +000064
Steven Morelandc88b7fc2021-06-10 00:40:39 +000065#define RPC_CONNECTION_INIT_OKAY "cci"
66
67/**
68 * Whenever a client connection is setup, this is sent as the initial
69 * transaction. The main use of this is in order to control the timing for when
Steven Moreland1b304292021-07-15 22:59:34 +000070 * an incoming connection is setup.
Steven Morelandc88b7fc2021-06-10 00:40:39 +000071 */
Steven Moreland19fc9f72021-06-10 03:57:30 +000072struct RpcOutgoingConnectionInit {
Steven Morelandc88b7fc2021-06-10 00:40:39 +000073 char msg[4];
74 uint8_t reserved[4];
75};
Steven Moreland14cd3fe2021-09-02 16:18:14 -070076static_assert(sizeof(RpcOutgoingConnectionInit) == 8);
Steven Morelandc88b7fc2021-06-10 00:40:39 +000077
Steven Moreland5553ac42020-11-11 02:14:45 +000078enum : uint32_t {
79 /**
80 * follows is RpcWireTransaction, if flags != oneway, reply w/ RPC_COMMAND_REPLY expected
81 */
82 RPC_COMMAND_TRANSACT = 0,
83 /**
84 * follows is RpcWireReply
85 */
86 RPC_COMMAND_REPLY,
87 /**
Steven Morelandfd1e8a02021-07-21 23:30:29 +000088 * follows is RpcDecStrong
Steven Moreland5553ac42020-11-11 02:14:45 +000089 *
90 * note - this in the protocol directly instead of as a 'special
91 * transaction' in order to keep it as lightweight as possible (we don't
92 * want to create a 'Parcel' object for every decref)
93 */
94 RPC_COMMAND_DEC_STRONG,
95};
96
97/**
98 * These commands are used when the address in an RpcWireTransaction is zero'd
99 * out (no address). This allows the transact/reply flow to be used for
100 * additional server commands, without making the protocol for
101 * transactions/replies more complicated.
102 */
103enum : uint32_t {
104 RPC_SPECIAL_TRANSACT_GET_ROOT = 0,
Steven Morelandf137de92021-04-24 01:54:26 +0000105 RPC_SPECIAL_TRANSACT_GET_MAX_THREADS = 1,
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000106 RPC_SPECIAL_TRANSACT_GET_SESSION_ID = 2,
Steven Moreland5553ac42020-11-11 02:14:45 +0000107};
108
Steven Moreland5553ac42020-11-11 02:14:45 +0000109// serialization is like:
110// |RpcWireHeader|struct desginated by 'command'| (over and over again)
111
112struct RpcWireHeader {
113 uint32_t command; // RPC_COMMAND_*
114 uint32_t bodySize;
115
116 uint32_t reserved[2];
117};
Steven Moreland14cd3fe2021-09-02 16:18:14 -0700118static_assert(sizeof(RpcWireHeader) == 16);
Steven Moreland5553ac42020-11-11 02:14:45 +0000119
Steven Morelandfd1e8a02021-07-21 23:30:29 +0000120struct RpcDecStrong {
121 RpcWireAddress address;
122 uint32_t amount;
123 uint32_t reserved;
124};
125static_assert(sizeof(RpcDecStrong) == 16);
126
Steven Moreland5553ac42020-11-11 02:14:45 +0000127struct RpcWireTransaction {
128 RpcWireAddress address;
129 uint32_t code;
130 uint32_t flags;
131
132 uint64_t asyncNumber;
133
134 uint32_t reserved[4];
135
Devin Moore139913a2021-08-13 19:59:16 +0000136 uint8_t data[];
Steven Moreland5553ac42020-11-11 02:14:45 +0000137};
Steven Moreland5623d1a2021-09-10 15:45:34 -0700138static_assert(sizeof(RpcWireTransaction) == 40);
Steven Moreland5553ac42020-11-11 02:14:45 +0000139
140struct RpcWireReply {
141 int32_t status; // transact return
Devin Moore139913a2021-08-13 19:59:16 +0000142 uint8_t data[];
Steven Moreland5553ac42020-11-11 02:14:45 +0000143};
Steven Moreland14cd3fe2021-09-02 16:18:14 -0700144static_assert(sizeof(RpcWireReply) == 4);
Steven Moreland5553ac42020-11-11 02:14:45 +0000145
146#pragma clang diagnostic pop
147
148} // namespace android