source: libcfa/src/concurrency/io.cfa @ 11054eb

arm-ehjacob/cs343-translationnew-ast-unique-expr
Last change on this file since 11054eb was 11054eb, checked in by Thierry Delisle <tdelisle@…>, 7 months ago

Fix io to no longer use monitors since some usages aren't in threads

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