encode.c File Reference

#include "postgres.h"
#include <ctype.h>
#include "common/hex.h"
#include "mb/pg_wchar.h"
#include "utils/builtins.h"
#include "utils/memutils.h"

Include dependency graph for encode.c:

Go to the source code of this file.

Data Structures
struct	pg_encoding

Macros
#define	VAL(CH)   ((CH) - '0')
#define	DIG(VAL)   ((VAL) + '0')

Functions
static const struct pg_encoding *	pg_find_encoding (const char *name)
Datum	binary_encode (PG_FUNCTION_ARGS)
Datum	binary_decode (PG_FUNCTION_ARGS)
static uint64	hex_enc_len (const char *src, size_t srclen)
static uint64	hex_dec_len (const char *src, size_t srclen)
static uint64	pg_base64_encode (const char *src, size_t srclen, char *dst, size_t dstlen)
static uint64	pg_base64_decode (const char *src, size_t srclen, char *dst, size_t dstlen)
static uint64	pg_base64_enc_len (const char *src, size_t srclen)
static uint64	pg_base64_dec_len (const char *src, size_t srclen)
static uint64	esc_encode (const char *src, size_t srclen, char *dst, size_t dstlen)
static uint64	esc_decode (const char *src, size_t srclen, char *dst, size_t dstlen)
static uint64	esc_enc_len (const char *src, size_t srclen)
static uint64	esc_dec_len (const char *src, size_t srclen)

Variables
static const char	_base64 []
static const int8	b64lookup [128]
struct {
const char *   name
struct pg_encoding   enc
}	enclist []

Macro Definition Documentation

DIG

#define DIG

(

VAL

)

((VAL) + '0')

Definition at line 340 of file encode.c.

Referenced by esc_encode().

VAL

#define VAL

(

CH

)

((CH) - '0')

Definition at line 339 of file encode.c.

Referenced by esc_decode().

Function Documentation

binary_decode()

Datum binary_decode

(

PG_FUNCTION_ARGS

)

Definition at line 94 of file encode.c.

References pg_encoding::decode, pg_encoding::decode_len, enc, ereport, errcode(), errmsg(), ERROR, MaxAllocSize, name, palloc(), pg_find_encoding(), PG_GETARG_DATUM, PG_GETARG_TEXT_PP, PG_RETURN_BYTEA_P, SET_VARSIZE, TextDatumGetCString, VARDATA, VARDATA_ANY, VARHDRSZ, and VARSIZE_ANY_EXHDR.

{
    text       *data = PG_GETARG_TEXT_PP(0);
    Datum       name = PG_GETARG_DATUM(1);
    bytea      *result;
    char       *namebuf;
    char       *dataptr;
    size_t      datalen;
    uint64      resultlen;
    uint64      res;
    const struct pg_encoding *enc;

    namebuf = TextDatumGetCString(name);

    enc = pg_find_encoding(namebuf);
    if (enc == NULL)
        ereport(ERROR,
                (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
                 errmsg("unrecognized encoding: \"%s\"", namebuf)));

    dataptr = VARDATA_ANY(data);
    datalen = VARSIZE_ANY_EXHDR(data);

    resultlen = enc->decode_len(dataptr, datalen);

    /*
     * resultlen possibly overflows uint32, therefore on 32-bit machines it's
     * unsafe to rely on palloc's internal check.
     */
    if (resultlen > MaxAllocSize - VARHDRSZ)
        ereport(ERROR,
                (errcode(ERRCODE_PROGRAM_LIMIT_EXCEEDED),
                 errmsg("result of decoding conversion is too large")));

    result = palloc(VARHDRSZ + resultlen);

    res = enc->decode(dataptr, datalen, VARDATA(result), resultlen);

    SET_VARSIZE(result, VARHDRSZ + res);

    PG_RETURN_BYTEA_P(result);
}

binary_encode()

Datum binary_encode

