pqformat.c File Reference

#include "postgres.h"
#include <sys/param.h>
#include "libpq/libpq.h"
#include "libpq/pqformat.h"
#include "mb/pg_wchar.h"
#include "port/pg_bswap.h"

Include dependency graph for pqformat.c:

Go to the source code of this file.

Functions
void	pq_beginmessage (StringInfo buf, char msgtype)
void	pq_beginmessage_reuse (StringInfo buf, char msgtype)
void	pq_sendbytes (StringInfo buf, const char *data, int datalen)
void	pq_sendcountedtext (StringInfo buf, const char *str, int slen, bool countincludesself)
void	pq_sendtext (StringInfo buf, const char *str, int slen)
void	pq_sendstring (StringInfo buf, const char *str)
void	pq_send_ascii_string (StringInfo buf, const char *str)
void	pq_sendfloat4 (StringInfo buf, float4 f)
void	pq_sendfloat8 (StringInfo buf, float8 f)
void	pq_endmessage (StringInfo buf)
void	pq_endmessage_reuse (StringInfo buf)
void	pq_begintypsend (StringInfo buf)
bytea *	pq_endtypsend (StringInfo buf)
void	pq_puttextmessage (char msgtype, const char *str)
void	pq_putemptymessage (char msgtype)
int	pq_getmsgbyte (StringInfo msg)
unsigned int	pq_getmsgint (StringInfo msg, int b)
int64	pq_getmsgint64 (StringInfo msg)
float4	pq_getmsgfloat4 (StringInfo msg)
float8	pq_getmsgfloat8 (StringInfo msg)
const char *	pq_getmsgbytes (StringInfo msg, int datalen)
void	pq_copymsgbytes (StringInfo msg, char *buf, int datalen)
char *	pq_getmsgtext (StringInfo msg, int rawbytes, int *nbytes)
const char *	pq_getmsgstring (StringInfo msg)
const char *	pq_getmsgrawstring (StringInfo msg)
void	pq_getmsgend (StringInfo msg)

Function Documentation

pq_beginmessage()

void pq_beginmessage	(	StringInfo	buf,
		char	msgtype
	)

Definition at line 87 of file pqformat.c.

References StringInfoData::cursor, and initStringInfo().

Referenced by NotifyMyFrontEnd(), ParallelWorkerMain(), perform_base_backup(), PostgresMain(), printsimple(), printsimple_startup(), ReadyForQuery(), ReceiveCopyBegin(), ReportGUCOption(), send_message_to_frontend(), sendAuthRequest(), SendBackupHeader(), SendCopyBegin(), SendFunctionResult(), SendNegotiateProtocolVersion(), SendTimeLineHistory(), SendXlogRecPtrResult(), StartLogicalReplication(), and StartReplication().

{
    initStringInfo(buf);

    /*
     * We stash the message type into the buffer's cursor field, expecting
     * that the pq_sendXXX routines won't touch it.  We could alternatively
     * make it the first byte of the buffer contents, but this seems easier.
     */
    buf->cursor = msgtype;
}

pq_beginmessage_reuse()

void pq_beginmessage_reuse	(	StringInfo	buf,
		char	msgtype
	)

Definition at line 108 of file pqformat.c.

References StringInfoData::cursor, and resetStringInfo().

Referenced by exec_describe_statement_message(), printtup(), printtup_20(), printtup_internal_20(), and SendRowDescriptionMessage().

{
    resetStringInfo(buf);

    /*
     * We stash the message type into the buffer's cursor field, expecting
     * that the pq_sendXXX routines won't touch it.  We could alternatively
     * make it the first byte of the buffer contents, but this seems easier.
     */
    buf->cursor = msgtype;
}

pq_begintypsend()

void pq_begintypsend

(

StringInfo

buf

)

Definition at line 328 of file pqformat.c.

References appendStringInfoCharMacro, and initStringInfo().

