Adriana Kobylak | 1bfbe0e | 2019-01-17 12:08:38 -0600 | [diff] [blame] | 1 | #pragma once |
| 2 | |
Ed Tanous | 3ccb3ad | 2023-01-13 17:40:03 -0800 | [diff] [blame] | 3 | #include "app.hpp" |
Ed Tanous | faf100f | 2023-05-25 10:03:14 -0700 | [diff] [blame] | 4 | #include "websocket.hpp" |
Ed Tanous | 3ccb3ad | 2023-01-13 17:40:03 -0800 | [diff] [blame] | 5 | |
Adriana Kobylak | 1bfbe0e | 2019-01-17 12:08:38 -0600 | [diff] [blame] | 6 | #include <boost/beast/core/flat_static_buffer.hpp> |
Ed Tanous | 5edbe94 | 2021-10-09 14:49:05 -0700 | [diff] [blame] | 7 | #include <boost/process/async_pipe.hpp> |
| 8 | #include <boost/process/child.hpp> |
| 9 | #include <boost/process/io.hpp> |
Adriana Kobylak | 1bfbe0e | 2019-01-17 12:08:38 -0600 | [diff] [blame] | 10 | |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 11 | #include <csignal> |
| 12 | |
Adriana Kobylak | 1bfbe0e | 2019-01-17 12:08:38 -0600 | [diff] [blame] | 13 | namespace crow |
| 14 | { |
| 15 | namespace obmc_vm |
| 16 | { |
| 17 | |
Ed Tanous | cf9e417 | 2022-12-21 09:30:16 -0800 | [diff] [blame] | 18 | // NOLINTNEXTLINE(cppcoreguidelines-avoid-non-const-global-variables) |
Adriana Kobylak | 1bfbe0e | 2019-01-17 12:08:38 -0600 | [diff] [blame] | 19 | static crow::websocket::Connection* session = nullptr; |
| 20 | |
| 21 | // The max network block device buffer size is 128kb plus 16bytes |
| 22 | // for the message header: |
| 23 | // https://github.com/NetworkBlockDevice/nbd/blob/master/doc/proto.md#simple-reply-message |
Troy Lee | 4ee8f0b | 2021-08-02 11:08:26 +0800 | [diff] [blame] | 24 | static constexpr auto nbdBufferSize = (128 * 1024 + 16) * 4; |
Adriana Kobylak | 1bfbe0e | 2019-01-17 12:08:38 -0600 | [diff] [blame] | 25 | |
| 26 | class Handler : public std::enable_shared_from_this<Handler> |
| 27 | { |
| 28 | public: |
Ed Tanous | 271584a | 2019-07-09 16:24:22 -0700 | [diff] [blame] | 29 | Handler(const std::string& mediaIn, boost::asio::io_context& ios) : |
Ed Tanous | f5b191a | 2022-02-15 11:30:39 -0800 | [diff] [blame] | 30 | pipeOut(ios), pipeIn(ios), media(mediaIn), |
Adriana Kobylak | 1bfbe0e | 2019-01-17 12:08:38 -0600 | [diff] [blame] | 31 | outputBuffer(new boost::beast::flat_static_buffer<nbdBufferSize>), |
| 32 | inputBuffer(new boost::beast::flat_static_buffer<nbdBufferSize>) |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 33 | {} |
Adriana Kobylak | 1bfbe0e | 2019-01-17 12:08:38 -0600 | [diff] [blame] | 34 | |
Ed Tanous | 0c0084a | 2019-10-24 15:57:51 -0700 | [diff] [blame] | 35 | ~Handler() = default; |
Adriana Kobylak | 1bfbe0e | 2019-01-17 12:08:38 -0600 | [diff] [blame] | 36 | |
Ed Tanous | ecd6a3a | 2022-01-07 09:18:40 -0800 | [diff] [blame] | 37 | Handler(const Handler&) = delete; |
| 38 | Handler(Handler&&) = delete; |
| 39 | Handler& operator=(const Handler&) = delete; |
| 40 | Handler& operator=(Handler&&) = delete; |
| 41 | |
Adriana Kobylak | 1bfbe0e | 2019-01-17 12:08:38 -0600 | [diff] [blame] | 42 | void doClose() |
| 43 | { |
| 44 | // boost::process::child::terminate uses SIGKILL, need to send SIGTERM |
| 45 | // to allow the proxy to stop nbd-client and the USB device gadget. |
| 46 | int rc = kill(proxy.id(), SIGTERM); |
Ed Tanous | e662eae | 2022-01-25 10:39:19 -0800 | [diff] [blame] | 47 | if (rc != 0) |
Adriana Kobylak | 1bfbe0e | 2019-01-17 12:08:38 -0600 | [diff] [blame] | 48 | { |
Ed Tanous | 62598e3 | 2023-07-17 17:06:25 -0700 | [diff] [blame] | 49 | BMCWEB_LOG_ERROR("Failed to terminate nbd-proxy: {}", errno); |
Adriana Kobylak | 1bfbe0e | 2019-01-17 12:08:38 -0600 | [diff] [blame] | 50 | return; |
| 51 | } |
Troy Lee | 36ecbf3 | 2021-08-17 18:15:28 +0800 | [diff] [blame] | 52 | |
Adriana Kobylak | 1bfbe0e | 2019-01-17 12:08:38 -0600 | [diff] [blame] | 53 | proxy.wait(); |
| 54 | } |
| 55 | |
| 56 | void connect() |
| 57 | { |
| 58 | std::error_code ec; |
Troy Lee | e1bf8bb | 2023-09-08 11:49:58 +0800 | [diff] [blame^] | 59 | proxy = boost::process::child("/usr/bin/nbd-proxy", media, |
Adriana Kobylak | 1bfbe0e | 2019-01-17 12:08:38 -0600 | [diff] [blame] | 60 | boost::process::std_out > pipeOut, |
| 61 | boost::process::std_in < pipeIn, ec); |
| 62 | if (ec) |
| 63 | { |
Ed Tanous | 62598e3 | 2023-07-17 17:06:25 -0700 | [diff] [blame] | 64 | BMCWEB_LOG_ERROR("Couldn't connect to nbd-proxy: {}", ec.message()); |
Adriana Kobylak | 1bfbe0e | 2019-01-17 12:08:38 -0600 | [diff] [blame] | 65 | if (session != nullptr) |
| 66 | { |
| 67 | session->close("Error connecting to nbd-proxy"); |
| 68 | } |
| 69 | return; |
| 70 | } |
| 71 | doWrite(); |
| 72 | doRead(); |
| 73 | } |
| 74 | |
| 75 | void doWrite() |
| 76 | { |
| 77 | if (doingWrite) |
| 78 | { |
Ed Tanous | 62598e3 | 2023-07-17 17:06:25 -0700 | [diff] [blame] | 79 | BMCWEB_LOG_DEBUG("Already writing. Bailing out"); |
Adriana Kobylak | 1bfbe0e | 2019-01-17 12:08:38 -0600 | [diff] [blame] | 80 | return; |
| 81 | } |
| 82 | |
| 83 | if (inputBuffer->size() == 0) |
| 84 | { |
Ed Tanous | 62598e3 | 2023-07-17 17:06:25 -0700 | [diff] [blame] | 85 | BMCWEB_LOG_DEBUG("inputBuffer empty. Bailing out"); |
Adriana Kobylak | 1bfbe0e | 2019-01-17 12:08:38 -0600 | [diff] [blame] | 86 | return; |
| 87 | } |
| 88 | |
| 89 | doingWrite = true; |
| 90 | pipeIn.async_write_some( |
| 91 | inputBuffer->data(), |
Ed Tanous | 81c4e33 | 2023-05-18 10:30:34 -0700 | [diff] [blame] | 92 | [this, self(shared_from_this())](const boost::beast::error_code& ec, |
Adriana Kobylak | 1bfbe0e | 2019-01-17 12:08:38 -0600 | [diff] [blame] | 93 | std::size_t bytesWritten) { |
Ed Tanous | 62598e3 | 2023-07-17 17:06:25 -0700 | [diff] [blame] | 94 | BMCWEB_LOG_DEBUG("Wrote {}bytes", bytesWritten); |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 95 | doingWrite = false; |
| 96 | inputBuffer->consume(bytesWritten); |
Adriana Kobylak | 1bfbe0e | 2019-01-17 12:08:38 -0600 | [diff] [blame] | 97 | |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 98 | if (session == nullptr) |
| 99 | { |
| 100 | return; |
| 101 | } |
| 102 | if (ec == boost::asio::error::eof) |
| 103 | { |
| 104 | session->close("VM socket port closed"); |
| 105 | return; |
| 106 | } |
| 107 | if (ec) |
| 108 | { |
| 109 | session->close("Error in writing to proxy port"); |
Ed Tanous | 62598e3 | 2023-07-17 17:06:25 -0700 | [diff] [blame] | 110 | BMCWEB_LOG_ERROR("Error in VM socket write {}", ec); |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 111 | return; |
| 112 | } |
| 113 | doWrite(); |
Adriana Kobylak | 1bfbe0e | 2019-01-17 12:08:38 -0600 | [diff] [blame] | 114 | }); |
| 115 | } |
| 116 | |
| 117 | void doRead() |
| 118 | { |
| 119 | std::size_t bytes = outputBuffer->capacity() - outputBuffer->size(); |
| 120 | |
| 121 | pipeOut.async_read_some( |
| 122 | outputBuffer->prepare(bytes), |
| 123 | [this, self(shared_from_this())]( |
| 124 | const boost::system::error_code& ec, std::size_t bytesRead) { |
Ed Tanous | 62598e3 | 2023-07-17 17:06:25 -0700 | [diff] [blame] | 125 | BMCWEB_LOG_DEBUG("Read done. Read {} bytes", bytesRead); |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 126 | if (ec) |
| 127 | { |
Ed Tanous | 62598e3 | 2023-07-17 17:06:25 -0700 | [diff] [blame] | 128 | BMCWEB_LOG_ERROR("Couldn't read from VM port: {}", ec); |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 129 | if (session != nullptr) |
Adriana Kobylak | 1bfbe0e | 2019-01-17 12:08:38 -0600 | [diff] [blame] | 130 | { |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 131 | session->close("Error in connecting to VM port"); |
Adriana Kobylak | 1bfbe0e | 2019-01-17 12:08:38 -0600 | [diff] [blame] | 132 | } |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 133 | return; |
| 134 | } |
| 135 | if (session == nullptr) |
| 136 | { |
| 137 | return; |
| 138 | } |
Adriana Kobylak | 1bfbe0e | 2019-01-17 12:08:38 -0600 | [diff] [blame] | 139 | |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 140 | outputBuffer->commit(bytesRead); |
| 141 | std::string_view payload( |
| 142 | static_cast<const char*>(outputBuffer->data().data()), |
| 143 | bytesRead); |
| 144 | session->sendBinary(payload); |
| 145 | outputBuffer->consume(bytesRead); |
Adriana Kobylak | 1bfbe0e | 2019-01-17 12:08:38 -0600 | [diff] [blame] | 146 | |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 147 | doRead(); |
Adriana Kobylak | 1bfbe0e | 2019-01-17 12:08:38 -0600 | [diff] [blame] | 148 | }); |
| 149 | } |
| 150 | |
| 151 | boost::process::async_pipe pipeOut; |
| 152 | boost::process::async_pipe pipeIn; |
| 153 | boost::process::child proxy; |
| 154 | std::string media; |
Ed Tanous | f5b191a | 2022-02-15 11:30:39 -0800 | [diff] [blame] | 155 | bool doingWrite{false}; |
Adriana Kobylak | 1bfbe0e | 2019-01-17 12:08:38 -0600 | [diff] [blame] | 156 | |
| 157 | std::unique_ptr<boost::beast::flat_static_buffer<nbdBufferSize>> |
| 158 | outputBuffer; |
| 159 | std::unique_ptr<boost::beast::flat_static_buffer<nbdBufferSize>> |
| 160 | inputBuffer; |
| 161 | }; |
| 162 | |
Ed Tanous | cf9e417 | 2022-12-21 09:30:16 -0800 | [diff] [blame] | 163 | // NOLINTNEXTLINE(cppcoreguidelines-avoid-non-const-global-variables) |
Adriana Kobylak | 1bfbe0e | 2019-01-17 12:08:38 -0600 | [diff] [blame] | 164 | static std::shared_ptr<Handler> handler; |
| 165 | |
Ed Tanous | 23a21a1 | 2020-07-25 04:45:05 +0000 | [diff] [blame] | 166 | inline void requestRoutes(App& app) |
Adriana Kobylak | 1bfbe0e | 2019-01-17 12:08:38 -0600 | [diff] [blame] | 167 | { |
| 168 | BMCWEB_ROUTE(app, "/vm/0/0") |
Ed Tanous | 432a890 | 2021-06-14 15:28:56 -0700 | [diff] [blame] | 169 | .privileges({{"ConfigureComponents", "ConfigureManager"}}) |
Adriana Kobylak | 1bfbe0e | 2019-01-17 12:08:38 -0600 | [diff] [blame] | 170 | .websocket() |
zhanghch05 | 7772638 | 2021-10-21 14:07:57 +0800 | [diff] [blame] | 171 | .onopen([](crow::websocket::Connection& conn) { |
Ed Tanous | 62598e3 | 2023-07-17 17:06:25 -0700 | [diff] [blame] | 172 | BMCWEB_LOG_DEBUG("Connection {} opened", logPtr(&conn)); |
Adriana Kobylak | 1bfbe0e | 2019-01-17 12:08:38 -0600 | [diff] [blame] | 173 | |
| 174 | if (session != nullptr) |
| 175 | { |
| 176 | conn.close("Session already connected"); |
| 177 | return; |
| 178 | } |
| 179 | |
| 180 | if (handler != nullptr) |
| 181 | { |
| 182 | conn.close("Handler already running"); |
| 183 | return; |
| 184 | } |
| 185 | |
| 186 | session = &conn; |
| 187 | |
| 188 | // media is the last digit of the endpoint /vm/0/0. A future |
| 189 | // enhancement can include supporting different endpoint values. |
| 190 | const char* media = "0"; |
Ed Tanous | 2c70f80 | 2020-09-28 14:29:23 -0700 | [diff] [blame] | 191 | handler = std::make_shared<Handler>(media, conn.getIoContext()); |
Adriana Kobylak | 1bfbe0e | 2019-01-17 12:08:38 -0600 | [diff] [blame] | 192 | handler->connect(); |
| 193 | }) |
Ed Tanous | cb13a39 | 2020-07-25 19:02:03 +0000 | [diff] [blame] | 194 | .onclose([](crow::websocket::Connection& conn, |
| 195 | const std::string& /*reason*/) { |
| 196 | if (&conn != session) |
| 197 | { |
| 198 | return; |
| 199 | } |
| 200 | |
| 201 | session = nullptr; |
| 202 | handler->doClose(); |
| 203 | handler->inputBuffer->clear(); |
| 204 | handler->outputBuffer->clear(); |
| 205 | handler.reset(); |
| 206 | }) |
Adriana Kobylak | 1bfbe0e | 2019-01-17 12:08:38 -0600 | [diff] [blame] | 207 | .onmessage([](crow::websocket::Connection& conn, |
Ed Tanous | cb13a39 | 2020-07-25 19:02:03 +0000 | [diff] [blame] | 208 | const std::string& data, bool) { |
Troy Lee | 4ee8f0b | 2021-08-02 11:08:26 +0800 | [diff] [blame] | 209 | if (data.length() > |
| 210 | handler->inputBuffer->capacity() - handler->inputBuffer->size()) |
Adriana Kobylak | 1bfbe0e | 2019-01-17 12:08:38 -0600 | [diff] [blame] | 211 | { |
Ed Tanous | 62598e3 | 2023-07-17 17:06:25 -0700 | [diff] [blame] | 212 | BMCWEB_LOG_ERROR("Buffer overrun when writing {} bytes", |
| 213 | data.length()); |
Adriana Kobylak | 1bfbe0e | 2019-01-17 12:08:38 -0600 | [diff] [blame] | 214 | conn.close("Buffer overrun"); |
| 215 | return; |
| 216 | } |
| 217 | |
| 218 | boost::asio::buffer_copy(handler->inputBuffer->prepare(data.size()), |
| 219 | boost::asio::buffer(data)); |
| 220 | handler->inputBuffer->commit(data.size()); |
| 221 | handler->doWrite(); |
| 222 | }); |
| 223 | } |
| 224 | |
| 225 | } // namespace obmc_vm |
| 226 | } // namespace crow |