yb_ddl_parser 0.1.0

data/ext/yb_ddl_parser/vendor/yugabyte-postgres/src/include/ybgate/ybgate_api.h

@@ -0,0 +1,283 @@
+/*-------------------------------------------------------------------------
+ *
+ * ybgate_api.h
+ *	  YbGate interface functions.
+ *	  YbGate allows to execute Postgres code from DocDB
+ *
+ * Copyright (c) YugabyteDB, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not
+ * use this file except in compliance with the License.  You may obtain a copy
+ * of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
+ * License for the specific language governing permissions and limitations
+ * under the License.
+ *
+ * IDENTIFICATION
+ *	  src/include/ybgate/ybgate_api.h
+ *
+ *-------------------------------------------------------------------------
+ */
+
+#pragma once
+
+#include <setjmp.h>
+#include <stdbool.h>
+#include <stddef.h>
+#include <stdint.h>
+
+#include "yb/yql/pggate/ybc_pg_typedefs.h"
+#include "ybgate/ybgate_status.h"
+
+#ifdef __cplusplus
+extern "C"
+{
+#endif
+
+/*-----------------------------------------------------------------------------
+ * Error Reporting
+ *-----------------------------------------------------------------------------
+ * !!! IMPORTANT: All public functions in the ybgate directory MUST return a
+ * YbgStatus and call PG_SETUP_ERROR_REPORTING first, before any execution.
+ *
+ * This will ensure that any elog or ereport called internally by a YSQL/PG
+ * function will be caught/handled (and not crash the tserver process).
+ *-----------------------------------------------------------------------------
+ */
+
+#ifdef __cplusplus
+typedef void *YbgMemoryContext;
+#else
+typedef MemoryContext YbgMemoryContext;
+#endif
+
+/*-----------------------------------------------------------------------------
+ * Memory Context
+ *-----------------------------------------------------------------------------
+ */
+
+extern YbgMemoryContext YbgGetCurrentMemoryContext();
+
+extern YbgMemoryContext YbgSetCurrentMemoryContext(YbgMemoryContext memctx);
+
+extern YbgStatus YbgCreateMemoryContext(YbgMemoryContext parent,
+										const char *name,
+										YbgMemoryContext *memctx);
+
+extern YbgStatus YbgPrepareMemoryContext();
+
+extern YbgStatus YbgResetMemoryContext();
+
+extern YbgStatus YbgDeleteMemoryContext();
+
+extern YbgStatus YbgInit();
+
+/*-----------------------------------------------------------------------------
+ * Types
+ *-----------------------------------------------------------------------------
+ */
+
+struct YbPgAttributeRow
+{
+	uint32_t	attrelid;
+	char		attname[64];
+	uint32_t	atttypid;
+	int32_t		attstattarget;
+	int16_t		attlen;
+	int16_t		attnum;
+	int32_t		attndims;
+	int32_t		attcacheoff;
+	int32_t		atttypmod;
+	bool		attbyval;
+	char		attstorage;
+	char		attalign;
+	bool		attnotnull;
+	bool		atthasdef;
+	bool		atthasmissing;
+	char		attidentity;
+	bool		attisdropped;
+	bool		attislocal;
+	int32_t		attinhcount;
+	uint32_t	attcollation;
+};
+
+#ifndef __cplusplus
+typedef struct YbPgAttributeRow YbPgAttributeRow;
+#endif
+
+struct YbgTypeDesc
+{
+	int32_t		type_id;		/* type identifier */
+	int32_t		type_mod;		/* type modifier */
+};
+
+#ifndef __cplusplus
+typedef struct YbgTypeDesc YbgTypeDesc;
+#endif
+
+/*
+ * Get the type entity table for the primitive YSQL/PG types.
+ * Used for for converting between DocDB values and YSQL datums.
+ */
+extern YbgStatus YbgGetTypeTable(YbcPgTypeEntities *type_entities);
+
+/*
+ * For non-primitive types (the ones without a corresponding YbcPgTypeEntity),
+ * get the corresponding primitive type's oid.
+ */
+extern YbgStatus YbgGetPrimitiveTypeOid(uint32_t type_oid, char typtype,
+										uint32_t typbasetype,
+										uint32_t *primitive_type_oid);
+
+/*-----------------------------------------------------------------------------
+ * Expression Evaluation
+ *-----------------------------------------------------------------------------
+ */
+
+#ifdef __cplusplus
+typedef void *YbgExprContext;
+typedef void *YbgPreparedExpr;
+#else
+typedef struct YbgExprContextData *YbgExprContext;
+typedef struct Expr *YbgPreparedExpr;
+#endif
+
+/*
+ * Create an expression context to evaluate expressions against.
+ */
+extern YbgStatus YbgExprContextCreate(int32_t min_attno, int32_t max_attno,
+									  YbgExprContext *expr_ctx);
+
+extern YbgStatus YbgExprContextReset(YbgExprContext expr_ctx);
+
+/*
+ * Add a column value from the table row.
+ * Used by expression evaluation to resolve scan variables.
+ */
+extern YbgStatus YbgExprContextAddColValue(YbgExprContext expr_ctx, int32_t attno,
+										   uint64_t datum, bool is_null);
+
+extern YbgStatus YbgPrepareExpr(char *expr_cstring, YbgPreparedExpr *expr,
+								int yb_expression_version);
+
+extern YbgStatus YbgExprType(const YbgPreparedExpr expr, int32_t *typid);
+
+extern YbgStatus YbgExprTypmod(const YbgPreparedExpr expr, int32_t *typmod);
+
+extern YbgStatus YbgExprCollation(const YbgPreparedExpr expr, int32_t *collid);
+
+/*
+ * Evaluate an expression, using the expression context to resolve scan variables.
+ * Will filling in datum and is_null with the result.
+ */
+extern YbgStatus YbgEvalExpr(YbgPreparedExpr expr, YbgExprContext expr_ctx, uint64_t *datum,
+							 bool *is_null);
+
+/*
+ * Given a 'datum' of array type, split datum into individual elements of type 'type' and store
+ * the result in 'result_datum_array', with number of elements in 'nelems'. This will error out
+ * if 'type' doesn't match the type of the individual elements in 'datum'. Memory for
+ * 'result_datum_array' will be allocated in this function itself, pre-allocation is not needed.
+ */
+extern YbgStatus YbgSplitArrayDatum(uint64_t datum, int type, uint64_t **result_datum_array,
+									int *nelems);
+
+/*-----------------------------------------------------------------------------
+ * Relation sampling
+ *-----------------------------------------------------------------------------
+ */
+
+#ifdef __cplusplus
+typedef void *YbgReservoirState;
+#else
+typedef struct YbgReservoirStateData *YbgReservoirState;
+#endif
+
+/*
+ * Allocate and initialize a YbgReservoirState.
+ */
+extern YbgStatus YbgSamplerCreate(double rstate_w, uint64_t randstate_s0, uint64_t randstate_s1,
+								  YbgReservoirState *yb_rs);
+
+/*
+ * Allocate and initialize a YbgReservoirState.
+ */
+extern YbgStatus YbgSamplerGetState(YbgReservoirState yb_rs, double *rstate_w,
+									uint64_t *randstate_s0, uint64_t *randstate_s1);
+
+/*
+ * Select a random value R uniformly distributed in (0 - 1)
+ */
+extern YbgStatus YbgSamplerRandomFract(YbgReservoirState yb_rs, double *value);
+
+/*
+ * Calculate next number of rows to skip based on current number of scanned rows
+ * and requested sample size.
+ */
+extern YbgStatus YbgReservoirGetNextS(YbgReservoirState yb_rs, double t, int n, double *s);
+
+extern char *DecodeDatum(char const *fn_name, uintptr_t datum);
+
+extern char *DecodeTZDatum(char const *fn_name, uintptr_t datum, const char *timezone,
+						   bool from_YB);
+
+extern char *DecodeArrayDatum(char const *arr_fn_name, uintptr_t datum, int16_t elem_len,
+							  bool elem_by_val, char elem_align, char elem_delim, bool from_YB,
+							  char const *fn_name, const char *timezone, char option);
+
+extern char *DecodeRangeDatum(char const *range_fn_name, uintptr_t datum, int16_t elem_len,
+							  bool elem_by_val, char elem_align, char option, bool from_YB,
+							  char const *elem_fn_name, int range_type, const char *timezone);
+
+extern char *DecodeRangeArrayDatum(char const *arr_fn_name, uintptr_t datum, int16_t elem_len,
+								   int16_t range_len, bool elem_by_val, bool range_by_val,
+								   char elem_align, char range_align, char elem_delim,
+								   char option, char range_option, bool from_YB,
+								   char const *elem_fn_name, char const *range_fn_name,
+								   int range_type, const char *timezone);
+
+extern char *DecodeRecordDatum(uintptr_t datum, void *attrs, size_t natts);
+
+extern uint32_t GetRecordTypeId(uintptr_t datum);
+
+extern uintptr_t HeapFormTuple(void *attrs, size_t natts, uintptr_t *values,
+							   bool *nulls);
+
+extern void HeapDeformTuple(uintptr_t datum, void *attrs, size_t natts,
+							uintptr_t *values, bool *nulls);
+
+/*-----------------------------------------------------------------------------
+ * PG Version
+ *-----------------------------------------------------------------------------
+ */
+extern int	YbgGetPgVersion();
+
+/*-----------------------------------------------------------------------------
+ * Ident Conf
+ *-----------------------------------------------------------------------------
+ */
+
+/*
+ * Read the ident config file and create a List of IdentLine records for
+ * the contents.
+ *
+ * Serves the purpose of load_ident from hba.c but with more control over file
+ * path and memory context so that this can be called from YCQL.
+ *
+ * Caller is responsible to free the memory context in case of errors.
+ */
+extern YbgStatus YbgLoadIdent(const char *ident_file_path,
+							  YbgMemoryContext ident_context);
+
+extern YbgStatus YbgCheckUsermap(const char *usermap_name, const char *pg_role,
+								 const char *auth_user, bool case_insensitive,
+								 bool *matched);
+
+#ifdef __cplusplus
+}
+#endif

