File: wrapped_platform_handle.cc

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (214 lines) | stat: -rw-r--r-- 6,223 bytes parent folder | download | duplicates (5)
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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
// Copyright 2022 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "mojo/core/ipcz_driver/wrapped_platform_handle.h"

#include <cstdint>
#include <utility>

#include "base/check.h"
#include "base/files/scoped_file.h"
#include "base/notreached.h"
#include "build/build_config.h"
#include "mojo/core/ipcz_driver/validate_enum.h"
#include "mojo/public/cpp/platform/platform_handle.h"
#include "third_party/ipcz/include/ipcz/ipcz.h"

#if BUILDFLAG(IS_FUCHSIA)
#include <lib/fdio/fd.h>
#include <lib/zx/handle.h>

#include "base/fuchsia/fuchsia_logging.h"
#endif

#if BUILDFLAG(IS_APPLE)
#include <mach/mach.h>

#include "base/apple/mach_logging.h"
#include "base/apple/scoped_mach_port.h"
#endif

namespace mojo::core::ipcz_driver {

namespace {

// Enumeration for different possible types of PlatformHandles that may be
// wrapped by a WrappedPlatformHandle.
enum class WrapperType : uint32_t {
  // The wrapped PlatformHandle is transmissible as-is and can pass through a
  // Transport unmodified.
  kTransmissible,

#if BUILDFLAG(IS_FUCHSIA) || BUILDFLAG(IS_APPLE)
  // The wrapped PlatformHandle is a file descriptor on Fuchsia or macOS/iOS,
  // where the Transport can only transmit Fuchsia handles or Mach port rights,
  // respectively.
  //
  // On Fuchsia we serialize this type of handle by replacing it with a handle
  // to a corresponding fdio object. On macOS/iOS we replace it with a handle to
  // a corresponding fileport send right. On the receiving end this deserializes
  // back to a file descriptor.
  kIndirectFileDescriptor,
#endif

  // For ValidateEnum().
  kMinValue = kTransmissible,
#if BUILDFLAG(IS_FUCHSIA) || BUILDFLAG(IS_APPLE)
  kMaxValue = kIndirectFileDescriptor,
#else
  kMaxValue = kTransmissible,
#endif
};

// Header for a serialized WrappedPlatformHandle object.
struct IPCZ_ALIGN(8) WrappedPlatformHandleHeader {
  // The size of this structure in bytes.
  uint32_t size;

  // Indicates what specific type of handle is wrapped.
  WrapperType type;
};
static_assert(sizeof(WrappedPlatformHandleHeader) == 8,
              "Invalid WrappedPlatformHandleHeader size");

#if BUILDFLAG(IS_FUCHSIA)
PlatformHandle MakeFDTransmissible(base::ScopedFD fd) {
  zx::handle result;
  const zx_status_t status =
      fdio_fd_transfer_or_clone(fd.release(), result.reset_and_get_address());
  if (status != ZX_OK) {
    ZX_DLOG(ERROR, status) << "fdio_fd_transfer_or_clone";
    return {};
  }
  return PlatformHandle(std::move(result));
}

base::ScopedFD RecoverFDFromTransmissible(PlatformHandle handle) {
  base::ScopedFD fd;
  zx_status_t status = fdio_fd_create(handle.ReleaseHandle(),
                                      base::ScopedFD::Receiver(fd).get());
  if (status != ZX_OK) {
    ZX_DLOG(ERROR, status) << "fdio_fd_create";
    return {};
  }
  return fd;
}
#elif BUILDFLAG(IS_APPLE)
extern "C" {
kern_return_t fileport_makeport(int fd, mach_port_t*);
int fileport_makefd(mach_port_t);
}  // extern "C"

PlatformHandle MakeFDTransmissible(base::ScopedFD fd) {
  base::apple::ScopedMachSendRight port;
  kern_return_t kr = fileport_makeport(
      fd.get(), base::apple::ScopedMachSendRight::Receiver(port).get());
  if (kr != KERN_SUCCESS) {
    MACH_LOG(ERROR, kr) << "fileport_makeport";
    return {};
  }
  return PlatformHandle(std::move(port));
}

base::ScopedFD RecoverFDFromTransmissible(PlatformHandle handle) {
  if (!handle.is_mach_send()) {
    return {};
  }
  return base::ScopedFD(fileport_makefd(handle.GetMachSendRight().get()));
}
#endif

}  // namespace

WrappedPlatformHandle::WrappedPlatformHandle() = default;

WrappedPlatformHandle::WrappedPlatformHandle(PlatformHandle handle)
    : handle_(std::move(handle)) {}

WrappedPlatformHandle::~WrappedPlatformHandle() = default;

void WrappedPlatformHandle::Close() {
  handle_.reset();
}

bool WrappedPlatformHandle::IsSerializable() const {
  return true;
}

bool WrappedPlatformHandle::GetSerializedDimensions(Transport& transmitter,
                                                    size_t& num_bytes,
                                                    size_t& num_handles) {
  DCHECK(handle_.is_valid());
  num_bytes = sizeof(WrappedPlatformHandleHeader);
  num_handles = 1;
  return true;
}

bool WrappedPlatformHandle::Serialize(Transport& transmitter,
                                      base::span<uint8_t> data,
                                      base::span<PlatformHandle> handles) {
  DCHECK(handle_.is_valid());
  DCHECK_EQ(sizeof(WrappedPlatformHandleHeader), data.size());
  DCHECK_EQ(1u, handles.size());

  PlatformHandle handle = std::move(handle_);
  WrapperType type = WrapperType::kTransmissible;

#if BUILDFLAG(IS_FUCHSIA) || BUILDFLAG(IS_APPLE)
  if (handle.is_fd()) {
    type = WrapperType::kIndirectFileDescriptor;
    handle = MakeFDTransmissible(handle.TakeFD());
  }
#endif

  auto& header = *reinterpret_cast<WrappedPlatformHandleHeader*>(data.data());
  header.size = sizeof(header);
  header.type = type;
  handles[0] = std::move(handle);
  return true;
}

// static
scoped_refptr<WrappedPlatformHandle> WrappedPlatformHandle::Deserialize(
    base::span<const uint8_t> data,
    base::span<PlatformHandle> handles) {
  if (data.size() < sizeof(WrappedPlatformHandleHeader) ||
      handles.size() != 1) {
    return nullptr;
  }

  const auto& header =
      *reinterpret_cast<const WrappedPlatformHandleHeader*>(data.data());
  const size_t header_size = header.size;
  if (header_size < sizeof(header) || header_size % 8 != 0) {
    return nullptr;
  }
  if (!ValidateEnum(header.type)) {
    return nullptr;
  }

  PlatformHandle handle = std::move(handles[0]);
  switch (header.type) {
    case WrapperType::kTransmissible:
      break;

#if BUILDFLAG(IS_FUCHSIA) || BUILDFLAG(IS_APPLE)
    case WrapperType::kIndirectFileDescriptor:
      handle = PlatformHandle(RecoverFDFromTransmissible(std::move(handle)));
      break;
#endif

    default:
      // Validated at head of function.
      NOTREACHED();
  }

  if (!handle.is_valid()) {
    return nullptr;
  }

  return base::MakeRefCounted<WrappedPlatformHandle>(std::move(handle));
}

}  // namespace mojo::core::ipcz_driver