trilogy 2.0.0

data/ext/trilogy-ruby/extconf.rb

@@ -0,0 +1,16 @@
+require "mkmf"
+
+# concatenate trilogy library sources to allow the compiler to optimise across
+# source files
+File.binwrite("trilogy.c",
+  Dir["#{__dir__}/src/**/*.c"].map { |src| File.binread(src) }.join)
+
+$objs = %w[trilogy.o cast.o cext.o]
+$CFLAGS << " -I #{__dir__}/inc -std=gnu99"
+
+dir_config("openssl")
+
+have_library("crypto", "CRYPTO_malloc")
+have_library("ssl", "SSL_new")
+
+create_makefile "trilogy/cext"

data/ext/trilogy-ruby/inc/trilogy/blocking.h

@@ -0,0 +1,163 @@
+#ifndef TRILOGY_BLOCKING_H
+#define TRILOGY_BLOCKING_H
+
+#include "client.h"
+
+/* Trilogy Blocking Client API
+ *
+ * This API is a set of high level functions for issuing commands to the MySQL-compatible
+ * server. Being just a simple wrapper around the non-blocking API - each call
+ * will block until a full request and response cycle has completed, or an error
+ * occurs.
+ *
+ * The trilogy_init function from client.h should be used to initialize a
+ * trilogy_conn_t struct. While trilogy_free should be used to ensure any internal
+ * buffers are freed.
+ *
+ * Applications requiring finer-grained control over I/O should use the
+ * non-blocking API in client.h
+ */
+
+/* trilogy_connect - Establish a connection to a MySQL-compatible server
+ *
+ * conn     - A pre-initialized trilogy_conn_t pointer.
+ * opts     - Connection options for where to connect to.
+ *
+ * Return values
+ *   TRILOGY_OK                 - Connected and authenticated successfully.
+ *   TRILOGY_SYSERR             - A system error occurred, check errno.
+ *   TRILOGY_CLOSED_CONNECTION  - The connection was severed during
+ * authentication. TRILOGY_PROTOCOL_VIOLATION - An error occurred while processing
+ * a network packet.
+ */
+int trilogy_connect(trilogy_conn_t *conn, const trilogy_sockopt_t *opts);
+
+/* trilogy_connect_sock - Establish a connection to a MySQL-compatible server with an
+ *                    - existing socket.
+ *
+ * conn     - A pre-initialized trilogy_conn_t pointer.
+ * sock     - A  connected socket.
+ *
+ * Return values
+ *   TRILOGY_OK                 - Connected and authenticated successfully.
+ *   TRILOGY_SYSERR             - A system error occurred, check errno.
+ *   TRILOGY_CLOSED_CONNECTION  - The connection was severed during
+ * authentication. TRILOGY_PROTOCOL_VIOLATION - An error occurred while processing
+ * a network packet.
+ */
+int trilogy_connect_sock(trilogy_conn_t *conn, trilogy_sock_t *sock);
+
+/* trilogy_change_db - Change the default database for a connection.
+ *
+ * conn     - A connected trilogy_conn_t pointer. Using a disconnected
+ * trilogy_conn_t is undefined. name     - Name of the database to set as default.
+ * name_len - Length of the database name string in bytes.
+ *
+ * Return values
+ *   TRILOGY_OK                 - The change db command completed successfully.
+ *   TRILOGY_ERR                - The server returned an error.
+ *   TRILOGY_SYSERR             - A system error occurred, check errno.
+ *   TRILOGY_CLOSED_CONNECTION  - The connection is closed.
+ *   TRILOGY_PROTOCOL_VIOLATION - An error occurred while processing a network
+ *                             packet.
+ */
+int trilogy_change_db(trilogy_conn_t *conn, const char *name, size_t name_len);
+
+/* trilogy_query - Send and execute a query.
+ *
+ * conn             - A connected trilogy_conn_t pointer. Using a disconnected
+ *                    trilogy_conn_t is undefined.
+ * query            - The query string to be sent to the server.
+ * query_len        - Length of the query string in bytes.
+ * column_count_out - Out parameter; The number of columns in the result set.
+ *
+ * Return values
+ *   TRILOGY_OK                 - The query completed successfully and there are
+ * no results to be read. TRILOGY_HAVE_RESULTS       - The query completed
+ * successfully and there are results to be read. The caller must then call
+ *                             trilogy_read_full_column to read all column info
+ *                             packets, then trilogy_read_full_row until all rows
+ *                             have been read.
+ *   TRILOGY_ERR                - The server returned an error.
+ *   TRILOGY_SYSERR             - A system error occurred, check errno.
+ *   TRILOGY_CLOSED_CONNECTION  - The connection is closed.
+ *   TRILOGY_PROTOCOL_VIOLATION - An error occurred while processing a network
+ *                             packet.
+ */
+int trilogy_query(trilogy_conn_t *conn, const char *query, size_t query_len, uint64_t *column_count_out);
+
+/* trilogy_read_full_column - Read a column from the result set.
+ *
+ * This should be called after issuing a query that has results. For example:
+ * an INSERT query won't have a result set.
+ *
+ * Calling this function at any other time during the connection lifecycle is
+ * undefined.
+ *
+ * conn       - A connected trilogy_conn_t pointer. Using a disconnected
+ *              trilogy_conn_t is undefined.
+ * column_out - Out parameter; A pointer to a pre-allocated trilogy_column_t,
+ * which will be filled out by this function.
+ *
+ * Return values
+ *   TRILOGY_OK                 - The column was successfully read.
+ *   TRILOGY_SYSERR             - A system error occurred, check errno.
+ *   TRILOGY_CLOSED_CONNECTION  - The connection is closed.
+ *   TRILOGY_PROTOCOL_VIOLATION - An error occurred while processing a network
+ *                             packet.
+ */
+int trilogy_read_full_column(trilogy_conn_t *conn, trilogy_column_t *column_out);
+
+/* trilogy_read_full_row - Read a row from the result set.
+ *
+ * This should only be called after reading all of the columns from a result
+ * set.
+ *
+ * Calling this function at any other time during the connection lifecycle is
+ * undefined.
+ *
+ * conn       - A connected trilogy_conn_t pointer. Using a disconnected
+ *              trilogy_conn_t is undefined.
+ * values_out - Out parameter; A pointer to a pre-allocated trilogy_value_t, which
+ *              will be filled out by this function. It should be allocated with
+ *              enough space to hold a trilogy_value_t pointer for each column.
+ *              Something like: `(sizeof(trilogy_value_t) * column_count)`.
+ *
+ * Return values
+ *   TRILOGY_OK                 - The row was successfully read.
+ *   TRILOGY_SYSERR             - A system error occurred, check errno.
+ *   TRILOGY_CLOSED_CONNECTION  - The connection is closed.
+ *   TRILOGY_PROTOCOL_VIOLATION - An error occurred while processing a network
+ *                             packet.
+ */
+int trilogy_read_full_row(trilogy_conn_t *conn, trilogy_value_t *values_out);
+
+/* trilogy_ping - Send a ping command to the server.
+ *
+ * conn - A connected trilogy_conn_t pointer. Using a disconnected trilogy_conn_t
+ *        is undefined.
+ *
+ * Return values
+ *   TRILOGY_OK                 - The ping command completed successfully.
+ *   TRILOGY_SYSERR             - A system error occurred, check errno.
+ *   TRILOGY_CLOSED_CONNECTION  - The connection is closed.
+ *   TRILOGY_PROTOCOL_VIOLATION - An error occurred while processing a network
+ *                             packet.
+ */
+int trilogy_ping(trilogy_conn_t *conn);
+
+/* trilogy_close - Send a quit command to the server.
+ *
+ * conn - A connected trilogy_conn_t pointer. Using a disconnected trilogy_conn_t
+ *        is undefined.
+ *
+ * Return values
+ *   TRILOGY_OK                 - The quit command was completed successfully.
+ *   TRILOGY_SYSERR             - A system error occurred, check errno.
+ *   TRILOGY_CLOSED_CONNECTION  - The connection is closed.
+ *   TRILOGY_PROTOCOL_VIOLATION - An error occurred while processing a network
+ *                             packet.
+ */
+int trilogy_close(trilogy_conn_t *conn);
+
+#endif