data/ext/yb_ddl_parser/vendor/yugabyte-postgres/src/include/ybgate/ybgate_cpp_util.h

@@ -0,0 +1,78 @@
+/*-------------------------------------------------------------------------
+ *
+ * ybgate_cpp_util.h
+ *	  YbGate macro to convert YbgStatus into regular Status.
+ *
+ * Copyright (c) YugabyteDB, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not
+ * use this file except in compliance with the License.  You may obtain a copy
+ * of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
+ * License for the specific language governing permissions and limitations
+ * under the License.
+ *
+ * IDENTIFICATION
+ *	  src/include/ybgate/ybgate_cpp_util.h
+ *
+ *-------------------------------------------------------------------------
+ */
+
+#pragma once
+
+#include "yb/common/pgsql_error.h"
+#include "yb/util/yb_pg_errcodes.h"
+#include "ybgate/ybgate_api.h"
+
+/*
+ * Macro to convert YbgStatus into regular Status.
+ * Use it as a reference if you need to create a Status in DocDB to be displayed by Postgres.
+ * Basically, STATUS(QLError, "<message>"); makes a good base, it should correctly set location
+ * (filename and line number) and error message. The STATUS macro does not support function name.
+ * Location is optional, though filename and line number are typically present. If function name is
+ * needed, it can be added separately:
+ *   s = s.CloneAndAddErrorCode(FuncName(funcname));
+ * If error message needs to be translatable template, template arguments should be converted to
+ * a vector of strings and added to status this way:
+ *   s = s.CloneAndAddErrorCode(PgsqlMessageArgs(args));
+ * If needed SQL code may be added to status this way:
+ *   s = s.CloneAndAddErrorCode(PgsqlError(sqlerror));
+ * It is possible to define more custom codes to send around with a status.
+ * They should be handled on the Postgres side, see the HandleYBStatusAtErrorLevel macro in the
+ * pg_yb_utils.h for details.
+ */
+#define PG_RETURN_NOT_OK(status) \
+	do { \
+		YbgStatus status_ = status; \
+		if (YbgStatusIsError(status_)) \
+		{ \
+			const char *filename = YbgStatusGetFilename(status_); \
+			int lineno = YbgStatusGetLineNumber(status_); \
+			const char *funcname = YbgStatusGetFuncname(status_); \
+			uint32_t sqlerror = YbgStatusGetSqlError(status_); \
+			std::string msg = std::string(YbgStatusGetMessage(status_)); \
+			std::vector<std::string> args; \
+			int32_t s_nargs; \
+			const char **s_args = YbgStatusGetMessageArgs(status_, &s_nargs); \
+			if (s_nargs > 0) \
+			{ \
+				args.reserve(s_nargs); \
+				for (int i = 0; i < s_nargs; i++) \
+					args.emplace_back(std::string(s_args[i])); \
+			} \
+			YbgStatusDestroy(status_); \
+			Status s = Status(Status::kQLError, filename, lineno, msg); \
+			s = s.CloneAndAddErrorCode(PgsqlError(static_cast<YBPgErrorCode>(sqlerror))); \
+			if (funcname) \
+				s = s.CloneAndAddErrorCode(FuncName(funcname)); \
+			return (args.empty() ? \
+					s : \
+					s.CloneAndAddErrorCode(PgsqlMessageArgs(args))); \
+		} \
+		YbgStatusDestroy(status_); \
+	} while(0)

