NeoMutt  2024-03-23-147-g885fbc
Teaching an old dog new tricks
DOXYGEN
Loading...
Searching...
No Matches
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 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 Bufferbuf_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.
 

Detailed Description

A global pool of Buffers.

Authors
  • Richard Russon

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 50 of file pool.c.

51{
54
55 mutt_mem_realloc(&BufferPool, BufferPoolLen * sizeof(struct Buffer *));
57 {
58 struct Buffer *newbuf = buf_new(NULL);
60 BufferPool[BufferPoolCount++] = newbuf;
61 }
62}
struct Buffer * buf_new(const char *str)
Allocate a new Buffer.
Definition: buffer.c:303
void buf_alloc(struct Buffer *buf, size_t new_size)
Make sure a buffer can store at least new_size bytes.
Definition: buffer.c:336
#define mutt_debug(LEVEL,...)
Definition: logging2.h:89
@ LL_DEBUG1
Log at debug level 1.
Definition: logging2.h:43
void mutt_mem_realloc(void *ptr, size_t size)
Resize a block of memory on the heap.
Definition: memory.c:114
static const size_t BufferPoolInitialBufferSize
Minimum size for a buffer.
Definition: pool.c:43
static const size_t BufferPoolIncrement
Amount to increase the size of the pool.
Definition: pool.c:41
static size_t BufferPoolLen
Total size of the pool.
Definition: pool.c:39
static size_t BufferPoolCount
Number of buffers in the pool.
Definition: pool.c:37
static struct Buffer ** BufferPool
A pool of buffers.
Definition: pool.c:45
String manipulation buffer.
Definition: buffer.h:36
+ 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 67 of file pool.c.

68{
69 mutt_debug(LL_DEBUG1, "%zu of %zu returned to pool\n", BufferPoolCount, BufferPoolLen);
70
71 while (BufferPoolCount)
74 BufferPoolLen = 0;
75}
void buf_free(struct Buffer **ptr)
Deallocates a buffer.
Definition: buffer.c:318
#define FREE(x)
Definition: memory.h:45
+ 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
ptrBuffer

Definition at line 81 of file pool.c.

82{
83 if (BufferPoolCount == 0)
86}
static void pool_increase_size(void)
Increase the size of the Buffer pool.
Definition: pool.c:50
+ 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]ptrBuffer to release
Note
The pointer will be NULL'd

Definition at line 94 of file pool.c.

95{
96 if (!ptr || !*ptr)
97 return;
98
100 {
101 // LCOV_EXCL_START
102 mutt_debug(LL_DEBUG1, "Internal buffer pool error\n");
103 buf_free(ptr);
104 return;
105 // LCOV_EXCL_STOP
106 }
107
108 // Reset the size if it's too big or too small
109 struct Buffer *buf = *ptr;
110 if ((buf->dsize > (2 * BufferPoolInitialBufferSize)) ||
112 {
114 mutt_mem_realloc(&buf->data, buf->dsize);
115 }
116 buf_reset(buf);
118
119 *ptr = NULL;
120}
void buf_reset(struct Buffer *buf)
Reset an existing Buffer.
Definition: buffer.c:75
size_t dsize
Length of data.
Definition: buffer.h:39
char * data
Pointer to data.
Definition: buffer.h:37
+ 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 37 of file pool.c.

◆ BufferPoolLen

size_t BufferPoolLen = 0
static

Total size of the pool.

Definition at line 39 of file pool.c.

◆ BufferPoolIncrement

const size_t BufferPoolIncrement = 20
static

Amount to increase the size of the pool.

Definition at line 41 of file pool.c.

◆ BufferPoolInitialBufferSize

const size_t BufferPoolInitialBufferSize = 1024
static

Minimum size for a buffer.

Definition at line 43 of file pool.c.

◆ BufferPool

struct Buffer** BufferPool = NULL
static

A pool of buffers.

Definition at line 45 of file pool.c.