Referenced by array_send(), boolsend(), box_send(), cash_send(), charsend(), cidsend(), circle_send(), complex_send(), cstring_send(), date_send(), enum_send(), float4send(), float8send(), hstore_send(), int2send(), int4send(), int8_avg_serialize(), int8send(), interval_send(), json_send(), jsonb_send(), jsonpath_send(), line_send(), lseg_send(), macaddr8_send(), macaddr_send(), namesend(), network_send(), numeric_avg_serialize(), numeric_poly_serialize(), numeric_send(), numeric_serialize(), oidsend(), path_send(), pg_lsn_send(), point_send(), poly_send(), pq_sendint(), range_send(), record_send(), textsend(), tidsend(), time_send(), timestamp_send(), timestamptz_send(), timetz_send(), tsquerysend(), tsvectorsend(), txid_snapshot_send(), unknownsend(), uuid_send(), varbit_send(), void_send(), xidsend(), and xml_send().

{
    initStringInfo(buf);
    /* Reserve four bytes for the bytea length word */
    appendStringInfoCharMacro(buf, '\0');
    appendStringInfoCharMacro(buf, '\0');
    appendStringInfoCharMacro(buf, '\0');
    appendStringInfoCharMacro(buf, '\0');
}

pq_copymsgbytes()

void pq_copymsgbytes	(	StringInfo	msg,
		char *	buf,
		int	datalen
	)

Definition at line 530 of file pqformat.c.

References StringInfoData::cursor, StringInfoData::data, ereport, errcode(), errmsg(), ERROR, and StringInfoData::len.

Referenced by bit_recv(), bytearecv(), CopyGetData(), logicalrep_read_tuple(), pq_getmsgint(), pq_getmsgint64(), pq_sendint(), and varbit_recv().

{
    if (datalen < 0 || datalen > (msg->len - msg->cursor))
        ereport(ERROR,
                (errcode(ERRCODE_PROTOCOL_VIOLATION),
                 errmsg("insufficient data left in message")));
    memcpy(buf, &msg->data[msg->cursor], datalen);
    msg->cursor += datalen;
}

pq_endmessage()

void pq_endmessage

(

StringInfo

buf

)

Definition at line 298 of file pqformat.c.

References StringInfoData::cursor, StringInfoData::data, StringInfoData::len, pfree(), and pq_putmessage.

Referenced by HandleParallelMessage(), NotifyMyFrontEnd(), ParallelWorkerMain(), perform_base_backup(), PostgresMain(), printsimple(), printsimple_startup(), ReadyForQuery(), ReceiveCopyBegin(), ReportGUCOption(), send_message_to_frontend(), sendAuthRequest(), SendBackupHeader(), SendCopyBegin(), SendFunctionResult(), SendNegotiateProtocolVersion(), SendTimeLineHistory(), SendXlogRecPtrResult(), StartLogicalReplication(), and StartReplication().

{
    /* msgtype was saved in cursor field */
    (void) pq_putmessage(buf->cursor, buf->data, buf->len);
    /* no need to complain about any failure, since pqcomm.c already did */
    pfree(buf->data);
    buf->data = NULL;
}

pq_endmessage_reuse()

void pq_endmessage_reuse

(

StringInfo

buf

)

Definition at line 316 of file pqformat.c.

References StringInfoData::cursor, StringInfoData::data, StringInfoData::len, and pq_putmessage.

Referenced by exec_describe_statement_message(), printtup(), printtup_20(), printtup_internal_20(), and SendRowDescriptionMessage().

{
    /* msgtype was saved in cursor field */
    (void) pq_putmessage(buf->cursor, buf->data, buf->len);
}

pq_endtypsend()

bytea* pq_endtypsend

(

StringInfo

buf

)

Definition at line 348 of file pqformat.c.

References Assert, StringInfoData::data, StringInfoData::len, SET_VARSIZE, and VARHDRSZ.

Referenced by array_send(), boolsend(), box_send(), cash_send(), charsend(), cidsend(), circle_send(), complex_send(), cstring_send(), date_send(), enum_send(), float4send(), float8send(), hstore_send(), int2send(), int4send(), int8_avg_serialize(), int8send(), interval_send(), json_send(), jsonb_send(), jsonpath_send(), line_send(), lseg_send(), macaddr8_send(), macaddr_send(), namesend(), network_send(), numeric_avg_serialize(), numeric_poly_serialize(), numeric_send(), numeric_serialize(), oidsend(), path_send(), pg_lsn_send(), point_send(), poly_send(), pq_sendint(), range_send(), record_send(), textsend(), tidsend(), time_send(), timestamp_send(), timestamptz_send(), timetz_send(), tsquerysend(), tsvectorsend(), txid_snapshot_send(), unknownsend(), uuid_send(), varbit_send(), void_send(), xidsend(), and xml_send().

