#include "postgres_fe.h"
#include <ctype.h>
#include <limits.h>
#include <sys/time.h>
#include <unistd.h>
#include "libpq-fe.h"
#include "libpq-int.h"
#include "port/pg_bswap.h"

Include dependency graph for fe-trace.c:

Functions
void	PQtrace (PGconn conn, FILE debug_port)

void	PQuntrace (PGconn *conn)

void	PQsetTraceFlags (PGconn *conn, int flags)

static void	pqTraceFormatTimestamp (char *timestr, size_t ts_len)

static void	pqTraceOutputByte1 (FILE pfdebug, const char data, int *cursor)

static int	pqTraceOutputInt16 (FILE pfdebug, const char data, int *cursor)

static int	pqTraceOutputInt32 (FILE pfdebug, const char data, int *cursor, bool suppress)

static void	pqTraceOutputString (FILE pfdebug, const char data, int *cursor, bool suppress)

static void	pqTraceOutputNchar (FILE pfdebug, int len, const char data, int *cursor, bool suppress)

static void	pqTraceOutput_NotificationResponse (FILE f, const char message, int *cursor, bool regress)

static void	pqTraceOutput_Bind (FILE f, const char message, int *cursor)

static void	pqTraceOutput_Close (FILE f, const char message, int *cursor)

static void	pqTraceOutput_CommandComplete (FILE f, const char message, int *cursor)

static void	pqTraceOutput_CopyData (FILE f, const char message, int *cursor, int length, bool suppress)

static void	pqTraceOutput_DataRow (FILE f, const char message, int *cursor)

static void	pqTraceOutput_Describe (FILE f, const char message, int *cursor)

static void	pqTraceOutputNR (FILE f, const char type, const char message, int cursor, bool regress)

static void	pqTraceOutput_ErrorResponse (FILE f, const char message, int *cursor, bool regress)

static void	pqTraceOutput_NoticeResponse (FILE f, const char message, int *cursor, bool regress)

static void	pqTraceOutput_Execute (FILE f, const char message, int *cursor, bool regress)

static void	pqTraceOutput_CopyFail (FILE f, const char message, int *cursor)

static void	pqTraceOutput_GSSResponse (FILE f, const char message, int *cursor, int length, bool regress)

static void	pqTraceOutput_PasswordMessage (FILE f, const char message, int *cursor)

static void	pqTraceOutput_SASLInitialResponse (FILE f, const char message, int *cursor, bool regress)

static void	pqTraceOutput_SASLResponse (FILE f, const char message, int *cursor, int length, bool regress)

static void	pqTraceOutput_FunctionCall (FILE f, const char message, int *cursor, bool regress)

static void	pqTraceOutput_CopyInResponse (FILE f, const char message, int *cursor)

static void	pqTraceOutput_CopyOutResponse (FILE f, const char message, int *cursor)

static void	pqTraceOutput_BackendKeyData (FILE f, const char message, int *cursor, int length, bool regress)

static void	pqTraceOutput_Parse (FILE f, const char message, int *cursor, bool regress)

static void	pqTraceOutput_Query (FILE f, const char message, int *cursor)

static void	pqTraceOutput_Authentication (FILE f, const char message, int *cursor, int length, bool suppress)

static void	pqTraceOutput_ParameterStatus (FILE f, const char message, int *cursor)

static void	pqTraceOutput_ParameterDescription (FILE f, const char message, int *cursor, bool regress)

static void	pqTraceOutput_RowDescription (FILE f, const char message, int *cursor, bool regress)

static void	pqTraceOutput_NegotiateProtocolVersion (FILE f, const char message, int *cursor)

static void	pqTraceOutput_FunctionCallResponse (FILE f, const char message, int *cursor)

static void	pqTraceOutput_CopyBothResponse (FILE f, const char message, int *cursor, int length)

static void	pqTraceOutput_ReadyForQuery (FILE f, const char message, int *cursor)

void	pqTraceOutputMessage (PGconn conn, const char message, bool toServer)

void	pqTraceOutputNoTypeByteMessage (PGconn conn, const char message)

void	pqTraceOutputCharResponse (PGconn conn, const char responseType, char response)

Function Documentation

◆ PQsetTraceFlags()

void PQsetTraceFlags	(	PGconn *	conn,
		int	flags
	)

Definition at line 64 of file fe-trace.c.

{
    if (conn == NULL)
        return;
    /* If PQtrace() failed, do nothing. */
    if (conn->Pfdebug == NULL)
        return;
    conn->traceFlags = flags;
}

References conn, fb(), pg_conn::Pfdebug, and pg_conn::traceFlags.

Referenced by main().

◆ PQtrace()

void PQtrace	(	PGconn *	conn,
		FILE *	debug_port
	)

Definition at line 35 of file fe-trace.c.

{
    if (conn == NULL)
        return;
    PQuntrace(conn);
    if (debug_port == NULL)
        return;
 
    conn->Pfdebug = debug_port;
    conn->traceFlags = 0;
}

References conn, fb(), pg_conn::Pfdebug, PQuntrace(), and pg_conn::traceFlags.

Referenced by main().

◆ pqTraceFormatTimestamp()

static void pqTraceFormatTimestamp	(	char *	timestr,
		size_t	ts_len
	)

static

Definition at line 80 of file fe-trace.c.

{
    struct timeval tval;
    time_t      now;
    struct tm   tmbuf;
 
    gettimeofday(&tval, NULL);
 
    /*
     * MSVC's implementation of timeval uses a long for tv_sec, however,
     * localtime() expects a time_t pointer.  Here we'll assign tv_sec to a
     * local time_t variable so that we pass localtime() the correct pointer
     * type.
     */
    now = tval.tv_sec;
    strftime(timestr, ts_len,
             "%Y-%m-%d %H:%M:%S",
             localtime_r(&now, &tmbuf));
    /* append microseconds */
    snprintf(timestr + strlen(timestr), ts_len - strlen(timestr),
             ".%06u", (unsigned int) (tval.tv_usec));
}

References fb(), gettimeofday(), now(), snprintf, and tm.