(

PG_FUNCTION_ARGS

)

Definition at line 50 of file encode.c.

References enc, pg_encoding::encode, pg_encoding::encode_len, ereport, errcode(), errmsg(), ERROR, MaxAllocSize, name, palloc(), pg_find_encoding(), PG_GETARG_BYTEA_PP, PG_GETARG_DATUM, PG_RETURN_TEXT_P, SET_VARSIZE, TextDatumGetCString, VARDATA, VARDATA_ANY, VARHDRSZ, and VARSIZE_ANY_EXHDR.

{
    bytea      *data = PG_GETARG_BYTEA_PP(0);
    Datum       name = PG_GETARG_DATUM(1);
    text       *result;
    char       *namebuf;
    char       *dataptr;
    size_t      datalen;
    uint64      resultlen;
    uint64      res;
    const struct pg_encoding *enc;

    namebuf = TextDatumGetCString(name);

    enc = pg_find_encoding(namebuf);
    if (enc == NULL)
        ereport(ERROR,
                (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
                 errmsg("unrecognized encoding: \"%s\"", namebuf)));

    dataptr = VARDATA_ANY(data);
    datalen = VARSIZE_ANY_EXHDR(data);

    resultlen = enc->encode_len(dataptr, datalen);

    /*
     * resultlen possibly overflows uint32, therefore on 32-bit machines it's
     * unsafe to rely on palloc's internal check.
     */
    if (resultlen > MaxAllocSize - VARHDRSZ)
        ereport(ERROR,
                (errcode(ERRCODE_PROGRAM_LIMIT_EXCEEDED),
                 errmsg("result of encoding conversion is too large")));

    result = palloc(VARHDRSZ + resultlen);

    res = enc->encode(dataptr, datalen, VARDATA(result), resultlen);

    SET_VARSIZE(result, VARHDRSZ + res);

    PG_RETURN_TEXT_P(result);
}

esc_dec_len()

static uint64 esc_dec_len ( const char *  src, size_t  srclen  )

static

Definition at line 467 of file encode.c.

References ereport, errcode(), errmsg(), and ERROR.

{
    const char *end = src + srclen;
    uint64      len = 0;

    while (src < end)
    {
        if (src[0] != '\\')
            src++;
        else if (src + 3 < end &&
                 (src[1] >= '0' && src[1] <= '3') &&
                 (src[2] >= '0' && src[2] <= '7') &&
                 (src[3] >= '0' && src[3] <= '7'))
        {
            /*
             * backslash + valid octal
             */
            src += 4;
        }
        else if (src + 1 < end &&
                 (src[1] == '\\'))
        {
            /*
             * two backslashes = backslash
             */
            src += 2;
        }
        else
        {
            /*
             * one backslash, not followed by ### valid octal
             */
            ereport(ERROR,
                    (errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
                     errmsg("invalid input syntax for type %s", "bytea")));
        }

        len++;
    }
    return len;
}

esc_decode()

static uint64 esc_decode ( const char *  src, size_t  srclen, char *  dst, size_t  dstlen  )

static

Definition at line 389 of file encode.c.

References Assert, elog, ereport, errcode(), errmsg(), ERROR, VAL, and val.

