uuid-ossp.c File Reference

#include "postgres.h"
#include "common/cryptohash.h"
#include "common/sha1.h"
#include "fmgr.h"
#include "port/pg_bswap.h"
#include "utils/builtins.h"
#include "utils/uuid.h"
#include "varatt.h"

Include dependency graph for uuid-ossp.c:

Go to the source code of this file.

Macros
#define	uuid_hash   bsd_uuid_hash
#define	UUID_MAKE_MC   0
#define	UUID_MAKE_V1   1
#define	UUID_MAKE_V2   2
#define	UUID_MAKE_V3   3
#define	UUID_MAKE_V4   4
#define	UUID_MAKE_V5   5
#define	dce_uuid_t   uuid_t
#define	UUID_TO_NETWORK(uu)
#define	UUID_TO_LOCAL(uu)
#define	UUID_V3_OR_V5(uu, v)

Functions
	PG_MODULE_MAGIC_EXT (.name="uuid-ossp",.version=PG_VERSION)
	PG_FUNCTION_INFO_V1 (uuid_nil)
	PG_FUNCTION_INFO_V1 (uuid_ns_dns)
	PG_FUNCTION_INFO_V1 (uuid_ns_url)
	PG_FUNCTION_INFO_V1 (uuid_ns_oid)
	PG_FUNCTION_INFO_V1 (uuid_ns_x500)
	PG_FUNCTION_INFO_V1 (uuid_generate_v1)
	PG_FUNCTION_INFO_V1 (uuid_generate_v1mc)
	PG_FUNCTION_INFO_V1 (uuid_generate_v3)
	PG_FUNCTION_INFO_V1 (uuid_generate_v4)
	PG_FUNCTION_INFO_V1 (uuid_generate_v5)
static Datum	uuid_generate_internal (int v, unsigned char *ns, const char *ptr, int len)
Datum	uuid_nil (PG_FUNCTION_ARGS)
Datum	uuid_ns_dns (PG_FUNCTION_ARGS)
Datum	uuid_ns_url (PG_FUNCTION_ARGS)
Datum	uuid_ns_oid (PG_FUNCTION_ARGS)
Datum	uuid_ns_x500 (PG_FUNCTION_ARGS)
Datum	uuid_generate_v1 (PG_FUNCTION_ARGS)
Datum	uuid_generate_v1mc (PG_FUNCTION_ARGS)
Datum	uuid_generate_v3 (PG_FUNCTION_ARGS)
Datum	uuid_generate_v4 (PG_FUNCTION_ARGS)
Datum	uuid_generate_v5 (PG_FUNCTION_ARGS)

Macro Definition Documentation

dce_uuid_t

#define dce_uuid_t   uuid_t

Definition at line 75 of file uuid-ossp.c.

uuid_hash

#define uuid_hash   bsd_uuid_hash

Definition at line 31 of file uuid-ossp.c.

UUID_MAKE_MC

#define UUID_MAKE_MC   0

Definition at line 52 of file uuid-ossp.c.

UUID_MAKE_V1

#define UUID_MAKE_V1   1

Definition at line 53 of file uuid-ossp.c.

UUID_MAKE_V2

#define UUID_MAKE_V2   2

Definition at line 54 of file uuid-ossp.c.

UUID_MAKE_V3

#define UUID_MAKE_V3   3

Definition at line 55 of file uuid-ossp.c.

UUID_MAKE_V4

#define UUID_MAKE_V4   4

Definition at line 56 of file uuid-ossp.c.

UUID_MAKE_V5

#define UUID_MAKE_V5   5

Definition at line 57 of file uuid-ossp.c.

UUID_TO_LOCAL

#define UUID_TO_LOCAL

(

uu

)

Value:

do { \
    uu.time_low = pg_ntoh32(uu.time_low); \
    uu.time_mid = pg_ntoh16(uu.time_mid); \
    uu.time_hi_and_version = pg_ntoh16(uu.time_hi_and_version); \
} while (0)

