]> granicus.if.org Git - strace/blob - aio.c
Update ioctl entries from linux v4.18
[strace] / aio.c
1 /*
2  * Copyright (c) 1991, 1992 Paul Kranenburg <pk@cs.few.eur.nl>
3  * Copyright (c) 1993 Branko Lankester <branko@hacktic.nl>
4  * Copyright (c) 1993, 1994, 1995, 1996 Rick Sladkey <jrs@world.std.com>
5  * Copyright (c) 1996-1999 Wichert Akkerman <wichert@cistron.nl>
6  * Copyright (c) 1999-2018 The strace developers.
7  * All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  * 3. The name of the author may not be used to endorse or promote products
18  *    derived from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
21  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
22  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
23  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
24  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
25  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
29  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31
32 #include "defs.h"
33 #include "print_fields.h"
34 #include <linux/aio_abi.h>
35
36 #include "xlat/aio_cmds.h"
37
38 SYS_FUNC(io_setup)
39 {
40         if (entering(tcp))
41                 tprintf("%u, ", (unsigned int) tcp->u_arg[0]);
42         else
43                 printnum_ptr(tcp, tcp->u_arg[1]);
44         return 0;
45 }
46
47 SYS_FUNC(io_destroy)
48 {
49         printaddr(tcp->u_arg[0]);
50
51         return RVAL_DECODED;
52 }
53
54 enum iocb_sub {
55         SUB_NONE, SUB_COMMON, SUB_VECTOR
56 };
57
58 static enum iocb_sub
59 tprint_lio_opcode(unsigned int cmd)
60 {
61         static const enum iocb_sub subs[] = {
62                 [IOCB_CMD_PREAD]        = SUB_COMMON,
63                 [IOCB_CMD_PWRITE]       = SUB_COMMON,
64                 [IOCB_CMD_FSYNC]        = SUB_NONE,
65                 [IOCB_CMD_FDSYNC]       = SUB_NONE,
66                 [IOCB_CMD_PREADX]       = SUB_NONE,
67                 [IOCB_CMD_POLL]         = SUB_NONE,
68                 [IOCB_CMD_NOOP]         = SUB_NONE,
69                 [IOCB_CMD_PREADV]       = SUB_VECTOR,
70                 [IOCB_CMD_PWRITEV]      = SUB_VECTOR,
71         };
72
73         printxval_indexn_ex(ARRSZ_PAIR(aio_cmds), cmd, "IOCB_CMD_???",
74                             XLAT_STYLE_FMT_U);
75
76         return cmd < ARRAY_SIZE(subs) ? subs[cmd] : SUB_NONE;
77 }
78
79 static void
80 print_common_flags(struct tcb *tcp, const struct iocb *cb)
81 {
82 /* IOCB_FLAG_RESFD is available since v2.6.22-rc1~47 */
83 #ifdef IOCB_FLAG_RESFD
84         if (cb->aio_flags & IOCB_FLAG_RESFD)
85                 PRINT_FIELD_FD(", ", *cb, aio_resfd, tcp);
86
87         if (cb->aio_flags & ~IOCB_FLAG_RESFD)
88                 PRINT_FIELD_X(", ", *cb, aio_flags);
89 #endif
90 }
91
92 static bool
93 iocb_is_valid(const struct iocb *cb)
94 {
95         return cb->aio_buf == (unsigned long) cb->aio_buf &&
96                cb->aio_nbytes == (size_t) cb->aio_nbytes &&
97                (ssize_t) cb->aio_nbytes >= 0;
98 }
99
100 static enum iocb_sub
101 print_iocb_header(struct tcb *tcp, const struct iocb *cb)
102 {
103         enum iocb_sub sub;
104
105         if (cb->aio_data){
106                 PRINT_FIELD_X("", *cb, aio_data);
107                 tprints(", ");
108         }
109
110         if (cb->aio_key) {
111                 PRINT_FIELD_U("", *cb, aio_key);
112                 tprints(", ");
113         }
114
115         tprints("aio_lio_opcode=");
116         sub = tprint_lio_opcode(cb->aio_lio_opcode);
117         if (cb->aio_reqprio)
118                 PRINT_FIELD_D(", ", *cb, aio_reqprio);
119
120         PRINT_FIELD_FD(", ", *cb, aio_fildes, tcp);
121
122         return sub;
123 }
124
125 static void
126 print_iocb(struct tcb *tcp, const struct iocb *cb)
127 {
128         tprints("{");
129
130         enum iocb_sub sub = print_iocb_header(tcp, cb);
131
132         switch (sub) {
133         case SUB_COMMON:
134                 if (cb->aio_lio_opcode == 1 && iocb_is_valid(cb)) {
135                         PRINT_FIELD_STRN(", ", *cb, aio_buf,
136                                          cb->aio_nbytes, tcp);
137                 } else {
138                         PRINT_FIELD_X(", ", *cb, aio_buf);
139                 }
140                 PRINT_FIELD_U(", ", *cb, aio_nbytes);
141                 PRINT_FIELD_D(", ", *cb, aio_offset);
142                 print_common_flags(tcp, cb);
143                 break;
144         case SUB_VECTOR:
145                 if (iocb_is_valid(cb)) {
146                         tprints(", aio_buf=");
147                         tprint_iov(tcp, cb->aio_nbytes, cb->aio_buf,
148                                    cb->aio_lio_opcode == 8
149                                    ? IOV_DECODE_STR
150                                    : IOV_DECODE_ADDR);
151                 } else {
152                         PRINT_FIELD_X(", ", *cb, aio_buf);
153                         PRINT_FIELD_U(", ", *cb, aio_nbytes);
154                 }
155                 PRINT_FIELD_D(", ", *cb, aio_offset);
156                 print_common_flags(tcp, cb);
157                 break;
158         case SUB_NONE:
159                 break;
160         }
161
162         tprints("}");
163 }
164
165 static bool
166 print_iocbp(struct tcb *tcp, void *elem_buf, size_t elem_size, void *data)
167 {
168         kernel_ulong_t addr;
169         struct iocb cb;
170
171         if (elem_size < sizeof(kernel_ulong_t)) {
172                 addr = *(unsigned int *) elem_buf;
173         } else {
174                 addr = *(kernel_ulong_t *) elem_buf;
175         }
176
177         if (!umove_or_printaddr(tcp, addr, &cb))
178                 print_iocb(tcp, &cb);
179
180         return true;
181 }
182
183 SYS_FUNC(io_submit)
184 {
185         const kernel_long_t nr =
186                 truncate_klong_to_current_wordsize(tcp->u_arg[1]);
187         const kernel_ulong_t addr = tcp->u_arg[2];
188         kernel_ulong_t iocbp;
189
190         printaddr(tcp->u_arg[0]);
191         tprintf(", %" PRI_kld ", ", nr);
192
193         if (nr < 0)
194                 printaddr(addr);
195         else
196                 print_array(tcp, addr, nr, &iocbp, current_wordsize,
197                             tfetch_mem, print_iocbp, 0);
198
199         return RVAL_DECODED;
200 }
201
202 static bool
203 print_io_event(struct tcb *tcp, void *elem_buf, size_t elem_size, void *data)
204 {
205         struct io_event *event = elem_buf;
206
207         PRINT_FIELD_X("{", *event, data);
208         PRINT_FIELD_X(", ", *event, obj);
209         PRINT_FIELD_D(", ", *event, res);
210         PRINT_FIELD_D(", ", *event, res2);
211         tprints("}");
212
213         return true;
214 }
215
216 SYS_FUNC(io_cancel)
217 {
218         if (entering(tcp)) {
219                 printaddr(tcp->u_arg[0]);
220                 tprints(", ");
221
222                 struct iocb cb;
223
224                 if (!umove_or_printaddr(tcp, tcp->u_arg[1], &cb)) {
225                         tprints("{");
226                         print_iocb_header(tcp, &cb);
227                         tprints("}");
228                 }
229                 tprints(", ");
230         } else {
231                 struct io_event event;
232
233                 if (!umove_or_printaddr(tcp, tcp->u_arg[2], &event))
234                         print_io_event(tcp, &event, sizeof(event), 0);
235         }
236         return 0;
237 }
238
239 static int
240 print_io_getevents(struct tcb *tcp, bool has_usig)
241 {
242         if (entering(tcp)) {
243                 printaddr(tcp->u_arg[0]);
244                 tprintf(", %" PRI_kld ", %" PRI_kld ", ",
245                         truncate_klong_to_current_wordsize(tcp->u_arg[1]),
246                         truncate_klong_to_current_wordsize(tcp->u_arg[2]));
247         } else {
248                 struct io_event buf;
249                 print_array(tcp, tcp->u_arg[3], tcp->u_rval, &buf, sizeof(buf),
250                             tfetch_mem, print_io_event, 0);
251                 tprints(", ");
252                 /*
253                  * Since the timeout and usig parameters are read by the kernel
254                  * on entering syscall, it has to be decoded the same way
255                  * whether the syscall has failed or not.
256                  */
257                 temporarily_clear_syserror(tcp);
258                 print_timespec(tcp, tcp->u_arg[4]);
259                 if (has_usig) {
260                         tprints(", ");
261                         print_aio_sigset(tcp, tcp->u_arg[5]);
262                 }
263                 restore_cleared_syserror(tcp);
264         }
265         return 0;
266 }
267
268 SYS_FUNC(io_getevents)
269 {
270         return print_io_getevents(tcp, false);
271 }
272
273 SYS_FUNC(io_pgetevents)
274 {
275         return print_io_getevents(tcp, true);
276 }