data/ext/yb_ddl_parser/vendor/yugabyte-postgres/src/include/ybgate/ybgate_status.h

@@ -0,0 +1,136 @@
+/*-------------------------------------------------------------------------
+ *
+ * ybgate_status.h
+ *	  YbGate interface functions.
+ *	  YbGate allows to execute Postgres code from DocDB
+ *
+ * Copyright (c) YugabyteDB, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not
+ * use this file except in compliance with the License.  You may obtain a copy
+ * of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
+ * License for the specific language governing permissions and limitations
+ * under the License.
+ *
+ * IDENTIFICATION
+ *	  src/include/ybgate/ybgate_status.h
+ *
+ *-------------------------------------------------------------------------
+ */
+
+#pragma once
+
+#include <setjmp.h>
+
+#include "yb/yql/pggate/ybc_pggate.h"
+
+#ifdef __cplusplus
+extern "C"
+{
+#endif
+
+/*-----------------------------------------------------------------------------
+ * Error Reporting
+ *-----------------------------------------------------------------------------
+ * !!! IMPORTANT: All functions invoking Postgres code MUST:
+ * - return YbgStatus;
+ * - call PG_SETUP_ERROR_REPORTING() before any Postgres code is called. It is
+ *   a good idea to put it as the first line of the function;
+ * - use PG_STATUS_OK() macro to exit from the function, put it at the and, and
+ *   wherever in the middle where shortcut return is needed.
+ *
+ * Postgres backends and auxillary processes set up error handling
+ * infrastructure at the very top level, and keep it forever, so elog / ereport,
+ * as well as PG_TRY / PG_CATCH work as expected.
+ * However, inside of the master / tserver processes this infrastructure is not
+ * available, and that may make respective process to crash.
+ * The PG_SETUP_ERROR_REPORTING() sets up equivalent infrastructure in
+ * multithreaded mode. Whether Postgres code throws an error, it is caught and
+ * wrapped into a YbgStatus, which is subsequently returned to the Postgres
+ * client.
+ *-----------------------------------------------------------------------------
+ */
+
+typedef struct YbgStatusData *YbgStatus;
+
+/*
+ * Macros to handle Postgres errors by YbGate.
+ *
+ * To be used in a function returning YbgStatus to surround calls to Postgres
+ * code:
+ *
+ *  PG_SETUP_ERROR_REPORTING();
+ *  ... PG calls go here ...
+ *  PG_STATUS_OK();
+ *
+ * The PG_SETUP_ERROR_REPORTING sets up a sigjmp buffer, similar to those set
+ * up by main routines of Postgres' processes. So if subsequent Postgres code
+ * executes any elog or ereport statement with elevel ERROR or higher, it jumps
+ * into the "if (r != 0)" block. By that time it is expected that thread local
+ * YbgStatus is set, so it is returned to the YbGate function's caller where it
+ * is typically converted to a regular Status. If the thread local YbgStatus is
+ * not set, that's a bug and we have a static YbgStatus instance to return in
+ * this case.
+ *
+ * The PG_STATUS_OK removes the sigjmp buffer and returns the current thread
+ * local status, which is normally NULL here.
+ *
+ * Do not nest PG_SETUP_ERROR_REPORTING / PG_STATUS_OK blocks, as the inner
+ * PG_STATUS_OK would end the protected block, and the rest of the code until
+ * the outer PG_STATUS_OK would run unprotected.
+ *
+ * Running code without setting up error reporting is allowed, if code does not
+ * emit Postgres errors. It is OK if error is handled in a PG_CATCH block, but
+ * any uncaught error would crash the tserver.
+ */
+#define PG_SETUP_ERROR_REPORTING() \
+	do { \
+		sigjmp_buf ybgate_sigjmp_buffer; \
+		int r = sigsetjmp(ybgate_sigjmp_buffer, 0); \
+		if (r == 0) \
+		{ \
+			YBCPgSetThreadLocalJumpBuffer(&ybgate_sigjmp_buffer)
+
+#define PG_STATUS_OK() \
+		} \
+		else \
+		{ \
+			YbgStatus status = (YbgStatus) YBCPgSetThreadLocalErrStatus(NULL); \
+			YBCPgSetThreadLocalJumpBuffer(NULL); \
+			return status ? status : YbgStatusErrorReportingError(); \
+		} \
+		YBCPgSetThreadLocalJumpBuffer(NULL); \
+		return (YbgStatus) YBCPgSetThreadLocalErrStatus(NULL); \
+	} while(0)
+
+YbgStatus	YbgStatusErrorReportingError();
+YbgStatus	YbgStatusCreate();
+YbgStatus	YbgStatusCreateError(const char *msg, const char *filename, int line);
+void		YbgStatusDestroy(YbgStatus status);
+void	   *YbgStatusGetContext(YbgStatus status);
+void		YbgStatusSetLevel(YbgStatus status, int32_t elevel);
+bool		YbgStatusIsError(YbgStatus status);
+void		YbgStatusSetMessageAndArgs(YbgStatus status, const char *msg,
+									   int32_t nargs, const char **args);
+const char *YbgStatusGetMessage(YbgStatus status);
+const char **YbgStatusGetMessageArgs(YbgStatus status, int32_t *nargs);
+uint32_t	YbgStatusGetSqlError(YbgStatus status);
+void		YbgStatusSetSqlError(YbgStatus status, uint32_t sqlerror);
+const char *YbgStatusGetFilename(YbgStatus status);
+void		YbgStatusSetFilename(YbgStatus status, const char *filename);
+int			YbgStatusGetLineNumber(YbgStatus status);
+void		YbgStatusSetLineNumber(YbgStatus status, int lineno);
+const char *YbgStatusGetFuncname(YbgStatus status);
+void		YbgStatusSetFuncname(YbgStatus status, const char *funcname);
+void		YbgStatusSetEdata(YbgStatus status, void *edata);
+void	   *YbgStatusGetEdata(YbgStatus status);
+
+#ifdef __cplusplus
+}
+#endif