xref: /dragonfly/sys/sys/mapped_ioctl.h (revision 86d7f5d305c6adaa56ff4582ece9859d73106103)
1 /*
2  * Copyright (c) 2004, 2005 The DragonFly Project.  All rights reserved.
3  *
4  * This code is derived from software contributed to The DragonFly Project
5  * by Simon 'corecode' Schubert <corecode@fs.ei.tum.de>.
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  * $DragonFly: src/sys/sys/mapped_ioctl.h,v 1.4 2006/05/20 02:42:13 dillon Exp $
35  */
36 #ifndef _SYS_MAPPED_IOCTL_H_
37 #define _SYS_MAPPED_IOCTL_H_
38 
39 #ifndef _SYS_TYPES_H_
40 #include <sys/types.h>
41 #endif
42 #ifndef _SYS_QUEUE_H_
43 #include <sys/queue.h>
44 #endif
45 #ifndef _SYS_IOCCOM_H_
46 #include <sys/ioccom.h>
47 #endif
48 
49 struct file;
50 struct thread;
51 struct ucred;
52 struct ioctl_map_entry;
53 
54 typedef int         (ioctl_wrap_func)(struct file *, u_long, u_long, caddr_t,
55                                           struct ucred *);
56 typedef u_long      (ioctl_map_func)(u_long, u_long, u_long, u_long, u_long, u_long);
57 
58 struct ioctl_map_range {
59           u_long              start;              /* Start of source range; inclusive */
60           u_long              end;                /* End of source range; inclusive */
61           u_long              maptocmd; /* Start of destination range */
62           u_long              maptoend; /* End of destination range */
63           ioctl_wrap_func *wrapfunc;    /* Ioctl handler to use */
64           ioctl_map_func  *mapfunc;     /* Handler to map source to dest */
65 };
66 
67 #define MAPPED_IOCTL_MAPRANGE(c,e,t,r,f,m)        { (c), (e), (t), (r), (f), (m) }
68 #define MAPPED_IOCTL_MAPF(c,t,f)                  MAPPED_IOCTL_MAPRANGE((c), (c), (t), (t), (f), NULL)
69 #define MAPPED_IOCTL_MAP(c,t)                     MAPPED_IOCTL_MAPF((c), (t), NULL)
70 #define MAPPED_IOCTL_IO(c,f)                      MAPPED_IOCTL_MAPF((c), _IO(0, 0), (f))
71 #define MAPPED_IOCTL_IOR(c,f,t)                   MAPPED_IOCTL_MAPF((c), _IOR(0, 0, t), (f))
72 #define MAPPED_IOCTL_IOW(c,f,t)                   MAPPED_IOCTL_MAPF((c), _IOW(0, 0, t), (f))
73 #define MAPPED_IOCTL_IOWR(c,f,t)                  MAPPED_IOCTL_MAPF((c), _IOWR(0, 0, t), (f))
74 
75 struct ioctl_map {
76           u_long mask;
77           const char *sys;
78           LIST_HEAD(, ioctl_map_entry) mapping;
79 };
80 
81 struct ioctl_map_handler {
82           struct ioctl_map    *map;
83           const char                    *subsys;
84           struct ioctl_map_range        *cmd_ranges;
85 };
86 
87 int mapped_ioctl(int fd, u_long com, caddr_t uspc_data,
88                      struct ioctl_map *map, struct sysmsg *msg);
89 int mapped_ioctl_register_handler(struct ioctl_map_handler *he);
90 int mapped_ioctl_unregister_handler(struct ioctl_map_handler *he);
91 
92 #endif /* !_SYS_MAPPED_IOCTL_H_ */
93