pool.h File Reference

A global pool of Buffers. More...

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
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.

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.h.

Function Documentation

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: