source: libcfa/src/concurrency/io.cfa @ 43784ac

jacob/cs343-translationnew-ast-unique-expr
Last change on this file since 43784ac was 43784ac, checked in by Thierry Delisle <tdelisle@…>, 4 months ago

Changed libcfathread to consistently define _GNU_SOURCE

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