nginx/src/core/ngx_palloc.h

   1
   2 /*
   3  * Copyright (C) Igor Sysoev
   4  */
   5
   6
   7 #ifndef _NGX_PALLOC_H_INCLUDED_
   8 #define _NGX_PALLOC_H_INCLUDED_
   9
  10
  11 #include <ngx_config.h>
  12 #include <ngx_core.h>
  13
  14
  15 /*
  16  * NGX_MAX_ALLOC_FROM_POOL should be (ngx_pagesize - 1), i.e. 4095 on x86.
  17  * On Windows NT it decreases a number of locked pages in a kernel.
  18  */
  19 #define NGX_MAX_ALLOC_FROM_POOL  (ngx_pagesize - 1)
  20
  21 #define NGX_DEFAULT_POOL_SIZE    (16 * 1024)
  22 #define NGX_MIN_POOL_SIZE                                                     \
  23     (sizeof(ngx_pool_t) + 2 * sizeof(ngx_pool_large_t))
  24
  25
  26 typedef void (*ngx_pool_cleanup_pt)(void *data);
  27
  28 typedef struct ngx_pool_cleanup_s  ngx_pool_cleanup_t;
  29
  30 struct ngx_pool_cleanup_s {
  31     ngx_pool_cleanup_pt   handler;
  32     void                 *data;
  33     ngx_pool_cleanup_t   *next;
  34 };
  35
  36
  37 typedef struct ngx_pool_large_s  ngx_pool_large_t;
  38
  39 struct ngx_pool_large_s {
  40     ngx_pool_large_t     *next;
  41     void                 *alloc;
  42 };
  43
  44
  45 typedef struct {
  46     u_char               *last;
  47     u_char               *end;
  48     ngx_pool_t           *next;
  49 } ngx_pool_data_t;
  50
  51
  52 struct ngx_pool_s {
  53     ngx_pool_data_t       d;
  54     size_t                max;
  55     ngx_pool_t           *current;
  56     ngx_chain_t          *chain;
  57     ngx_pool_large_t     *large;
  58     ngx_pool_cleanup_t   *cleanup;
  59     ngx_log_t            *log;
  60 };
  61
  62
  63 typedef struct {
  64     ngx_fd_t              fd;
  65     u_char               *name;
  66     ngx_log_t            *log;
  67 } ngx_pool_cleanup_file_t;
  68
  69
  70 void *ngx_alloc(size_t size, ngx_log_t *log);
  71 void *ngx_calloc(size_t size, ngx_log_t *log);
  72
  73 ngx_pool_t *ngx_create_pool(size_t size, ngx_log_t *log);
  74 void ngx_destroy_pool(ngx_pool_t *pool);
  75 void ngx_reset_pool(ngx_pool_t *pool);
  76
  77 void *ngx_palloc(ngx_pool_t *pool, size_t size);
  78 void *ngx_pnalloc(ngx_pool_t *pool, size_t size);
  79 void *ngx_pcalloc(ngx_pool_t *pool, size_t size);
  80 void *ngx_pmemalign(ngx_pool_t *pool, size_t size, size_t alignment);
  81 ngx_int_t ngx_pfree(ngx_pool_t *pool, void *p);
  82
  83
  84 ngx_pool_cleanup_t *ngx_pool_cleanup_add(ngx_pool_t *p, size_t size);
  85 void ngx_pool_cleanup_file(void *data);
  86 void ngx_pool_delete_file(void *data);
  87
  88
  89 #endif /* _NGX_PALLOC_H_INCLUDED_ */