{
    const char *end = src + srclen;
    char       *rp = dst;
    uint64      len = 0;

    while (src < end)
    {
        if (src[0] != '\\')
        {
            if ((rp - dst + 1) > dstlen)
                elog(ERROR, "overflow of destination buffer in escape decoding");
            *rp++ = *src++;
        }
        else if (src + 3 < end &&
                 (src[1] >= '0' && src[1] <= '3') &&
                 (src[2] >= '0' && src[2] <= '7') &&
                 (src[3] >= '0' && src[3] <= '7'))
        {
            int         val;

            val = VAL(src[1]);
            val <<= 3;
            val += VAL(src[2]);
            val <<= 3;
            if ((rp - dst + 1) > dstlen)
                elog(ERROR, "overflow of destination buffer in escape decoding");
            *rp++ = val + VAL(src[3]);
            src += 4;
        }
        else if (src + 1 < end &&
                 (src[1] == '\\'))
        {
            if ((rp - dst + 1) > dstlen)
                elog(ERROR, "overflow of destination buffer in escape decoding");
            *rp++ = '\\';
            src += 2;
        }
        else
        {
            /*
             * One backslash, not followed by ### valid octal. Should never
             * get here, since esc_dec_len does same check.
             */
            ereport(ERROR,
                    (errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
                     errmsg("invalid input syntax for type %s", "bytea")));
        }

        len++;
    }

    Assert((rp - dst) <= dstlen);
    return len;
}

esc_enc_len()

static uint64 esc_enc_len ( const char *  src, size_t  srclen  )

static

Definition at line 446 of file encode.c.

References IS_HIGHBIT_SET.

{
    const char *end = src + srclen;
    uint64      len = 0;

    while (src < end)
    {
        if (*src == '\0' || IS_HIGHBIT_SET(*src))
            len += 4;
        else if (*src == '\\')
            len += 2;
        else
            len++;

        src++;
    }

    return len;
}

esc_encode()

static uint64 esc_encode ( const char *  src, size_t  srclen, char *  dst, size_t  dstlen  )

static

Definition at line 343 of file encode.c.

References Assert, DIG, elog, ERROR, and IS_HIGHBIT_SET.

{
    const char *end = src + srclen;
    char       *rp = dst;
    uint64      len = 0;

    while (src < end)
    {
        unsigned char c = (unsigned char) *src;

        if (c == '\0' || IS_HIGHBIT_SET(c))
        {
            if ((rp - dst + 4) > dstlen)
                elog(ERROR, "overflow of destination buffer in escape encoding");
            rp[0] = '\\';
            rp[1] = DIG(c >> 6);
            rp[2] = DIG((c >> 3) & 7);
            rp[3] = DIG(c & 7);
            rp += 4;
            len += 4;
        }
        else if (c == '\\')
        {
            if ((rp - dst + 2) > dstlen)
                elog(ERROR, "overflow of destination buffer in escape encoding");
            rp[0] = '\\';
            rp[1] = '\\';
            rp += 2;
            len += 2;
        }
        else
        {
            if ((rp - dst + 1) > dstlen)
                elog(ERROR, "overflow of destination buffer in escape encoding");
            *rp++ = c;
            len++;
        }

        src++;
    }

    Assert((rp - dst) <= dstlen);
    return len;
}

hex_dec_len()

static uint64 hex_dec_len ( const char *  src, size_t  srclen  )

static

Definition at line 153 of file encode.c.

References pg_hex_dec_len().

{
    return pg_hex_dec_len(srclen);
}

hex_enc_len()

static uint64 hex_enc_len ( const char *  src, size_t  srclen  )

static

Definition at line 147 of file encode.c.

References pg_hex_enc_len().

{
    return pg_hex_enc_len(srclen);
}

pg_base64_dec_len()

static uint64 pg_base64_dec_len ( const char *  src, size_t  srclen  )

static

Definition at line 320 of file encode.c.

{
    return ((uint64) srclen * 3) >> 2;
}

pg_base64_decode()

static uint64 pg_base64_decode ( const char *  src, size_t  srclen, char *  dst, size_t  dstlen  )

static

Definition at line 231 of file encode.c.

References Assert, b64lookup, buf, elog, ereport, errcode(), errhint(), errmsg(), ERROR, and pg_mblen().