Definition at line 88 of file uuid-ossp.c.

   { \
    uu.time_low = pg_ntoh32(uu.time_low); \
    uu.time_mid = pg_ntoh16(uu.time_mid); \
    uu.time_hi_and_version = pg_ntoh16(uu.time_hi_and_version); \
} while (0)

UUID_TO_NETWORK

#define UUID_TO_NETWORK

(

uu

)

Value:

do { \
    uu.time_low = pg_hton32(uu.time_low); \
    uu.time_mid = pg_hton16(uu.time_mid); \
    uu.time_hi_and_version = pg_hton16(uu.time_hi_and_version); \
} while (0)

Definition at line 81 of file uuid-ossp.c.

   { \
    uu.time_low = pg_hton32(uu.time_low); \
    uu.time_mid = pg_hton16(uu.time_mid); \
    uu.time_hi_and_version = pg_hton16(uu.time_hi_and_version); \
} while (0)

UUID_V3_OR_V5

#define UUID_V3_OR_V5	(		uu,
			v
	)

Value:

do { \
    uu.time_hi_and_version &= 0x0FFF; \
    uu.time_hi_and_version |= (v << 12); \
    uu.clock_seq_hi_and_reserved &= 0x3F; \
    uu.clock_seq_hi_and_reserved |= 0x80; \
} while(0)

Definition at line 95 of file uuid-ossp.c.

   { \
    uu.time_hi_and_version &= 0x0FFF; \
    uu.time_hi_and_version |= (v << 12); \
    uu.clock_seq_hi_and_reserved &= 0x3F; \
    uu.clock_seq_hi_and_reserved |= 0x80; \
} while(0)

Function Documentation

PG_FUNCTION_INFO_V1() [1/10]

PG_FUNCTION_INFO_V1

(

uuid_generate_v1

)

PG_FUNCTION_INFO_V1() [2/10]

PG_FUNCTION_INFO_V1

(

uuid_generate_v1mc

)

PG_FUNCTION_INFO_V1() [3/10]

PG_FUNCTION_INFO_V1

(

uuid_generate_v3

)

PG_FUNCTION_INFO_V1() [4/10]

PG_FUNCTION_INFO_V1

(

uuid_generate_v4

)

PG_FUNCTION_INFO_V1() [5/10]

PG_FUNCTION_INFO_V1

(

uuid_generate_v5

)

PG_FUNCTION_INFO_V1() [6/10]

PG_FUNCTION_INFO_V1

(

uuid_nil

)

PG_FUNCTION_INFO_V1() [7/10]

PG_FUNCTION_INFO_V1

(

uuid_ns_dns

)

PG_FUNCTION_INFO_V1() [8/10]

PG_FUNCTION_INFO_V1

(

uuid_ns_oid

)

PG_FUNCTION_INFO_V1() [9/10]

PG_FUNCTION_INFO_V1

(

uuid_ns_url

)

PG_FUNCTION_INFO_V1() [10/10]

PG_FUNCTION_INFO_V1

(

uuid_ns_x500

)

PG_MODULE_MAGIC_EXT()

PG_MODULE_MAGIC_EXT	(	.	name = "uuid-ossp",
		.	version = PG_VERSION
	)

uuid_generate_internal()

static Datum uuid_generate_internal ( int  v, unsigned char *  ns, const char *  ptr, int  len  )

static

Definition at line 252 of file uuid-ossp.c.

