144 lines
		
	
	
		
			4.4 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
			
		
		
	
	
			144 lines
		
	
	
		
			4.4 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
/*-
 | 
						|
 * Copyright (c) 2006 Thomas Friebel    <tf13@os.inf.tu-dresden.de>
 | 
						|
 * Copyright (c) 2006 Christian Helmuth <ch12@os.inf.tu-dresden.de>
 | 
						|
 * Copyright (c) 2010 Dirk Vogt <dvogt@few.vu.nl>.
 | 
						|
 * 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.
 | 
						|
 *
 | 
						|
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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
 | 
						|
 * COPYRIGHT HOLDERS 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.
 | 
						|
 */
 | 
						|
#ifndef _DDEKIT_MEMORY_H
 | 
						|
#define _DDEKIT_MEMORY_H
 | 
						|
 | 
						|
#include <ddekit/ddekit.h>
 | 
						|
 | 
						|
/*******************
 | 
						|
 ** Slab facility **
 | 
						|
 *******************/
 | 
						|
 | 
						|
struct ddekit_slab;
 | 
						|
 | 
						|
/* Store user pointer in slab cache */
 | 
						|
void ddekit_slab_set_data(struct ddekit_slab * slab, void *data);
 | 
						|
 | 
						|
/* Read user pointer from slab cache */
 | 
						|
void *ddekit_slab_get_data(struct ddekit_slab * slab);
 | 
						|
 | 
						|
/* Allocate slab in slab cache */
 | 
						|
void *ddekit_slab_alloc(struct ddekit_slab * slab);
 | 
						|
 | 
						|
/* Allocate slab in slab cache */
 | 
						|
void ddekit_slab_free(struct ddekit_slab * slab, void *objp);
 | 
						|
 | 
						|
/*
 | 
						|
 * Setup page cache for all slabs
 | 
						|
 *
 | 
						|
 * pages:  maximal number of memory pages
 | 
						|
 *
 | 
						|
 * If 'pages' is too low, memory pages may be given back to the memory server
 | 
						|
 * (dm_phys) and just to be allocated again later. This hits performance (but
 | 
						|
 * saves memory). Increase 'pages' to avoid this thrashing-like effect.
 | 
						|
 *
 | 
						|
 * If the maximal number of unused pages is exceeded, subsequent deallocation
 | 
						|
 * will be freed at the memory server. This page cache caches pages from all
 | 
						|
 * slabs.
 | 
						|
 */
 | 
						|
void ddekit_slab_setup_page_cache(unsigned pages);
 | 
						|
 | 
						|
/*
 | 
						|
 * Destroy slab cache
 | 
						|
 *
 | 
						|
 * slab:  pointer to slab cache structure
 | 
						|
 */
 | 
						|
void ddekit_slab_destroy(struct ddekit_slab * slab);
 | 
						|
 | 
						|
/**
 | 
						|
 * Initialize slab cache
 | 
						|
 *
 | 
						|
 * \param size          size of cache objects
 | 
						|
 * \param contiguous    make this slab use physically contiguous memory
 | 
						|
 *
 | 
						|
 * \return pointer to new slab cache or 0 on error
 | 
						|
 */
 | 
						|
struct ddekit_slab * ddekit_slab_init(unsigned size, int contiguous);
 | 
						|
 | 
						|
 | 
						|
/**********************
 | 
						|
 ** Memory allocator **
 | 
						|
 **********************/
 | 
						|
 | 
						|
/*
 | 
						|
 * Allocate large memory block
 | 
						|
 *
 | 
						|
 * \param size  block size
 | 
						|
 * \return pointer to new memory block
 | 
						|
 *
 | 
						|
 * Allocations via this allocator may be slow (because memory servers are
 | 
						|
 * involved) and should be used only for large (i.e., > page size) blocks. If
 | 
						|
 * allocations/deallocations are relatively dynamic this may not be what you
 | 
						|
 * want.
 | 
						|
 *
 | 
						|
 * Allocated blocks have valid virt->phys mappings and are physically
 | 
						|
 * contiguous.
 | 
						|
 */
 | 
						|
void *ddekit_large_malloc(int size);
 | 
						|
 | 
						|
/**
 | 
						|
 * Free large memory block
 | 
						|
 *
 | 
						|
 * \param p  pointer to memory block
 | 
						|
 */
 | 
						|
void ddekit_large_free(void *p);
 | 
						|
 | 
						|
/** FIXME
 | 
						|
 * contig_malloc() is the lowest-level allocator interface one could implement.
 | 
						|
 * we should consider to provide vmalloc() too. */
 | 
						|
void *ddekit_contig_malloc(unsigned long size, unsigned long low,
 | 
						|
	unsigned long high, unsigned long alignment, unsigned long boundary);
 | 
						|
 | 
						|
 | 
						|
/*****************************
 | 
						|
 ** Simple memory allocator **
 | 
						|
 *****************************/
 | 
						|
 | 
						|
/**
 | 
						|
 * Allocate memory block via simple allocator
 | 
						|
 *
 | 
						|
 * \param size  block size
 | 
						|
 * \return pointer to new memory block
 | 
						|
 *
 | 
						|
 * The blocks allocated via this allocator CANNOT be used for DMA or other
 | 
						|
 * device operations, i.e., there exists no virt->phys mapping.
 | 
						|
 */
 | 
						|
void *ddekit_simple_malloc(unsigned size);
 | 
						|
 | 
						|
/**
 | 
						|
 * Free memory block via simple allocator
 | 
						|
 *
 | 
						|
 * \param p  pointer to memory block
 | 
						|
 */
 | 
						|
void ddekit_simple_free(void *p);
 | 
						|
 | 
						|
#endif
 |