Referenced by pqTraceOutputCharResponse(), pqTraceOutputMessage(), and pqTraceOutputNoTypeByteMessage().

◆ pqTraceOutput_Authentication()

static void pqTraceOutput_Authentication	(	FILE *	f,
		const char *	message,
		int *	cursor,
		int	length,
		bool	suppress
	)

static

Definition at line 485 of file fe-trace.c.

{
    int         authType = 0;
 
    memcpy(&authType, message + *cursor, 4);
    authType = (int) pg_ntoh32(authType);
    *cursor += 4;
    switch (authType)
    {
        case AUTH_REQ_OK:
            fprintf(f, "AuthenticationOk");
            break;
            /* AUTH_REQ_KRB4 not supported */
            /* AUTH_REQ_KRB5 not supported */
        case AUTH_REQ_PASSWORD:
            fprintf(f, "AuthenticationCleartextPassword");
            break;
            /* AUTH_REQ_CRYPT not supported */
        case AUTH_REQ_MD5:
            fprintf(f, "AuthenticationMD5Password");
            break;
        case AUTH_REQ_GSS:
            fprintf(f, "AuthenticationGSS");
            break;
        case AUTH_REQ_GSS_CONT:
            fprintf(f, "AuthenticationGSSContinue\t");
            pqTraceOutputNchar(f, length - *cursor + 1, message, cursor,
                               suppress);
            break;
        case AUTH_REQ_SSPI:
            fprintf(f, "AuthenticationSSPI");
            break;
        case AUTH_REQ_SASL:
            fprintf(f, "AuthenticationSASL\t");
            while (message[*cursor] != '\0')
                pqTraceOutputString(f, message, cursor, false);
            pqTraceOutputString(f, message, cursor, false);
            break;
        case AUTH_REQ_SASL_CONT:
            fprintf(f, "AuthenticationSASLContinue\t");
            pqTraceOutputNchar(f, length - *cursor + 1, message, cursor,
                               suppress);
            break;
        case AUTH_REQ_SASL_FIN:
            fprintf(f, "AuthenticationSASLFinal\t");
            pqTraceOutputNchar(f, length - *cursor + 1, message, cursor,
                               suppress);
            break;
        default:
            fprintf(f, "Unknown authentication message %d", authType);
    }
}

References AUTH_REQ_GSS, AUTH_REQ_GSS_CONT, AUTH_REQ_MD5, AUTH_REQ_OK, AUTH_REQ_PASSWORD, AUTH_REQ_SASL, AUTH_REQ_SASL_CONT, AUTH_REQ_SASL_FIN, AUTH_REQ_SSPI, fb(), fprintf, memcpy(), pg_ntoh32, pqTraceOutputNchar(), and pqTraceOutputString().

Referenced by pqTraceOutputMessage().

◆ pqTraceOutput_BackendKeyData()

static void pqTraceOutput_BackendKeyData	(	FILE *	f,
		const char *	message,
		int *	cursor,
		int	length,
		bool	regress
	)

static

Definition at line 455 of file fe-trace.c.

{
    fprintf(f, "BackendKeyData\t");
    pqTraceOutputInt32(f, message, cursor, regress);
    pqTraceOutputNchar(f, length - *cursor + 1, message, cursor, regress);
}

References fb(), fprintf, pqTraceOutputInt32(), and pqTraceOutputNchar().

Referenced by pqTraceOutputMessage().

◆ pqTraceOutput_Bind()

static void pqTraceOutput_Bind	(	FILE *	f,
		const char *	message,
		int *	cursor
	)

static

Definition at line 240 of file fe-trace.c.

{
    int         nparams;
 
    fprintf(f, "Bind\t");
    pqTraceOutputString(f, message, cursor, false);
    pqTraceOutputString(f, message, cursor, false);
    nparams = pqTraceOutputInt16(f, message, cursor);
 
    for (int i = 0; i < nparams; i++)
        pqTraceOutputInt16(f, message, cursor);
 
    nparams = pqTraceOutputInt16(f, message, cursor);
 
    for (int i = 0; i < nparams; i++)
    {
        int         nbytes;
 
        nbytes = pqTraceOutputInt32(f, message, cursor, false);
        if (nbytes == -1)
            continue;
        pqTraceOutputNchar(f, nbytes, message, cursor, false);
    }
 
    nparams = pqTraceOutputInt16(f, message, cursor);
    for (int i = 0; i < nparams; i++)
        pqTraceOutputInt16(f, message, cursor);
}

References fprintf, i, pqTraceOutputInt16(), pqTraceOutputInt32(), pqTraceOutputNchar(), and pqTraceOutputString().

Referenced by pqTraceOutputMessage().

◆ pqTraceOutput_Close()

static void pqTraceOutput_Close	(	FILE *	f,
		const char *	message,
		int *	cursor
	)

static

Definition at line 270 of file fe-trace.c.

{
    fprintf(f, "Close\t");
    pqTraceOutputByte1(f, message, cursor);
    pqTraceOutputString(f, message, cursor, false);
}

References fprintf, pqTraceOutputByte1(), and pqTraceOutputString().

Referenced by pqTraceOutputMessage().

◆ pqTraceOutput_CommandComplete()

static void pqTraceOutput_CommandComplete	(	FILE *	f,
		const char *	message,
		int *	cursor
	)

static

Definition at line 278 of file fe-trace.c.

{
    fprintf(f, "CommandComplete\t");
    pqTraceOutputString(f, message, cursor, false);
}

References fprintf, and pqTraceOutputString().

Referenced by pqTraceOutputMessage().

◆ pqTraceOutput_CopyBothResponse()

static void pqTraceOutput_CopyBothResponse	(	FILE *	f,
		const char *	message,
		int *	cursor,
		int	length
	)

static

Definition at line 605 of file fe-trace.c.

{
    fprintf(f, "CopyBothResponse\t");
    pqTraceOutputByte1(f, message, cursor);
 
    while (length > *cursor)
        pqTraceOutputInt16(f, message, cursor);
}

References fprintf, pqTraceOutputByte1(), and pqTraceOutputInt16().

