util-pool.h

Go to the documentation of this file.

/* Copyright (C) 2007-2010 Open Information Security Foundation
 *
 * You can copy, redistribute or modify this Program under the terms of
 * the GNU General Public License version 2 as published by the Free
 * Software Foundation.
 *
 * This program 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.
 *
 * You should have received a copy of the GNU General Public License
 * version 2 along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301, USA.
 */
 
/**
 * \ingroup utilpool
 *
 * @{
 */
 
/**
 * \file
 *
 * \author Victor Julien <victor@inliniac.net>
 */
 
#ifndef SURICATA_UTIL_POOL_H
#define SURICATA_UTIL_POOL_H
 
#define POOL_BUCKET_PREALLOCATED    (1 << 0)
 
/* pool bucket structure */
typedef struct PoolBucket_ {
    void *data;
    uint8_t flags;
    struct PoolBucket_ *next;
} PoolBucket;
 
/* pool structure */
typedef struct Pool_ {
    uint32_t max_buckets;
    uint32_t preallocated;
    uint32_t allocated;         /**< counter of data elements, both currently in
                                 *   the pool and outside of it (outstanding) */
 
    uint32_t alloc_stack_size;
 
    PoolBucket *alloc_stack;
 
    PoolBucket *empty_stack;
    uint32_t empty_stack_size;
 
    int data_buffer_size;
    void *data_buffer;
    PoolBucket *pb_buffer;
 
    void *(*Alloc)(void);
    int (*Init)(void *, void *);
    void *InitData;
    void (*Cleanup)(void *);
    void (*Free)(void *);
 
    uint32_t elt_size;
    uint32_t outstanding;       /**< counter of data items 'in use'. Pretty much
                                 *   the diff between PoolGet and PoolReturn */
#ifdef DEBUG
    uint32_t max_outstanding;   /**< max value of outstanding we saw */
#endif
} Pool;
 
/* prototypes */
Pool* PoolInit(uint32_t, uint32_t, uint32_t, void *(*Alloc)(void), int (*Init)(void *, void *), void *, void (*Cleanup)(void *), void (*Free)(void *));
void PoolFree(Pool *);
 
void *PoolGet(Pool *);
void PoolReturn(Pool *, void *);
 
void PoolRegisterTests(void);
 
#endif /* SURICATA_UTIL_POOL_H */
 
/**
 * @}
 */