source: libcfa/src/concurrency/io.cfa @ 059ad16

enumforall-pointer-decaypthread-emulation
Last change on this file since 059ad16 was 059ad16, checked in by Thierry Delisle <tdelisle@…>, 9 months ago

Flush now supports blocking until at least one I/O op terminates.

  • Property mode set to 100644
File size: 15.2 KB
Line 
1//
2// Cforall Version 1.0.0 Copyright (C) 2020 University of Waterloo
3//
4// The contents of this file are covered under the licence agreement in the
5// file "LICENCE" distributed with Cforall.
6//
7// io.cfa --
8//
9// Author           : Thierry Delisle
10// Created On       : Thu Apr 23 17:31:00 2020
11// Last Modified By :
12// Last Modified On :
13// Update Count     :
14//
15
16#define __cforall_thread__
17#define _GNU_SOURCE
18
19#if defined(__CFA_DEBUG__)
20        // #define __CFA_DEBUG_PRINT_IO__
21        // #define __CFA_DEBUG_PRINT_IO_CORE__
22#endif
23
24
25#if defined(CFA_HAVE_LINUX_IO_URING_H)
26        #include <errno.h>
27        #include <signal.h>
28        #include <stdint.h>
29        #include <string.h>
30        #include <unistd.h>
31
32        extern "C" {
33                #include <sys/syscall.h>
34                #include <sys/eventfd.h>
35
36                #include <linux/io_uring.h>
37        }
38
39        #include "stats.hfa"
40        #include "kernel.hfa"
41        #include "kernel/fwd.hfa"
42        #include "kernel_private.hfa"
43        #include "io/types.hfa"
44
45        __attribute__((unused)) static const char * opcodes[] = {
46                "OP_NOP",
47                "OP_READV",
48                "OP_WRITEV",
49                "OP_FSYNC",
50                "OP_READ_FIXED",
51                "OP_WRITE_FIXED",
52                "OP_POLL_ADD",
53                "OP_POLL_REMOVE",
54                "OP_SYNC_FILE_RANGE",
55                "OP_SENDMSG",
56                "OP_RECVMSG",
57                "OP_TIMEOUT",
58                "OP_TIMEOUT_REMOVE",
59                "OP_ACCEPT",
60                "OP_ASYNC_CANCEL",
61                "OP_LINK_TIMEOUT",
62                "OP_CONNECT",
63                "OP_FALLOCATE",
64                "OP_OPENAT",
65                "OP_CLOSE",
66                "OP_FILES_UPDATE",
67                "OP_STATX",
68                "OP_READ",
69                "OP_WRITE",
70                "OP_FADVISE",
71                "OP_MADVISE",
72                "OP_SEND",
73                "OP_RECV",
74                "OP_OPENAT2",
75                "OP_EPOLL_CTL",
76                "OP_SPLICE",
77                "OP_PROVIDE_BUFFERS",
78                "OP_REMOVE_BUFFERS",
79                "OP_TEE",
80                "INVALID_OP"
81        };
82
83        static $io_context * __ioarbiter_allocate( $io_arbiter & this, __u32 idxs[], __u32 want );
84        static void __ioarbiter_submit( $io_context * , __u32 idxs[], __u32 have, bool lazy );
85        static void __ioarbiter_flush ( $io_context & );
86        static inline void __ioarbiter_notify( $io_context & ctx );
87//=============================================================================================
88// I/O Polling
89//=============================================================================================
90        static inline unsigned __flush( struct $io_context & );
91        static inline __u32 __release_sqes( struct $io_context & );
92        extern void __kernel_unpark( thread$ * thrd, unpark_hint );
93
94        bool __cfa_io_drain( processor * proc ) {
95                /* paranoid */ verify( ! __preemption_enabled() );
96                /* paranoid */ verify( ready_schedule_islocked() );
97                /* paranoid */ verify( proc );
98                /* paranoid */ verify( proc->io.ctx );
99
100                // Drain the queue
101                $io_context * ctx = proc->io.ctx;
102                unsigned head = *ctx->cq.head;
103                unsigned tail = *ctx->cq.tail;
104                const __u32 mask = *ctx->cq.mask;
105
106                __u32 count = tail - head;
107                __STATS__( false, io.calls.drain++; io.calls.completed += count; )
108
109                if(count == 0) return false;
110
111                for(i; count) {
112                        unsigned idx = (head + i) & mask;
113                        volatile struct io_uring_cqe & cqe = ctx->cq.cqes[idx];
114
115                        /* paranoid */ verify(&cqe);
116
117                        struct io_future_t * future = (struct io_future_t *)(uintptr_t)cqe.user_data;
118                        __cfadbg_print_safe( io, "Kernel I/O : Syscall completed : cqe %p, result %d for %p\n", &cqe, cqe.res, future );
119
120                        __kernel_unpark( fulfil( *future, cqe.res, false ), UNPARK_LOCAL );
121                }
122
123                __cfadbg_print_safe(io, "Kernel I/O : %u completed\n", count);
124
125                // Mark to the kernel that the cqe has been seen
126                // Ensure that the kernel only sees the new value of the head index after the CQEs have been read.
127                __atomic_store_n( ctx->cq.head, head + count, __ATOMIC_SEQ_CST );
128
129                /* paranoid */ verify( ready_schedule_islocked() );
130                /* paranoid */ verify( ! __preemption_enabled() );
131
132                return true;
133        }
134
135        bool __cfa_io_flush( processor * proc, bool wait ) {
136                /* paranoid */ verify( ! __preemption_enabled() );
137                /* paranoid */ verify( proc );
138                /* paranoid */ verify( proc->io.ctx );
139
140                __attribute__((unused)) cluster * cltr = proc->cltr;
141                $io_context & ctx = *proc->io.ctx;
142
143                __ioarbiter_flush( ctx );
144
145                __STATS__( true, io.calls.flush++; )
146                int ret = syscall( __NR_io_uring_enter, ctx.fd, ctx.sq.to_submit, wait ? 1 : 0, 0, (sigset_t *)0p, _NSIG / 8);
147                if( ret < 0 ) {
148                        switch((int)errno) {
149                        case EAGAIN:
150                        case EINTR:
151                        case EBUSY:
152                                // Update statistics
153                                __STATS__( false, io.calls.errors.busy ++; )
154                                return false;
155                        default:
156                                abort( "KERNEL ERROR: IO_URING SYSCALL - (%d) %s\n", (int)errno, strerror(errno) );
157                        }
158                }
159
160                __cfadbg_print_safe(io, "Kernel I/O : %u submitted to io_uring %d\n", ret, ctx.fd);
161                __STATS__( true, io.calls.submitted += ret; )
162                /* paranoid */ verify( ctx.sq.to_submit <= *ctx.sq.num );
163                /* paranoid */ verify( ctx.sq.to_submit >= ret );
164
165                ctx.sq.to_submit -= ret;
166
167                /* paranoid */ verify( ctx.sq.to_submit <= *ctx.sq.num );
168
169                // Release the consumed SQEs
170                __release_sqes( ctx );
171
172                /* paranoid */ verify( ! __preemption_enabled() );
173
174                ctx.proc->io.pending = false;
175
176                return __cfa_io_drain( proc );
177        }
178
179//=============================================================================================
180// I/O Submissions
181//=============================================================================================
182
183// Submition steps :
184// 1 - Allocate a queue entry. The ring already has memory for all entries but only the ones
185//     listed in sq.array are visible by the kernel. For those not listed, the kernel does not
186//     offer any assurance that an entry is not being filled by multiple flags. Therefore, we
187//     need to write an allocator that allows allocating concurrently.
188//
189// 2 - Actually fill the submit entry, this is the only simple and straightforward step.
190//
191// 3 - Append the entry index to the array and adjust the tail accordingly. This operation
192//     needs to arrive to two concensus at the same time:
193//     A - The order in which entries are listed in the array: no two threads must pick the
194//         same index for their entries
195//     B - When can the tail be update for the kernel. EVERY entries in the array between
196//         head and tail must be fully filled and shouldn't ever be touched again.
197//
198        //=============================================================================================
199        // Allocation
200        // for user's convenience fill the sqes from the indexes
201        static inline void __fill(struct io_uring_sqe * out_sqes[], __u32 want, __u32 idxs[], struct $io_context * ctx)  {
202                struct io_uring_sqe * sqes = ctx->sq.sqes;
203                for(i; want) {
204                        __cfadbg_print_safe(io, "Kernel I/O : filling loop\n");
205                        out_sqes[i] = &sqes[idxs[i]];
206                }
207        }
208
209        // Try to directly allocate from the a given context
210        // Not thread-safe
211        static inline bool __alloc(struct $io_context * ctx, __u32 idxs[], __u32 want) {
212                __sub_ring_t & sq = ctx->sq;
213                const __u32 mask  = *sq.mask;
214                __u32 fhead = sq.free_ring.head;    // get the current head of the queue
215                __u32 ftail = sq.free_ring.tail;    // get the current tail of the queue
216
217                // If we don't have enough sqes, fail
218                if((ftail - fhead) < want) { return false; }
219
220                // copy all the indexes we want from the available list
221                for(i; want) {
222                        __cfadbg_print_safe(io, "Kernel I/O : allocating loop\n");
223                        idxs[i] = sq.free_ring.array[(fhead + i) & mask];
224                }
225
226                // Advance the head to mark the indexes as consumed
227                __atomic_store_n(&sq.free_ring.head, fhead + want, __ATOMIC_RELEASE);
228
229                // return success
230                return true;
231        }
232
233        // Allocate an submit queue entry.
234        // The kernel cannot see these entries until they are submitted, but other threads must be
235        // able to see which entries can be used and which are already un used by an other thread
236        // for convenience, return both the index and the pointer to the sqe
237        // sqe == &sqes[idx]
238        struct $io_context * cfa_io_allocate(struct io_uring_sqe * sqes[], __u32 idxs[], __u32 want) {
239                __cfadbg_print_safe(io, "Kernel I/O : attempting to allocate %u\n", want);
240
241                disable_interrupts();
242                processor * proc = __cfaabi_tls.this_processor;
243                $io_context * ctx = proc->io.ctx;
244                /* paranoid */ verify( __cfaabi_tls.this_processor );
245                /* paranoid */ verify( ctx );
246
247                __cfadbg_print_safe(io, "Kernel I/O : attempting to fast allocation\n");
248
249                // We can proceed to the fast path
250                if( __alloc(ctx, idxs, want) ) {
251                        // Allocation was successful
252                        __STATS__( true, io.alloc.fast += 1; )
253                        enable_interrupts();
254
255                        __cfadbg_print_safe(io, "Kernel I/O : fast allocation successful from ring %d\n", ctx->fd);
256
257                        __fill( sqes, want, idxs, ctx );
258                        return ctx;
259                }
260                // The fast path failed, fallback
261                __STATS__( true, io.alloc.fail += 1; )
262
263                // Fast path failed, fallback on arbitration
264                __STATS__( true, io.alloc.slow += 1; )
265                enable_interrupts();
266
267                $io_arbiter * ioarb = proc->cltr->io.arbiter;
268                /* paranoid */ verify( ioarb );
269
270                __cfadbg_print_safe(io, "Kernel I/O : falling back on arbiter for allocation\n");
271
272                struct $io_context * ret = __ioarbiter_allocate(*ioarb, idxs, want);
273
274                __cfadbg_print_safe(io, "Kernel I/O : slow allocation completed from ring %d\n", ret->fd);
275
276                __fill( sqes, want, idxs,ret );
277                return ret;
278        }
279
280
281        //=============================================================================================
282        // submission
283        static inline void __submit( struct $io_context * ctx, __u32 idxs[], __u32 have, bool lazy) {
284                // We can proceed to the fast path
285                // Get the right objects
286                __sub_ring_t & sq = ctx->sq;
287                const __u32 mask  = *sq.mask;
288                __u32 tail = *sq.kring.tail;
289
290                // Add the sqes to the array
291                for( i; have ) {
292                        __cfadbg_print_safe(io, "Kernel I/O : __submit loop\n");
293                        sq.kring.array[ (tail + i) & mask ] = idxs[i];
294                }
295
296                // Make the sqes visible to the submitter
297                __atomic_store_n(sq.kring.tail, tail + have, __ATOMIC_RELEASE);
298                sq.to_submit += have;
299
300                ctx->proc->io.pending = true;
301                ctx->proc->io.dirty   = true;
302                if(sq.to_submit > 30 || !lazy) {
303                        ready_schedule_lock();
304                        __cfa_io_flush( ctx->proc, false );
305                        ready_schedule_unlock();
306                }
307        }
308
309        void cfa_io_submit( struct $io_context * inctx, __u32 idxs[], __u32 have, bool lazy ) __attribute__((nonnull (1))) {
310                __cfadbg_print_safe(io, "Kernel I/O : attempting to submit %u (%s)\n", have, lazy ? "lazy" : "eager");
311
312                disable_interrupts();
313                processor * proc = __cfaabi_tls.this_processor;
314                $io_context * ctx = proc->io.ctx;
315                /* paranoid */ verify( __cfaabi_tls.this_processor );
316                /* paranoid */ verify( ctx );
317
318                // Can we proceed to the fast path
319                if( ctx == inctx )              // We have the right instance?
320                {
321                        __submit(ctx, idxs, have, lazy);
322
323                        // Mark the instance as no longer in-use, re-enable interrupts and return
324                        __STATS__( true, io.submit.fast += 1; )
325                        enable_interrupts();
326
327                        __cfadbg_print_safe(io, "Kernel I/O : submitted on fast path\n");
328                        return;
329                }
330
331                // Fast path failed, fallback on arbitration
332                __STATS__( true, io.submit.slow += 1; )
333                enable_interrupts();
334
335                __cfadbg_print_safe(io, "Kernel I/O : falling back on arbiter for submission\n");
336
337                __ioarbiter_submit(inctx, idxs, have, lazy);
338        }
339
340        //=============================================================================================
341        // Flushing
342        // Go through the ring's submit queue and release everything that has already been consumed
343        // by io_uring
344        // This cannot be done by multiple threads
345        static __u32 __release_sqes( struct $io_context & ctx ) {
346                const __u32 mask = *ctx.sq.mask;
347
348                __attribute__((unused))
349                __u32 ctail = *ctx.sq.kring.tail;    // get the current tail of the queue
350                __u32 chead = *ctx.sq.kring.head;        // get the current head of the queue
351                __u32 phead = ctx.sq.kring.released; // get the head the last time we were here
352
353                __u32 ftail = ctx.sq.free_ring.tail;  // get the current tail of the queue
354
355                // the 3 fields are organized like this diagram
356                // except it's are ring
357                // ---+--------+--------+----
358                // ---+--------+--------+----
359                //    ^        ^        ^
360                // phead    chead    ctail
361
362                // make sure ctail doesn't wrap around and reach phead
363                /* paranoid */ verify(
364                           (ctail >= chead && chead >= phead)
365                        || (chead >= phead && phead >= ctail)
366                        || (phead >= ctail && ctail >= chead)
367                );
368
369                // find the range we need to clear
370                __u32 count = chead - phead;
371
372                if(count == 0) {
373                        return 0;
374                }
375
376                // We acquired an previous-head/current-head range
377                // go through the range and release the sqes
378                for( i; count ) {
379                        __cfadbg_print_safe(io, "Kernel I/O : release loop\n");
380                        __u32 idx = ctx.sq.kring.array[ (phead + i) & mask ];
381                        ctx.sq.free_ring.array[ (ftail + i) & mask ] = idx;
382                }
383
384                ctx.sq.kring.released = chead;          // note up to were we processed
385                __atomic_store_n(&ctx.sq.free_ring.tail, ftail + count, __ATOMIC_SEQ_CST);
386
387                __ioarbiter_notify(ctx);
388
389                return count;
390        }
391
392//=============================================================================================
393// I/O Arbiter
394//=============================================================================================
395        static inline void block(__outstanding_io_queue & queue, __outstanding_io & item) {
396                // Lock the list, it's not thread safe
397                lock( queue.lock __cfaabi_dbg_ctx2 );
398                {
399                        // Add our request to the list
400                        add( queue.queue, item );
401
402                        // Mark as pending
403                        __atomic_store_n( &queue.empty, false, __ATOMIC_SEQ_CST );
404                }
405                unlock( queue.lock );
406
407                wait( item.sem );
408        }
409
410        static inline bool empty(__outstanding_io_queue & queue ) {
411                return __atomic_load_n( &queue.empty, __ATOMIC_SEQ_CST);
412        }
413
414        static $io_context * __ioarbiter_allocate( $io_arbiter & this, __u32 idxs[], __u32 want ) {
415                __cfadbg_print_safe(io, "Kernel I/O : arbiter allocating\n");
416
417                __STATS__( false, io.alloc.block += 1; )
418
419                // No one has any resources left, wait for something to finish
420                // We need to add ourself to a list of pending allocs and wait for an answer
421                __pending_alloc pa;
422                pa.idxs = idxs;
423                pa.want = want;
424
425                block(this.pending, (__outstanding_io&)pa);
426
427                return pa.ctx;
428
429        }
430
431        static void __ioarbiter_notify( $io_arbiter & this, $io_context * ctx ) {
432                /* paranoid */ verify( !empty(this.pending.queue) );
433
434                lock( this.pending.lock __cfaabi_dbg_ctx2 );
435                {
436                        while( !empty(this.pending.queue) ) {
437                                __cfadbg_print_safe(io, "Kernel I/O : notifying\n");
438                                __u32 have = ctx->sq.free_ring.tail - ctx->sq.free_ring.head;
439                                __pending_alloc & pa = (__pending_alloc&)head( this.pending.queue );
440
441                                if( have > pa.want ) goto DONE;
442                                drop( this.pending.queue );
443
444                                /* paranoid */__attribute__((unused)) bool ret =
445
446                                __alloc(ctx, pa.idxs, pa.want);
447
448                                /* paranoid */ verify( ret );
449
450                                pa.ctx = ctx;
451
452                                post( pa.sem );
453                        }
454
455                        this.pending.empty = true;
456                        DONE:;
457                }
458                unlock( this.pending.lock );
459        }
460
461        static void __ioarbiter_notify( $io_context & ctx ) {
462                if(!empty( ctx.arbiter->pending )) {
463                        __ioarbiter_notify( *ctx.arbiter, &ctx );
464                }
465        }
466
467        // Simply append to the pending
468        static void __ioarbiter_submit( $io_context * ctx, __u32 idxs[], __u32 have, bool lazy ) {
469                __cfadbg_print_safe(io, "Kernel I/O : submitting %u from the arbiter to context %u\n", have, ctx->fd);
470
471                __cfadbg_print_safe(io, "Kernel I/O : waiting to submit %u\n", have);
472
473                __external_io ei;
474                ei.idxs = idxs;
475                ei.have = have;
476                ei.lazy = lazy;
477
478                block(ctx->ext_sq, (__outstanding_io&)ei);
479
480                __cfadbg_print_safe(io, "Kernel I/O : %u submitted from arbiter\n", have);
481        }
482
483        static void __ioarbiter_flush( $io_context & ctx ) {
484                if(!empty( ctx.ext_sq )) {
485                        __STATS__( false, io.flush.external += 1; )
486
487                        __cfadbg_print_safe(io, "Kernel I/O : arbiter flushing\n");
488
489                        lock( ctx.ext_sq.lock __cfaabi_dbg_ctx2 );
490                        {
491                                while( !empty(ctx.ext_sq.queue) ) {
492                                        __external_io & ei = (__external_io&)drop( ctx.ext_sq.queue );
493
494                                        __submit(&ctx, ei.idxs, ei.have, ei.lazy);
495
496                                        post( ei.sem );
497                                }
498
499                                ctx.ext_sq.empty = true;
500                        }
501                        unlock(ctx.ext_sq.lock );
502                }
503        }
504#endif
Note: See TracBrowser for help on using the repository browser.