warden.hpp

 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
#pragma once

#include <felspar/coro/start.hpp>
#include <felspar/coro/stream.hpp>
#include <felspar/io/completion.hpp>
#include <felspar/io/pipe.hpp>
#include <felspar/io/posix.hpp>
#include <felspar/memory/pmr.hpp>
#include <felspar/test/source.hpp>

#include <chrono>
#include <span>


namespace felspar::io {


    class allocator;


    class warden : public felspar::pmr::memory_resource {
        friend class allocator;
        template<typename R>
        friend class felspar::io::iop;

      public:
        virtual ~warden() = default;

        template<typename R>
        using task = coro::task<R, warden>;
        template<typename R>
        using stream = coro::stream<R, warden>;

        template<typename R = void>
        using eager = coro::eager<task<R>>;
        template<typename R = void>
        using starter = coro::starter<task<R>>;

        template<typename Ret, typename... PArgs, typename... MArgs>
        Ret run(task<Ret> (*f)(warden &, PArgs...), MArgs &&...margs) {
            auto handle = f(*this, std::forward<MArgs>(margs)...).release();
            run_until(handle.get());
            return handle.promise().consume_value();
        }
        template<typename Ret, typename N, typename... PArgs, typename... MArgs>
        Ret run(N &o,
                coro::task<Ret> (N::*f)(warden &, PArgs...),
                MArgs &&...margs) {
            auto task = (o.*f)(*this, std::forward<MArgs>(margs)...);
            auto handle = task.release();
            run_until(handle.get());
            return handle.promise().consume_value();
        }

Run a single IO submission and resume ready coroutines. Only processing is performed without any waits

57
        virtual void run_batch() = 0;

File descriptors

 
60
61
62
63
64
65
66
67
68
69
70
71
        iop<void>
                close(socket_descriptor fd,
                      felspar::source_location const &loc =
                              felspar::source_location::current()) {
            return do_close(fd, loc);
        }
        iop<void>
                close(posix::fd s,
                      felspar::source_location const &loc =
                              felspar::source_location::current()) {
            return close(s.release(), loc);
        }

Time management

 
74
75
76
77
78
79
        iop<void>
                sleep(std::chrono::nanoseconds ns,
                      felspar::source_location const &loc =
                              felspar::source_location::current()) {
            return do_sleep(ns, loc);
        }

Reading and writing

Read or write bytes from the provided buffer returning the number of bytes read/written.

 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
        iop<std::size_t> read_some(
                socket_descriptor fd,
                std::span<std::byte> s,
                std::optional<std::chrono::nanoseconds> timeout,
                felspar::source_location const &loc =
                        felspar::source_location::current()) {
            return do_read_some(fd, s, timeout, loc);
        }
        iop<std::size_t> read_some(
                posix::fd const &s,
                std::span<std::byte> b,
                std::optional<std::chrono::nanoseconds> timeout = {},
                felspar::source_location const &l =
                        felspar::source_location::current()) {
            return read_some(s.native_handle(), b, timeout, l);
        }
        iop<std::size_t> write_some(
                socket_descriptor fd,
                std::span<std::byte const> s,
                std::optional<std::chrono::nanoseconds> timeout = {},
                felspar::source_location const &loc =
                        felspar::source_location::current()) {
            return do_write_some(fd, s, timeout, loc);
        }
        iop<std::size_t> write_some(
                posix::fd const &s,
                std::span<std::byte const> b,
                std::optional<std::chrono::nanoseconds> timeout = {},
                felspar::source_location const &l =
                        felspar::source_location::current()) {
            return write_some(s.native_handle(), b, timeout, l);
        }

Socket APIs

Socket creation

Some wardens may need special socket options to be set, so in order to be portable across wardens use this API instead of the POSIX ::socket one.

127
128
129
130
131
132
        posix::fd create_socket(
                int domain,
                int type,
                int protocol,
                felspar::source_location const & =
                        felspar::source_location::current());

Pipe

Create a pipe usable by this warden. On Windows a true pipe will be simulated by a socket pair.

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
        pipe create_pipe(
                felspar::source_location const & =
                        felspar::source_location::current());


