lwtarantool 0.0.2

data/ext/lwtarantool/vendor/tarantool-c/include/tarantool/tnt_proto.h

@@ -0,0 +1,295 @@
+#ifndef TNT_PROTO_H_INCLUDED
+#define TNT_PROTO_H_INCLUDED
+
+/*
+ * Redistribution and use in source and binary forms, with or
+ * without modification, are permitted provided that the following
+ * conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above
+ *    copyright notice, this list of conditions and the
+ *    following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above
+ *    copyright notice, this list of conditions and the following
+ *    disclaimer in the documentation and/or other materials
+ *    provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY <COPYRIGHT HOLDER> ``AS IS'' AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+ * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
+ * <COPYRIGHT HOLDER> OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+ * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
+ * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
+ * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ */
+
+/**
+ * \file tnt_proto.h
+ * \brief IProto protocol constants
+ */
+
+/**
+ * \brief Request/response header field types (keys)
+ */
+enum tnt_header_key_t {
+	TNT_CODE      = 0x00,
+	TNT_SYNC      = 0x01,
+	TNT_SERVER_ID = 0x02,
+	TNT_LSN       = 0x03,
+	TNT_TIMESTAMP = 0x04,
+	TNT_SCHEMA_ID = 0x05
+};
+
+/**
+ * \brief Request body field types (keys)
+ */
+enum tnt_body_key_t {
+	TNT_SPACE = 0x10,
+	TNT_INDEX = 0x11,
+	TNT_LIMIT = 0x12,
+	TNT_OFFSET = 0x13,
+	TNT_ITERATOR = 0x14,
+	TNT_INDEX_BASE = 0x15,
+	TNT_KEY = 0x20,
+	TNT_TUPLE = 0x21,
+	TNT_FUNCTION = 0x22,
+	TNT_USERNAME = 0x23,
+	TNT_SERVER_UUID = 0x24,
+	TNT_CLUSTER_UUID = 0x25,
+	TNT_VCLOCK = 0x26,
+	TNT_EXPRESSION = 0x27,
+	TNT_OPS = 0x28,
+	TNT_SQL_TEXT = 0x40,
+	TNT_SQL_BIND = 0x41,
+};
+
+/**
+ * \brief Response body field types (keys)
+ */
+enum tnt_response_key_t {
+	TNT_DATA = 0x30,
+	TNT_ERROR = 0x31,
+	TNT_METADATA = 0x32,
+	TNT_SQL_INFO = 0x43,
+};
+
+/**
+ * \brief Request types
+ */
+enum tnt_request_t {
+	TNT_OP_SELECT    = 1,
+	TNT_OP_INSERT    = 2,
+	TNT_OP_REPLACE   = 3,
+	TNT_OP_UPDATE    = 4,
+	TNT_OP_DELETE    = 5,
+	TNT_OP_CALL_16   = 6,
+	TNT_OP_AUTH      = 7,
+	TNT_OP_EVAL      = 8,
+	TNT_OP_UPSERT    = 9,
+	TNT_OP_CALL      = 10,
+	TNT_OP_EXECUTE   = 11,
+	TNT_OP_PING      = 64,
+	TNT_OP_JOIN      = 65,
+	TNT_OP_SUBSCRIBE = 66
+};
+
+/**
+ * \brief Update operations
+ */
+enum tnt_update_op_t {
+	TNT_UOP_ADDITION = '+',
+	TNT_UOP_SUBSTRACT = '-',
+	TNT_UOP_AND = '&',
+	TNT_UOP_XOR = '^',
+	TNT_UOP_OR = '|',
+	TNT_UOP_DELETE = '#',
+	TNT_UOP_INSERT = '!',
+	TNT_UOP_ASSIGN = '=',
+	TNT_UOP_SPLICE = ':',
+};
+
+/**
+ * \brief Iterator types
+ */
+enum tnt_iterator_t {
+	TNT_ITER_EQ = 0,
+	TNT_ITER_REQ,
+	TNT_ITER_ALL,
+	TNT_ITER_LT,
+	TNT_ITER_LE,
+	TNT_ITER_GE,
+	TNT_ITER_GT,
+	TNT_ITER_BITS_ALL_SET,
+	TNT_ITER_BITS_ANY_SET,
+	TNT_ITER_BITS_ALL_NOT_SET,
+	TNT_ITER_OVERLAP,
+	TNT_ITER_NEIGHBOR,
+};
+
+/**
+ * \internal
+ */
+#define TNT_SCRAMBLE_SIZE 20
+/**
+ * \internal
+ */
+#define TNT_GREETING_SIZE 128
+/**
+ * \internal
+ */
+#define TNT_VERSION_SIZE  64
+/**
+ * \internal
+ */
+#define TNT_SALT_SIZE     44
+
+/**
+ * \brief System spaces
+ */
+enum tnt_spaces_t {
+	tnt_sp_space = 280,
+	tnt_sp_index = 288,
+	tnt_sp_func  = 296,
+	tnt_sp_user  = 304,
+	tnt_sp_priv  = 312,
+	tnt_vsp_space = 281,
+	tnt_vsp_index = 289,
+	tnt_vsp_func  = 297,
+	tnt_vsp_user  = 305,
+	tnt_vsp_priv  = 313,
+};
+
+/**
+ * \brief System indexes
+ */
+enum tnt_indexes_t {
+	tnt_vin_primary = 0,
+	tnt_vin_owner   = 1,
+	tnt_vin_name    = 2,
+};
+
+/**
+ * \brief Error code types
+ */
+enum tnt_errcode_t {
+	TNT_ER_UNKNOWN = 0,
+	TNT_ER_ILLEGAL_PARAMS = 1,
+	TNT_ER_MEMORY_ISSUE = 2,
+	TNT_ER_TUPLE_FOUND = 3,
+	TNT_ER_TUPLE_NOT_FOUND = 4,
+	TNT_ER_UNSUPPORTED = 5,
+	TNT_ER_NONMASTER = 6,
+	TNT_ER_READONLY = 7,
+	TNT_ER_INJECTION = 8,
+	TNT_ER_CREATE_SPACE = 9,
+	TNT_ER_SPACE_EXISTS = 10,
+	TNT_ER_DROP_SPACE = 11,
+	TNT_ER_ALTER_SPACE = 12,
+	TNT_ER_INDEX_TYPE = 13,
+	TNT_ER_MODIFY_INDEX = 14,
+	TNT_ER_LAST_DROP = 15,
+	TNT_ER_TUPLE_FORMAT_LIMIT = 16,
+	TNT_ER_DROP_PRIMARY_KEY = 17,
+	TNT_ER_KEY_PART_TYPE = 18,
+	TNT_ER_EXACT_MATCH = 19,
+	TNT_ER_INVALID_MSGPACK = 20,
+	TNT_ER_PROC_RET = 21,
+	TNT_ER_TUPLE_NOT_ARRAY = 22,
+	TNT_ER_FIELD_TYPE = 23,
+	TNT_ER_FIELD_TYPE_MISMATCH = 24,
+	TNT_ER_SPLICE = 25,
+	TNT_ER_ARG_TYPE = 26,
+	TNT_ER_TUPLE_IS_TOO_LONG = 27,
+	TNT_ER_UNKNOWN_UPDATE_OP = 28,
+	TNT_ER_UPDATE_FIELD = 29,
+	TNT_ER_FIBER_STACK = 30,
+	TNT_ER_KEY_PART_COUNT = 31,
+	TNT_ER_PROC_LUA = 32,
+	TNT_ER_NO_SUCH_PROC = 33,
+	TNT_ER_NO_SUCH_TRIGGER = 34,
+	TNT_ER_NO_SUCH_INDEX = 35,
+	TNT_ER_NO_SUCH_SPACE = 36,
+	TNT_ER_NO_SUCH_FIELD = 37,
+	TNT_ER_SPACE_FIELD_COUNT = 38,
+	TNT_ER_INDEX_FIELD_COUNT = 39,
+	TNT_ER_WAL_IO = 40,
+	TNT_ER_MORE_THAN_ONE_TUPLE = 41,
+	TNT_ER_ACCESS_DENIED = 42,
+	TNT_ER_CREATE_USER = 43,
+	TNT_ER_DROP_USER = 44,
+	TNT_ER_NO_SUCH_USER = 45,
+	TNT_ER_USER_EXISTS = 46,
+	TNT_ER_PASSWORD_MISMATCH = 47,
+	TNT_ER_UNKNOWN_REQUEST_TYPE = 48,
+	TNT_ER_UNKNOWN_SCHEMA_OBJECT = 49,
+	TNT_ER_CREATE_FUNCTION = 50,
+	TNT_ER_NO_SUCH_FUNCTION = 51,
+	TNT_ER_FUNCTION_EXISTS = 52,
+	TNT_ER_FUNCTION_ACCESS_DENIED = 53,
+	TNT_ER_FUNCTION_MAX = 54,
+	TNT_ER_SPACE_ACCESS_DENIED = 55,
+	TNT_ER_USER_MAX = 56,
+	TNT_ER_NO_SUCH_ENGINE = 57,
+	TNT_ER_RELOAD_CFG = 58,
+	TNT_ER_CFG = 59,
+	TNT_ER_SOPHIA = 60,
+	TNT_ER_LOCAL_SERVER_IS_NOT_ACTIVE = 61,
+	TNT_ER_UNKNOWN_SERVER = 62,
+	TNT_ER_CLUSTER_ID_MISMATCH = 63,
+	TNT_ER_INVALID_UUID = 64,
+	TNT_ER_CLUSTER_ID_IS_RO = 65,
+	TNT_ER_RESERVED66 = 66,
+	TNT_ER_SERVER_ID_IS_RESERVED = 67,
+	TNT_ER_INVALID_ORDER = 68,
+	TNT_ER_MISSING_REQUEST_FIELD = 69,
+	TNT_ER_IDENTIFIER = 70,
+	TNT_ER_DROP_FUNCTION = 71,
+	TNT_ER_ITERATOR_TYPE = 72,
+	TNT_ER_REPLICA_MAX = 73,
+	TNT_ER_INVALID_XLOG = 74,
+	TNT_ER_INVALID_XLOG_NAME = 75,
+	TNT_ER_INVALID_XLOG_ORDER = 76,
+	TNT_ER_NO_CONNECTION = 77,
+	TNT_ER_TIMEOUT = 78,
+	TNT_ER_ACTIVE_TRANSACTION = 79,
+	TNT_ER_NO_ACTIVE_TRANSACTION = 80,
+	TNT_ER_CROSS_ENGINE_TRANSACTION = 81,
+	TNT_ER_NO_SUCH_ROLE = 82,
+	TNT_ER_ROLE_EXISTS = 83,
+	TNT_ER_CREATE_ROLE = 84,
+	TNT_ER_INDEX_EXISTS = 85,
+	TNT_ER_TUPLE_REF_OVERFLOW = 86,
+	TNT_ER_ROLE_LOOP = 87,
+	TNT_ER_GRANT = 88,
+	TNT_ER_PRIV_GRANTED = 89,
+	TNT_ER_ROLE_GRANTED = 90,
+	TNT_ER_PRIV_NOT_GRANTED = 91,
+	TNT_ER_ROLE_NOT_GRANTED = 92,
+	TNT_ER_MISSING_SNAPSHOT = 93,
+	TNT_ER_CANT_UPDATE_PRIMARY_KEY = 94,
+	TNT_ER_UPDATE_INTEGER_OVERFLOW = 95,
+	TNT_ER_GUEST_USER_PASSWORD = 96,
+	TNT_ER_TRANSACTION_CONFLICT = 97,
+	TNT_ER_UNSUPPORTED_ROLE_PRIV = 98,
+	TNT_ER_LOAD_FUNCTION = 99,
+	TNT_ER_FUNCTION_LANGUAGE = 100,
+	TNT_ER_RTREE_RECT = 101,
+	TNT_ER_PROC_C = 102,
+	TNT_ER_UNKNOWN_RTREE_INDEX_DISTANCE_TYPE = 103,
+	TNT_ER_PROTOCOL = 104,
+	TNT_ER_UPSERT_UNIQUE_SECONDARY_KEY = 105,
+	TNT_ER_WRONG_INDEX_RECORD = 106,
+	TNT_ER_WRONG_INDEX_PARTS = 107,
+	TNT_ER_WRONG_INDEX_OPTIONS = 108,
+	TNT_ER_WRONG_SCHEMA_VERSION = 109,
+	TNT_ER_SLAB_ALLOC_MAX = 110,
+};
+
+#endif /* TNT_PROTO_H_INCLUDED */