{
    const char *srcend = src + srclen,
               *s = src;
    char       *p = dst;
    char        c;
    int         b = 0;
    uint32      buf = 0;
    int         pos = 0,
                end = 0;

    while (s < srcend)
    {
        c = *s++;

        if (c == ' ' || c == '\t' || c == '\n' || c == '\r')
            continue;

        if (c == '=')
        {
            /* end sequence */
            if (!end)
            {
                if (pos == 2)
                    end = 1;
                else if (pos == 3)
                    end = 2;
                else
                    ereport(ERROR,
                            (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
                             errmsg("unexpected \"=\" while decoding base64 sequence")));
            }
            b = 0;
        }
        else
        {
            b = -1;
            if (c > 0 && c < 127)
                b = b64lookup[(unsigned char) c];
            if (b < 0)
                ereport(ERROR,
                        (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
                         errmsg("invalid symbol \"%.*s\" found while decoding base64 sequence",
                                pg_mblen(s - 1), s - 1)));
        }
        /* add it to buffer */
        buf = (buf << 6) + b;
        pos++;
        if (pos == 4)
        {
            if ((p - dst + 1) > dstlen)
                elog(ERROR, "overflow of destination buffer in base64 decoding");
            *p++ = (buf >> 16) & 255;
            if (end == 0 || end > 1)
            {
                if ((p - dst + 1) > dstlen)
                    elog(ERROR, "overflow of destination buffer in base64 decoding");
                *p++ = (buf >> 8) & 255;
            }
            if (end == 0 || end > 2)
            {
                if ((p - dst + 1) > dstlen)
                    elog(ERROR, "overflow of destination buffer in base64 decoding");
                *p++ = buf & 255;
            }
            buf = 0;
            pos = 0;
        }
    }

    if (pos != 0)
        ereport(ERROR,
                (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
                 errmsg("invalid base64 end sequence"),
                 errhint("Input data is missing padding, is truncated, or is otherwise corrupted.")));

    Assert((p - dst) <= dstlen);
    return p - dst;
}

pg_base64_enc_len()

static uint64 pg_base64_enc_len ( const char *  src, size_t  srclen  )

static

Definition at line 313 of file encode.c.

{
    /* 3 bytes will be converted to 4, linefeed after 76 chars */
    return ((uint64) srclen + 2) * 4 / 3 + (uint64) srclen / (76 * 3 / 4);
}

pg_base64_encode()

static uint64 pg_base64_encode ( const char *  src, size_t  srclen, char *  dst, size_t  dstlen  )

static

Definition at line 177 of file encode.c.

References _base64, Assert, buf, elog, and ERROR.

{
    char       *p,
               *lend = dst + 76;
    const char *s,
               *end = src + srclen;
    int         pos = 2;
    uint32      buf = 0;

    s = src;
    p = dst;

    while (s < end)
    {
        buf |= (unsigned char) *s << (pos << 3);
        pos--;
        s++;

        /* write it out */
        if (pos < 0)
        {
            if ((p - dst + 4) > dstlen)
                elog(ERROR, "overflow of destination buffer in base64 encoding");
            *p++ = _base64[(buf >> 18) & 0x3f];
            *p++ = _base64[(buf >> 12) & 0x3f];
            *p++ = _base64[(buf >> 6) & 0x3f];
            *p++ = _base64[buf & 0x3f];

            pos = 2;
            buf = 0;
        }
        if (p >= lend)
        {
            if ((p - dst + 1) > dstlen)
                elog(ERROR, "overflow of destination buffer in base64 encoding");
            *p++ = '\n';
            lend = p + 76;
        }
    }
    if (pos != 2)
    {
        if ((p - dst + 4) > dstlen)
            elog(ERROR, "overflow of destination buffer in base64 encoding");
        *p++ = _base64[(buf >> 18) & 0x3f];
        *p++ = _base64[(buf >> 12) & 0x3f];
        *p++ = (pos == 0) ? _base64[(buf >> 6) & 0x3f] : '=';
        *p++ = '=';
    }

    Assert((p - dst) <= dstlen);
    return p - dst;
}

pg_find_encoding()

static const struct pg_encoding * pg_find_encoding ( const char *  name )