        iop<socket_descriptor>
                accept(socket_descriptor fd,
                       std::optional<std::chrono::nanoseconds> timeout = {},
                       felspar::source_location const &loc =
                               felspar::source_location::current()) {
            return do_accept(fd, timeout, loc);
        }
        iop<socket_descriptor>
                accept(posix::fd const &sock,
                       std::optional<std::chrono::nanoseconds> timeout = {},
                       felspar::source_location const &loc =
                               felspar::source_location::current()) {
            return accept(sock.native_handle(), timeout, loc);
        }
        iop<void>
                connect(socket_descriptor fd,
                        sockaddr const *addr,
                        socklen_t addrlen,
                        std::optional<std::chrono::nanoseconds> timeout = {},
                        felspar::source_location const &loc =
                                felspar::source_location::current()) {
            return do_connect(fd, addr, addrlen, timeout, loc);
        }
        iop<void>
                connect(posix::fd const &sock,
                        sockaddr const *addr,
                        socklen_t addrlen,
                        std::optional<std::chrono::nanoseconds> timeout = {},
                        felspar::source_location const &loc =
                                felspar::source_location::current()) {
            return connect(sock.native_handle(), addr, addrlen, timeout, loc);
        }

File readiness

 
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
        iop<void> read_ready(
                socket_descriptor fd,
                std::optional<std::chrono::nanoseconds> timeout = {},
                felspar::source_location const &loc =
                        felspar::source_location::current()) {
            return do_read_ready(fd, timeout, loc);
        }
        iop<void> read_ready(
                posix::fd const &sock,
                std::optional<std::chrono::nanoseconds> timeout = {},
                felspar::source_location const &loc =
                        felspar::source_location::current()) {
            return read_ready(sock.native_handle(), timeout, loc);
        }
        iop<void> write_ready(
                socket_descriptor fd,
                std::optional<std::chrono::nanoseconds> timeout = {},
                felspar::source_location const &loc =
                        felspar::source_location::current()) {
            return do_write_ready(fd, timeout, loc);
        }
        iop<void> write_ready(
                posix::fd const &sock,
                std::optional<std::chrono::nanoseconds> timeout = {},
                felspar::source_location const &loc =
                        felspar::source_location::current()) {
            return write_ready(sock.native_handle(), timeout, loc);
        }

      private:

PMR based memory allocation

 
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
        void *do_allocate(
                std::size_t const bytes, std::size_t const alignment) override {
            return felspar::pmr::new_delete_resource()->allocate(
                    bytes, alignment);
        }
        void do_deallocate(
                void *const p,
                std::size_t const bytes,
                std::size_t const alignment) override {
            return felspar::pmr::new_delete_resource()->deallocate(
                    p, bytes, alignment);
        }
        bool do_is_equal(memory_resource const &other) const noexcept override {
            return this == &other;
        }


      protected:
        virtual void run_until(felspar::coro::coroutine_handle<>) = 0;
        virtual iop<void> do_close(
                socket_descriptor fd, felspar::source_location const &) = 0;
        virtual iop<void> do_sleep(
                std::chrono::nanoseconds, felspar::source_location const &) = 0;
        virtual iop<std::size_t> do_read_some(
                socket_descriptor fd,
                std::span<std::byte>,
                std::optional<std::chrono::nanoseconds> timeout,
                felspar::source_location const &) = 0;
        virtual iop<std::size_t> do_write_some(
                socket_descriptor fd,
                std::span<std::byte const>,
                std::optional<std::chrono::nanoseconds> timeout,
                felspar::source_location const &) = 0;
        virtual void do_prepare_socket(
                socket_descriptor, felspar::source_location const &) {}
        virtual iop<socket_descriptor> do_accept(
                socket_descriptor fd,
                std::optional<std::chrono::nanoseconds> timeout,
                felspar::source_location const &) = 0;
        virtual iop<void> do_connect(
                socket_descriptor fd,
                sockaddr const *,
                socklen_t,
                std::optional<std::chrono::nanoseconds> timeout,
                felspar::source_location const &) = 0;
        virtual iop<void> do_read_ready(
                socket_descriptor fd,
                std::optional<std::chrono::nanoseconds> timeout,
                felspar::source_location const &) = 0;
        virtual iop<void> do_write_ready(
                socket_descriptor fd,
                std::optional<std::chrono::nanoseconds> timeout,
                felspar::source_location const &) = 0;
    };


    template<typename R>
    inline iop<R>::~iop() {
        if (comp and comp->delete_due_to_iop_destructed()) { delete comp; }
    }


}