Referenced by pqTraceOutputMessage().

◆ pqTraceOutput_CopyData()

static void pqTraceOutput_CopyData	(	FILE *	f,
		const char *	message,
		int *	cursor,
		int	length,
		bool	suppress
	)

static

Definition at line 285 of file fe-trace.c.

{
    fprintf(f, "CopyData\t");
    pqTraceOutputNchar(f, length - *cursor + 1, message, cursor, suppress);
}

References fb(), fprintf, and pqTraceOutputNchar().

Referenced by pqTraceOutputMessage().

◆ pqTraceOutput_CopyFail()

static void pqTraceOutput_CopyFail	(	FILE *	f,
		const char *	message,
		int *	cursor
	)

static

Definition at line 360 of file fe-trace.c.

{
    fprintf(f, "CopyFail\t");
    pqTraceOutputString(f, message, cursor, false);
}

References fprintf, and pqTraceOutputString().

Referenced by pqTraceOutputMessage().

◆ pqTraceOutput_CopyInResponse()

static void pqTraceOutput_CopyInResponse	(	FILE *	f,
		const char *	message,
		int *	cursor
	)

static

Definition at line 429 of file fe-trace.c.

{
    int         nfields;
 
    fprintf(f, "CopyInResponse\t");
    pqTraceOutputByte1(f, message, cursor);
    nfields = pqTraceOutputInt16(f, message, cursor);
 
    for (int i = 0; i < nfields; i++)
        pqTraceOutputInt16(f, message, cursor);
}

References fprintf, i, pqTraceOutputByte1(), and pqTraceOutputInt16().

Referenced by pqTraceOutputMessage().

◆ pqTraceOutput_CopyOutResponse()

static void pqTraceOutput_CopyOutResponse	(	FILE *	f,
		const char *	message,
		int *	cursor
	)

static

Definition at line 442 of file fe-trace.c.

{
    int         nfields;
 
    fprintf(f, "CopyOutResponse\t");
    pqTraceOutputByte1(f, message, cursor);
    nfields = pqTraceOutputInt16(f, message, cursor);
 
    for (int i = 0; i < nfields; i++)
        pqTraceOutputInt16(f, message, cursor);
}

References fprintf, i, pqTraceOutputByte1(), and pqTraceOutputInt16().

Referenced by pqTraceOutputMessage().

◆ pqTraceOutput_DataRow()

static void pqTraceOutput_DataRow	(	FILE *	f,
		const char *	message,
		int *	cursor
	)

static

Definition at line 293 of file fe-trace.c.

{
    int         nfields;
    int         len;
    int         i;
 
    fprintf(f, "DataRow\t");
    nfields = pqTraceOutputInt16(f, message, cursor);
    for (i = 0; i < nfields; i++)
    {
        len = pqTraceOutputInt32(f, message, cursor, false);
        if (len == -1)
            continue;
        pqTraceOutputNchar(f, len, message, cursor, false);
    }
}

References fprintf, i, len, pqTraceOutputInt16(), pqTraceOutputInt32(), and pqTraceOutputNchar().

Referenced by pqTraceOutputMessage().

◆ pqTraceOutput_Describe()

static void pqTraceOutput_Describe	(	FILE *	f,
		const char *	message,
		int *	cursor
	)

static

Definition at line 311 of file fe-trace.c.

{
    fprintf(f, "Describe\t");
    pqTraceOutputByte1(f, message, cursor);
    pqTraceOutputString(f, message, cursor, false);
}

References fprintf, pqTraceOutputByte1(), and pqTraceOutputString().

Referenced by pqTraceOutputMessage().

◆ pqTraceOutput_ErrorResponse()

static void pqTraceOutput_ErrorResponse	(	FILE *	f,
		const char *	message,
		int *	cursor,
		bool	regress
	)

static

Definition at line 340 of file fe-trace.c.

{
    pqTraceOutputNR(f, "ErrorResponse", message, cursor, regress);
}

References fb(), and pqTraceOutputNR().

Referenced by pqTraceOutputMessage().

◆ pqTraceOutput_Execute()

static void pqTraceOutput_Execute	(	FILE *	f,
		const char *	message,
		int *	cursor,
		bool	regress
	)

static

Definition at line 352 of file fe-trace.c.

{
    fprintf(f, "Execute\t");
    pqTraceOutputString(f, message, cursor, false);
    pqTraceOutputInt32(f, message, cursor, false);
}

References fprintf, pqTraceOutputInt32(), and pqTraceOutputString().

Referenced by pqTraceOutputMessage().

◆ pqTraceOutput_FunctionCall()

static void pqTraceOutput_FunctionCall	(	FILE *	f,
		const char *	message,
		int *	cursor,
		bool	regress
	)

static

Definition at line 403 of file fe-trace.c.

{
    int         nfields;
    int         nbytes;
 
    fprintf(f, "FunctionCall\t");
    pqTraceOutputInt32(f, message, cursor, regress);
    nfields = pqTraceOutputInt16(f, message, cursor);
 
    for (int i = 0; i < nfields; i++)
        pqTraceOutputInt16(f, message, cursor);
 
    nfields = pqTraceOutputInt16(f, message, cursor);
 
    for (int i = 0; i < nfields; i++)
    {
        nbytes = pqTraceOutputInt32(f, message, cursor, false);
        if (nbytes == -1)
            continue;
        pqTraceOutputNchar(f, nbytes, message, cursor, false);
    }
 
    pqTraceOutputInt16(f, message, cursor);
}

References fb(), fprintf, i, pqTraceOutputInt16(), pqTraceOutputInt32(), and pqTraceOutputNchar().

Referenced by pqTraceOutputMessage().

◆ pqTraceOutput_FunctionCallResponse()

static void pqTraceOutput_FunctionCallResponse	(	FILE *	f,
		const char *	message,
		int *	cursor
	)

static

Definition at line 594 of file fe-trace.c.

{
    int         len;
 
    fprintf(f, "FunctionCallResponse\t");
    len = pqTraceOutputInt32(f, message, cursor, false);
    if (len != -1)
        pqTraceOutputNchar(f, len, message, cursor, false);
}