{
    char        strbuf[40];
 
    switch (v)
    {
        case 0:                 /* constant-value uuids */
            strlcpy(strbuf, ptr, 37);
            break;
 
        case 1:                 /* time/node-based uuids */
            {
#ifdef HAVE_UUID_E2FS
                uuid_t      uu;
 
                uuid_generate_time(uu);
                uuid_unparse(uu, strbuf);
 
                /*
                 * PTR, if set, replaces the trailing characters of the uuid;
                 * this is to support v1mc, where a random multicast MAC is
                 * used instead of the physical one
                 */
                if (ptr && len <= 36)
                    strcpy(strbuf + (36 - len), ptr);
#else                           /* BSD */
                uuid_t      uu;
                uint32_t    status = uuid_s_ok;
                char       *str = NULL;
 
                uuid_create(&uu, &status);
 
                if (status == uuid_s_ok)
                {
                    uuid_to_string(&uu, &str, &status);
                    if (status == uuid_s_ok)
                    {
                        strlcpy(strbuf, str, 37);
 
                        /*
                         * In recent NetBSD, uuid_create() has started
                         * producing v4 instead of v1 UUIDs.  Check the
                         * version field and complain if it's not v1.
                         */
                        if (strbuf[14] != '1')
                            ereport(ERROR,
                                    (errcode(ERRCODE_EXTERNAL_ROUTINE_EXCEPTION),
                            /* translator: %c will be a hex digit */
                                     errmsg("uuid_create() produced a version %c UUID instead of the expected version 1",
                                            strbuf[14])));
 
                        /*
                         * PTR, if set, replaces the trailing characters of
                         * the uuid; this is to support v1mc, where a random
                         * multicast MAC is used instead of the physical one
                         */
                        if (ptr && len <= 36)
                            strcpy(strbuf + (36 - len), ptr);
                    }
                    free(str);
                }
 
                if (status != uuid_s_ok)
                    ereport(ERROR,
                            (errcode(ERRCODE_EXTERNAL_ROUTINE_EXCEPTION),
                             errmsg("uuid library failure: %d",
                                    (int) status)));
#endif
                break;
            }
 
        case 3:                 /* namespace-based MD5 uuids */
        case 5:                 /* namespace-based SHA1 uuids */
            {
                dce_uuid_t  uu;
#ifdef HAVE_UUID_BSD
                uint32_t    status = uuid_s_ok;
                char       *str = NULL;
#endif
 
                if (v == 3)
                {
                    pg_cryptohash_ctx *ctx = pg_cryptohash_create(PG_MD5);
 
                    if (pg_cryptohash_init(ctx) < 0)
                        elog(ERROR, "could not initialize %s context: %s", "MD5",
                             pg_cryptohash_error(ctx));
                    if (pg_cryptohash_update(ctx, ns, sizeof(uu)) < 0 ||
                        pg_cryptohash_update(ctx, (const unsigned char *) ptr, len) < 0)
                        elog(ERROR, "could not update %s context: %s", "MD5",
                             pg_cryptohash_error(ctx));
                    /* we assume sizeof MD5 result is 16, same as UUID size */
                    if (pg_cryptohash_final(ctx, (unsigned char *) &uu,
                                            sizeof(uu)) < 0)
                        elog(ERROR, "could not finalize %s context: %s", "MD5",
                             pg_cryptohash_error(ctx));
                    pg_cryptohash_free(ctx);
                }
                else
                {
                    pg_cryptohash_ctx *ctx = pg_cryptohash_create(PG_SHA1);
                    unsigned char sha1result[SHA1_DIGEST_LENGTH];
 
                    if (pg_cryptohash_init(ctx) < 0)
                        elog(ERROR, "could not initialize %s context: %s", "SHA1",
                             pg_cryptohash_error(ctx));
                    if (pg_cryptohash_update(ctx, ns, sizeof(uu)) < 0 ||
                        pg_cryptohash_update(ctx, (const unsigned char *) ptr, len) < 0)
                        elog(ERROR, "could not update %s context: %s", "SHA1",
                             pg_cryptohash_error(ctx));
                    if (pg_cryptohash_final(ctx, sha1result, sizeof(sha1result)) < 0)
                        elog(ERROR, "could not finalize %s context: %s", "SHA1",
                             pg_cryptohash_error(ctx));
                    pg_cryptohash_free(ctx);
 
                    memcpy(&uu, sha1result, sizeof(uu));
                }
 
                /* the calculated hash is using local order */
                UUID_TO_NETWORK(uu);
                UUID_V3_OR_V5(uu, v);
 
#ifdef HAVE_UUID_E2FS
                /* uuid_unparse expects local order */
                UUID_TO_LOCAL(uu);
                uuid_unparse((unsigned char *) &uu, strbuf);
#else                           /* BSD */
                uuid_to_string(&uu, &str, &status);
 
                if (status == uuid_s_ok)
                    strlcpy(strbuf, str, 37);
 
                free(str);
 
                if (status != uuid_s_ok)
                    ereport(ERROR,
                            (errcode(ERRCODE_EXTERNAL_ROUTINE_EXCEPTION),
                             errmsg("uuid library failure: %d",
                                    (int) status)));
#endif
                break;
            }
 
        case 4:                 /* random uuid */
        default:
            {
#ifdef HAVE_UUID_E2FS
                uuid_t      uu;
 
                uuid_generate_random(uu);
                uuid_unparse(uu, strbuf);
#else                           /* BSD */
                snprintf(strbuf, sizeof(strbuf),
                         "%08lx-%04x-%04x-%04x-%04x%08lx",
                         (unsigned long) arc4random(),
                         (unsigned) (arc4random() & 0xffff),
                         (unsigned) ((arc4random() & 0xfff) | 0x4000),
                         (unsigned) ((arc4random() & 0x3fff) | 0x8000),
                         (unsigned) (arc4random() & 0xffff),
                         (unsigned long) arc4random());
#endif
                break;
            }
    }
 
    return DirectFunctionCall1(uuid_in, CStringGetDatum(strbuf));
}

