xref: /dragonfly/sys/sys/sysmsg.h (revision 071d1d69a6c13b850f725b3213176dbda1aee838)
1 /*
2  * Copyright (c) 2003-2020 The DragonFly Project.  All rights reserved.
3  *
4  * This code is derived from software contributed to The DragonFly Project
5  * by Matthew Dillon <dillon@dragonflybsd.org>.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in
15  *    the documentation and/or other materials provided with the
16  *    distribution.
17  * 3. Neither the name of The DragonFly Project nor the names of its
18  *    contributors may be used to endorse or promote products derived
19  *    from this software without specific, prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
25  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
29  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
31  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  */
34 
35 #ifndef _SYS_SYSMSG_H_
36 #define _SYS_SYSMSG_H_
37 
38 #ifdef _KERNEL
39 
40 #ifndef _SYS_TYPES_H_
41 #include <sys/types.h>
42 #endif
43 #ifndef _SYS_SYSPROTO_H_
44 #include <sys/sysproto.h>
45 #endif
46 #ifndef _SYS_SYSUNION_H_
47 #include <sys/sysunion.h>
48 #endif
49 
50 /*
51  * The sysmsg holds the kernelland version of a system call's arguments
52  * and return value.  It typically preceeds the syscall arguments in sysunion
53  * (see sys/sysunion.h).
54  *
55  * WARNING: fds must be long so it translates to two 64 bit registers
56  * on 64 bit architectures.
57  */
58 struct sysmsg {
59           union {
60               void    *resultp;                   /* misc pointer data or result */
61               int     iresult;                    /* standard 'int'eger result */
62               long    lresult;                    /* long result */
63               size_t  szresult;                   /* size_t result */
64               long    fds[2];           /* double result */
65               __int32_t result32;                 /* 32 bit result */
66               __int64_t result64;                 /* 64 bit result */
67               __off_t offset;           /* off_t result */
68               register_t reg;
69           } sm_result;
70           struct trapframe *sm_frame;   /* trapframe - saved user context */
71           union sysunion extargs;                 /* if more than 6 args */
72 } __packed;
73 
74 #define sysmsg_result         sm_result.iresult
75 #define sysmsg_iresult        sm_result.iresult
76 #define sysmsg_lresult        sm_result.lresult
77 #define sysmsg_szresult       sm_result.szresult
78 #define sysmsg_resultp        sm_result.resultp
79 #define sysmsg_fds  sm_result.fds
80 #define sysmsg_offset         sm_result.offset
81 #define sysmsg_result32       sm_result.result32
82 #define sysmsg_result64       sm_result.result64
83 #define sysmsg_reg  sm_result.reg
84 #define sysmsg_frame          sm_frame
85 
86 #endif /* _KERNEL */
87 
88 #endif /* !_SYS_SYSMSG_H_ */
89