data/ext/trilogy-ruby/inc/trilogy/buffer.h

@@ -0,0 +1,64 @@
+#ifndef TRILOGY_BUFFER_H
+#define TRILOGY_BUFFER_H
+
+#include <stddef.h>
+#include <stdint.h>
+
+/* trilogy_buffer_t - A convenience type used for wrapping a reusable chunk of
+ * memory.
+ */
+typedef struct {
+    size_t len;
+    size_t cap;
+    uint8_t *buff;
+} trilogy_buffer_t;
+
+/* trilogy_buffer_init - Initialize an trilogy_buffer_t and pre-allocate
+ * `initial_capacity` bytes.
+ *
+ * buffer           - A pointer to an allocated, uninitialized trilogy_buffer_t.
+ * initial_capacity - The initial capacity for the buffer.
+ *
+ * Return values:
+ *   TRILOGY_OK     - The buffer was initialized.
+ *   TRILOGY_SYSERR - A system error occurred, check errno.
+ */
+int trilogy_buffer_init(trilogy_buffer_t *buffer, size_t initial_capacity);
+
+/* trilogy_buffer_expand - Make sure there is at least `needed` bytes available in
+ * the underlying buffer, resizing it to be larger if necessary.
+ *
+ * buffer - A pre-initialized trilogy_buffer_t pointer.
+ * needed - The amount of space requested to be available in the buffer after
+ *          after this call returns.
+ *
+ * Return values:
+ *   TRILOGY_OK     - The buffer is guaranteed to have at least `needed` bytes of
+ *                 space available.
+ *   TRILOGY_SYSERR - A system error occurred, check errno.
+ *   TRILOGY_TYPE_OVERFLOW - The amount of buffer spaced needed is larger than the
+ *                         what can be represented by `size_t`.
+ */
+int trilogy_buffer_expand(trilogy_buffer_t *buffer, size_t needed);
+
+/* trilogy_buffer_putc - Appends a byte to the buffer, resizing the underlying
+ * allocation if necessary.
+ *
+ * buffer - A pointer to a pre-initialized trilogy_buffer_t.
+ * c      - The byte to append to the buffer.
+ *
+ * Return values:
+ *   TRILOGY_OK     - The character was appended to the buffer
+ *   TRILOGY_SYSERR - A system error occurred, check errno.
+ */
+int trilogy_buffer_putc(trilogy_buffer_t *buffer, uint8_t c);
+
+/* trilogy_buffer_free - Free an trilogy_buffer_t's underlying storage. The buffer
+ * must be re-initialized with trilogy_buffer_init if it is to be reused. Any
+ * operations performed on an unintialized or freed buffer are undefined.
+ *
+ * buffer - An initialized trilogy_buffer_t.
+ */
+void trilogy_buffer_free(trilogy_buffer_t *buffer);
+
+#endif