References fprintf, len, pqTraceOutputInt32(), and pqTraceOutputNchar().

Referenced by pqTraceOutputMessage().

◆ pqTraceOutput_GSSResponse()

static void pqTraceOutput_GSSResponse	(	FILE *	f,
		const char *	message,
		int *	cursor,
		int	length,
		bool	regress
	)

static

Definition at line 367 of file fe-trace.c.

{
    fprintf(f, "GSSResponse\t");
    pqTraceOutputNchar(f, length - *cursor + 1, message, cursor, regress);
}

References fb(), fprintf, and pqTraceOutputNchar().

Referenced by pqTraceOutputMessage().

◆ pqTraceOutput_NegotiateProtocolVersion()

static void pqTraceOutput_NegotiateProtocolVersion	(	FILE *	f,
		const char *	message,
		int *	cursor
	)

static

Definition at line 580 of file fe-trace.c.

{
    int         nparams;
 
    fprintf(f, "NegotiateProtocolVersion\t");
    pqTraceOutputInt32(f, message, cursor, false);
    nparams = pqTraceOutputInt32(f, message, cursor, false);
    for (int i = 0; i < nparams; i++)
    {
        pqTraceOutputString(f, message, cursor, false);
    }
}

References fprintf, i, pqTraceOutputInt32(), and pqTraceOutputString().

Referenced by pqTraceOutputMessage().

◆ pqTraceOutput_NoticeResponse()

static void pqTraceOutput_NoticeResponse	(	FILE *	f,
		const char *	message,
		int *	cursor,
		bool	regress
	)

static

Definition at line 346 of file fe-trace.c.

{
    pqTraceOutputNR(f, "NoticeResponse", message, cursor, regress);
}

References fb(), and pqTraceOutputNR().

Referenced by pqTraceOutputMessage().

◆ pqTraceOutput_NotificationResponse()

static void pqTraceOutput_NotificationResponse	(	FILE *	f,
		const char *	message,
		int *	cursor,
		bool	regress
	)

static

Definition at line 231 of file fe-trace.c.

{
    fprintf(f, "NotificationResponse\t");
    pqTraceOutputInt32(f, message, cursor, regress);
    pqTraceOutputString(f, message, cursor, false);
    pqTraceOutputString(f, message, cursor, false);
}

References fb(), fprintf, pqTraceOutputInt32(), and pqTraceOutputString().

Referenced by pqTraceOutputMessage().

◆ pqTraceOutput_ParameterDescription()

static void pqTraceOutput_ParameterDescription	(	FILE *	f,
		const char *	message,
		int *	cursor,
		bool	regress
	)

static

Definition at line 548 of file fe-trace.c.

{
    int         nfields;
 
    fprintf(f, "ParameterDescription\t");
    nfields = pqTraceOutputInt16(f, message, cursor);
 
    for (int i = 0; i < nfields; i++)
        pqTraceOutputInt32(f, message, cursor, regress);
}

References fb(), fprintf, i, pqTraceOutputInt16(), and pqTraceOutputInt32().

Referenced by pqTraceOutputMessage().

◆ pqTraceOutput_ParameterStatus()

static void pqTraceOutput_ParameterStatus	(	FILE *	f,
		const char *	message,
		int *	cursor
	)

static

Definition at line 540 of file fe-trace.c.

{
    fprintf(f, "ParameterStatus\t");
    pqTraceOutputString(f, message, cursor, false);
    pqTraceOutputString(f, message, cursor, false);
}

References fprintf, and pqTraceOutputString().

Referenced by pqTraceOutputMessage().

◆ pqTraceOutput_Parse()

static void pqTraceOutput_Parse	(	FILE *	f,
		const char *	message,
		int *	cursor,
		bool	regress
	)

static

Definition at line 464 of file fe-trace.c.

{
    int         nparams;
 
    fprintf(f, "Parse\t");
    pqTraceOutputString(f, message, cursor, false);
    pqTraceOutputString(f, message, cursor, false);
    nparams = pqTraceOutputInt16(f, message, cursor);
 
    for (int i = 0; i < nparams; i++)
        pqTraceOutputInt32(f, message, cursor, regress);
}

References fb(), fprintf, i, pqTraceOutputInt16(), pqTraceOutputInt32(), and pqTraceOutputString().

Referenced by pqTraceOutputMessage().

◆ pqTraceOutput_PasswordMessage()

static void pqTraceOutput_PasswordMessage	(	FILE *	f,
		const char *	message,
		int *	cursor
	)

static

Definition at line 375 of file fe-trace.c.

{
    fprintf(f, "PasswordMessage\t");
    pqTraceOutputString(f, message, cursor, false);
}

References fprintf, and pqTraceOutputString().

Referenced by pqTraceOutputMessage().

◆ pqTraceOutput_Query()

static void pqTraceOutput_Query	(	FILE *	f,
		const char *	message,
		int *	cursor
	)

static

Definition at line 478 of file fe-trace.c.

{
    fprintf(f, "Query\t");
    pqTraceOutputString(f, message, cursor, false);
}

References fprintf, and pqTraceOutputString().

Referenced by pqTraceOutputMessage().

◆ pqTraceOutput_ReadyForQuery()

static void pqTraceOutput_ReadyForQuery	(	FILE *	f,
		const char *	message,
		int *	cursor
	)

static

Definition at line 615 of file fe-trace.c.

{
    fprintf(f, "ReadyForQuery\t");
    pqTraceOutputByte1(f, message, cursor);
}

References fprintf, and pqTraceOutputByte1().

Referenced by pqTraceOutputMessage().

◆ pqTraceOutput_RowDescription()

static void pqTraceOutput_RowDescription	(	FILE *	f,
		const char *	message,
		int *	cursor,
		bool	regress
	)

static

Definition at line 560 of file fe-trace.c.

