#include "postgres_fe.h"
#include <unistd.h>
#include "common/connect.h"
#include "fe_utils/cancel.h"
#include "fe_utils/string_utils.h"

Include dependency graph for cancel.c:

Macros
#define	write_stderr(str)

Functions
void	SetCancelConn (PGconn *conn)

void	ResetCancelConn (void)

static void	handle_sigint (SIGNAL_ARGS)

void	setup_cancel_handler (void(*query_cancel_callback)(void))

Variables
static PGcancel *volatile	cancelConn = NULL

static const char *	cancel_sent_msg = NULL

static const char *	cancel_not_sent_msg = NULL

volatile sig_atomic_t	CancelRequested = false

static void(*	cancel_callback )(void) = NULL

Macro Definition Documentation

◆ write_stderr

#define write_stderr ( str )

Value:

    do { \
        const char *str_ = (str); \
        ssize_t rc_; \
        rc_ = write(fileno(stderr), str_, strlen(str_)); \
        (void) rc_; \
    } while (0)

Definition at line 61 of file cancel.c.

       { \
        const char *str_ = (str); \
        ssize_t rc_; \
        rc_ = write(fileno(stderr), str_, strlen(str_)); \
        (void) rc_; \
    } while (0)

Function Documentation

◆ handle_sigint()

static void handle_sigint ( SIGNAL_ARGS )

static

Definition at line 183 of file cancel.c.

{
    char        errbuf[256];
 
    CancelRequested = true;
 
    if (cancel_callback != NULL)
        cancel_callback();
 
    /* Send QueryCancel if we are processing a database query */
    if (cancelConn != NULL)
    {
        if (PQcancel(cancelConn, errbuf, sizeof(errbuf)))
        {
            write_stderr(cancel_sent_msg);
        }
        else
        {
            write_stderr(cancel_not_sent_msg);
            write_stderr(errbuf);
        }
    }
}

References cancel_callback, cancel_not_sent_msg, cancel_sent_msg, cancelConn, CancelRequested, fb(), PQcancel(), and write_stderr.

Referenced by setup_cancel_handler().

◆ ResetCancelConn()

void ResetCancelConn ( void )

Definition at line 137 of file cancel.c.

{
    PGcancel   *oldCancelConn;
 
#ifdef WIN32
    EnterCriticalSection(&cancelConnLock);
#endif
 
    oldCancelConn = cancelConn;
 
    /* be sure handle_sigint doesn't use pointer while freeing */
    cancelConn = NULL;
 
    if (oldCancelConn != NULL)
        PQfreeCancel(oldCancelConn);
 
#ifdef WIN32
    LeaveCriticalSection(&cancelConnLock);
#endif
}

References cancelConn, fb(), and PQfreeCancel().

Referenced by CheckConnection(), consumeQueryResult(), do_connect(), do_lo_export(), do_lo_import(), do_lo_unlink(), executeMaintenanceCommand(), HandleCopyResult(), PSQLexec(), PSQLexecWatch(), runInitSteps(), SendQuery(), and wait_on_slots().

◆ SetCancelConn()

void SetCancelConn ( PGconn * conn )

Definition at line 107 of file cancel.c.

{
    PGcancel   *oldCancelConn;
 
#ifdef WIN32
    EnterCriticalSection(&cancelConnLock);
#endif
 
    /* Free the old one if we have one */
    oldCancelConn = cancelConn;
 
    /* be sure handle_sigint doesn't use pointer while freeing */
    cancelConn = NULL;
 
    if (oldCancelConn != NULL)
        PQfreeCancel(oldCancelConn);
 
    cancelConn = PQgetCancel(conn);
 
#ifdef WIN32
    LeaveCriticalSection(&cancelConnLock);
#endif
}

References cancelConn, conn, fb(), PQfreeCancel(), and PQgetCancel().

Referenced by consumeQueryResult(), do_lo_export(), do_lo_import(), do_lo_unlink(), executeMaintenanceCommand(), HandleCopyResult(), PSQLexec(), PSQLexecWatch(), runInitSteps(), SendQuery(), and wait_on_slots().

◆ setup_cancel_handler()

void setup_cancel_handler ( void(*)(void) query_cancel_callback )

Definition at line 213 of file cancel.c.

{
    cancel_callback = query_cancel_callback;
    cancel_sent_msg = _("Cancel request sent\n");
    cancel_not_sent_msg = _("Could not send cancel request: ");
 
    pqsignal(SIGINT, handle_sigint);
}