pool.c File Reference

A global pool of Buffers. More...

#include "config.h"
#include <stdio.h>
#include "pool.h"
#include "buffer.h"
#include "logging.h"
#include "memory.h"

Include dependency graph for pool.c:

Go to the source code of this file.

Functions
static struct Buffer *	buffer_new (void)
	Allocate a new Buffer on the heap. More...
static void	buffer_free (struct Buffer **p)
	Release a Buffer and its contents. More...
static void	increase_buffer_pool (void)
	Increase the size of the Buffer pool. More...
void	mutt_buffer_pool_free (void)
	Release the Buffer pool. More...
struct Buffer *	mutt_buffer_pool_get (void)
	Get a Buffer from the pool. More...
void	mutt_buffer_pool_release (struct Buffer **pbuf)
	Free a Buffer from the pool. More...

Variables
static size_t	BufferPoolCount = 0
static size_t	BufferPoolLen = 0
static size_t	BufferPoolIncrement = 20
static size_t	BufferPoolInitialBufferSize = 1024
static struct Buffer **	BufferPool = NULL

Detailed Description

A global pool of Buffers.

Authors

• Richard Russon

Copyright

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.

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 along with this program. If not, see http://www.gnu.org/licenses/.

Definition in file pool.c.

Function Documentation

buffer_new()

static struct Buffer* buffer_new ( void  )

static

Allocate a new Buffer on the heap.

Return values

buf	A newly allocated Buffer

Note

call buffer_free to release the memory

Definition at line 47 of file pool.c.

{
  struct Buffer *buf = mutt_mem_malloc(sizeof(struct Buffer));
  mutt_buffer_init(buf);
  return buf;
}

Here is the call graph for this function:

Here is the caller graph for this function:

buffer_free()

static void buffer_free ( struct Buffer **  p )

static

Release a Buffer and its contents.

Parameters

[out]

p

Buffer pointer to free and NULL

Definition at line 58 of file pool.c.

{
  if (!p || !*p)
    return;
 
  mutt_buffer_dealloc(*p);
  FREE(p);
}

Here is the call graph for this function:

Here is the caller graph for this function:

increase_buffer_pool()

static void increase_buffer_pool ( void  )

static

Increase the size of the Buffer pool.

Definition at line 70 of file pool.c.

{
  BufferPoolLen += BufferPoolIncrement;
  mutt_debug(LL_DEBUG1, "%zu\n", BufferPoolLen);
 
  mutt_mem_realloc(&BufferPool, BufferPoolLen * sizeof(struct Buffer *));
  while (BufferPoolCount < BufferPoolIncrement)
  {
    struct Buffer *newbuf = buffer_new();
    mutt_buffer_alloc(newbuf, BufferPoolInitialBufferSize);
    BufferPool[BufferPoolCount++] = newbuf;
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_buffer_pool_free()

void mutt_buffer_pool_free

(

void

)

Release the Buffer pool.

Definition at line 87 of file pool.c.

{
  mutt_debug(LL_DEBUG1, "%zu of %zu returned to pool\n", BufferPoolCount, BufferPoolLen);
 
  while (BufferPoolCount)
    buffer_free(&BufferPool[--BufferPoolCount]);
  FREE(&BufferPool);
  BufferPoolLen = 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_buffer_pool_get()

struct Buffer* mutt_buffer_pool_get

(

void

)

Get a Buffer from the pool.

Return values

ptr

Buffer

Definition at line 101 of file pool.c.

{
  if (BufferPoolCount == 0)
    increase_buffer_pool();
  return BufferPool[--BufferPoolCount];
}

Here is the call graph for this function:

mutt_buffer_pool_release()

void mutt_buffer_pool_release

(

struct Buffer **

pbuf

)

Free a Buffer from the pool.

Parameters

[out]

pbuf

Buffer to free

Definition at line 112 of file pool.c.

{
  if (!pbuf || !*pbuf)
    return;
 
  if (BufferPoolCount >= BufferPoolLen)
  {
    mutt_debug(LL_DEBUG1, "Internal buffer pool error\n");
    buffer_free(pbuf);
    return;
  }
 
  struct Buffer *buf = *pbuf;
  if ((buf->dsize > (2 * BufferPoolInitialBufferSize)) ||
      (buf->dsize < BufferPoolInitialBufferSize))
  {
    buf->dsize = BufferPoolInitialBufferSize;
    mutt_mem_realloc(&buf->data, buf->dsize);
  }
  mutt_buffer_reset(buf);
  BufferPool[BufferPoolCount++] = buf;
 
  *pbuf = NULL;
}

Here is the call graph for this function:

Variable Documentation

BufferPoolCount

size_t BufferPoolCount = 0

static

Definition at line 36 of file pool.c.

BufferPoolLen

size_t BufferPoolLen = 0

static

Definition at line 37 of file pool.c.

BufferPoolIncrement

size_t BufferPoolIncrement = 20

static

Definition at line 38 of file pool.c.

BufferPoolInitialBufferSize

size_t BufferPoolInitialBufferSize = 1024

static

Definition at line 39 of file pool.c.

BufferPool

struct Buffer** BufferPool = NULL

static

Definition at line 40 of file pool.c.