PostgreSQL Source Code  git master
resowner.h
Go to the documentation of this file.
1 /*-------------------------------------------------------------------------
2  *
3  * resowner.h
4  * POSTGRES resource owner definitions.
5  *
6  * Query-lifespan resources are tracked by associating them with
7  * ResourceOwner objects. This provides a simple mechanism for ensuring
8  * that such resources are freed at the right time.
9  * See utils/resowner/README for more info.
10  *
11  *
12  * Portions Copyright (c) 1996-2023, PostgreSQL Global Development Group
13  * Portions Copyright (c) 1994, Regents of the University of California
14  *
15  * src/include/utils/resowner.h
16  *
17  *-------------------------------------------------------------------------
18  */
19 #ifndef RESOWNER_H
20 #define RESOWNER_H
21 
22 
23 /*
24  * ResourceOwner objects are an opaque data structure known only within
25  * resowner.c.
26  */
28 
29 
30 /*
31  * Globally known ResourceOwners
32  */
37 
38 /*
39  * Resource releasing is done in three phases: pre-locks, locks, and
40  * post-locks. The pre-lock phase must release any resources that are
41  * visible to other backends (such as pinned buffers); this ensures that
42  * when we release a lock that another backend may be waiting on, it will
43  * see us as being fully out of our transaction. The post-lock phase
44  * should be used for backend-internal cleanup.
45  */
46 typedef enum
47 {
52 
53 /*
54  * Dynamically loaded modules can get control during ResourceOwnerRelease
55  * by providing a callback of this form.
56  */
58  bool isCommit,
59  bool isTopLevel,
60  void *arg);
61 
62 
63 /*
64  * Functions in resowner.c
65  */
66 
67 /* generic routines */
69  const char *name);
70 extern void ResourceOwnerRelease(ResourceOwner owner,
72  bool isCommit,
73  bool isTopLevel);
75 extern void ResourceOwnerDelete(ResourceOwner owner);
77 extern void ResourceOwnerNewParent(ResourceOwner owner,
78  ResourceOwner newparent);
80  void *arg);
82  void *arg);
83 extern void CreateAuxProcessResourceOwner(void);
84 extern void ReleaseAuxProcessResources(bool isCommit);
85 
86 #endif /* RESOWNER_H */
#define PGDLLIMPORT
Definition: c.h:1303
const char * name
Definition: encode.c:571
void * arg
void ResourceOwnerNewParent(ResourceOwner owner, ResourceOwner newparent)
Definition: resowner.c:806
PGDLLIMPORT ResourceOwner TopTransactionResourceOwner
Definition: resowner.c:148
void UnregisterResourceReleaseCallback(ResourceReleaseCallback callback, void *arg)
Definition: resowner.c:868
ResourceOwner ResourceOwnerCreate(ResourceOwner parent, const char *name)
Definition: resowner.c:428
void ReleaseAuxProcessResources(bool isCommit)
Definition: resowner.c:912
ResourceOwner ResourceOwnerGetParent(ResourceOwner owner)
Definition: resowner.c:797
ResourceReleasePhase
Definition: resowner.h:47
@ RESOURCE_RELEASE_LOCKS
Definition: resowner.h:49
@ RESOURCE_RELEASE_BEFORE_LOCKS
Definition: resowner.h:48
@ RESOURCE_RELEASE_AFTER_LOCKS
Definition: resowner.h:50
PGDLLIMPORT ResourceOwner AuxProcessResourceOwner
Definition: resowner.c:149
void CreateAuxProcessResourceOwner(void)
Definition: resowner.c:892
void ResourceOwnerRelease(ResourceOwner owner, ResourceReleasePhase phase, bool isCommit, bool isTopLevel)
Definition: resowner.c:486
PGDLLIMPORT ResourceOwner CurTransactionResourceOwner
Definition: resowner.c:147
void RegisterResourceReleaseCallback(ResourceReleaseCallback callback, void *arg)
Definition: resowner.c:854
void ResourceOwnerDelete(ResourceOwner owner)
Definition: resowner.c:742
void ResourceOwnerReleaseAllPlanCacheRefs(ResourceOwner owner)
Definition: resowner.c:723
PGDLLIMPORT ResourceOwner CurrentResourceOwner
Definition: resowner.c:146
struct ResourceOwnerData * ResourceOwner
Definition: resowner.h:27
void(* ResourceReleaseCallback)(ResourceReleasePhase phase, bool isCommit, bool isTopLevel, void *arg)
Definition: resowner.h:57
ResourceOwner parent
Definition: resowner.c:117
static void callback(struct sockaddr *addr, struct sockaddr *mask, void *unused)
Definition: test_ifaddrs.c:46