data/ext/lwtarantool/vendor/tarantool-c/include/tarantool/tnt_reply.h

@@ -0,0 +1,204 @@
+#ifndef TNT_REPLY_H_INCLUDED
+#define TNT_REPLY_H_INCLUDED
+
+/*
+ * Redistribution and use in source and binary forms, with or
+ * without modification, are permitted provided that the following
+ * conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above
+ *    copyright notice, this list of conditions and the
+ *    following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above
+ *    copyright notice, this list of conditions and the following
+ *    disclaimer in the documentation and/or other materials
+ *    provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY <COPYRIGHT HOLDER> ``AS IS'' AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+ * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
+ * <COPYRIGHT HOLDER> OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+ * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
+ * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
+ * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ */
+
+/**
+ * \file tnt_reply.h
+ * \brief Basic reply structure (parsing responses, e.t.c)
+ */
+
+/**
+ * \brief Size of iproto header
+ */
+#define TNT_REPLY_IPROTO_HDR_SIZE	5
+
+/**
+ * \brief Callback for recv reply from buffer
+ *
+ * \param ptr  pointer to buffer and offset
+ * \param dst  copy reply to
+ * \param size size to recv to
+ *
+ * \returns size of bytes written
+ * \retval  -1 error
+ */
+typedef ssize_t (*tnt_reply_t)(void *ptr, char *dst, ssize_t size);
+
+/*!
+ * \brief basic reply structure
+ */
+struct tnt_reply {
+	int alloc;		/*!< allocation mark */
+	uint64_t bitmap;	/*!< bitmap of field IDs that was read */
+	const char *buf;	/*!< points to beginning of buffer */
+	size_t buf_size;	/*!< size of query buffer */
+	uint64_t code;		/*!< response code (0 is success, error number if not) */
+	uint64_t sync;		/*!< synchronization id */
+	uint64_t schema_id;	/*!< unique schema id */
+	const char *error;	/*!< error message (NULL if not present) */
+	const char *error_end;	/*!< end of error message (NULL if not present) */
+	const char *data;	/*!< tuple data (NULL if not present) */
+	const char *data_end;	/*!< end if tuple data (NULL if not present) */
+	const char *metadata;	/*!< tuple metadata (NULL if not present) */
+	const char *metadata_end; /*!< end if tuple metadata (NULL if not present) */
+	const char *sqlinfo;	/*!< map sqlinfo (NULL if not present) */
+	const char *sqlinfo_end;/*!< end if map sqlinfo (NULL if not present) */
+};
+
+/*!
+ * \brief Get error number
+ */
+#define TNT_REPLY_ERR(R) ((R)->code)
+
+/*!
+ * \brief Allocate and init reply object
+ *
+ * if reply pointer is NULL, then new stream will be created
+ *
+ * \param r reply object pointer
+ *
+ * \returns reply object pointer
+ * \retval  NULL memory allocation failure
+ */
+struct tnt_reply *
+tnt_reply_init(struct tnt_reply *r);
+
+/*!
+ * \brief Free previously inited reply object
+ *
+ * \param r reply object pointer
+ */
+void
+tnt_reply_free(struct tnt_reply *r);
+
+/*!
+ * \brief process buffer as iproto reply
+ *
+ * \param[in]  r    reply object pointer
+ * \param[in]  buf  buffer data pointer
+ * \param[in]  size buffer data size
+ * \param[out] off  returned offset, may be NULL
+ *
+ * if reply is fully read, then zero is returned and offset set to the
+ * end of reply data in buffer.
+ *
+ * if reply is not complete, then 1 is returned and offset set to the
+ * size needed to read.
+ *
+ * if there were error while parsing reply, -1 is returned.
+ *
+ * \returns status of processing reply
+ * \retval 0  read reply
+ * \retval 1  need 'offset' bytes more
+ * \retval -1 error while parsing request
+ */
+int
+tnt_reply(struct tnt_reply *r, char *buf, size_t size, size_t *off);
+
+/*!
+ * \brief Process iproto reply with supplied recv function
+ *
+ * \param r   reply object pointer
+ * \param rcv supplied recv function
+ * \param ptr recv function argument
+ *
+ * \returns status of parsing
+ * \retval  0 ok
+ * \retval -1 error, while parsing response
+ */
+int
+tnt_reply_from(struct tnt_reply *r, tnt_reply_t rcv, void *ptr);
+
+/*!
+ * \brief Process buffer as reply header without copying processed bytes
+ *
+ * \param[in]  r    reply object pointer
+ * \param[in]  buf  buffer data pointer
+ * \param[in]  size buffer data size
+ * \param[out] off  returned offset, may be NULL
+ *
+ * if buffer contains valid reply header, then zero is returned and offset set to the
+ * end of reply header in buffer.
+ *
+ * if there were error while parsing buffer, -1 is returned.
+ *
+ * \returns status of processing reply
+ * \retval 0  process reply header
+ * \retval -1 error while parsing buffer
+ */
+int
+tnt_reply_hdr0(struct tnt_reply *r, const char *buf, size_t size, size_t *off);
+
+/*!
+ * \brief Process buffer as reply body without copying processed bytes
+ *
+ * \param[in]  r    reply object pointer
+ * \param[in]  buf  buffer data pointer
+ * \param[in]  size buffer data size
+ * \param[out] off  returned offset, may be NULL
+ *
+ * if buffer contains valid reply body, then zero is returned and offset set to the
+ * end of reply body in buffer.
+ *
+ * if there were error while parsing buffer, -1 is returned.
+ *
+ * \returns status of processing reply
+ * \retval 0  process reply body
+ * \retval -1 error while parsing buffer
+ */
+int
+tnt_reply_body0(struct tnt_reply *r, const char *buf, size_t size, size_t *off);
+
+/*!
+ * \brief Process buffer as reply without copying processed bytes
+ *
+ * \param[in]  r    reply object pointer
+ * \param[in]  buf  buffer data pointer
+ * \param[in]  size buffer data size
+ * \param[out] off  returned offset, may be NULL
+ *
+ * if buffer contains full and valid reply, then zero is returned and offset set to the
+ * end of reply in buffer.
+ *
+ * if buffer doesn't contain full reply, then 1 is returned and offset set to the
+ * size needed to read.
+ *
+ * if there were error while parsing buffer, -1 is returned.
+ *
+ * \returns status of processing reply
+ * \retval 0  process reply
+ * \retval 1  need 'offset' bytes more
+ * \retval -1 error while parsing buffer
+ */
+int
+tnt_reply0(struct tnt_reply *r, const char *buf, size_t size, size_t *off);
+
+#endif /* TNT_REPLY_H_INCLUDED */