{
    bytea      *result = (bytea *) buf->data;

    /* Insert correct length into bytea length word */
    Assert(buf->len >= VARHDRSZ);
    SET_VARSIZE(result, buf->len);

    return result;
}

pq_getmsgbyte()

int pq_getmsgbyte

(

StringInfo

msg

)

Definition at line 401 of file pqformat.c.

References StringInfoData::cursor, StringInfoData::data, ereport, errcode(), errmsg(), ERROR, and StringInfoData::len.

Referenced by apply_dispatch(), boolrecv(), charrecv(), HandleParallelMessage(), logicalrep_read_attrs(), logicalrep_read_commit(), logicalrep_read_delete(), logicalrep_read_insert(), logicalrep_read_rel(), logicalrep_read_tuple(), logicalrep_read_update(), LogicalRepApplyLoop(), macaddr8_recv(), macaddr_recv(), network_recv(), path_recv(), PostgresMain(), pq_parse_errornotice(), pq_sendint(), ProcessStandbyMessage(), ProcessStandbyReplyMessage(), range_recv(), and XLogWalRcvProcessMsg().

{
    if (msg->cursor >= msg->len)
        ereport(ERROR,
                (errcode(ERRCODE_PROTOCOL_VIOLATION),
                 errmsg("no data left in message")));
    return (unsigned char) msg->data[msg->cursor++];
}

pq_getmsgbytes()

const char* pq_getmsgbytes	(	StringInfo	msg,
		int	datalen
	)

Definition at line 510 of file pqformat.c.

References StringInfoData::cursor, StringInfoData::data, ereport, errcode(), errmsg(), ERROR, and StringInfoData::len.

Referenced by CheckSCRAMAuth(), exec_bind_message(), parse_fcall_arguments(), parse_fcall_arguments_20(), pq_sendint(), range_recv(), uuid_recv(), and xml_recv().

{
    const char *result;

    if (datalen < 0 || datalen > (msg->len - msg->cursor))
        ereport(ERROR,
                (errcode(ERRCODE_PROTOCOL_VIOLATION),
                 errmsg("insufficient data left in message")));
    result = &msg->data[msg->cursor];
    msg->cursor += datalen;
    return result;
}

pq_getmsgend()

void pq_getmsgend

(

StringInfo

msg

)

Definition at line 637 of file pqformat.c.

References StringInfoData::cursor, ereport, errcode(), errmsg(), ERROR, and StringInfoData::len.

Referenced by CheckSCRAMAuth(), exec_bind_message(), HandleFunctionRequest(), HandleParallelMessage(), int8_avg_deserialize(), numeric_avg_deserialize(), numeric_deserialize(), numeric_poly_deserialize(), PostgresMain(), pq_parse_errornotice(), pq_sendint(), and range_recv().

{
    if (msg->cursor != msg->len)
        ereport(ERROR,
                (errcode(ERRCODE_PROTOCOL_VIOLATION),
                 errmsg("invalid message format")));
}

pq_getmsgfloat4()

float4 pq_getmsgfloat4

(

StringInfo

msg

)

Definition at line 471 of file pqformat.c.

References i, pq_getmsgint(), and swap.

Referenced by float4recv(), and pq_sendint().

{
    union
    {
        float4      f;
        uint32      i;
    }           swap;

    swap.i = pq_getmsgint(msg, 4);
    return swap.f;
}

pq_getmsgfloat8()

float8 pq_getmsgfloat8

(

StringInfo

msg

)

Definition at line 490 of file pqformat.c.

References i, pq_getmsgint64(), and swap.

Referenced by box_recv(), circle_recv(), complex_recv(), float8recv(), line_recv(), lseg_recv(), path_recv(), point_recv(), poly_recv(), and pq_sendint().

{
    union
    {
        float8      f;
        int64       i;
    }           swap;

    swap.i = pq_getmsgint64(msg);
    return swap.f;
}

