xref: /freebsd/sys/kern/subr_bufring.c (revision f39bffc62c1395bde25d152c7f68fdf7cbaab414)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 2007, 2008 Kip Macy <kmacy@freebsd.org>
5  * All rights reserved.
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  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
31 
32 
33 #include <sys/param.h>
34 #include <sys/systm.h>
35 #include <sys/kernel.h>
36 #include <sys/malloc.h>
37 #include <sys/ktr.h>
38 #include <sys/buf_ring.h>
39 
40 
41 struct buf_ring *
42 buf_ring_alloc(int count, struct malloc_type *type, int flags, struct mtx *lock)
43 {
44 	struct buf_ring *br;
45 
46 	KASSERT(powerof2(count), ("buf ring must be size power of 2"));
47 
48 	br = malloc(sizeof(struct buf_ring) + count*sizeof(caddr_t),
49 	    type, flags|M_ZERO);
50 	if (br == NULL)
51 		return (NULL);
52 #ifdef DEBUG_BUFRING
53 	br->br_lock = lock;
54 #endif
55 	br->br_prod_size = br->br_cons_size = count;
56 	br->br_prod_mask = br->br_cons_mask = count-1;
57 	br->br_prod_head = br->br_cons_head = 0;
58 	br->br_prod_tail = br->br_cons_tail = 0;
59 
60 	return (br);
61 }
62 
63 void
64 buf_ring_free(struct buf_ring *br, struct malloc_type *type)
65 {
66 	free(br, type);
67 }
68