Add the MPIPE subsystem. This subsystem is used for 'pipelining' fixed-size
[dragonfly.git] / sys / sys / mpipe.h
1 /*
2  * Copyright (c) 2003 Matthew Dillon <dillon@backplane.com>
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  * $DragonFly: src/sys/sys/mpipe.h,v 1.1 2003/11/30 20:13:53 dillon Exp $
27  */
28
29 #ifndef _SYS_MPIPE_H_
30 #define _SYS_MPIPE_H_
31
32 #ifndef _SYS_MALLOC_H_
33 #include <sys/malloc.h>
34 #endif
35
36 /*
37  * Pipeline memory allocations.  This implements a pipeline for allocations
38  * of a particular size.  It is used in order to allow memory allocations
39  * to block while at the same time guarenteeing that no deadlocks will occur.
40  */
41 struct mpipe_buf;
42
43 struct malloc_pipe {
44     TAILQ_HEAD(, mpipe_buf) queue;
45     malloc_type_t type;         /* malloc bucket */
46     int         bytes;          /* allocation size */
47     int         pending;        /* there is a request pending */
48     int         free_count;     /* entries in free list */
49     int         total_count;    /* total free + outstanding */
50     int         max_count;      /* maximum cache size */
51     void        (*trigger)(void *data); /* trigger function on free */
52     void        *trigger_data;
53 };
54
55 typedef struct malloc_pipe *malloc_pipe_t;
56
57 #ifdef _KERNEL
58
59 void mpipe_init(malloc_pipe_t mpipe, malloc_type_t type,
60                 int bytes, int nnow, int nmax);
61 void mpipe_done(malloc_pipe_t mpipe);
62 void *mpipe_alloc(malloc_pipe_t mpipe, int flags);
63 void mpipe_free(malloc_pipe_t mpipe, void *vbuf);
64
65 #endif
66
67 #endif
68