pq_getmsgint()

unsigned int pq_getmsgint	(	StringInfo	msg,
		int	b
	)

Definition at line 417 of file pqformat.c.

References elog, ERROR, pg_ntoh16, pg_ntoh32, and pq_copymsgbytes().

Referenced by array_recv(), bit_recv(), CheckSCRAMAuth(), cidrecv(), date_recv(), exec_bind_message(), HandleFunctionRequest(), HandleParallelMessage(), hstore_recv(), int2recv(), int4recv(), interval_recv(), jsonb_recv(), jsonpath_recv(), logicalrep_read_attrs(), logicalrep_read_begin(), logicalrep_read_delete(), logicalrep_read_insert(), logicalrep_read_rel(), logicalrep_read_truncate(), logicalrep_read_tuple(), logicalrep_read_typ(), logicalrep_read_update(), numeric_avg_deserialize(), numeric_deserialize(), numeric_recv(), oidrecv(), parse_fcall_arguments(), parse_fcall_arguments_20(), path_recv(), poly_recv(), PostgresMain(), pq_getmsgfloat4(), pq_sendint(), ProcessStandbyHSFeedbackMessage(), range_recv(), ReadArrayBinary(), record_recv(), tidrecv(), timetz_recv(), tsqueryrecv(), tsvectorrecv(), txid_snapshot_recv(), varbit_recv(), and xidrecv().

{
    unsigned int result;
    unsigned char n8;
    uint16      n16;
    uint32      n32;

    switch (b)
    {
        case 1:
            pq_copymsgbytes(msg, (char *) &n8, 1);
            result = n8;
            break;
        case 2:
            pq_copymsgbytes(msg, (char *) &n16, 2);
            result = pg_ntoh16(n16);
            break;
        case 4:
            pq_copymsgbytes(msg, (char *) &n32, 4);
            result = pg_ntoh32(n32);
            break;
        default:
            elog(ERROR, "unsupported integer size %d", b);
            result = 0;         /* keep compiler quiet */
            break;
    }
    return result;
}

pq_getmsgint64()

int64 pq_getmsgint64

(

StringInfo

msg

)

Definition at line 455 of file pqformat.c.

References pg_ntoh64, and pq_copymsgbytes().

Referenced by cash_recv(), int8_avg_deserialize(), int8recv(), interval_recv(), logicalrep_read_begin(), logicalrep_read_commit(), logicalrep_read_origin(), LogicalRepApplyLoop(), numeric_avg_deserialize(), numeric_deserialize(), numeric_poly_deserialize(), pg_lsn_recv(), pq_getmsgfloat8(), pq_sendint(), ProcessStandbyHSFeedbackMessage(), ProcessStandbyReplyMessage(), time_recv(), timestamp_recv(), timestamptz_recv(), timetz_recv(), txid_snapshot_recv(), and XLogWalRcvProcessMsg().

{
    uint64      n64;

    pq_copymsgbytes(msg, (char *) &n64, sizeof(n64));

    return pg_ntoh64(n64);
}

pq_getmsgrawstring()

const char* pq_getmsgrawstring

(

StringInfo

msg

)

Definition at line 610 of file pqformat.c.

References StringInfoData::cursor, StringInfoData::data, ereport, errcode(), errmsg(), ERROR, StringInfoData::len, and generate_unaccent_rules::str.

Referenced by CheckSCRAMAuth(), HandleParallelMessage(), pq_parse_errornotice(), and pq_sendint().

{
    char       *str;
    int         slen;

    str = &msg->data[msg->cursor];

    /*
     * It's safe to use strlen() here because a StringInfo is guaranteed to
     * have a trailing null byte.  But check we found a null inside the
     * message.
     */
    slen = strlen(str);
    if (msg->cursor + slen >= msg->len)
        ereport(ERROR,
                (errcode(ERRCODE_PROTOCOL_VIOLATION),
                 errmsg("invalid string in message")));
    msg->cursor += slen + 1;

    return str;
}

pq_getmsgstring()

const char* pq_getmsgstring

(

StringInfo

msg

)

Definition at line 581 of file pqformat.c.

References StringInfoData::cursor, StringInfoData::data, ereport, errcode(), errmsg(), ERROR, StringInfoData::len, pg_client_to_server(), and generate_unaccent_rules::str.