{
    int         nfields;
 
    fprintf(f, "RowDescription\t");
    nfields = pqTraceOutputInt16(f, message, cursor);
 
    for (int i = 0; i < nfields; i++)
    {
        pqTraceOutputString(f, message, cursor, false);
        pqTraceOutputInt32(f, message, cursor, regress);
        pqTraceOutputInt16(f, message, cursor);
        pqTraceOutputInt32(f, message, cursor, regress);
        pqTraceOutputInt16(f, message, cursor);
        pqTraceOutputInt32(f, message, cursor, false);
        pqTraceOutputInt16(f, message, cursor);
    }
}

References fb(), fprintf, i, pqTraceOutputInt16(), pqTraceOutputInt32(), and pqTraceOutputString().

Referenced by pqTraceOutputMessage().

◆ pqTraceOutput_SASLInitialResponse()

static void pqTraceOutput_SASLInitialResponse	(	FILE *	f,
		const char *	message,
		int *	cursor,
		bool	regress
	)

static

Definition at line 382 of file fe-trace.c.

{
    int         initialResponse;
 
    fprintf(f, "SASLInitialResponse\t");
    pqTraceOutputString(f, message, cursor, false);
    initialResponse = pqTraceOutputInt32(f, message, cursor, false);
    if (initialResponse != -1)
        pqTraceOutputNchar(f, initialResponse, message, cursor, regress);
}

References fb(), fprintf, pqTraceOutputInt32(), pqTraceOutputNchar(), and pqTraceOutputString().

Referenced by pqTraceOutputMessage().

◆ pqTraceOutput_SASLResponse()

static void pqTraceOutput_SASLResponse	(	FILE *	f,
		const char *	message,
		int *	cursor,
		int	length,
		bool	regress
	)

static

Definition at line 395 of file fe-trace.c.

{
    fprintf(f, "SASLResponse\t");
    pqTraceOutputNchar(f, length - *cursor + 1, message, cursor, regress);
}

References fb(), fprintf, and pqTraceOutputNchar().

Referenced by pqTraceOutputMessage().

◆ pqTraceOutputByte1()

static void pqTraceOutputByte1	(	FILE *	pfdebug,
		const char *	data,
		int *	cursor
	)

static

Definition at line 107 of file fe-trace.c.

{
    const char *v = data + *cursor;
 
    /*
     * Show non-printable data in hex format, including the terminating \0
     * that completes ErrorResponse and NoticeResponse messages.
     */
    if (!isprint((unsigned char) *v))
        fprintf(pfdebug, " \\x%02x", (unsigned char) *v);
    else
        fprintf(pfdebug, " %c", *v);
    *cursor += 1;
}

References data, fb(), and fprintf.

Referenced by pqTraceOutput_Close(), pqTraceOutput_CopyBothResponse(), pqTraceOutput_CopyInResponse(), pqTraceOutput_CopyOutResponse(), pqTraceOutput_Describe(), pqTraceOutput_ReadyForQuery(), and pqTraceOutputNR().

◆ pqTraceOutputCharResponse()

void pqTraceOutputCharResponse	(	PGconn *	conn,
		const char *	responseType,
		char	response
	)

Definition at line 918 of file fe-trace.c.

{
    if ((conn->traceFlags & PQTRACE_SUPPRESS_TIMESTAMPS) == 0)
    {
        char        timestr[128];
 
        pqTraceFormatTimestamp(timestr, sizeof(timestr));
        fprintf(conn->Pfdebug, "%s\t", timestr);
    }
 
    fprintf(conn->Pfdebug, "B\t1\t%s\t %c\n", responseType, response);
}

References conn, fb(), fprintf, pg_conn::Pfdebug, PQTRACE_SUPPRESS_TIMESTAMPS, pqTraceFormatTimestamp(), and pg_conn::traceFlags.

Referenced by PQconnectPoll().

◆ pqTraceOutputInt16()

static int pqTraceOutputInt16	(	FILE *	pfdebug,
		const char *	data,
		int *	cursor
	)

static

Definition at line 126 of file fe-trace.c.

{
    uint16      tmp;
    int         result;
 
    memcpy(&tmp, data + *cursor, 2);
    *cursor += 2;
    result = (int) pg_ntoh16(tmp);
    fprintf(pfdebug, " %d", result);
 
    return result;
}

References data, fb(), fprintf, memcpy(), pg_ntoh16, and result.

Referenced by pqTraceOutput_Bind(), pqTraceOutput_CopyBothResponse(), pqTraceOutput_CopyInResponse(), pqTraceOutput_CopyOutResponse(), pqTraceOutput_DataRow(), pqTraceOutput_FunctionCall(), pqTraceOutput_ParameterDescription(), pqTraceOutput_Parse(), pqTraceOutput_RowDescription(), and pqTraceOutputNoTypeByteMessage().

◆ pqTraceOutputInt32()

static int pqTraceOutputInt32	(	FILE *	pfdebug,
		const char *	data,
		int *	cursor,
		bool	suppress
	)

static

Definition at line 145 of file fe-trace.c.

{
    int         result;
 
    memcpy(&result, data + *cursor, 4);
    *cursor += 4;
    result = (int) pg_ntoh32(result);
    if (suppress)
        fprintf(pfdebug, " NNNN");
    else
        fprintf(pfdebug, " %d", result);
 
    return result;
}

References data, fb(), fprintf, memcpy(), pg_ntoh32, and result.

Referenced by pqTraceOutput_BackendKeyData(), pqTraceOutput_Bind(), pqTraceOutput_DataRow(), pqTraceOutput_Execute(), pqTraceOutput_FunctionCall(), pqTraceOutput_FunctionCallResponse(), pqTraceOutput_NegotiateProtocolVersion(), pqTraceOutput_NotificationResponse(), pqTraceOutput_ParameterDescription(), pqTraceOutput_Parse(), pqTraceOutput_RowDescription(), pqTraceOutput_SASLInitialResponse(), and pqTraceOutputNoTypeByteMessage().

◆ pqTraceOutputMessage()

void pqTraceOutputMessage	(	PGconn *	conn,
		const char *	message,
		bool	toServer
	)

Definition at line 625 of file fe-trace.c.

