pool.c File Reference

A global pool of Buffers. More...

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

Include dependency graph for pool.c:

Go to the source code of this file.

Functions
static void	pool_increase_size (void)
	Increase the size of the Buffer pool.
void	buf_pool_cleanup (void)
	Release the Buffer pool.
struct Buffer *	buf_pool_get (void)
	Get a Buffer from the pool.
void	buf_pool_release (struct Buffer **ptr)
	Return a Buffer to the pool.

Variables
static size_t	BufferPoolCount = 0
	Number of buffers in the pool.
static size_t	BufferPoolLen = 0
	Total size of the pool.
static const size_t	BufferPoolIncrement = 20
	Amount to increase the size of the pool.
static const size_t	BufferPoolInitialBufferSize = 1024
	Minimum size for a buffer.
static struct Buffer **	BufferPool = NULL
	A pool of buffers.
static size_t	BufferPoolGetCount = 0
	Statistics: total number of buf_pool_get() calls.
static size_t	BufferPoolGivenOut = 0
	Statistics: number of buffers currently given out.
static size_t	BufferPoolMaxGivenOut = 0
	Statistics: maximum number of buffers given out concurrently.

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

pool_increase_size()

static void pool_increase_size ( void )

static

Increase the size of the Buffer pool.

Definition at line 58 of file pool.c.

{
  BufferPoolLen += BufferPoolIncrement;
  mutt_debug(LL_DEBUG1, "%zu\n", BufferPoolLen);
 
  MUTT_MEM_REALLOC(&BufferPool, BufferPoolLen, struct Buffer *);
  while (BufferPoolCount < BufferPoolIncrement)
  {
    struct Buffer *newbuf = buf_new(NULL);
    buf_alloc(newbuf, BufferPoolInitialBufferSize);
    BufferPool[BufferPoolCount++] = newbuf;
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

buf_pool_cleanup()

void buf_pool_cleanup

(

void

)

Release the Buffer pool.

Definition at line 75 of file pool.c.

{
  mutt_debug(LL_DEBUG3, "%zu of %zu returned to pool\n", BufferPoolCount, BufferPoolLen);
  mutt_debug(LL_DEBUG3, "pool stats: %zu gets, %zu max buffers in use\n",
             BufferPoolGetCount, BufferPoolMaxGivenOut);
 
  while (BufferPoolCount)
    buf_free(&BufferPool[--BufferPoolCount]);
  FREE(&BufferPool);
  BufferPoolLen = 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

buf_pool_get()

struct Buffer * buf_pool_get

(

void

)

Get a Buffer from the pool.

Return values

ptr

Buffer

Definition at line 91 of file pool.c.

{
  if (BufferPoolCount == 0)
    pool_increase_size();
  ASSERT(BufferPoolCount > 0);
 
  BufferPoolGetCount++;
  BufferPoolGivenOut++;
  if (BufferPoolGivenOut > BufferPoolMaxGivenOut)
    BufferPoolMaxGivenOut = BufferPoolGivenOut;
 
  return BufferPool[--BufferPoolCount];
}

Here is the call graph for this function:

buf_pool_release()

void buf_pool_release

(

struct Buffer **

ptr

)

Return a Buffer to the pool.

Parameters

[out]

ptr

Buffer to release

Note

The pointer will be NULL'd

Definition at line 111 of file pool.c.

{
  if (!ptr || !*ptr)
    return;
 
  if (BufferPoolGivenOut > 0)
    BufferPoolGivenOut--;
 
  if (BufferPoolCount >= BufferPoolLen)
  {
    // LCOV_EXCL_START
    mutt_debug(LL_DEBUG1, "Internal buffer pool error\n");
    buf_free(ptr);
    return;
    // LCOV_EXCL_STOP
  }
 
  // Reset the size if it's too big or too small
  struct Buffer *buf = *ptr;
  if ((buf->dsize > (2 * BufferPoolInitialBufferSize)) ||
      (buf->dsize < BufferPoolInitialBufferSize))
  {
    buf->dsize = BufferPoolInitialBufferSize;
    MUTT_MEM_REALLOC(&buf->data, buf->dsize, char);
  }
  buf_reset(buf);
  BufferPool[BufferPoolCount++] = buf;
 
  *ptr = NULL;
}

Here is the call graph for this function:

Variable Documentation

BufferPoolCount

size_t BufferPoolCount = 0

static

Number of buffers in the pool.

Definition at line 38 of file pool.c.

BufferPoolLen

size_t BufferPoolLen = 0

static

Total size of the pool.

Definition at line 40 of file pool.c.

BufferPoolIncrement

const size_t BufferPoolIncrement = 20

static

Amount to increase the size of the pool.

Definition at line 42 of file pool.c.

BufferPoolInitialBufferSize

const size_t BufferPoolInitialBufferSize = 1024

static

Minimum size for a buffer.

Definition at line 44 of file pool.c.

BufferPool

struct Buffer** BufferPool = NULL

static

A pool of buffers.

Definition at line 46 of file pool.c.

BufferPoolGetCount

size_t BufferPoolGetCount = 0

static

Statistics: total number of buf_pool_get() calls.

Definition at line 49 of file pool.c.

BufferPoolGivenOut

size_t BufferPoolGivenOut = 0

static

Statistics: number of buffers currently given out.

Definition at line 51 of file pool.c.

BufferPoolMaxGivenOut

size_t BufferPoolMaxGivenOut = 0

static

Statistics: maximum number of buffers given out concurrently.

Definition at line 53 of file pool.c.