pgagroal use a process model (fork()), where each process handles one connection to PostgreSQL.
This was done such a potential crash on one connection won't take the entire pool down.
The main process is defined in main.c. When a client connects it is processed in its own process, which is handle in worker.h (worker.c).
Once the client disconnects the connection is put back in the pool, and the child process is terminated.
A memory segment (shmem.h) is shared among all processes which contains the pgagroal state containing the configuration of the pool, the list of servers and the state of each connection.
The configuration of pgagroal (struct configuration), the configuration of the servers (struct server) and
the state of each connection (struct connection) is initialized in this shared memory segment.
These structs are all defined in pgagroal.h.
The shared memory segment is created using the mmap() call.
The atomic operation library is used to define the state of each of the connection, and move them around in the connection state diagram. The state diagram has the follow states
| State name | Description |
|---|---|
STATE_NOTINIT |
The connection has not been initialized |
STATE_INIT |
The connection is being initialized |
STATE_FREE |
The connection is free |
STATE_IN_USE |
The connection is in use |
STATE_GRACEFULLY |
The connection will be killed upon return to the pool |
STATE_FLUSH |
The connection is being flushed |
STATE_IDLE_CHECK |
The connection is being idle timeout checked |
STATE_MAX_CONNECTION_AGE |
The connection is being max connection age checked |
STATE_VALIDATION |
The connection is being validated |
STATE_REMOVE |
The connection is being removed |
These state are defined in pgagroal.h.
The pgagroal pool API is defined in pool.h (pool.c).
This API defines the functionality of the pool such as getting a connection from the pool, and returning it. There is no ordering among processes, so a newly created process can obtain a connection before an older process.
The pool operates on the struct connection data type defined in pgagroal.h.
All communication is abstracted using the struct message data type defined in message.h.
Reading and writing messages are handled in the message.h (message.c) files.
Network operations are defined in network.h (network.c).
Each process uses a fixed memory block for its network communication, which is allocated upon startup of the worker.
That way we don't have to allocate memory for each network message, and more importantly free it after end of use.
The memory interface is defined in memory.h (memory.c).
pgagroal has a management interface which defines the administrator abilities that can be performed when it is running.
This include for example taking a backup. The pgagroal-cli program is used for these operations (cli.c).
The management interface is defined in management.h. The management interface uses its own protocol which uses JSON as its foundation.
The client sends a single JSON string to the server,
| Field | Type | Description |
|---|---|---|
compression |
uint8 | The compression type |
encryption |
uint8 | The encryption type |
length |
uint32 | The length of the JSON document |
json |
String | The JSON document |
The server sends a single JSON string to the client,
| Field | Type | Description |
|---|---|---|
compression |
uint8 | The compression type |
encryption |
uint8 | The encryption type |
length |
uint32 | The length of the JSON document |
json |
String | The JSON document |
The server sends a single JSON string to the client,
| Field | Type | Description |
|---|---|---|
compression |
uint8 | The compression type |
encryption |
uint8 | The encryption type |
length |
uint32 | The length of the JSON document |
json |
String | The JSON document |
The client sends to the server a single JSON documents,
| Field | Type | Description |
|---|---|---|
compression |
uint8 | The compression type |
encryption |
uint8 | The encryption type |
length |
uint32 | The length of the JSON document |
json |
String | The JSON document |
The remote management functionality uses the same protocol as the standard management method.
However, before the management packet is sent the client has to authenticate using SCRAM-SHA-256 using the same message format that PostgreSQL uses, e.g. StartupMessage, AuthenticationSASL, AuthenticationSASLContinue, AuthenticationSASLFinal and AuthenticationOk. The SSLRequest message is supported.
The remote management interface is defined in remote.h (remote.c).
libev is used to handle network interactions, which is "activated"
upon an EV_READ event.
Each process has its own event loop, such that the process only gets notified when data related only to that process is ready. The main loop handles the system wide "services" such as idle timeout checks and so on.
pgagroal has the concept of a pipeline that defines how communication is routed from the client through pgagroal to PostgreSQL. Likewise in the other direction.
A pipeline is defined by
struct pipeline
{
initialize initialize;
start start;
callback client;
callback server;
stop stop;
destroy destroy;
periodic periodic;
};in pipeline.h.
The functions in the pipeline are defined as
| Function | Description |
|---|---|
initialize |
Global initialization of the pipeline, may return a pointer to a shared memory segment |
start |
Called when the pipeline instance is started |
client |
Client to pgagroal communication |
server |
PostgreSQL to pgagroal communication |
stop |
Called when the pipeline instance is stopped |
destroy |
Global destruction of the pipeline |
periodic |
Called periodic |
The functions start, client, server and stop has access to the following information
struct worker_io
{
struct ev_io io; /* The libev base type */
int client_fd; /* The client descriptor */
int server_fd; /* The server descriptor */
int slot; /* The slot */
SSL* client_ssl; /* The client SSL context */
SSL* server_ssl; /* The server SSL context */
};defined in worker.h.
One of the goals for pgagroal is performance, so the performance pipeline will only look for the
Terminate message from the client and act on that.
Likewise the performance pipeline will only look for FATAL errors from the server. This makes the pipeline very fast, since there
is a minimum overhead in the interaction.
The pipeline is defined in pipeline_perf.c in the functions
| Function | Description |
|---|---|
performance_initialize |
Nothing |
performance_start |
Nothing |
performance_client |
Client to pgagroal communication |
performance_server |
PostgreSQL to pgagroal communication |
performance_stop |
Nothing |
performance_destroy |
Nothing |
performance_periodic |
Nothing |
The session pipeline works like the performance pipeline with the exception that it checks if a Transport Layer Security (TLS) transport should be used.
The pipeline is defined in pipeline_session.c in the functions
| Function | Description |
|---|---|
session_initialize |
Initialize memory segment if disconnect_client is active |
session_start |
Prepares the client segment if disconnect_client is active |
session_client |
Client to pgagroal communication |
session_server |
PostgreSQL to pgagroal communication |
session_stop |
Updates the client segment if disconnect_client is active |
session_destroy |
Destroys memory segment if initialized |
session_periodic |
Checks if clients should be disconnected |
The transaction pipeline will return the connection to the server after each transaction. The pipeline supports Transport Layer Security (TLS).
The pipeline uses the ReadyForQuery message to check the status of the transaction, and therefore needs to maintain track of the message headers.
The pipeline has a management interface in order to receive the socket descriptors from the parent process when a new connection is added to the pool. The pool will retry if the client in question doesn't consider the socket descriptor valid.
The pipeline is defined in pipeline_transaction.c in the functions
| Function | Description |
|---|---|
transaction_initialize |
Nothing |
transaction_start |
Setup process variables and returns the connection to the pool |
transaction_client |
Client to pgagroal communication. Obtain connection if needed |
transaction_server |
PostgreSQL to pgagroal communication. Keep track of message headers |
transaction_stop |
Return connection to the pool if needed. Possible rollback of active transaction |
transaction_destroy |
Nothing |
transaction_periodic |
Nothing |
The main process of pgagroal supports the following signals SIGTERM, SIGINT and SIGALRM
as a mechanism for shutting down. The SIGTRAP signal will put pgagroal into graceful shutdown, meaning that
exisiting connections are allowed to finish their session. The SIGABRT is used to request a core dump (abort()).
The SIGHUP signal will trigger a reload of the configuration.
The child processes support SIGQUIT as a mechanism to shutdown. This will not shutdown the pool itself.
It should not be needed to use SIGKILL for pgagroal. Please, consider using SIGABRT instead, and share the
core dump and debug logs with the pgagroal community.
The SIGHUP signal will trigger a reload of the configuration.
However, some configuration settings requires a full restart of pgagroal in order to take effect. These are
hugepagelibevlog_pathlog_typemax_connectionspipelineunix_socket_dirpidfile- Limit rules defined by
pgagroal_databases.conf - TLS rules defined by server section
The configuration can also be reloaded using pgagroal-cli -c pgagroal.conf conf reload. The command is only supported
over the local interface, and hence doesn't work remotely.
pgagroal has support for Prometheus when the metrics port is specified.
Note: It is crucial to carefully initialize Prometheus memory in any program files for example functions like pgagroal_init_prometheus() and pgagroal_init_prometheus_cache() should only be invoked if metrics is greater than 0.
The module serves two endpoints
/- Overview of the functionality (text/html)/metrics- The metrics (text/plain)
All other URLs will result in a 403 response.
The metrics endpoint supports Transfer-Encoding: chunked to account for a large amount of data.
The implementation is done in prometheus.h and prometheus.c.
pgagroal can failover a PostgreSQL instance if clients can't write to it.
This is done using an external script provided by the user.
The implementation is done in server.h and server.c.
Simple logging implementation based on a atomic_schar lock.
The implementation is done in logging.h and logging.c.
The protocol interactions can be debugged using Wireshark or pgprtdbg.