References CStringGetDatum(), dce_uuid_t, DirectFunctionCall1, elog, ereport, errcode(), errmsg(), ERROR, fb(), free, len, pg_cryptohash_create(), pg_cryptohash_error(), pg_cryptohash_final(), pg_cryptohash_free(), pg_cryptohash_init(), pg_cryptohash_update(), PG_MD5, PG_SHA1, SHA1_DIGEST_LENGTH, snprintf, str, strlcpy(), uuid_in(), UUID_TO_LOCAL, UUID_TO_NETWORK, and UUID_V3_OR_V5.

Referenced by uuid_generate_v1(), uuid_generate_v1mc(), uuid_generate_v3(), uuid_generate_v4(), uuid_generate_v5(), uuid_nil(), uuid_ns_dns(), uuid_ns_oid(), uuid_ns_url(), and uuid_ns_x500().

uuid_generate_v1()

Datum uuid_generate_v1

(

PG_FUNCTION_ARGS

)

Definition at line 484 of file uuid-ossp.c.

{
    return uuid_generate_internal(UUID_MAKE_V1, NULL, NULL, 0);
}

References fb(), uuid_generate_internal(), and UUID_MAKE_V1.

uuid_generate_v1mc()

Datum uuid_generate_v1mc

(

PG_FUNCTION_ARGS

)

Definition at line 491 of file uuid-ossp.c.

{
#ifdef HAVE_UUID_OSSP
    char       *buf = NULL;
#elif defined(HAVE_UUID_E2FS)
    char        strbuf[40];
    char       *buf;
    uuid_t      uu;
 
    uuid_generate_random(uu);
 
    /* set IEEE802 multicast and local-admin bits */
    ((dce_uuid_t *) &uu)->node[0] |= 0x03;
 
    uuid_unparse(uu, strbuf);
    buf = strbuf + 24;
#else                           /* BSD */
    char        buf[16];
 
    /* set IEEE802 multicast and local-admin bits */
    snprintf(buf, sizeof(buf), "-%04x%08lx",
             (unsigned) ((arc4random() & 0xffff) | 0x0300),
             (unsigned long) arc4random());
#endif
 
    return uuid_generate_internal(UUID_MAKE_V1 | UUID_MAKE_MC, NULL,
                                  buf, 13);
}

References buf, dce_uuid_t, fb(), snprintf, uuid_generate_internal(), UUID_MAKE_MC, and UUID_MAKE_V1.

uuid_generate_v3()

Datum uuid_generate_v3

(

PG_FUNCTION_ARGS

)

Definition at line 522 of file uuid-ossp.c.