Referenced by CopyGetData(), exec_bind_message(), HandleFunctionRequest(), logicalrep_read_attrs(), logicalrep_read_namespace(), logicalrep_read_origin(), logicalrep_read_rel(), logicalrep_read_typ(), PostgresMain(), pq_sendint(), tsqueryrecv(), and tsvectorrecv().

{
    char       *str;
    int         slen;

    str = &msg->data[msg->cursor];

    /*
     * It's safe to use strlen() here because a StringInfo is guaranteed to
     * have a trailing null byte.  But check we found a null inside the
     * message.
     */
    slen = strlen(str);
    if (msg->cursor + slen >= msg->len)
        ereport(ERROR,
                (errcode(ERRCODE_PROTOCOL_VIOLATION),
                 errmsg("invalid string in message")));
    msg->cursor += slen + 1;

    return pg_client_to_server(str, slen);
}

pq_getmsgtext()

char* pq_getmsgtext	(	StringInfo	msg,
		int	rawbytes,
		int *	nbytes
	)

Definition at line 548 of file pqformat.c.

References StringInfoData::cursor, StringInfoData::data, ereport, errcode(), errmsg(), ERROR, StringInfoData::len, palloc(), pg_client_to_server(), and generate_unaccent_rules::str.

Referenced by bpcharrecv(), cstring_recv(), enum_recv(), hstore_recv(), json_recv(), jsonb_recv(), jsonpath_recv(), namerecv(), pq_sendint(), textrecv(), unknownrecv(), and varcharrecv().

{
    char       *str;
    char       *p;

    if (rawbytes < 0 || rawbytes > (msg->len - msg->cursor))
        ereport(ERROR,
                (errcode(ERRCODE_PROTOCOL_VIOLATION),
                 errmsg("insufficient data left in message")));
    str = &msg->data[msg->cursor];
    msg->cursor += rawbytes;

    p = pg_client_to_server(str, rawbytes);
    if (p != str)               /* actual conversion has been done? */
        *nbytes = strlen(p);
    else
    {
        p = (char *) palloc(rawbytes + 1);
        memcpy(p, str, rawbytes);
        p[rawbytes] = '\0';
        *nbytes = rawbytes;
    }
    return p;
}

pq_putemptymessage()

void pq_putemptymessage

(

char

msgtype

)

Definition at line 390 of file pqformat.c.

References pq_putmessage.

Referenced by exec_bind_message(), exec_describe_portal_message(), exec_describe_statement_message(), exec_execute_message(), exec_parse_message(), NullCommand(), perform_base_backup(), PostgresMain(), pq_sendint(), ReadyForQuery(), ReceiveCopyBegin(), SendCopyBegin(), and SendCopyEnd().

{
    (void) pq_putmessage(msgtype, NULL, 0);
}

pq_puttextmessage()

void pq_puttextmessage	(	char	msgtype,
		const char *	str
	)

Definition at line 369 of file pqformat.c.

References pfree(), pg_server_to_client(), and pq_putmessage.

Referenced by pq_sendint(), printtup_startup(), SendBackupHeader(), SendXlogRecPtrResult(), and StartReplication().

{
    int         slen = strlen(str);
    char       *p;

    p = pg_server_to_client(str, slen);
    if (p != str)               /* actual conversion has been done? */
    {
        (void) pq_putmessage(msgtype, p, strlen(p) + 1);
        pfree(p);
        return;
    }
    (void) pq_putmessage(msgtype, str, slen + 1);
}

pq_send_ascii_string()

void pq_send_ascii_string	(	StringInfo	buf,
		const char *	str
	)

Definition at line 229 of file pqformat.c.

References appendStringInfoChar(), appendStringInfoCharMacro, and IS_HIGHBIT_SET.

Referenced by err_sendstring().

{
    while (*str)
    {
        char        ch = *str++;

        if (IS_HIGHBIT_SET(ch))
            ch = '?';
        appendStringInfoCharMacro(buf, ch);
    }
    appendStringInfoChar(buf, '\0');
}

pq_sendbytes()

void pq_sendbytes	(	StringInfo	buf,
		const char *	data,
		int	datalen
	)