{
    char        id;
    int         length;
    char       *prefix = toServer ? "F" : "B";
    int         logCursor = 0;
    bool        regress;
 
    if ((conn->traceFlags & PQTRACE_SUPPRESS_TIMESTAMPS) == 0)
    {
        char        timestr[128];
 
        pqTraceFormatTimestamp(timestr, sizeof(timestr));
        fprintf(conn->Pfdebug, "%s\t", timestr);
    }
    regress = (conn->traceFlags & PQTRACE_REGRESS_MODE) != 0;
 
    id = message[logCursor++];
 
    memcpy(&length, message + logCursor, 4);
    length = (int) pg_ntoh32(length);
    logCursor += 4;
 
    /*
     * In regress mode, suppress the length of ErrorResponse and
     * NoticeResponse.  The F (file name), L (line number) and R (routine
     * name) fields can change as server code is modified, and if their
     * lengths differ from the originals, that would break tests.
     */
    if (regress && !toServer && (id == PqMsg_ErrorResponse || id == PqMsg_NoticeResponse))
        fprintf(conn->Pfdebug, "%s\tNN\t", prefix);
    else
        fprintf(conn->Pfdebug, "%s\t%d\t", prefix, length);
 
    switch (id)
    {
        case PqMsg_ParseComplete:
            fprintf(conn->Pfdebug, "ParseComplete");
            /* No message content */
            break;
        case PqMsg_BindComplete:
            fprintf(conn->Pfdebug, "BindComplete");
            /* No message content */
            break;
        case PqMsg_CloseComplete:
            fprintf(conn->Pfdebug, "CloseComplete");
            /* No message content */
            break;
        case PqMsg_NotificationResponse:
            pqTraceOutput_NotificationResponse(conn->Pfdebug, message, &logCursor, regress);
            break;
        case PqMsg_Bind:
            pqTraceOutput_Bind(conn->Pfdebug, message, &logCursor);
            break;
        case PqMsg_CopyDone:
            fprintf(conn->Pfdebug, "CopyDone");
            /* No message content */
            break;
        case PqMsg_CommandComplete:
            /* Close(F) and CommandComplete(B) use the same identifier. */
            Assert(PqMsg_Close == PqMsg_CommandComplete);
            if (toServer)
                pqTraceOutput_Close(conn->Pfdebug, message, &logCursor);
            else
                pqTraceOutput_CommandComplete(conn->Pfdebug, message, &logCursor);
            break;
        case PqMsg_CopyData:
            pqTraceOutput_CopyData(conn->Pfdebug, message, &logCursor,
                                   length, regress);
            break;
        case PqMsg_Describe:
            /* Describe(F) and DataRow(B) use the same identifier. */
            Assert(PqMsg_Describe == PqMsg_DataRow);
            if (toServer)
                pqTraceOutput_Describe(conn->Pfdebug, message, &logCursor);
            else
                pqTraceOutput_DataRow(conn->Pfdebug, message, &logCursor);
            break;
        case PqMsg_Execute:
            /* Execute(F) and ErrorResponse(B) use the same identifier. */
            Assert(PqMsg_Execute == PqMsg_ErrorResponse);
            if (toServer)
                pqTraceOutput_Execute(conn->Pfdebug, message, &logCursor, regress);
            else
                pqTraceOutput_ErrorResponse(conn->Pfdebug, message, &logCursor, regress);
            break;
        case PqMsg_CopyFail:
            pqTraceOutput_CopyFail(conn->Pfdebug, message, &logCursor);
            break;
        case PqMsg_GSSResponse:
            Assert(PqMsg_GSSResponse == PqMsg_PasswordMessage);
            Assert(PqMsg_GSSResponse == PqMsg_SASLInitialResponse);
            Assert(PqMsg_GSSResponse == PqMsg_SASLResponse);
 
            /*
             * These messages share a common type byte, so we discriminate by
             * having the code store the auth type separately.
             */
            switch (conn->current_auth_response)
            {
                case AUTH_RESPONSE_GSS:
                    pqTraceOutput_GSSResponse(conn->Pfdebug, message,
                                              &logCursor, length, regress);
                    break;
                case AUTH_RESPONSE_PASSWORD:
                    pqTraceOutput_PasswordMessage(conn->Pfdebug, message,
                                                  &logCursor);
                    break;
                case AUTH_RESPONSE_SASL_INITIAL:
                    pqTraceOutput_SASLInitialResponse(conn->Pfdebug, message,
                                                      &logCursor, regress);
                    break;
                case AUTH_RESPONSE_SASL:
                    pqTraceOutput_SASLResponse(conn->Pfdebug, message,
                                               &logCursor, length, regress);
                    break;
                default:
                    fprintf(conn->Pfdebug, "UnknownAuthenticationResponse");
                    break;
            }
            conn->current_auth_response = '\0';
            break;
        case PqMsg_FunctionCall:
            pqTraceOutput_FunctionCall(conn->Pfdebug, message, &logCursor, regress);
            break;
        case PqMsg_CopyInResponse:
            pqTraceOutput_CopyInResponse(conn->Pfdebug, message, &logCursor);
            break;
        case PqMsg_Flush:
            /* Flush(F) and CopyOutResponse(B) use the same identifier */
            Assert(PqMsg_CopyOutResponse == PqMsg_Flush);
            if (toServer)
                fprintf(conn->Pfdebug, "Flush");    /* no message content */
            else
                pqTraceOutput_CopyOutResponse(conn->Pfdebug, message, &logCursor);
            break;
        case PqMsg_EmptyQueryResponse:
            fprintf(conn->Pfdebug, "EmptyQueryResponse");
            /* No message content */
            break;
        case PqMsg_BackendKeyData:
            pqTraceOutput_BackendKeyData(conn->Pfdebug, message, &logCursor,
                                         length, regress);
            break;
        case PqMsg_NoData:
            fprintf(conn->Pfdebug, "NoData");
            /* No message content */
            break;
        case PqMsg_NoticeResponse:
            pqTraceOutput_NoticeResponse(conn->Pfdebug, message, &logCursor, regress);
            break;
        case PqMsg_Parse:
            pqTraceOutput_Parse(conn->Pfdebug, message, &logCursor, regress);
            break;
        case PqMsg_Query:
            pqTraceOutput_Query(conn->Pfdebug, message, &logCursor);
            break;
        case PqMsg_AuthenticationRequest:
            pqTraceOutput_Authentication(conn->Pfdebug, message, &logCursor,
                                         length, regress);
            break;
        case PqMsg_PortalSuspended:
            fprintf(conn->Pfdebug, "PortalSuspended");
            /* No message content */
            break;
        case PqMsg_Sync:
            /* ParameterStatus(B) and Sync(F) use the same identifier */
            Assert(PqMsg_ParameterStatus == PqMsg_Sync);
            if (toServer)
                fprintf(conn->Pfdebug, "Sync"); /* no message content */
            else
                pqTraceOutput_ParameterStatus(conn->Pfdebug, message, &logCursor);
            break;
        case PqMsg_ParameterDescription:
            pqTraceOutput_ParameterDescription(conn->Pfdebug, message, &logCursor, regress);
            break;
        case PqMsg_RowDescription:
            pqTraceOutput_RowDescription(conn->Pfdebug, message, &logCursor, regress);
            break;
        case PqMsg_NegotiateProtocolVersion:
            pqTraceOutput_NegotiateProtocolVersion(conn->Pfdebug, message, &logCursor);
            break;
        case PqMsg_FunctionCallResponse:
            pqTraceOutput_FunctionCallResponse(conn->Pfdebug, message, &logCursor);
            break;
        case PqMsg_CopyBothResponse:
            pqTraceOutput_CopyBothResponse(conn->Pfdebug, message, &logCursor, length);
            break;
        case PqMsg_Terminate:
            fprintf(conn->Pfdebug, "Terminate");
            /* No message content */
            break;
        case PqMsg_ReadyForQuery:
            pqTraceOutput_ReadyForQuery(conn->Pfdebug, message, &logCursor);
            break;
        default:
            fprintf(conn->Pfdebug, "Unknown message: %02x", id);
            break;
    }
 
    fputc('\n', conn->Pfdebug);
 
    /*
     * Verify the printing routine did it right.  Note that the one-byte
     * message identifier is not included in the length, but our cursor does
     * include it.
     */
    if (logCursor - 1 != length)
        fprintf(conn->Pfdebug,
                "mismatched message length: consumed %d, expected %d\n",
                logCursor - 1, length);
}