static

Definition at line 547 of file encode.c.

References enclist, i, and pg_strcasecmp().

Referenced by binary_decode(), and binary_encode().

{
    int         i;

    for (i = 0; enclist[i].name; i++)
        if (pg_strcasecmp(enclist[i].name, name) == 0)
            return &enclist[i].enc;

    return NULL;
}

Variable Documentation

_base64

const char _base64[]

static

Initial value:

=
"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/"

Definition at line 162 of file encode.c.

Referenced by pg_base64_encode().

b64lookup

const int8 b64lookup[128]

static

Initial value:

= {
    -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
    -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
    -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, 62, -1, -1, -1, 63,
    52, 53, 54, 55, 56, 57, 58, 59, 60, 61, -1, -1, -1, -1, -1, -1,
    -1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14,
    15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, -1, -1, -1, -1, -1,
    -1, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40,
    41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, -1, -1, -1, -1, -1,
}

Definition at line 165 of file encode.c.

Referenced by pg_base64_decode().

enc

struct pg_encoding enc

Definition at line 516 of file encode.c.

Referenced by binary_decode(), binary_encode(), get_encoding_id(), pg_import_system_collations(), pg_stat_statements_internal(), pg_valid_client_encoding(), pg_valid_server_encoding(), to_ascii_default(), to_ascii_enc(), and to_ascii_encname().

enclist

const { ... } enclist[]

Initial value:

=

{
    {
        "hex",
        {
            hex_enc_len, hex_dec_len, pg_hex_encode, pg_hex_decode
        }
    },
    {
        "base64",
        {
            pg_base64_enc_len, pg_base64_dec_len, pg_base64_encode, pg_base64_decode
        }
    },
    {
        "escape",
        {
            esc_enc_len, esc_dec_len, esc_encode, esc_decode
        }
    },
    {
        NULL,
        {
            NULL, NULL, NULL, NULL
        }
    }
}

Referenced by pg_find_encoding().

name

const char* name

Definition at line 515 of file encode.c.

