Stop exporting from libc the <mpool.h> and the mpool_* API

ports scan by sthen@
author: guenther <> 2015-09-09 15:35:24 +0000
committer: guenther <> 2015-09-09 15:35:24 +0000
commit: 1a1ff861f294119b12656e27a1f1381427fe92f5 (patch)
tree: a2fe59d784590858f164d5192347a23a84aeea64 /src/lib/libc/include
parent: 2c18a6f4d09c01f7d9827c8868326f2e32148d48 (diff)
download: openbsd-1a1ff861f294119b12656e27a1f1381427fe92f5.tar.gz
openbsd-1a1ff861f294119b12656e27a1f1381427fe92f5.tar.bz2
openbsd-1a1ff861f294119b12656e27a1f1381427fe92f5.zip
1 files changed, 122 insertions, 0 deletions
diff --git a/src/lib/libc/include/mpool.h b/src/lib/libc/include/mpool.h
new file mode 100644
index 0000000000..005b006d17
--- /dev/null
+++ b/src/lib/libc/include/mpool.h
@@ -0,0 +1,122 @@
+/*      $OpenBSD: mpool.h,v 1.1 2015/09/09 15:35:24 guenther Exp $      */
+/*      $NetBSD: mpool.h,v 1.7 1996/05/03 21:13:41 cgd Exp $    */
+/*-
+ * Copyright (c) 1991, 1993, 1994
+ *      The Regents of the University of California.  All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ * 3. Neither the name of the University nor the names of its contributors
+ *    may be used to endorse or promote products derived from this software
+ *    without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+ * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+ * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ *
+ *      @(#)mpool.h     8.4 (Berkeley) 11/2/95
+ */
+#ifndef _MPOOL_H_ 
+#define _MPOOL_H_
+#include <sys/queue.h>
+/*
+ * The memory pool scheme is a simple one.  Each in-memory page is referenced
+ * by a bucket which is threaded in up to two of three ways.  All active pages
+ * are threaded on a hash chain (hashed by page number) and an lru chain.
+ * Inactive pages are threaded on a free chain.  Each reference to a memory
+ * pool is handed an opaque MPOOL cookie which stores all of this information.
+ */
+#define HASHSIZE        128
+#define HASHKEY(pgno)   ((pgno - 1 + HASHSIZE) % HASHSIZE)
+/* The BKT structures are the elements of the queues. */
+typedef struct _bkt {
+        TAILQ_ENTRY(_bkt) hq;           /* hash queue */
+        TAILQ_ENTRY(_bkt) q;            /* lru queue */
+        void    *page;                  /* page */
+        pgno_t   pgno;                  /* page number */
+#define MPOOL_DIRTY     0x01            /* page needs to be written */
+#define MPOOL_PINNED    0x02            /* page is pinned into memory */
+#define MPOOL_INUSE     0x04            /* page address is valid */
+        u_int8_t flags;                 /* flags */
+} BKT;
+typedef struct MPOOL {
+        TAILQ_HEAD(_lqh, _bkt) lqh;     /* lru queue head */
+                                        /* hash queue array */
+        TAILQ_HEAD(_hqh, _bkt) hqh[HASHSIZE];
+        pgno_t  curcache;               /* current number of cached pages */
+        pgno_t  maxcache;               /* max number of cached pages */
+        pgno_t  npages;                 /* number of pages in the file */
+        unsigned long   pagesize;       /* file page size */
+        int     fd;                     /* file descriptor */
+                                        /* page in conversion routine */
+        void    (*pgin)(void *, pgno_t, void *);
+                                        /* page out conversion routine */
+        void    (*pgout)(void *, pgno_t, void *);
+        void    *pgcookie;              /* cookie for page in/out routines */
+#ifdef STATISTICS
+        unsigned long   cachehit;
+        unsigned long   cachemiss;
+        unsigned long   pagealloc;
+        unsigned long   pageflush;
+        unsigned long   pageget;
+        unsigned long   pagenew;
+        unsigned long   pageput;
+        unsigned long   pageread;
+        unsigned long   pagewrite;
+#endif
+} MPOOL;
+#define MPOOL_IGNOREPIN 0x01            /* Ignore if the page is pinned. */
+#define MPOOL_PAGE_REQUEST      0x01    /* Allocate a new page with a
+                                           specific page number. */
+#define MPOOL_PAGE_NEXT         0x02    /* Allocate a new page with the next
+                                          page number. */
+__BEGIN_HIDDEN_DECLS
+MPOOL   *mpool_open(void *, int, pgno_t, pgno_t);
+void     mpool_filter(MPOOL *, void (*)(void *, pgno_t, void *),
+            void (*)(void *, pgno_t, void *), void *);
+void    *mpool_new(MPOOL *, pgno_t *, unsigned int);
+void    *mpool_get(MPOOL *, pgno_t, unsigned int);
+int      mpool_delete(MPOOL *, void *);
+int      mpool_put(MPOOL *, void *, unsigned int);
+int      mpool_sync(MPOOL *);
+int      mpool_close(MPOOL *);
+PROTO_NORMAL(mpool_open);
+PROTO_NORMAL(mpool_filter);
+PROTO_NORMAL(mpool_new);
+PROTO_NORMAL(mpool_get);
+PROTO_NORMAL(mpool_delete);
+PROTO_NORMAL(mpool_put);
+PROTO_NORMAL(mpool_sync);
+PROTO_NORMAL(mpool_close);
+#ifdef STATISTICS
+void     mpool_stat(MPOOL *);
+PROTO_NORMAL(mpool_stat);
+#endif
+__END_HIDDEN_DECLS
+#endif
author	guenther <>	2015-09-09 15:35:24 +0000
committer	guenther <>	2015-09-09 15:35:24 +0000
commit	1a1ff861f294119b12656e27a1f1381427fe92f5 (patch)
tree	a2fe59d784590858f164d5192347a23a84aeea64 /src/lib/libc/include
parent	2c18a6f4d09c01f7d9827c8868326f2e32148d48 (diff)
download	openbsd-1a1ff861f294119b12656e27a1f1381427fe92f5.tar.gz openbsd-1a1ff861f294119b12656e27a1f1381427fe92f5.tar.bz2 openbsd-1a1ff861f294119b12656e27a1f1381427fe92f5.zip

