xref: /onnv-gate/usr/src/uts/common/sys/copyops.h (revision 0:68f95e015346)
1*0Sstevel@tonic-gate /*
2*0Sstevel@tonic-gate  * CDDL HEADER START
3*0Sstevel@tonic-gate  *
4*0Sstevel@tonic-gate  * The contents of this file are subject to the terms of the
5*0Sstevel@tonic-gate  * Common Development and Distribution License, Version 1.0 only
6*0Sstevel@tonic-gate  * (the "License").  You may not use this file except in compliance
7*0Sstevel@tonic-gate  * with the License.
8*0Sstevel@tonic-gate  *
9*0Sstevel@tonic-gate  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10*0Sstevel@tonic-gate  * or http://www.opensolaris.org/os/licensing.
11*0Sstevel@tonic-gate  * See the License for the specific language governing permissions
12*0Sstevel@tonic-gate  * and limitations under the License.
13*0Sstevel@tonic-gate  *
14*0Sstevel@tonic-gate  * When distributing Covered Code, include this CDDL HEADER in each
15*0Sstevel@tonic-gate  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16*0Sstevel@tonic-gate  * If applicable, add the following below this CDDL HEADER, with the
17*0Sstevel@tonic-gate  * fields enclosed by brackets "[]" replaced with your own identifying
18*0Sstevel@tonic-gate  * information: Portions Copyright [yyyy] [name of copyright owner]
19*0Sstevel@tonic-gate  *
20*0Sstevel@tonic-gate  * CDDL HEADER END
21*0Sstevel@tonic-gate  */
22*0Sstevel@tonic-gate /*
23*0Sstevel@tonic-gate  * Copyright 2004 Sun Microsystems, Inc.  All rights reserved.
24*0Sstevel@tonic-gate  * Use is subject to license terms.
25*0Sstevel@tonic-gate  */
26*0Sstevel@tonic-gate 
27*0Sstevel@tonic-gate #ifndef	_SYS_COPYOPS_H
28*0Sstevel@tonic-gate #define	_SYS_COPYOPS_H
29*0Sstevel@tonic-gate 
30*0Sstevel@tonic-gate #pragma ident	"%Z%%M%	%I%	%E% SMI"
31*0Sstevel@tonic-gate 
32*0Sstevel@tonic-gate #include <sys/types.h>
33*0Sstevel@tonic-gate #include <sys/thread.h>
34*0Sstevel@tonic-gate #include <sys/buf.h>
35*0Sstevel@tonic-gate #include <sys/aio_req.h>
36*0Sstevel@tonic-gate #include <sys/uio.h>
37*0Sstevel@tonic-gate 
38*0Sstevel@tonic-gate #ifdef	__cplusplus
39*0Sstevel@tonic-gate extern "C" {
40*0Sstevel@tonic-gate #endif
41*0Sstevel@tonic-gate 
42*0Sstevel@tonic-gate #ifdef _KERNEL
43*0Sstevel@tonic-gate 
44*0Sstevel@tonic-gate /*
45*0Sstevel@tonic-gate  * Copy in/out vector operations.  This structure is used to interpose
46*0Sstevel@tonic-gate  * on the kernel copyin/copyout/etc. operations for various purposes
47*0Sstevel@tonic-gate  * such as handling watchpoints in the affected user memory.  When one of the
48*0Sstevel@tonic-gate  * copy operations causes a fault, the corresponding function in this vector is
49*0Sstevel@tonic-gate  * called to handle it.
50*0Sstevel@tonic-gate  *
51*0Sstevel@tonic-gate  * The 64-bit operations in the structure fetch and store extended
52*0Sstevel@tonic-gate  * words and are only used on platforms with 64 bit general
53*0Sstevel@tonic-gate  * registers e.g. sun4u.
54*0Sstevel@tonic-gate  *
55*0Sstevel@tonic-gate  * Since the only users of these interfaces (watchpoints and pxfs) perform the
56*0Sstevel@tonic-gate  * default action unless there is a page fault, we can save the overhead of
57*0Sstevel@tonic-gate  * having to go through this indirection unless there is a page fault.  This
58*0Sstevel@tonic-gate  * improves performance both in general and when watchpoints are enabled.  If,
59*0Sstevel@tonic-gate  * in the future, a consumer relies on being able to interpose on all actions,
60*0Sstevel@tonic-gate  * then this assumption will have to be undone.
61*0Sstevel@tonic-gate  *
62*0Sstevel@tonic-gate  * No consumers should call these functions directly.  They are automatically
63*0Sstevel@tonic-gate  * handled by the generic versions.
64*0Sstevel@tonic-gate  */
65*0Sstevel@tonic-gate typedef struct copyops {
66*0Sstevel@tonic-gate 	/*
67*0Sstevel@tonic-gate 	 * unstructured byte copyin/out functions
68*0Sstevel@tonic-gate 	 */
69*0Sstevel@tonic-gate 	int	(*cp_copyin)(const void *, void *, size_t);
70*0Sstevel@tonic-gate 	int	(*cp_xcopyin)(const void *, void *, size_t);
71*0Sstevel@tonic-gate 	int	(*cp_copyout)(const void *, void *, size_t);
72*0Sstevel@tonic-gate 	int	(*cp_xcopyout)(const void *, void *, size_t);
73*0Sstevel@tonic-gate 	int	(*cp_copyinstr)(const char *, char *, size_t, size_t *);
74*0Sstevel@tonic-gate 	int	(*cp_copyoutstr)(const char *, char *, size_t, size_t *);
75*0Sstevel@tonic-gate 
76*0Sstevel@tonic-gate 	/*
77*0Sstevel@tonic-gate 	 * fetch/store byte/halfword/word/extended word
78*0Sstevel@tonic-gate 	 */
79*0Sstevel@tonic-gate 	int	(*cp_fuword8)(const void *, uint8_t *);
80*0Sstevel@tonic-gate 	int	(*cp_fuword16)(const void *, uint16_t *);
81*0Sstevel@tonic-gate 	int	(*cp_fuword32)(const void *, uint32_t *);
82*0Sstevel@tonic-gate 	int	(*cp_fuword64)(const void *, uint64_t *);
83*0Sstevel@tonic-gate 
84*0Sstevel@tonic-gate 	int	(*cp_suword8)(void *, uint8_t);
85*0Sstevel@tonic-gate 	int	(*cp_suword16)(void *, uint16_t);
86*0Sstevel@tonic-gate 	int	(*cp_suword32)(void *, uint32_t);
87*0Sstevel@tonic-gate 	int	(*cp_suword64)(void *, uint64_t);
88*0Sstevel@tonic-gate 
89*0Sstevel@tonic-gate 	int	(*cp_physio)(int (*)(struct buf *), struct buf *, dev_t,
90*0Sstevel@tonic-gate 	    int, void (*)(struct buf *), struct uio *);
91*0Sstevel@tonic-gate } copyops_t;
92*0Sstevel@tonic-gate 
93*0Sstevel@tonic-gate extern int	default_physio(int (*)(struct buf *), struct buf *,
94*0Sstevel@tonic-gate     dev_t, int, void (*)(struct buf *), struct uio *);
95*0Sstevel@tonic-gate 
96*0Sstevel@tonic-gate /*
97*0Sstevel@tonic-gate  * Interfaces for installing and removing copyops.
98*0Sstevel@tonic-gate  */
99*0Sstevel@tonic-gate extern void install_copyops(kthread_id_t tp, copyops_t *cp);
100*0Sstevel@tonic-gate extern void remove_copyops(kthread_id_t tp);
101*0Sstevel@tonic-gate extern int copyops_installed(kthread_id_t tp);
102*0Sstevel@tonic-gate 
103*0Sstevel@tonic-gate #endif	/* _KERNEL */
104*0Sstevel@tonic-gate 
105*0Sstevel@tonic-gate #ifdef	__cplusplus
106*0Sstevel@tonic-gate }
107*0Sstevel@tonic-gate #endif
108*0Sstevel@tonic-gate 
109*0Sstevel@tonic-gate #endif /* _SYS_COPYOPS_H */
110