{
    pg_uuid_t  *ns = PG_GETARG_UUID_P(0);
    text       *name = PG_GETARG_TEXT_PP(1);
 
#ifdef HAVE_UUID_OSSP
    return uuid_generate_v35_internal(UUID_MAKE_V3, ns, name);
#else
    return uuid_generate_internal(UUID_MAKE_V3, (unsigned char *) ns,
                                  VARDATA_ANY(name), VARSIZE_ANY_EXHDR(name));
#endif
}

References fb(), name, PG_GETARG_TEXT_PP, PG_GETARG_UUID_P, uuid_generate_internal(), UUID_MAKE_V3, VARDATA_ANY(), and VARSIZE_ANY_EXHDR().

uuid_generate_v4()

Datum uuid_generate_v4

(

PG_FUNCTION_ARGS

)

Definition at line 537 of file uuid-ossp.c.

{
    return uuid_generate_internal(UUID_MAKE_V4, NULL, NULL, 0);
}

References fb(), uuid_generate_internal(), and UUID_MAKE_V4.

uuid_generate_v5()

Datum uuid_generate_v5

(

PG_FUNCTION_ARGS

)

Definition at line 544 of file uuid-ossp.c.

{
    pg_uuid_t  *ns = PG_GETARG_UUID_P(0);
    text       *name = PG_GETARG_TEXT_PP(1);
 
#ifdef HAVE_UUID_OSSP
    return uuid_generate_v35_internal(UUID_MAKE_V5, ns, name);
#else
    return uuid_generate_internal(UUID_MAKE_V5, (unsigned char *) ns,
                                  VARDATA_ANY(name), VARSIZE_ANY_EXHDR(name));
#endif
}

References fb(), name, PG_GETARG_TEXT_PP, PG_GETARG_UUID_P, uuid_generate_internal(), UUID_MAKE_V5, VARDATA_ANY(), and VARSIZE_ANY_EXHDR().

uuid_nil()

Datum uuid_nil

(

PG_FUNCTION_ARGS

)

Definition at line 424 of file uuid-ossp.c.

{
#ifdef HAVE_UUID_OSSP
    return special_uuid_value("nil");
#else
    return uuid_generate_internal(0, NULL,
                                  "00000000-0000-0000-0000-000000000000", 36);
#endif
}

References fb(), and uuid_generate_internal().

uuid_ns_dns()

Datum uuid_ns_dns

(

PG_FUNCTION_ARGS

)

Definition at line 436 of file uuid-ossp.c.

{
#ifdef HAVE_UUID_OSSP
    return special_uuid_value("ns:DNS");
#else
    return uuid_generate_internal(0, NULL,
                                  "6ba7b810-9dad-11d1-80b4-00c04fd430c8", 36);
#endif
}

References fb(), and uuid_generate_internal().

uuid_ns_oid()

Datum uuid_ns_oid

(

PG_FUNCTION_ARGS

)

Definition at line 460 of file uuid-ossp.c.

{
#ifdef HAVE_UUID_OSSP
    return special_uuid_value("ns:OID");
#else
    return uuid_generate_internal(0, NULL,
                                  "6ba7b812-9dad-11d1-80b4-00c04fd430c8", 36);
#endif
}

References fb(), and uuid_generate_internal().

uuid_ns_url()

Datum uuid_ns_url

(

PG_FUNCTION_ARGS

)

Definition at line 448 of file uuid-ossp.c.

{
#ifdef HAVE_UUID_OSSP
    return special_uuid_value("ns:URL");
#else
    return uuid_generate_internal(0, NULL,
                                  "6ba7b811-9dad-11d1-80b4-00c04fd430c8", 36);
#endif
}

References fb(), and uuid_generate_internal().

uuid_ns_x500()

Datum uuid_ns_x500

(

PG_FUNCTION_ARGS

)

Definition at line 472 of file uuid-ossp.c.

{
#ifdef HAVE_UUID_OSSP
    return special_uuid_value("ns:X500");
#else
    return uuid_generate_internal(0, NULL,
                                  "6ba7b814-9dad-11d1-80b4-00c04fd430c8", 36);
#endif
}

References fb(), and uuid_generate_internal().