17c478bd9Sstevel@tonic-gate #ifndef freelist_h 27c478bd9Sstevel@tonic-gate #define freelist_h 37c478bd9Sstevel@tonic-gate 47c478bd9Sstevel@tonic-gate /* 57c478bd9Sstevel@tonic-gate * Copyright (c) 2000, 2001, 2002, 2003, 2004 by Martin C. Shepherd. 6*1da57d55SToomas Soome * 77c478bd9Sstevel@tonic-gate * All rights reserved. 8*1da57d55SToomas Soome * 97c478bd9Sstevel@tonic-gate * Permission is hereby granted, free of charge, to any person obtaining a 107c478bd9Sstevel@tonic-gate * copy of this software and associated documentation files (the 117c478bd9Sstevel@tonic-gate * "Software"), to deal in the Software without restriction, including 127c478bd9Sstevel@tonic-gate * without limitation the rights to use, copy, modify, merge, publish, 137c478bd9Sstevel@tonic-gate * distribute, and/or sell copies of the Software, and to permit persons 147c478bd9Sstevel@tonic-gate * to whom the Software is furnished to do so, provided that the above 157c478bd9Sstevel@tonic-gate * copyright notice(s) and this permission notice appear in all copies of 167c478bd9Sstevel@tonic-gate * the Software and that both the above copyright notice(s) and this 177c478bd9Sstevel@tonic-gate * permission notice appear in supporting documentation. 18*1da57d55SToomas Soome * 197c478bd9Sstevel@tonic-gate * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS 207c478bd9Sstevel@tonic-gate * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 217c478bd9Sstevel@tonic-gate * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT 227c478bd9Sstevel@tonic-gate * OF THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR 237c478bd9Sstevel@tonic-gate * HOLDERS INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL 247c478bd9Sstevel@tonic-gate * INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING 257c478bd9Sstevel@tonic-gate * FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, 267c478bd9Sstevel@tonic-gate * NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION 277c478bd9Sstevel@tonic-gate * WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 28*1da57d55SToomas Soome * 297c478bd9Sstevel@tonic-gate * Except as contained in this notice, the name of a copyright holder 307c478bd9Sstevel@tonic-gate * shall not be used in advertising or otherwise to promote the sale, use 317c478bd9Sstevel@tonic-gate * or other dealings in this Software without prior written authorization 327c478bd9Sstevel@tonic-gate * of the copyright holder. 337c478bd9Sstevel@tonic-gate */ 347c478bd9Sstevel@tonic-gate 357c478bd9Sstevel@tonic-gate /* 367c478bd9Sstevel@tonic-gate * This module provides a memory allocation scheme that helps to 377c478bd9Sstevel@tonic-gate * prevent memory fragmentation by allocating large blocks of 387c478bd9Sstevel@tonic-gate * fixed sized objects and forming them into a free-list for 397c478bd9Sstevel@tonic-gate * subsequent allocations. The free-list is expanded as needed. 407c478bd9Sstevel@tonic-gate */ 417c478bd9Sstevel@tonic-gate typedef struct FreeList FreeList; 427c478bd9Sstevel@tonic-gate 437c478bd9Sstevel@tonic-gate /* 447c478bd9Sstevel@tonic-gate * Allocate a new free-list from blocks of 'blocking_factor' objects of size 457c478bd9Sstevel@tonic-gate * node_size. The node_size argument should be determined by applying 467c478bd9Sstevel@tonic-gate * the sizeof() operator to the object type that you intend to allocate from 477c478bd9Sstevel@tonic-gate * the freelist. 487c478bd9Sstevel@tonic-gate */ 497c478bd9Sstevel@tonic-gate FreeList *_new_FreeList(size_t node_size, unsigned blocking_factor); 507c478bd9Sstevel@tonic-gate 517c478bd9Sstevel@tonic-gate /* 527c478bd9Sstevel@tonic-gate * If it is known that none of the nodes currently allocated from 537c478bd9Sstevel@tonic-gate * a freelist are still in use, the following function can be called 547c478bd9Sstevel@tonic-gate * to return all nodes to the freelist without the overhead of 557c478bd9Sstevel@tonic-gate * having to call del_FreeListNode() for every allocated node. The 567c478bd9Sstevel@tonic-gate * nodes of the freelist can then be reused by future callers to 577c478bd9Sstevel@tonic-gate * new_FreeListNode(). 587c478bd9Sstevel@tonic-gate */ 597c478bd9Sstevel@tonic-gate void _rst_FreeList(FreeList *fl); 607c478bd9Sstevel@tonic-gate 617c478bd9Sstevel@tonic-gate /* 627c478bd9Sstevel@tonic-gate * Delete a free-list. 637c478bd9Sstevel@tonic-gate */ 647c478bd9Sstevel@tonic-gate FreeList *_del_FreeList(FreeList *fl, int force); 657c478bd9Sstevel@tonic-gate 667c478bd9Sstevel@tonic-gate /* 677c478bd9Sstevel@tonic-gate * Determine the number of nodes that are currently in use. 687c478bd9Sstevel@tonic-gate */ 697c478bd9Sstevel@tonic-gate long _busy_FreeListNodes(FreeList *fl); 707c478bd9Sstevel@tonic-gate 717c478bd9Sstevel@tonic-gate /* 727c478bd9Sstevel@tonic-gate * Query the number of allocated nodes in the freelist which are 737c478bd9Sstevel@tonic-gate * currently unused. 747c478bd9Sstevel@tonic-gate */ 757c478bd9Sstevel@tonic-gate long _idle_FreeListNodes(FreeList *fl); 767c478bd9Sstevel@tonic-gate 777c478bd9Sstevel@tonic-gate /* 787c478bd9Sstevel@tonic-gate * Allocate a new object from a free-list. 797c478bd9Sstevel@tonic-gate */ 807c478bd9Sstevel@tonic-gate void *_new_FreeListNode(FreeList *fl); 817c478bd9Sstevel@tonic-gate 827c478bd9Sstevel@tonic-gate /* 837c478bd9Sstevel@tonic-gate * Return an object to the free-list that it was allocated from. 847c478bd9Sstevel@tonic-gate */ 857c478bd9Sstevel@tonic-gate void *_del_FreeListNode(FreeList *fl, void *object); 867c478bd9Sstevel@tonic-gate 877c478bd9Sstevel@tonic-gate #endif 88