Referenced by pg_password_sendauth(), pg_SASL_continue(), pg_SASL_init(), pqParseDone(), and pqPutMsgEnd().

◆ pqTraceOutputNchar()

static void pqTraceOutputNchar	(	FILE *	pfdebug,
		int	len,
		const char *	data,
		int *	cursor,
		bool	suppress
	)

static

Definition at line 193 of file fe-trace.c.

{
    int         i,
                next;           /* first char not yet printed */
    const char *v = data + *cursor;
 
    if (suppress)
    {
        fprintf(pfdebug, " 'BBBB'");
        *cursor += len;
        return;
    }
 
    fprintf(pfdebug, " \'");
 
    for (next = i = 0; i < len; ++i)
    {
        if (isprint((unsigned char) v[i]))
            continue;
        else
        {
            fwrite(v + next, 1, i - next, pfdebug);
            fprintf(pfdebug, "\\x%02x", (unsigned char) v[i]);
            next = i + 1;
        }
    }
    if (next < len)
        fwrite(v + next, 1, len - next, pfdebug);
 
    fprintf(pfdebug, "\'");
    *cursor += len;
}

References data, fb(), fprintf, i, len, and next.

Referenced by pqTraceOutput_Authentication(), pqTraceOutput_BackendKeyData(), pqTraceOutput_Bind(), pqTraceOutput_CopyData(), pqTraceOutput_DataRow(), pqTraceOutput_FunctionCall(), pqTraceOutput_FunctionCallResponse(), pqTraceOutput_GSSResponse(), pqTraceOutput_SASLInitialResponse(), pqTraceOutput_SASLResponse(), and pqTraceOutputNoTypeByteMessage().

◆ pqTraceOutputNoTypeByteMessage()

void pqTraceOutputNoTypeByteMessage	(	PGconn *	conn,
		const char *	message
	)

Definition at line 843 of file fe-trace.c.

{
    int         length;
    int         version;
    bool        regress;
    int         logCursor = 0;
 
    regress = (conn->traceFlags & PQTRACE_REGRESS_MODE) != 0;
 
    if ((conn->traceFlags & PQTRACE_SUPPRESS_TIMESTAMPS) == 0)
    {
        char        timestr[128];
 
        pqTraceFormatTimestamp(timestr, sizeof(timestr));
        fprintf(conn->Pfdebug, "%s\t", timestr);
    }
 
    memcpy(&length, message + logCursor, 4);
    length = (int) pg_ntoh32(length);
    logCursor += 4;
 
    fprintf(conn->Pfdebug, "F\t%d\t", length);
 
    if (length < 8)
    {
        fprintf(conn->Pfdebug, "Unknown message\n");
        return;
    }
 
    memcpy(&version, message + logCursor, 4);
    version = (int) pg_ntoh32(version);
 
    if (version == CANCEL_REQUEST_CODE && length >= 16)
    {
        fprintf(conn->Pfdebug, "CancelRequest\t");
        pqTraceOutputInt16(conn->Pfdebug, message, &logCursor);
        pqTraceOutputInt16(conn->Pfdebug, message, &logCursor);
        pqTraceOutputInt32(conn->Pfdebug, message, &logCursor, regress);
        pqTraceOutputNchar(conn->Pfdebug, length - logCursor, message,
                           &logCursor, regress);
    }
    else if (version == NEGOTIATE_SSL_CODE)
    {
        fprintf(conn->Pfdebug, "SSLRequest\t");
        pqTraceOutputInt16(conn->Pfdebug, message, &logCursor);
        pqTraceOutputInt16(conn->Pfdebug, message, &logCursor);
    }
    else if (version == NEGOTIATE_GSS_CODE)
    {
        fprintf(conn->Pfdebug, "GSSENCRequest\t");
        pqTraceOutputInt16(conn->Pfdebug, message, &logCursor);
        pqTraceOutputInt16(conn->Pfdebug, message, &logCursor);
    }
    else
    {
        fprintf(conn->Pfdebug, "StartupMessage\t");
        pqTraceOutputInt16(conn->Pfdebug, message, &logCursor);
        pqTraceOutputInt16(conn->Pfdebug, message, &logCursor);
        while (message[logCursor] != '\0')
        {
            /* XXX should we suppress anything in regress mode? */
            pqTraceOutputString(conn->Pfdebug, message, &logCursor, false);
            pqTraceOutputString(conn->Pfdebug, message, &logCursor, false);
        }
    }
 
    fputc('\n', conn->Pfdebug);
}

