NeoMutt  2020-11-20
Teaching an old dog new tricks
 		DOXYGEN
pool.c
Go to the documentation of this file.
1 
29 #include "config.h"
30 #include <stdio.h>
31 #include "pool.h"
32 #include "buffer.h"
33 #include "logging.h"
34 #include "memory.h"
35 
36 static size_t BufferPoolCount = 0;
37 static size_t BufferPoolLen = 0;
38 static size_t BufferPoolIncrement = 20;
39 static size_t BufferPoolInitialBufferSize = 1024;
40 static struct Buffer **BufferPool = NULL;
41 
47 static struct Buffer *buffer_new(void)
48 {
49  struct Buffer *buf = mutt_mem_malloc(sizeof(struct Buffer));
50  mutt_buffer_init(buf);
51  return buf;
52 }
53 
58 static void buffer_free(struct Buffer **p)
59 {
60  if (!p || !*p)
61  return;
62 
63  mutt_buffer_dealloc(*p);
64  FREE(p);
65 }
66 
70 static void increase_buffer_pool(void)
71 {
72  BufferPoolLen += BufferPoolIncrement;
73  mutt_debug(LL_DEBUG1, "%zu\n", BufferPoolLen);
74 
75  mutt_mem_realloc(&BufferPool, BufferPoolLen * sizeof(struct Buffer *));
76  while (BufferPoolCount < BufferPoolIncrement)
77  {
78  struct Buffer *newbuf = buffer_new();
79  mutt_buffer_alloc(newbuf, BufferPoolInitialBufferSize);
80  BufferPool[BufferPoolCount++] = newbuf;
81  }
82 }
83 
87 void mutt_buffer_pool_free(void)
88 {
89  mutt_debug(LL_DEBUG1, "%zu of %zu returned to pool\n", BufferPoolCount, BufferPoolLen);
90 
91  while (BufferPoolCount)
92  buffer_free(&BufferPool[--BufferPoolCount]);
93  FREE(&BufferPool);
94  BufferPoolLen = 0;
95 }
96 
101 struct Buffer *mutt_buffer_pool_get(void)
102 {
103  if (BufferPoolCount == 0)
104  increase_buffer_pool();
105  return BufferPool[--BufferPoolCount];
106 }
107 
112 void mutt_buffer_pool_release(struct Buffer **pbuf)
113 {
114  if (!pbuf || !*pbuf)
115  return;
116 
117  if (BufferPoolCount >= BufferPoolLen)
118  {
119  mutt_debug(LL_DEBUG1, "Internal buffer pool error\n");
120  buffer_free(pbuf);
121  return;
122  }
123 
124  struct Buffer *buf = *pbuf;
125  if ((buf->dsize > (2 * BufferPoolInitialBufferSize)) ||
126  (buf->dsize < BufferPoolInitialBufferSize))
127  {
128  buf->dsize = BufferPoolInitialBufferSize;
129  mutt_mem_realloc(&buf->data, buf->dsize);
130  }
131  mutt_buffer_reset(buf);
132  BufferPool[BufferPoolCount++] = buf;
133 
134  *pbuf = NULL;
135 }
BufferPoolIncrement
static size_t BufferPoolIncrement
Definition: pool.c:38
mutt_buffer_reset
void mutt_buffer_reset(struct Buffer *buf)
Reset an existing Buffer.
Definition: buffer.c:79
mutt_buffer_pool_get
struct Buffer * mutt_buffer_pool_get(void)
Get a Buffer from the pool.
Definition: pool.c:101
memory.h
Memory management wrappers.
increase_buffer_pool
static void increase_buffer_pool(void)
Increase the size of the Buffer pool.
Definition: pool.c:70
pool.h
A global pool of Buffers.
mutt_buffer_pool_release
void mutt_buffer_pool_release(struct Buffer **pbuf)
Free a Buffer from the pool.
Definition: pool.c:112
Buffer
String manipulation buffer.
Definition: buffer.h:33
logging.h
Logging Dispatcher.
Buffer::dsize
size_t dsize
Length of data.
Definition: buffer.h:37
mutt_buffer_dealloc
void mutt_buffer_dealloc(struct Buffer *buf)
Release the memory allocated by a buffer.
Definition: buffer.c:294
mutt_mem_realloc
void mutt_mem_realloc(void *ptr, size_t size)
Resize a block of memory on the heap.
Definition: memory.c:114
mutt_mem_malloc
void * mutt_mem_malloc(size_t size)
Allocate memory on the heap.
Definition: memory.c:90
Buffer::data
char * data
Pointer to data.
Definition: buffer.h:35
buffer_new
static struct Buffer * buffer_new(void)
Allocate a new Buffer on the heap.
Definition: pool.c:47
BufferPoolLen
static size_t BufferPoolLen
Definition: pool.c:37
buffer.h
General purpose object for storing and parsing strings.
LL_DEBUG1
Log at debug level 1.
Definition: logging.h:40
BufferPoolInitialBufferSize
static size_t BufferPoolInitialBufferSize
Definition: pool.c:39
FREE
#define FREE(x)
Definition: memory.h:40
mutt_debug
#define mutt_debug(LEVEL,...)
Definition: logging.h:81
mutt_buffer_init
struct Buffer * mutt_buffer_init(struct Buffer *buf)
Initialise a new Buffer.
Definition: buffer.c:46
mutt_buffer_pool_free
void mutt_buffer_pool_free(void)
Release the Buffer pool.
Definition: pool.c:87
pbuf
static unsigned char * pbuf
Cache PGP data packet.
Definition: pgppacket.c:38
BufferPoolCount
static size_t BufferPoolCount
Definition: pool.c:36
buffer_free
static void buffer_free(struct Buffer **p)
Release a Buffer and its contents.
Definition: pool.c:58
mutt_buffer_alloc
void mutt_buffer_alloc(struct Buffer *buf, size_t new_size)
Make sure a buffer can store at least new_size bytes.
Definition: buffer.c:265