PostgreSQL Source Code  git master
memnodes.h
Go to the documentation of this file.
1 /*-------------------------------------------------------------------------
2  *
3  * memnodes.h
4  * POSTGRES memory context node definitions.
5  *
6  *
7  * Portions Copyright (c) 1996-2023, PostgreSQL Global Development Group
8  * Portions Copyright (c) 1994, Regents of the University of California
9  *
10  * src/include/nodes/memnodes.h
11  *
12  *-------------------------------------------------------------------------
13  */
14 #ifndef MEMNODES_H
15 #define MEMNODES_H
16 
17 #include "nodes/nodes.h"
18 
19 /*
20  * MemoryContextCounters
21  * Summarization state for MemoryContextStats collection.
22  *
23  * The set of counters in this struct is biased towards AllocSet; if we ever
24  * add any context types that are based on fundamentally different approaches,
25  * we might need more or different counters here. A possible API spec then
26  * would be to print only nonzero counters, but for now we just summarize in
27  * the format historically used by AllocSet.
28  */
29 typedef struct MemoryContextCounters
30 {
31  Size nblocks; /* Total number of malloc blocks */
32  Size freechunks; /* Total number of free chunks */
33  Size totalspace; /* Total bytes requested from malloc */
34  Size freespace; /* The unused portion of totalspace */
36 
37 /*
38  * MemoryContext
39  * A logical context in which memory allocations occur.
40  *
41  * MemoryContext itself is an abstract type that can have multiple
42  * implementations.
43  * The function pointers in MemoryContextMethods define one specific
44  * implementation of MemoryContext --- they are a virtual function table
45  * in C++ terms.
46  *
47  * Node types that are actual implementations of memory contexts must
48  * begin with the same fields as MemoryContextData.
49  *
50  * Note: for largely historical reasons, typedef MemoryContext is a pointer
51  * to the context struct rather than the struct type itself.
52  */
53 
54 typedef void (*MemoryStatsPrintFunc) (MemoryContext context, void *passthru,
55  const char *stats_string,
56  bool print_to_stderr);
57 
58 typedef struct MemoryContextMethods
59 {
60  void *(*alloc) (MemoryContext context, Size size);
61  /* call this free_p in case someone #define's free() */
62  void (*free_p) (void *pointer);
63  void *(*realloc) (void *pointer, Size size);
64  void (*reset) (MemoryContext context);
65  void (*delete_context) (MemoryContext context);
66  MemoryContext (*get_chunk_context) (void *pointer);
67  Size (*get_chunk_space) (void *pointer);
68  bool (*is_empty) (MemoryContext context);
69  void (*stats) (MemoryContext context,
70  MemoryStatsPrintFunc printfunc, void *passthru,
71  MemoryContextCounters *totals,
72  bool print_to_stderr);
73 #ifdef MEMORY_CONTEXT_CHECKING
74  void (*check) (MemoryContext context);
75 #endif
77 
78 
79 typedef struct MemoryContextData
80 {
81  pg_node_attr(abstract) /* there are no nodes of this type */
82 
83  NodeTag type; /* identifies exact kind of context */
84  /* these two fields are placed here to minimize alignment wastage: */
85  bool isReset; /* T = no space alloced since last reset */
86  bool allowInCritSection; /* allow palloc in critical section */
87  Size mem_allocated; /* track memory allocated for this context */
88  const MemoryContextMethods *methods; /* virtual function table */
89  MemoryContext parent; /* NULL if no parent (toplevel context) */
90  MemoryContext firstchild; /* head of linked list of children */
91  MemoryContext prevchild; /* previous child of same parent */
92  MemoryContext nextchild; /* next child of same parent */
93  const char *name; /* context name (just for debugging) */
94  const char *ident; /* context ID if any (just for debugging) */
95  MemoryContextCallback *reset_cbs; /* list of reset/delete callbacks */
97 
98 /* utils/palloc.h contains typedef struct MemoryContextData *MemoryContext */
99 
100 
101 /*
102  * MemoryContextIsValid
103  * True iff memory context is valid.
104  *
105  * Add new context types to the set accepted by this macro.
106  */
107 #define MemoryContextIsValid(context) \
108  ((context) != NULL && \
109  (IsA((context), AllocSetContext) || \
110  IsA((context), SlabContext) || \
111  IsA((context), GenerationContext)))
112 
113 #endif /* MEMNODES_H */
unsigned char bool
Definition: c.h:445
size_t Size
Definition: c.h:594
void(* MemoryStatsPrintFunc)(MemoryContext context, void *passthru, const char *stats_string, bool print_to_stderr)
Definition: memnodes.h:54
struct MemoryContextMethods MemoryContextMethods
struct MemoryContextCounters MemoryContextCounters
NodeTag
Definition: nodes.h:27
struct MemoryContextData * MemoryContext
Definition: palloc.h:36
MemoryContext prevchild
Definition: memnodes.h:91
MemoryContext firstchild
Definition: memnodes.h:90
bool allowInCritSection
Definition: memnodes.h:86
const char * ident
Definition: memnodes.h:94
MemoryContext parent
Definition: memnodes.h:89
MemoryContextCallback * reset_cbs
Definition: memnodes.h:95
const MemoryContextMethods * methods
Definition: memnodes.h:88
MemoryContext nextchild
Definition: memnodes.h:92
Size mem_allocated
Definition: memnodes.h:87
pg_node_attr(abstract) NodeTag type
const char * name
Definition: memnodes.h:93
void(* delete_context)(MemoryContext context)
Definition: memnodes.h:65
void(* stats)(MemoryContext context, MemoryStatsPrintFunc printfunc, void *passthru, MemoryContextCounters *totals, bool print_to_stderr)
Definition: memnodes.h:69
void(* free_p)(void *pointer)
Definition: memnodes.h:62
bool(* is_empty)(MemoryContext context)
Definition: memnodes.h:68
void(* reset)(MemoryContext context)
Definition: memnodes.h:64
MemoryContext(* get_chunk_context)(void *pointer)
Definition: memnodes.h:66
Size(* get_chunk_space)(void *pointer)
Definition: memnodes.h:67
const char * type