X-Git-Url: http://research.m1stereo.tv/gitweb?a=blobdiff_plain;f=src%2Fframework%2Fmlt_pool.c;h=b708f878272c087e5553420fef3b7d49e4d8e6a9;hb=4fc3fa1bf4116848c423837437d75f103cdd0154;hp=87da0df1273a415f22c4f34842896a2b376c99ba;hpb=f5a438b319b560eccf511ebf3eed5db9edbac1de;p=melted diff --git a/src/framework/mlt_pool.c b/src/framework/mlt_pool.c index 87da0df..b708f87 100644 --- a/src/framework/mlt_pool.c +++ b/src/framework/mlt_pool.c @@ -1,21 +1,24 @@ -/* - * mlt_pool.c -- memory pooling functionality - * Copyright (C) 2003-2004 Ushodaya Enterprises Limited - * Author: Charles Yates +/** + * \file mlt_pool.c + * \brief memory pooling functionality + * \see mlt_pool_s * - * This program is free software; you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation; either version 2 of the License, or - * (at your option) any later version. + * Copyright (C) 2003-2009 Ushodaya Enterprises Limited + * \author Charles Yates * - * This program is distributed in the hope that it will be useful, + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. * - * You should have received a copy of the GNU General Public License - * along with this program; if not, write to the Free Software Foundation, - * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #include "mlt_properties.h" @@ -30,23 +33,25 @@ #include #endif -/** Singleton repositories -*/ +/** global singleton for tracking pools */ static mlt_properties pools = NULL; -/** Private pooling structure. -*/ +/** \brief Pool (memory) class + */ typedef struct mlt_pool_s { - pthread_mutex_t lock; - mlt_deque stack; - int size; - int count; + pthread_mutex_t lock; ///< lock to prevent race conditions + mlt_deque stack; ///< a stack of addresses to memory blocks + int size; ///< the size of the memory block as a power of 2 + int count; ///< the number of blocks in the pool } *mlt_pool; +/** \brief private to mlt_pool_s, for tracking items to release + */ + typedef struct mlt_release_s { mlt_pool pool; @@ -55,7 +60,11 @@ typedef struct mlt_release_s *mlt_release; /** Create a pool. -*/ + * + * \private \memberof mlt_pool_s + * \param size the size of the memory blocks to hold as some power of two + * \return a new pool object + */ static mlt_pool pool_init( int size ) { @@ -80,7 +89,11 @@ static mlt_pool pool_init( int size ) } /** Get an item from the pool. -*/ + * + * \private \memberof mlt_pool_s + * \param this a pool + * \return an opaque pointer + */ static void *pool_fetch( mlt_pool this ) { @@ -137,7 +150,10 @@ static void *pool_fetch( mlt_pool this ) } /** Return an item to the pool. -*/ + * + * \private \memberof mlt_pool_s + * \param ptr an opaque pointer + */ static void pool_return( void *ptr ) { @@ -175,7 +191,10 @@ static void pool_return( void *ptr ) } /** Destroy a pool. -*/ + * + * \private \memberof mlt_pool_s + * \param this a pool + */ static void pool_close( mlt_pool this ) { @@ -202,8 +221,10 @@ static void pool_close( mlt_pool this ) } } -/** Initialise the pool. -*/ +/** Initialise the global pool. + * + * \public \memberof mlt_pool_s + */ void mlt_pool_init( ) { @@ -231,7 +252,10 @@ void mlt_pool_init( ) } /** Allocate size bytes from the pool. -*/ + * + * \public \memberof mlt_pool_s + * \param size the number of bytes + */ void *mlt_pool_alloc( int size ) { @@ -254,7 +278,11 @@ void *mlt_pool_alloc( int size ) } /** Allocate size bytes from the pool. -*/ + * + * \public \memberof mlt_pool_s + * \param ptr an opaque pointer - can be in the pool or a new block to allocate + * \param size the number of bytes + */ void *mlt_pool_realloc( void *ptr, int size ) { @@ -294,8 +322,42 @@ void *mlt_pool_realloc( void *ptr, int size ) return result; } +/** Purge unused items in the pool. + * + * A form of garbage collection. + * \public \memberof mlt_pool_s + */ + +void mlt_pool_purge( ) +{ + int i = 0; + + // For each pool + for ( i = 0; i < mlt_properties_count( pools ); i ++ ) + { + // Get the pool + mlt_pool this = mlt_properties_get_data_at( pools, i, NULL ); + + // Pointer to unused memory + void *release = NULL; + + // Lock the pool + pthread_mutex_lock( &this->lock ); + + // We'll free all unused items now + while ( ( release = mlt_deque_pop_back( this->stack ) ) != NULL ) + free( release - sizeof( struct mlt_release_s ) ); + + // Unlock the pool + pthread_mutex_unlock( &this->lock ); + } +} + /** Release the allocated memory. -*/ + * + * \public \memberof mlt_pool_s + * \param release an opaque pointer of a block in the pool + */ void mlt_pool_release( void *release ) { @@ -304,20 +366,22 @@ void mlt_pool_release( void *release ) } /** Close the pool. -*/ + * + * \public \memberof mlt_pool_s + */ void mlt_pool_close( ) { #ifdef _MLT_POOL_CHECKS_ // Stats dump on close int i = 0; - fprintf( stderr, "Usage:\n\n" ); for ( i = 0; i < mlt_properties_count( pools ); i ++ ) { mlt_pool pool = mlt_properties_get_data_at( pools, i, NULL ); if ( pool->count ) - fprintf( stderr, "%d: allocated %d returned %d %c\n", pool->size, pool->count, mlt_deque_count( pool->stack ), - pool->count != mlt_deque_count( pool->stack ) ? '*' : ' ' ); + mlt_log( NULL, MLT_LOG_DEBUG, "%s: size %d allocated %d returned %d %c\n", __FUNCTION__, + pool->size, pool->count, mlt_deque_count( pool->stack ), + pool->count != mlt_deque_count( pool->stack ) ? '*' : ' ' ); } #endif