source: libcfa/src/concurrency/io/setup.cfa@ 33b7d49

ADT ast-experimental enum pthread-emulation qualifiedEnum
Last change on this file since 33b7d49 was bfb9bf5, checked in by Thierry Delisle <tdelisle@…>, 4 years ago

Fixed some warnings
  • Property mode set to 100644
File size: 12.4 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/setup.cfa --
8//
9// Author : Thierry Delisle
10// Created On : Fri Jul 31 16:25:51 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#include "io/types.hfa"
25#include "kernel.hfa"
26
27#if !defined(CFA_HAVE_LINUX_IO_URING_H)
28 void ?{}(io_context_params & this) {}
29
30 void ?{}($io_context & this, struct cluster & cl) {}
31 void ^?{}($io_context & this) {}
32
33 void __cfa_io_start( processor * proc ) {}
34 bool __cfa_io_flush( processor * proc, int ) { return false; }
35 void __cfa_io_stop ( processor * proc ) {}
36
37 $io_arbiter * create(void) { return 0p; }
38 void destroy($io_arbiter *) {}
39
40#else
41#pragma GCC diagnostic push
42#pragma GCC diagnostic ignored "-Waddress-of-packed-member"
43 #include <errno.h>
44 #include <stdint.h>
45 #include <string.h>
46 #include <signal.h>
47 #include <unistd.h>
48
49 extern "C" {
50 #include <pthread.h>
51 #include <sys/epoll.h>
52 #include <sys/eventfd.h>
53 #include <sys/mman.h>
54 #include <sys/syscall.h>
55
56 #include <linux/io_uring.h>
57 }
58
59 #include "bitmanip.hfa"
60 #include "fstream.hfa"
61 #include "kernel_private.hfa"
62 #include "thread.hfa"
63#pragma GCC diagnostic pop
64
65 void ?{}(io_context_params & this) {
66 this.num_entries = 256;
67 }
68
69 static void * __io_poller_slow( void * arg );
70
71 // Weirdly, some systems that do support io_uring don't actually define these
72 #ifdef __alpha__
73 /*
74 * alpha is the only exception, all other architectures
75 * have common numbers for new system calls.
76 */
77 #ifndef __NR_io_uring_setup
78 #define __NR_io_uring_setup 535
79 #endif
80 #ifndef __NR_io_uring_enter
81 #define __NR_io_uring_enter 536
82 #endif
83 #ifndef __NR_io_uring_register
84 #define __NR_io_uring_register 537
85 #endif
86 #else /* !__alpha__ */
87 #ifndef __NR_io_uring_setup
88 #define __NR_io_uring_setup 425
89 #endif
90 #ifndef __NR_io_uring_enter
91 #define __NR_io_uring_enter 426
92 #endif
93 #ifndef __NR_io_uring_register
94 #define __NR_io_uring_register 427
95 #endif
96 #endif
97
98//=============================================================================================
99// I/O Context Constrution/Destruction
100//=============================================================================================
101
102
103
104 static void __io_uring_setup ( $io_context & this, const io_context_params & params_in, int procfd );
105 static void __io_uring_teardown( $io_context & this );
106 static void __epoll_register($io_context & ctx);
107 static void __epoll_unregister($io_context & ctx);
108 void __ioarbiter_register( $io_arbiter & mutex, $io_context & ctx );
109 void __ioarbiter_unregister( $io_arbiter & mutex, $io_context & ctx );
110
111 void ?{}($io_context & this, processor * proc, struct cluster & cl) {
112 /* paranoid */ verify( cl.io.arbiter );
113 this.proc = proc;
114 this.arbiter = cl.io.arbiter;
115 this.ext_sq.empty = true;
116 (this.ext_sq.queue){};
117 __io_uring_setup( this, cl.io.params, proc->idle_fd );
118 __cfadbg_print_safe(io_core, "Kernel I/O : Created ring for io_context %u (%p)\n", this.fd, &this);
119 }
120
121 void ^?{}($io_context & this) {
122 __cfadbg_print_safe(io_core, "Kernel I/O : tearing down io_context %u\n", this.fd);
123
124 __io_uring_teardown( this );
125 __cfadbg_print_safe(io_core, "Kernel I/O : Destroyed ring for io_context %u\n", this.fd);
126 }
127
128 extern void __disable_interrupts_hard();
129 extern void __enable_interrupts_hard();
130
131 static void __io_uring_setup( $io_context & this, const io_context_params & params_in, int procfd ) {
132 // Step 1 : call to setup
133 struct io_uring_params params;
134 memset(&params, 0, sizeof(params));
135 // if( params_in.poll_submit ) params.flags |= IORING_SETUP_SQPOLL;
136 // if( params_in.poll_complete ) params.flags |= IORING_SETUP_IOPOLL;
137
138 __u32 nentries = params_in.num_entries != 0 ? params_in.num_entries : 256;
139 if( !is_pow2(nentries) ) {
140 abort("ERROR: I/O setup 'num_entries' must be a power of 2\n");
141 }
142
143 int fd = syscall(__NR_io_uring_setup, nentries, &params );
144 if(fd < 0) {
145 abort("KERNEL ERROR: IO_URING SETUP - %s\n", strerror(errno));
146 }
147
148 // Step 2 : mmap result
149 struct __sub_ring_t & sq = this.sq;
150 struct __cmp_ring_t & cq = this.cq;
151
152 // calculate the right ring size
153 sq.ring_sz = params.sq_off.array + (params.sq_entries * sizeof(unsigned) );
154 cq.ring_sz = params.cq_off.cqes + (params.cq_entries * sizeof(struct io_uring_cqe));
155
156 // Requires features
157 #if defined(IORING_FEAT_SINGLE_MMAP)
158 // adjust the size according to the parameters
159 if ((params.features & IORING_FEAT_SINGLE_MMAP) != 0) {
160 cq.ring_sz = sq.ring_sz = max(cq.ring_sz, sq.ring_sz);
161 }
162 #endif
163
164 // mmap the Submit Queue into existence
165 sq.ring_ptr = mmap(0, sq.ring_sz, PROT_READ | PROT_WRITE, MAP_SHARED | MAP_POPULATE, fd, IORING_OFF_SQ_RING);
166 if (sq.ring_ptr == (void*)MAP_FAILED) {
167 abort("KERNEL ERROR: IO_URING MMAP1 - %s\n", strerror(errno));
168 }
169
170 // Requires features
171 #if defined(IORING_FEAT_SINGLE_MMAP)
172 // mmap the Completion Queue into existence (may or may not be needed)
173 if ((params.features & IORING_FEAT_SINGLE_MMAP) != 0) {
174 cq.ring_ptr = sq.ring_ptr;
175 }
176 else
177 #endif
178 {
179 // We need multiple call to MMAP
180 cq.ring_ptr = mmap(0, cq.ring_sz, PROT_READ | PROT_WRITE, MAP_SHARED | MAP_POPULATE, fd, IORING_OFF_CQ_RING);
181 if (cq.ring_ptr == (void*)MAP_FAILED) {
182 munmap(sq.ring_ptr, sq.ring_sz);
183 abort("KERNEL ERROR: IO_URING MMAP2 - %s\n", strerror(errno));
184 }
185 }
186
187 // mmap the submit queue entries
188 size_t size = params.sq_entries * sizeof(struct io_uring_sqe);
189 sq.sqes = (struct io_uring_sqe *)mmap(0, size, PROT_READ | PROT_WRITE, MAP_SHARED | MAP_POPULATE, fd, IORING_OFF_SQES);
190 if (sq.sqes == (struct io_uring_sqe *)MAP_FAILED) {
191 munmap(sq.ring_ptr, sq.ring_sz);
192 if (cq.ring_ptr != sq.ring_ptr) munmap(cq.ring_ptr, cq.ring_sz);
193 abort("KERNEL ERROR: IO_URING MMAP3 - %s\n", strerror(errno));
194 }
195
196 // Step 3 : Initialize the data structure
197 // Get the pointers from the kernel to fill the structure
198 // submit queue
199 sq.kring.head = (volatile __u32 *)(((intptr_t)sq.ring_ptr) + params.sq_off.head);
200 sq.kring.tail = (volatile __u32 *)(((intptr_t)sq.ring_ptr) + params.sq_off.tail);
201 sq.kring.array = ( __u32 *)(((intptr_t)sq.ring_ptr) + params.sq_off.array);
202 sq.mask = ( const __u32 *)(((intptr_t)sq.ring_ptr) + params.sq_off.ring_mask);
203 sq.num = ( const __u32 *)(((intptr_t)sq.ring_ptr) + params.sq_off.ring_entries);
204 sq.flags = ( __u32 *)(((intptr_t)sq.ring_ptr) + params.sq_off.flags);
205 sq.dropped = ( __u32 *)(((intptr_t)sq.ring_ptr) + params.sq_off.dropped);
206
207 sq.kring.released = 0;
208
209 sq.free_ring.head = 0;
210 sq.free_ring.tail = *sq.num;
211 sq.free_ring.array = alloc( *sq.num, 128`align );
212 for(i; (__u32)*sq.num) {
213 sq.free_ring.array[i] = i;
214 }
215
216 sq.to_submit = 0;
217
218 // completion queue
219 cq.head = (volatile __u32 *)(((intptr_t)cq.ring_ptr) + params.cq_off.head);
220 cq.tail = (volatile __u32 *)(((intptr_t)cq.ring_ptr) + params.cq_off.tail);
221 cq.mask = ( const __u32 *)(((intptr_t)cq.ring_ptr) + params.cq_off.ring_mask);
222 cq.num = ( const __u32 *)(((intptr_t)cq.ring_ptr) + params.cq_off.ring_entries);
223 cq.overflow = ( __u32 *)(((intptr_t)cq.ring_ptr) + params.cq_off.overflow);
224 cq.cqes = (struct io_uring_cqe *)(((intptr_t)cq.ring_ptr) + params.cq_off.cqes);
225
226 #if !defined(CFA_WITH_IO_URING_IDLE)
227 // Step 4 : eventfd
228 // io_uring_register is so f*cking slow on some machine that it
229 // will never succeed if preemption isn't hard blocked
230 __cfadbg_print_safe(io_core, "Kernel I/O : registering %d for completion with ring %d\n", procfd, fd);
231
232 __disable_interrupts_hard();
233
234 int ret = syscall( __NR_io_uring_register, fd, IORING_REGISTER_EVENTFD, &procfd, 1);
235 if (ret < 0) {
236 abort("KERNEL ERROR: IO_URING EVENTFD REGISTER - %s\n", strerror(errno));
237 }
238
239 __enable_interrupts_hard();
240
241 __cfadbg_print_safe(io_core, "Kernel I/O : registered %d for completion with ring %d\n", procfd, fd);
242 #endif
243
244 // some paranoid checks
245 /* paranoid */ verifyf( (*cq.mask) == ((*cq.num) - 1ul32), "IO_URING Expected mask to be %u (%u entries), was %u", (*cq.num) - 1ul32, *cq.num, *cq.mask );
246 /* paranoid */ verifyf( (*cq.num) >= nentries, "IO_URING Expected %u entries, got %u", nentries, *cq.num );
247 /* paranoid */ verifyf( (*cq.head) == 0, "IO_URING Expected head to be 0, got %u", *cq.head );
248 /* paranoid */ verifyf( (*cq.tail) == 0, "IO_URING Expected tail to be 0, got %u", *cq.tail );
249
250 /* paranoid */ verifyf( (*sq.mask) == ((*sq.num) - 1ul32), "IO_URING Expected mask to be %u (%u entries), was %u", (*sq.num) - 1ul32, *sq.num, *sq.mask );
251 /* paranoid */ verifyf( (*sq.num) >= nentries, "IO_URING Expected %u entries, got %u", nentries, *sq.num );
252 /* paranoid */ verifyf( (*sq.kring.head) == 0, "IO_URING Expected head to be 0, got %u", *sq.kring.head );
253 /* paranoid */ verifyf( (*sq.kring.tail) == 0, "IO_URING Expected tail to be 0, got %u", *sq.kring.tail );
254
255 // Update the global ring info
256 this.ring_flags = 0;
257 this.fd = fd;
258 }
259
260 static void __io_uring_teardown( $io_context & this ) {
261 // Shutdown the io rings
262 struct __sub_ring_t & sq = this.sq;
263 struct __cmp_ring_t & cq = this.cq;
264 {
265 __u32 fhead = sq.free_ring.head;
266 __u32 ftail = sq.free_ring.tail;
267
268 __u32 total = *sq.num;
269 __u32 avail = ftail - fhead;
270
271 if(avail != total) abort | "Processor (" | (void*)this.proc | ") tearing down ring with" | (total - avail) | "entries allocated but not submitted, out of" | total;
272 }
273
274 // unmap the submit queue entries
275 munmap(sq.sqes, (*sq.num) * sizeof(struct io_uring_sqe));
276
277 // unmap the Submit Queue ring
278 munmap(sq.ring_ptr, sq.ring_sz);
279
280 // unmap the Completion Queue ring, if it is different
281 if (cq.ring_ptr != sq.ring_ptr) {
282 munmap(cq.ring_ptr, cq.ring_sz);
283 }
284
285 // close the file descriptor
286 close(this.fd);
287
288 free( this.sq.free_ring.array ); // Maybe null, doesn't matter
289 }
290
291 void __cfa_io_start( processor * proc ) {
292 proc->io.ctx = alloc();
293 (*proc->io.ctx){proc, *proc->cltr};
294 }
295 void __cfa_io_stop ( processor * proc ) {
296 ^(*proc->io.ctx){};
297 free(proc->io.ctx);
298 }
299
300//=============================================================================================
301// I/O Context Sleep
302//=============================================================================================
303 // static inline void __epoll_ctl($io_context & ctx, int op, const char * error) {
304 // struct epoll_event ev;
305 // ev.events = EPOLLIN | EPOLLONESHOT;
306 // ev.data.u64 = (__u64)&ctx;
307 // int ret = epoll_ctl(iopoll.epollfd, op, ctx.efd, &ev);
308 // if (ret < 0) {
309 // abort( "KERNEL ERROR: EPOLL %s - (%d) %s\n", error, (int)errno, strerror(errno) );
310 // }
311 // }
312
313 // static void __epoll_register($io_context & ctx) {
314 // __epoll_ctl(ctx, EPOLL_CTL_ADD, "ADD");
315 // }
316
317 // static void __epoll_unregister($io_context & ctx) {
318 // // Read the current epoch so we know when to stop
319 // size_t curr = __atomic_load_n(&iopoll.epoch, __ATOMIC_SEQ_CST);
320
321 // // Remove the fd from the iopoller
322 // __epoll_ctl(ctx, EPOLL_CTL_DEL, "REMOVE");
323
324 // // Notify the io poller thread of the shutdown
325 // iopoll.run = false;
326 // sigval val = { 1 };
327 // pthread_sigqueue( iopoll.thrd, SIGUSR1, val );
328
329 // // Make sure all this is done
330 // __atomic_thread_fence(__ATOMIC_SEQ_CST);
331
332 // // Wait for the next epoch
333 // while(curr == iopoll.epoch && !iopoll.stopped) Pause();
334 // }
335
336 // void __ioctx_prepare_block($io_context & ctx) {
337 // __cfadbg_print_safe(io_core, "Kernel I/O - epoll : Re-arming io poller %d (%p)\n", ctx.fd, &ctx);
338 // __epoll_ctl(ctx, EPOLL_CTL_MOD, "REARM");
339 // }
340
341
342//=============================================================================================
343// I/O Context Misc Setup
344//=============================================================================================
345 void ?{}( $io_arbiter & this ) {
346 this.pending.empty = true;
347 }
348
349 void ^?{}( $io_arbiter & this ) {}
350
351 $io_arbiter * create(void) {
352 return new();
353 }
354 void destroy($io_arbiter * arbiter) {
355 delete(arbiter);
356 }
357
358//=============================================================================================
359// I/O Context Misc Setup
360//=============================================================================================
361
362#endif
Note: See TracBrowser for help on using the repository browser.