References CANCEL_REQUEST_CODE, conn, fb(), fprintf, memcpy(), NEGOTIATE_GSS_CODE, NEGOTIATE_SSL_CODE, pg_conn::Pfdebug, pg_ntoh32, PQTRACE_REGRESS_MODE, PQTRACE_SUPPRESS_TIMESTAMPS, pqTraceFormatTimestamp(), pqTraceOutputInt16(), pqTraceOutputInt32(), pqTraceOutputNchar(), pqTraceOutputString(), and pg_conn::traceFlags.

Referenced by pqPutMsgEnd().

◆ pqTraceOutputNR()

static void pqTraceOutputNR	(	FILE *	f,
		const char *	type,
		const char *	message,
		int *	cursor,
		bool	regress
	)

static

Definition at line 320 of file fe-trace.c.

{
    fprintf(f, "%s\t", type);
    for (;;)
    {
        char        field;
        bool        suppress;
 
        pqTraceOutputByte1(f, message, cursor);
        field = message[*cursor - 1];
        if (field == '\0')
            break;
 
        suppress = regress && (field == 'L' || field == 'F' || field == 'R');
        pqTraceOutputString(f, message, cursor, suppress);
    }
}

References fb(), fprintf, pqTraceOutputByte1(), pqTraceOutputString(), and type.

Referenced by pqTraceOutput_ErrorResponse(), and pqTraceOutput_NoticeResponse().

◆ pqTraceOutputString()

static void pqTraceOutputString	(	FILE *	pfdebug,
		const char *	data,
		int *	cursor,
		bool	suppress
	)

static

Definition at line 166 of file fe-trace.c.

{
    int         len;
 
    if (suppress)
    {
        fprintf(pfdebug, " \"SSSS\"");
        *cursor += strlen(data + *cursor) + 1;
    }
    else
    {
        len = fprintf(pfdebug, " \"%s\"", data + *cursor);
 
        /*
         * This is a null-terminated string. So add 1 after subtracting 3
         * which is the double quotes and space length from len.
         */
        *cursor += (len - 3 + 1);
    }
}

References data, fb(), fprintf, and len.

Referenced by pqTraceOutput_Authentication(), pqTraceOutput_Bind(), pqTraceOutput_Close(), pqTraceOutput_CommandComplete(), pqTraceOutput_CopyFail(), pqTraceOutput_Describe(), pqTraceOutput_Execute(), pqTraceOutput_NegotiateProtocolVersion(), pqTraceOutput_NotificationResponse(), pqTraceOutput_ParameterStatus(), pqTraceOutput_Parse(), pqTraceOutput_PasswordMessage(), pqTraceOutput_Query(), pqTraceOutput_RowDescription(), pqTraceOutput_SASLInitialResponse(), pqTraceOutputNoTypeByteMessage(), and pqTraceOutputNR().

◆ PQuntrace()

void PQuntrace ( PGconn * conn )

Definition at line 49 of file fe-trace.c.

{
    if (conn == NULL)
        return;
    if (conn->Pfdebug)
    {
        fflush(conn->Pfdebug);
        conn->Pfdebug = NULL;
    }
 
    conn->traceFlags = 0;
}

References conn, fb(), pg_conn::Pfdebug, and pg_conn::traceFlags.

Referenced by PQtrace().

Functions

Function Documentation

◆ PQsetTraceFlags()

◆ PQtrace()

◆ pqTraceFormatTimestamp()

◆ pqTraceOutput_Authentication()

◆ pqTraceOutput_BackendKeyData()

◆ pqTraceOutput_Bind()

◆ pqTraceOutput_Close()

◆ pqTraceOutput_CommandComplete()

◆ pqTraceOutput_CopyBothResponse()

◆ pqTraceOutput_CopyData()

◆ pqTraceOutput_CopyFail()

◆ pqTraceOutput_CopyInResponse()

◆ pqTraceOutput_CopyOutResponse()

◆ pqTraceOutput_DataRow()

◆ pqTraceOutput_Describe()

◆ pqTraceOutput_ErrorResponse()

◆ pqTraceOutput_Execute()

◆ pqTraceOutput_FunctionCall()

◆ pqTraceOutput_FunctionCallResponse()

◆ pqTraceOutput_GSSResponse()

◆ pqTraceOutput_NegotiateProtocolVersion()

◆ pqTraceOutput_NoticeResponse()

◆ pqTraceOutput_NotificationResponse()

◆ pqTraceOutput_ParameterDescription()

◆ pqTraceOutput_ParameterStatus()

◆ pqTraceOutput_Parse()

◆ pqTraceOutput_PasswordMessage()

◆ pqTraceOutput_Query()

◆ pqTraceOutput_ReadyForQuery()

◆ pqTraceOutput_RowDescription()

◆ pqTraceOutput_SASLInitialResponse()

◆ pqTraceOutput_SASLResponse()

◆ pqTraceOutputByte1()

◆ pqTraceOutputCharResponse()

◆ pqTraceOutputInt16()

◆ pqTraceOutputInt32()

◆ pqTraceOutputMessage()

◆ pqTraceOutputNchar()

◆ pqTraceOutputNoTypeByteMessage()

◆ pqTraceOutputNR()

◆ pqTraceOutputString()

◆ PQuntrace()