data/ext/trilogy-ruby/inc/trilogy/builder.h

@@ -0,0 +1,161 @@
+#ifndef TRILOGY_BUILDER_H
+#define TRILOGY_BUILDER_H
+
+#include <stddef.h>
+#include <stdint.h>
+
+#include "trilogy/buffer.h"
+
+/* Trilogy Packet Builder API
+ *
+ * The builder API is used for building protocol packet buffers.
+ */
+
+/* trilogy_builder_t - The builder API's instance type.
+ */
+typedef struct {
+    trilogy_buffer_t *buffer;
+    size_t header_offset;
+    uint32_t fragment_length;
+    uint8_t seq;
+} trilogy_builder_t;
+
+/* trilogy_builder_init - Initialize a pre-allocated trilogy_builder_t
+ *
+ * builder - A pre-allocated trilogy_builder_t pointer
+ * buffer  - A pre-initialized trilogy_buffer_t pointer
+ * seq     - The initial sequence number for the packet to be built. This is
+ *           the initial number because the builder API will automatically
+ *           split buffers that are larger than TRILOGY_MAX_PROTO_PACKET_LEN into
+ *           multiple packets and increment the sequence number in each packet
+ *           following the initial.
+ *
+ * Return values:
+ *   TRILOGY_OK     - The builder was successfully initialized.
+ *   TRILOGY_SYSERR - A system error occurred, check errno.
+ */
+int trilogy_builder_init(trilogy_builder_t *builder, trilogy_buffer_t *buffer, uint8_t seq);
+
+/* trilogy_builder_finalize - Finalize internal buffer state, ensuring all of the
+ * packets inside are valid and ready for use over the wire.
+ *
+ * builder - A pre-initialized trilogy_builder_t pointer.
+ *
+ * Returns nothing.
+ */
+void trilogy_builder_finalize(trilogy_builder_t *builder);
+
+/* trilogy_builder_write_uint8 - Append an unsigned 8-bit integer to the packet
+ * buffer.
+ *
+ * builder - A pre-initialized trilogy_builder_t pointer.
+ * val     - The value to append to the buffer.
+ *
+ * Return values:
+ *   TRILOGY_OK     - The value was appended to the packet buffer.
+ *   TRILOGY_SYSERR - A system error occurred, check errno.
+ */
+int trilogy_builder_write_uint8(trilogy_builder_t *builder, uint8_t val);
+
+/* trilogy_builder_write_uint16 - Append an unsigned 16-bit integer to the packet
+ * buffer.
+ *
+ * builder - A pre-initialized trilogy_builder_t pointer.
+ * val     - The value to append to the buffer.
+ *
+ * Return values:
+ *   TRILOGY_OK     - The value was appended to the packet buffer.
+ *   TRILOGY_SYSERR - A system error occurred, check errno.
+ */
+int trilogy_builder_write_uint16(trilogy_builder_t *builder, uint16_t val);
+
+/* trilogy_builder_write_uint24 - Append an unsigned 24-bit integer to the packet
+ * buffer.
+ *
+ * builder - A pre-initialized trilogy_builder_t pointer.
+ * val     - The value to append to the buffer.
+ *
+ * Return values:
+ *   TRILOGY_OK     - The value was appended to the packet buffer.
+ *   TRILOGY_SYSERR - A system error occurred, check errno.
+ */
+int trilogy_builder_write_uint24(trilogy_builder_t *builder, uint32_t val);
+
+/* trilogy_builder_write_uint32 - Append an unsigned 32-bit integer to the packet
+ * buffer.
+ *
+ * builder - A pre-initialized trilogy_builder_t pointer
+ * val     - The value to append to the buffer
+ *
+ * Return values:
+ *   TRILOGY_OK     - The value was appended to the packet buffer.
+ *   TRILOGY_SYSERR - A system error occurred, check errno.
+ */
+int trilogy_builder_write_uint32(trilogy_builder_t *builder, uint32_t val);
+
+/* trilogy_builder_write_uint64 - Append an unsigned 64-bit integer to the packet
+ * buffer.
+ *
+ * builder - A pre-initialized trilogy_builder_t pointer
+ * val     - The value to append to the buffer
+ *
+ * Return values:
+ *   TRILOGY_OK     - The value was appended to the packet buffer.
+ *   TRILOGY_SYSERR - A system error occurred, check errno.
+ */
+int trilogy_builder_write_uint64(trilogy_builder_t *builder, uint64_t val);
+
+/* trilogy_builder_write_lenenc - Append a length-encoded integer to the packet
+ * buffer.
+ *
+ * The actual number of bytes appended to the buffer depends on the value passed
+ * in.
+ *
+ * builder - A pre-initialized trilogy_builder_t pointer
+ * val     - The value to append to the buffer
+ *
+ * Return values:
+ *   TRILOGY_OK     - The value was appended to the packet buffer.
+ *   TRILOGY_SYSERR - A system error occurred, check errno.
+ */
+int trilogy_builder_write_lenenc(trilogy_builder_t *builder, uint64_t val);
+
+/* trilogy_builder_write_buffer - Append opaque bytes to the packet buffer.
+ *
+ * builder - A pre-initialized trilogy_builder_t pointer
+ * data    - A pointer to the opaque data to be appended
+ * len     - The number of bytes to append from the location in memory the
+ *           `data` parameter points to.
+ *
+ * Return values:
+ *   TRILOGY_OK     - The value was appended to the packet buffer.
+ *   TRILOGY_SYSERR - A system error occurred, check errno.
+ */
+int trilogy_builder_write_buffer(trilogy_builder_t *builder, const void *data, size_t len);
+
+/* trilogy_builder_write_lenenc_buffer - Append opaque bytes to the packet buffer,
+ * prepended by its length as a length-encoded integer.
+ *
+ * builder - A pre-initialized trilogy_builder_t pointer
+ * data    - A pointer to the opaque data to be appended
+ * len     - The number of bytes to append from the location in memory the
+ *           `data` parameter points to.
+ *
+ * Return values:
+ *   TRILOGY_OK     - The value was appended to the packet buffer.
+ *   TRILOGY_SYSERR - A system error occurred, check errno.
+ */
+int trilogy_builder_write_lenenc_buffer(trilogy_builder_t *builder, const void *data, size_t len);
+
+/* trilogy_builder_write_string - Append a C-string to the packet buffer.
+ *
+ * builder - A pre-initialized trilogy_builder_t pointer
+ * data    - A pointer to the C-string to append
+ *
+ * Return values:
+ *   TRILOGY_OK     - The value was appended to the packet buffer.
+ *   TRILOGY_SYSERR - A system error occurred, check errno.
+ */
+int trilogy_builder_write_string(trilogy_builder_t *builder, const char *data);
+
+#endif