source: libcfa/src/concurrency/io/call.cfa.in @ 0dffe91

Last change on this file since 0dffe91 was a51dc0d, checked in by Peter A. Buhr <pabuhr@…>, 3 months ago

add missing #ifdef to handle systems without io_uring
  • Property mode set to 100644
File size: 13.6 KB
Line 
1#!python3
2#
3# Cforall Version 1.0.0 Copyright (C) 2020 University of Waterloo
4#
5# The contents of this file are covered under the licence agreement in the
6# file "LICENCE" distributed with Cforall.
7#
8# call.cfa.in -- Python script to generate io/call.cfa
9#
10# Author           : Thierry Delisle
11# Created On       : Fri Sep 11 12:41:16 2020
12# Last Modified By :
13# Last Modified On :
14# Update Count     :
15#
16
17Header = """//
18// Cforall Version 1.0.0 Copyright (C) 2020 University of Waterloo
19//
20// The contents of this file are covered under the licence agreement in the
21// file "LICENCE" distributed with Cforall.
22//
23// call.cfa -- Api for cforall
24//
25// Author           : Generated from call.cfa.in
26// Created On       : {}
27//
28
29"""
30
31Prelude = """#define __cforall_thread__
32
33#include <unistd.h>
34#include <errno.h>
35#include <sys/socket.h>
36#include <time.hfa>
37
38#include "bits/defs.hfa"
39#include "kernel.hfa"
40#include "io/types.hfa"
41#include "stats.hfa"
42
43//=============================================================================================
44// I/O uring backend
45//=============================================================================================
46
47#if defined(CFA_HAVE_LINUX_IO_URING_H)
48        #include <assert.h>
49        #include <stdint.h>
50        #include <linux/io_uring.h>
51        #include "kernel/fwd.hfa"
52
53        static const __u8 REGULAR_FLAGS = 0
54                #if defined(CFA_HAVE_IOSQE_FIXED_FILE)
55                        | IOSQE_FIXED_FILE
56                #endif
57                #if defined(CFA_HAVE_IOSQE_IO_DRAIN)
58                        | IOSQE_IO_DRAIN
59                #endif
60                #if defined(CFA_HAVE_IOSQE_IO_LINK)
61                        | IOSQE_IO_LINK
62                #endif
63                #if defined(CFA_HAVE_IOSQE_IO_HARDLINK)
64                        | IOSQE_IO_HARDLINK
65                #endif
66                #if defined(CFA_HAVE_IOSQE_ASYNC)
67                        | IOSQE_ASYNC
68                #endif
69                #if defined(CFA_HAVE_IOSQE_BUFFER_SELECTED)
70                        | IOSQE_BUFFER_SELECTED
71                #endif
72        ;
73
74        static const __u32 SPLICE_FLAGS = 0
75                #if defined(CFA_HAVE_SPLICE_F_FD_IN_FIXED)
76                        | SPLICE_F_FD_IN_FIXED
77                #endif
78        ;
79
80        extern struct io_context$ * cfa_io_allocate(struct io_uring_sqe * out_sqes[], __u32 out_idxs[], __u32 want)  __attribute__((nonnull (1,2)));
81        extern void cfa_io_submit( struct io_context$ * in_ctx, __u32 in_idxs[], __u32 have, bool lazy ) __attribute__((nonnull (1,2)));
82#endif
83
84//=============================================================================================
85// I/O Forwards
86//=============================================================================================
87
88extern "C" {
89#if defined(CFA_HAVE_PREADV2)
90        struct iovec;
91        extern ssize_t preadv2 (int fd, const struct iovec * iov, int iovcnt, off_t offset, int flags);
92#endif
93#if defined(CFA_HAVE_PWRITEV2)
94        struct iovec;
95        extern ssize_t pwritev2(int fd, const struct iovec * iov, int iovcnt, off_t offset, int flags);
96#endif
97
98        extern int fsync(int fd);
99
100        #if __OFF_T_MATCHES_OFF64_T
101                typedef __off64_t off_t;
102        #else
103                typedef __off_t off_t;
104        #endif
105        typedef __off64_t off64_t;
106        extern int sync_file_range(int fd, off64_t offset, off64_t nbytes, unsigned int flags);
107
108        struct msghdr;
109        struct sockaddr;
110        extern ssize_t sendmsg(int sockfd, const struct msghdr * msg, int flags);
111        extern ssize_t recvmsg(int sockfd, struct msghdr * msg, int flags);
112        extern ssize_t send(int sockfd, const void * buf, size_t len, int flags);
113        extern ssize_t recv(int sockfd, void * buf, size_t len, int flags);
114
115        extern int fallocate(int fd, int mode, off_t offset, off_t len);
116        extern int posix_fadvise(int fd, off_t offset, off_t len, int advice);
117        extern int madvise(void * addr, size_t length, int advice);
118
119        extern int openat(int dirfd, const char * pathname, int flags, mode_t mode);
120        extern int close(int fd);
121
122        extern ssize_t read (int fd, void * buf, size_t count);
123
124        struct epoll_event;
125        extern int epoll_ctl(int epfd, int op, int fd, struct epoll_event * event);
126
127        extern ssize_t splice(int fd_in, __off64_t * off_in, int fd_out, __off64_t * off_out, size_t len, unsigned int flags);
128        extern ssize_t tee(int fd_in, int fd_out, size_t len, unsigned int flags);
129}
130
131//=============================================================================================
132// I/O Interface
133//=============================================================================================
134#pragma GCC visibility push(default)
135"""
136
137print(Header.format("A Date"))
138print(Prelude)
139
140import re
141import sys
142class Call:
143        def __init__(self, op, signature, body, define=None):
144                sig = re.search("(.*) (.*)\((.*)\)", signature)
145                if not sig:
146                        print("OP '{}' has invalid signature {}".format(op, signature), file=sys.stderr)
147                        sys.exit(1)
148
149                self.op     = op
150                self.ret    = sig.group(1)
151                self.name   = sig.group(2)
152                self.params = sig.group(3)
153                self.define = define
154                self.body = ""
155
156                accepted_keys = [ 'ioprio', 'fd', 'off', 'addr2','addr', 'splice_off_in','len',
157                        'rw_flags', 'fsync_flags', 'poll_events', 'poll32_events',
158                        'sync_range_flags', 'msg_flags', 'timeout_flags', 'accept_flags',
159                        'cancel_flags', 'open_flags', 'statx_flags', 'fadvise_advice',
160                        'splice_flags', 'buf_index' ,'buf_group' 'personality',
161                        'splice_fd_in' ]
162
163                for k, v in body.items():
164                        if not k in accepted_keys:
165                                print("OP '{}' has invalid body kew {}".format(op, k), file=sys.stderr)
166                                sys.exit(1)
167
168                        self.body += "\n                sqe->{key} = {value};".format(key=k, value=v)
169
170
171        def args(self):
172                param_a = self.params.split(',')
173                args_a = [p.replace('*', ' ').split()[-1] for p in param_a]
174                for a in args_a:
175                        if '*' in a:
176                                print("OP '{}' has invalid * in argument {}".format(self.op, a), file=sys.stderr)
177                                sys.exit(1)
178
179                return ', '.join(args_a)
180
181AsyncTemplate = """inline void async_{name}(io_future_t & future, {params}, __u64 submit_flags) {{
182        #if !defined(CFA_HAVE_LINUX_IO_URING_H) || !defined(CFA_HAVE_IORING_OP_{op})
183                ssize_t res = {name}({args});
184                if (res >= 0) {{
185                        fulfil(future, res);
186                }}
187                else {{
188                        fulfil(future, -errno);
189                }}
190        #else
191                __u8 sflags = REGULAR_FLAGS & submit_flags;
192                __u32 idx;
193                struct io_uring_sqe * sqe;
194                struct io_context$ * ctx = cfa_io_allocate( &sqe, &idx, 1 );
195
196                memset(sqe, 0, sizeof(*sqe));
197                sqe->opcode = IORING_OP_{op};
198                sqe->flags = sflags;
199                sqe->user_data = (uintptr_t)&future;
200                {body}
201
202                asm volatile("": : :"memory");
203
204                verify( sqe->user_data == (uintptr_t)&future );
205                cfa_io_submit( ctx, &idx, 1, 0 != (submit_flags & CFA_IO_LAZY) );
206        #endif
207}}"""
208
209SyncTemplate = """{ret} cfa_{name}({params}, __u64 submit_flags) {{
210        io_future_t future;
211
212        async_{name}( future, {args}, submit_flags );
213
214        __attribute__((unused)) bool parked;
215        parked = wait( future );
216#if defined(CFA_HAVE_LINUX_IO_URING_H)
217        __STATS__(false, if(!parked) io.submit.nblk += 1; )
218#endif
219        if( future.result < 0 ) {{
220                errno = -future.result;
221                return -1;
222        }}
223        return future.result;
224}}"""
225
226calls = [
227        # CFA_HAVE_IORING_OP_READV
228        Call('READV', 'ssize_t preadv2(int fd, const struct iovec * iov, int iovcnt, off_t offset, int flags)', {
229                'fd'  : 'fd',
230                'addr': '(typeof(sqe->addr))iov',
231                'len' : 'iovcnt',
232                'off' : 'offset',
233                'rw_flags' : 'flags'
234        }, define = 'CFA_HAVE_PREADV2'),
235        # CFA_HAVE_IORING_OP_WRITEV
236        Call('WRITEV', 'ssize_t pwritev2(int fd, const struct iovec * iov, int iovcnt, off_t offset, int flags)', {
237                'fd'  : 'fd',
238                'addr': '(typeof(sqe->addr))iov',
239                'len' : 'iovcnt',
240                'off' : 'offset',
241                'rw_flags' : 'flags'
242        }, define = 'CFA_HAVE_PWRITEV2'),
243        # CFA_HAVE_IORING_OP_FSYNC
244        Call('FSYNC', 'int fsync(int fd)', {
245                'fd': 'fd'
246        }),
247        # CFA_HAVE_IORING_OP_EPOLL_CTL
248        Call('EPOLL_CTL', 'int epoll_ctl(int epfd, int op, int fd, struct epoll_event * event)', {
249                'fd': 'epfd',
250                'len': 'op',
251                'addr': 'fd',
252                'off': '(typeof(sqe->off))event'
253        }),
254        # CFA_HAVE_IORING_OP_SYNC_FILE_RANGE
255        Call('SYNC_FILE_RANGE', 'int sync_file_range(int fd, off64_t offset, off64_t nbytes, unsigned int flags)', {
256                'fd': 'fd',
257                'off': 'offset',
258                'len': 'nbytes',
259                'sync_range_flags': 'flags'
260        }),
261        # CFA_HAVE_IORING_OP_SENDMSG
262        Call('SENDMSG', 'ssize_t sendmsg(int sockfd, const struct msghdr * msg, int flags)', {
263                'fd': 'sockfd',
264                'addr': '(typeof(sqe->addr))(struct msghdr *)msg',
265                'len': '1',
266                'msg_flags': 'flags'
267        }),
268        # CFA_HAVE_IORING_OP_RECVMSG
269        Call('RECVMSG', 'ssize_t recvmsg(int sockfd, struct msghdr * msg, int flags)', {
270                'fd': 'sockfd',
271                'addr': '(typeof(sqe->addr))(struct msghdr *)msg',
272                'len': '1',
273                'msg_flags': 'flags'
274        }),
275        # CFA_HAVE_IORING_OP_SEND
276        Call('SEND', 'ssize_t send(int sockfd, const void * buf, size_t len, int flags)', {
277                'fd': 'sockfd',
278                'addr': '(typeof(sqe->addr))buf',
279                'len': 'len',
280                'msg_flags': 'flags'
281        }),
282        # CFA_HAVE_IORING_OP_RECV
283        Call('RECV', 'ssize_t recv(int sockfd, void * buf, size_t len, int flags)', {
284                'fd': 'sockfd',
285                'addr': '(typeof(sqe->addr))buf',
286                'len': 'len',
287                'msg_flags': 'flags'
288        }),
289        # CFA_HAVE_IORING_OP_ACCEPT
290        Call('ACCEPT', 'int accept4(int sockfd, __SOCKADDR_ARG addr, socklen_t * restrict addrlen, int flags)', {
291                'fd': 'sockfd',
292                'addr': '(typeof(sqe->addr))&addr',
293                'addr2': '(typeof(sqe->addr2))addrlen',
294                'accept_flags': 'flags'
295        }),
296        # CFA_HAVE_IORING_OP_CONNECT
297        Call('CONNECT', 'int connect(int sockfd, __CONST_SOCKADDR_ARG addr, socklen_t addrlen)', {
298                'fd': 'sockfd',
299                'addr': '(typeof(sqe->addr))&addr',
300                'off': 'addrlen'
301        }),
302        # CFA_HAVE_IORING_OP_FALLOCATE
303        Call('FALLOCATE', 'int fallocate(int fd, int mode, off_t offset, off_t len)', {
304                'fd': 'fd',
305                'len': 'mode',
306                'off': 'offset',
307                'addr': 'len'
308        }),
309        # CFA_HAVE_IORING_OP_FADVISE
310        Call('FADVISE', 'int posix_fadvise(int fd, off_t offset, off_t len, int advice)', {
311                'fd': 'fd',
312                'off': 'offset',
313                'len': 'len',
314                'fadvise_advice': 'advice'
315        }),
316        # CFA_HAVE_IORING_OP_MADVISE
317        Call('MADVISE', 'int madvise(void * addr, size_t length, int advice)', {
318                'addr': '(typeof(sqe->addr))addr',
319                'len': 'length',
320                'fadvise_advice': 'advice'
321        }),
322        # CFA_HAVE_IORING_OP_OPENAT
323        Call('OPENAT', 'int openat(int dirfd, const char * pathname, int flags, mode_t mode)', {
324                'fd': 'dirfd',
325                'addr': '(typeof(sqe->addr))pathname',
326                'open_flags': 'flags;',
327                'len': 'mode'
328        }),
329        # CFA_HAVE_IORING_OP_OPENAT2
330        Call('OPENAT2', 'int openat2(int dirfd, const char * pathname, struct open_how * how, size_t size)', {
331                'fd': 'dirfd',
332                'addr': '(typeof(sqe->addr))pathname',
333                'off': '(typeof(sqe->off))how',
334                'len': 'sizeof(*how)'
335        }, define = 'CFA_HAVE_OPENAT2'),
336        # CFA_HAVE_IORING_OP_CLOSE
337        Call('CLOSE', 'int close(int fd)', {
338                'fd': 'fd'
339        }),
340        # CFA_HAVE_IORING_OP_STATX
341        Call('STATX', 'int statx(int dirfd, const char * pathname, int flags, unsigned int mask, struct statx * statxbuf)', {
342                'fd': 'dirfd',
343                'addr': '(typeof(sqe->addr))pathname',
344                'statx_flags': 'flags',
345                'len': 'mask',
346                'off': '(typeof(sqe->off))statxbuf'
347        }, define = 'CFA_HAVE_STATX'),
348        # CFA_HAVE_IORING_OP_READ
349        Call('READ', 'ssize_t read(int fd, void * buf, size_t count)', {
350                'fd': 'fd',
351                'addr': '(typeof(sqe->addr))buf',
352                'len': 'count'
353        }),
354        # CFA_HAVE_IORING_OP_WRITE
355        Call('WRITE', 'ssize_t write(int fd, void * buf, size_t count)', {
356                'fd': 'fd',
357                'addr': '(typeof(sqe->addr))buf',
358                'len': 'count'
359        }),
360        # CFA_HAVE_IORING_OP_SPLICE
361        Call('SPLICE', 'ssize_t splice(int fd_in, __off64_t * off_in, int fd_out, __off64_t * off_out, size_t len, unsigned int flags)', {
362                'splice_fd_in': 'fd_in',
363                'splice_off_in': 'off_in ? (typeof(sqe->splice_off_in))*off_in : (typeof(sqe->splice_off_in))-1',
364                'fd': 'fd_out',
365                'off': 'off_out ? (typeof(sqe->off))*off_out : (typeof(sqe->off))-1',
366                'len': 'len',
367                'splice_flags': 'flags'
368        }),
369        # CFA_HAVE_IORING_OP_TEE
370        Call('TEE', 'ssize_t tee(int fd_in, int fd_out, size_t len, unsigned int flags)', {
371                'splice_fd_in': 'fd_in',
372                'fd': 'fd_out',
373                'len': 'len',
374                'splice_flags': 'flags'
375        })
376]
377
378print("//----------")
379print("// synchronous calls")
380for c in calls:
381        if c.define:
382                print("""#if defined({define})
383        {ret} cfa_{name}({params}, __u64 submit_flags);
384#endif""".format(define=c.define,ret=c.ret, name=c.name, params=c.params))
385        else:
386                print("{ret} cfa_{name}({params}, __u64 submit_flags);"
387                .format(ret=c.ret, name=c.name, params=c.params))
388
389print("\n//----------")
390print("// asynchronous calls")
391for c in calls:
392        if c.define:
393                print("""#if defined({define})
394        void async_{name}(io_future_t & future, {params}, __u64 submit_flags);
395#endif""".format(define=c.define,name=c.name, params=c.params))
396        else:
397                print("void async_{name}(io_future_t & future, {params}, __u64 submit_flags);"
398                .format(name=c.name, params=c.params))
399print("\n")
400
401for c in calls:
402        print("//-----------------------------------------------------------------------------")
403        print("// {}".format(c.name))
404        Async = AsyncTemplate.format(
405                name   = c.name,
406                ret    = c.ret,
407                params = c.params,
408                args   = c.args(),
409                op     = c.op,
410                body   = c.body
411
412        )
413        Sync = SyncTemplate.format(
414                name   = c.name,
415                ret    = c.ret,
416                params = c.params,
417                args   = c.args()
418        )
419
420        if c.define:
421                print("""#if defined({})
422        //----------
423        // asynchronous call
424        {}
425
426        //----------
427        // synchronous call
428        {}
429#endif
430""".format(c.define, "\n\t".join( Async.splitlines() ), "\n\t".join( Sync.splitlines() )))
431        else :
432                print("""//----------
433// asynchronous call
434{}
435
436//----------
437// synchronous call
438{}
439""".format(Async, Sync))
440
441print("""
442//-----------------------------------------------------------------------------
443// Check if a function is has asynchronous
444bool has_user_level_blocking( fptr_t func ) {
445        #if defined(CFA_HAVE_LINUX_IO_URING_H)""")
446
447for c in calls:
448        if c.define:
449                print("""               #if defined({define})
450                        if( /*func == (fptr_t)preadv2 || */
451                                func == (fptr_t)cfa_{name} ||
452                                func == (fptr_t)async_{name} ) {{
453                                #if defined(CFA_HAVE_IORING_OP_{op})
454                                        return true;
455                                #else
456                                        return false;
457                                #endif
458                        }}
459                #endif""".format(define=c.define, name=c.name, op=c.op))
460        else:
461                print("""               if( /*func == (fptr_t)preadv2 || */
462                        func == (fptr_t)cfa_{name} ||
463                        func == (fptr_t)async_{name} ) {{
464                        #if defined(CFA_HAVE_IORING_OP_{op})
465                                return true;
466                        #else
467                                return false;
468                        #endif
469                }}""".format(name=c.name, op=c.op))
470
471print("""       #endif
472
473        return false;
474}""")
Note: See TracBrowser for help on using the repository browser.