Referenced by _copyAExpr(), _copyAlterDomainStmt(), _copyAlterTableCmd(), _copyCreateOpClassItem(), _copyDeallocateStmt(), _copyExecuteStmt(), _copyFunctionParameter(), _copyIndexElem(), _copyNamedArgExpr(), _copyPartitionCmd(), _copyPartitionElem(), _copyPLAssignStmt(), _copyPrepareStmt(), _copyReindexStmt(), _copyReplicaIdentityStmt(), _copyResTarget(), _copyStatsElem(), _copyTriggerTransition(), _copyVariableSetStmt(), _copyVariableShowStmt(), _copyWindowClause(), _copyWindowDef(), _copyXmlExpr(), _equalAExpr(), _equalAlterDomainStmt(), _equalAlterTableCmd(), _equalCreateOpClassItem(), _equalDeallocateStmt(), _equalExecuteStmt(), _equalFunctionParameter(), _equalIndexElem(), _equalNamedArgExpr(), _equalPartitionCmd(), _equalPartitionElem(), _equalPLAssignStmt(), _equalPrepareStmt(), _equalReindexStmt(), _equalReplicaIdentityStmt(), _equalResTarget(), _equalStatsElem(), _equalTriggerTransition(), _equalVariableSetStmt(), _equalVariableShowStmt(), _equalWindowClause(), _equalWindowDef(), _equalXmlExpr(), _outAExpr(), _outIndexElem(), _outNamedArgExpr(), _outPartitionElem(), _outPLAssignStmt(), _outResTarget(), _outStatsElem(), _outTriggerTransition(), _outWindowClause(), _outWindowDef(), _outXmlExpr(), _readNamedArgExpr(), _readWindowClause(), _readXmlExpr(), aclparse(), aes_cbc_decrypt(), AllocSetContextCreateInternal(), AllocSetStats(), AlterObjectNamespace_internal(), AlterSystemSetConfigFile(), AlterTableGetRelOptionsLockLevel(), appendReloptionsArray(), assignVariables(), AuxiliaryPidGetProc(), binary_decode(), binary_encode(), BuildOnConflictExcludedTargetlist(), check_duplicates_in_publist(), check_encoding_conversion_args(), checkInsertTargets(), choose_dsm_implementation(), ChooseExtendedStatisticNameAddition(), ChooseForeignKeyConstraintNameAddition(), ChooseIndexNameAddition(), compareVariableNames(), convert_sourcefiles_in(), convertRegProcReference(), CopyGetAttnums(), CreateTrigger(), cursor_to_xml(), cursor_to_xmlschema(), deallocate_one(), define_custom_variable(), DescribeQuery(), do_pset(), does_not_exist_skipping(), dsm_impl_mmap(), dsm_impl_op(), dsm_impl_pin_segment(), dsm_impl_sysv(), dsm_impl_unpin_segment(), dump_block(), dupEvents(), eats(), ecpg_register_prepared_stmt(), ECPGdescribe(), enum_in(), enum_recv(), ExecParallelHashJoinSetUpBatches(), expandNSItemAttrs(), FigureColname(), FigureIndexColname(), find_option(), findTargetlistEntrySQL92(), GenerationFree(), GenerationRealloc(), GenerationStats(), get_collation_actual_version(), get_object_address_unqualified(), get_prompt(), get_reloptions(), get_type(), GetMemoryChunkContext(), getopt_long(), initialize_reloptions(), initialize_worker_spi(), InitializeClientEncoding(), InitializeLWLocks(), leftmostvalue_name(), listAvailableScripts(), llvm_resolve_symbol(), lookupVariable(), main(), makeA_Expr(), makeDefElem(), makeDefElemExtended(), makeFuncCall(), makeObjectName(), MemoryContextCreate(), MemoryContextStatsPrint(), merge_publications(), MergeAttributes(), mkdirs(), namecheck(), NameListToString(), parseQuery(), parseVariable(), pg_any_to_server(), pg_create_logical_replication_slot(), pg_create_physical_replication_slot(), pg_digest(), pg_drop_replication_slot(), pg_fe_getauthname(), pg_get_functiondef(), pg_get_object_address(), pg_hmac(), pg_import_system_collations(), pg_logging_init(), pg_logical_slot_get_changes_guts(), pg_open_tzfile(), pg_replication_origin_advance(), pg_replication_origin_create(), pg_replication_origin_drop(), pg_replication_origin_oid(), pg_replication_origin_progress(), pg_replication_origin_session_setup(), pg_stat_get_slru(), pg_unicode_to_server(), pgstat_get_replslot_entry(), pgstat_reset_slru_counter(), pgtls_verify_peer_name_matches_certificate_guts(), PLy_traceback(), PostmasterMain(), pp_require_safe(), pq_verify_peer_name_matches_certificate_name(), process_postgres_switches(), process_startup_options(), ProcessGUCArray(), PutMemoryContextsStatsTupleStore(), px_resolve_alias(), repairDependencyLoop(), report_invalid_encoding(), report_multiple_error_messages(), report_untranslatable_char(), ResourceOwnerCreate(), ri_ReportViolation(), run_permutation(), scan_available_timezones(), schema_to_xml(), schema_to_xml_and_xmlschema(), schema_to_xmlschema(), sendCommand(), seq_search_ascii(), set_config_by_name(), set_ps_display(), SetMessageEncoding(), show_item(), SlabStats(), strlist_to_textarray(), sts_parallel_scan_next(), sts_puttuple(), tarOpen(), TSConfigIsVisible(), TSDictionaryIsVisible(), TSParserIsVisible(), TSTemplateIsVisible(), TypeCreate(), TypeShellMake(), tzloadbody(), tzparse(), and xml_is_document().