Definition at line 125 of file pqformat.c.

References appendBinaryStringInfo().

Referenced by array_send(), int8_avg_serialize(), numeric_avg_serialize(), numeric_poly_serialize(), numeric_serialize(), printtup(), printtup_internal_20(), range_send(), record_send(), send_int8_string(), sendAuthRequest(), SendBackupHeader(), SendFunctionResult(), SendTimeLineHistory(), SendXlogRecPtrResult(), uuid_send(), and varbit_send().

{
    /* use variant that maintains a trailing null-byte, out of caution */
    appendBinaryStringInfo(buf, data, datalen);
}

pq_sendcountedtext()

void pq_sendcountedtext	(	StringInfo	buf,
		const char *	str,
		int	slen,
		bool	countincludesself
	)

Definition at line 142 of file pqformat.c.

References appendBinaryStringInfoNT(), pfree(), pg_server_to_client(), and pq_sendint32().

Referenced by logicalrep_write_tuple(), printsimple(), printtup(), printtup_20(), and SendFunctionResult().

{
    int         extra = countincludesself ? 4 : 0;
    char       *p;

    p = pg_server_to_client(str, slen);
    if (p != str)               /* actual conversion has been done? */
    {
        slen = strlen(p);
        pq_sendint32(buf, slen + extra);
        appendBinaryStringInfoNT(buf, p, slen);
        pfree(p);
    }
    else
    {
        pq_sendint32(buf, slen + extra);
        appendBinaryStringInfoNT(buf, str, slen);
    }
}

pq_sendfloat4()

void pq_sendfloat4	(	StringInfo	buf,
		float4	f
	)

Definition at line 254 of file pqformat.c.

References i, pq_sendint32(), and swap.

Referenced by float4send().

{
    union
    {
        float4      f;
        uint32      i;
    }           swap;

    swap.f = f;
    pq_sendint32(buf, swap.i);
}

pq_sendfloat8()

void pq_sendfloat8	(	StringInfo	buf,
		float8	f
	)

Definition at line 278 of file pqformat.c.

References i, pq_sendint64(), and swap.

Referenced by box_send(), circle_send(), complex_send(), float8send(), line_send(), lseg_send(), path_send(), point_send(), and poly_send().

{
    union
    {
        float8      f;
        int64       i;
    }           swap;

    swap.f = f;
    pq_sendint64(buf, swap.i);
}

pq_sendstring()

void pq_sendstring	(	StringInfo	buf,
		const char *	str
	)

Definition at line 197 of file pqformat.c.

References appendBinaryStringInfoNT(), pfree(), and pg_server_to_client().

Referenced by err_sendstring(), logicalrep_write_attrs(), logicalrep_write_namespace(), logicalrep_write_origin(), logicalrep_write_rel(), logicalrep_write_typ(), NotifyMyFrontEnd(), printsimple_startup(), ReportGUCOption(), SendBackupHeader(), SendNegotiateProtocolVersion(), SendRowDescriptionCols_2(), SendTimeLineHistory(), SendXlogRecPtrResult(), and tsquerysend().

{
    int         slen = strlen(str);
    char       *p;

    p = pg_server_to_client(str, slen);
    if (p != str)               /* actual conversion has been done? */
    {
        slen = strlen(p);
        appendBinaryStringInfoNT(buf, p, slen + 1);
        pfree(p);
    }
    else
        appendBinaryStringInfoNT(buf, str, slen + 1);
}

pq_sendtext()

void pq_sendtext	(	StringInfo	buf,
		const char *	str,
		int	slen
	)

Definition at line 174 of file pqformat.c.

References appendBinaryStringInfo(), pfree(), and pg_server_to_client().

Referenced by cstring_send(), enum_send(), hstore_send(), json_send(), jsonb_send(), jsonpath_send(), namesend(), textsend(), tsvectorsend(), unknownsend(), and xml_send().

{
    char       *p;

    p = pg_server_to_client(str, slen);
    if (p != str)               /* actual conversion has been done? */
    {
        slen = strlen(p);
        appendBinaryStringInfo(buf, p, slen);
        pfree(p);
    }
    else
        appendBinaryStringInfo(buf, str, slen);
}