diff --git a/src/lib/libc/include/mpool.h b/src/lib/libc/include/mpool.h new file mode 100644 index 0000000000..005b006d17 --- /dev/null +++ b/src/lib/libc/include/mpool.h
@@ -0,0 +1,122 @@
	1	/* $OpenBSD: mpool.h,v 1.1 2015/09/09 15:35:24 guenther Exp $ */
	2	/* $NetBSD: mpool.h,v 1.7 1996/05/03 21:13:41 cgd Exp $ */
	3
	4	/*-
	5	* Copyright (c) 1991, 1993, 1994
	6	* The Regents of the University of California. All rights reserved.
	7	*
	8	* Redistribution and use in source and binary forms, with or without
	9	* modification, are permitted provided that the following conditions
	10	* are met:
	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 the
	15	* documentation and/or other materials provided with the distribution.
	16	* 3. Neither the name of the University nor the names of its contributors
	17	* may be used to endorse or promote products derived from this software
	18	* without specific prior written permission.
	19	*
	20	* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	21	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	22	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	23	* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	24	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	25	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	26	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	27	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	28	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	29	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	30	* SUCH DAMAGE.
	31	*
	32	* @(#)mpool.h 8.4 (Berkeley) 11/2/95
	33	*/
	34
	35	#ifndef _MPOOL_H_
	36	#define _MPOOL_H_
	37
	38	#include <sys/queue.h>
	39
	40	/*
	41	* The memory pool scheme is a simple one. Each in-memory page is referenced
	42	* by a bucket which is threaded in up to two of three ways. All active pages
	43	* are threaded on a hash chain (hashed by page number) and an lru chain.
	44	* Inactive pages are threaded on a free chain. Each reference to a memory
	45	* pool is handed an opaque MPOOL cookie which stores all of this information.
	46	*/
	47	#define HASHSIZE 128
	48	#define HASHKEY(pgno) ((pgno - 1 + HASHSIZE) % HASHSIZE)
	49
	50	/* The BKT structures are the elements of the queues. */
	51	typedef struct _bkt {
	52	TAILQ_ENTRY(_bkt) hq; /* hash queue */
	53	TAILQ_ENTRY(_bkt) q; /* lru queue */
	54	void page; / page */
	55	pgno_t pgno; /* page number */
	56
	57	#define MPOOL_DIRTY 0x01 /* page needs to be written */
	58	#define MPOOL_PINNED 0x02 /* page is pinned into memory */
	59	#define MPOOL_INUSE 0x04 /* page address is valid */
	60	u_int8_t flags; /* flags */
	61	} BKT;
	62
	63	typedef struct MPOOL {
	64	TAILQ_HEAD(_lqh, _bkt) lqh; /* lru queue head */
	65	/* hash queue array */
	66	TAILQ_HEAD(_hqh, _bkt) hqh[HASHSIZE];
	67	pgno_t curcache; /* current number of cached pages */
	68	pgno_t maxcache; /* max number of cached pages */
	69	pgno_t npages; /* number of pages in the file */
	70	unsigned long pagesize; /* file page size */
	71	int fd; /* file descriptor */
	72	/* page in conversion routine */
	73	void (pgin)(void , pgno_t, void *);
	74	/* page out conversion routine */
	75	void (pgout)(void , pgno_t, void *);
	76	void pgcookie; / cookie for page in/out routines */
	77	#ifdef STATISTICS
	78	unsigned long cachehit;
	79	unsigned long cachemiss;
	80	unsigned long pagealloc;
	81	unsigned long pageflush;
	82	unsigned long pageget;
	83	unsigned long pagenew;
	84	unsigned long pageput;
	85	unsigned long pageread;
	86	unsigned long pagewrite;
	87	#endif
	88	} MPOOL;
	89
	90	#define MPOOL_IGNOREPIN 0x01 /* Ignore if the page is pinned. */
	91	#define MPOOL_PAGE_REQUEST 0x01 /* Allocate a new page with a
	92	specific page number. */
	93	#define MPOOL_PAGE_NEXT 0x02 /* Allocate a new page with the next
	94	page number. */
	95
	96	__BEGIN_HIDDEN_DECLS
	97	MPOOL mpool_open(void , int, pgno_t, pgno_t);
	98	void mpool_filter(MPOOL , void ()(void , pgno_t, void ),
	99	void ()(void , pgno_t, void ), void );
	100	void mpool_new(MPOOL , pgno_t *, unsigned int);
	101	void mpool_get(MPOOL , pgno_t, unsigned int);
	102	int mpool_delete(MPOOL , void );
	103	int mpool_put(MPOOL , void , unsigned int);
	104	int mpool_sync(MPOOL *);
	105	int mpool_close(MPOOL *);
	106
	107	PROTO_NORMAL(mpool_open);
	108	PROTO_NORMAL(mpool_filter);
	109	PROTO_NORMAL(mpool_new);
	110	PROTO_NORMAL(mpool_get);
	111	PROTO_NORMAL(mpool_delete);
	112	PROTO_NORMAL(mpool_put);
	113	PROTO_NORMAL(mpool_sync);
	114	PROTO_NORMAL(mpool_close);
	115
	116	#ifdef STATISTICS
	117	void mpool_stat(MPOOL *);
	118	PROTO_NORMAL(mpool_stat);
	119	#endif
	120	__END_HIDDEN_DECLS
	121
	122	#endif