xref: /trueos/sys/sys/sf_buf.h (revision 12fb397079ae31a26be56507235df63d4f0ef5a3)
1 /*-
2  * Copyright (c) 2003-2004 Alan L. Cox <alc@cs.rice.edu>
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  *
26  * $FreeBSD$
27  */
28 
29 #ifndef _SYS_SF_BUF_H_
30 #define _SYS_SF_BUF_H_
31 
32 /*
33  * Options to sf_buf_alloc() are specified through its flags argument.  This
34  * argument's value should be the result of a bitwise or'ing of one or more
35  * of the following values.
36  */
37 #define	SFB_CATCH	1		/* Check signals if the allocation
38 					   sleeps. */
39 #define	SFB_CPUPRIVATE	2		/* Create a CPU private mapping. */
40 #define	SFB_DEFAULT	0
41 #define	SFB_NOWAIT	4		/* Return NULL if all bufs are used. */
42 
43 struct vm_page;
44 
45 struct sfstat {				/* sendfile statistics */
46 	uint64_t	sf_iocnt;	/* times sendfile had to do disk I/O */
47 	uint64_t	sf_allocfail;	/* times sfbuf allocation failed */
48 	uint64_t	sf_allocwait;	/* times sfbuf allocation had to wait */
49 };
50 
51 #ifdef _KERNEL
52 #include <machine/sf_buf.h>
53 #include <sys/systm.h>
54 #include <sys/counter.h>
55 struct mbuf;	/* for sf_buf_mext() */
56 
57 extern counter_u64_t sfstat[sizeof(struct sfstat) / sizeof(uint64_t)];
58 #define	SFSTAT_ADD(name, val)	\
59     counter_u64_add(sfstat[offsetof(struct sfstat, name) / sizeof(uint64_t)],\
60 	(val))
61 #define	SFSTAT_INC(name)	SFSTAT_ADD(name, 1)
62 #endif /* _KERNEL */
63 
64 int	sf_buf_mext(struct mbuf *mb, void *addr, void *args);
65 
66 #endif /* !_SYS_SF_BUF_H_ */
67