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
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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
|
#ifndef INCLUDES_TARANTOOL_BOX_PORT_H
#define INCLUDES_TARANTOOL_BOX_PORT_H
/*
* Copyright 2010-2016, Tarantool AUTHORS, please see AUTHORS file.
*
* 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.
*/
#include "trivia/util.h"
#include <port.h>
#include <stdbool.h>
#if defined(__cplusplus)
extern "C" {
#endif /* defined(__cplusplus) */
struct tuple;
extern const struct port_vtab port_c_vtab;
/** Port implementation used for storing raw data. */
struct port_msgpack {
const struct port_vtab *vtab;
const char *data;
uint32_t data_sz;
/**
* Buffer for dump_plain() function. It is created during
* dump on demand and is deleted together with the port.
*/
char *plain;
};
static_assert(sizeof(struct port_msgpack) <= sizeof(struct port),
"sizeof(struct port_msgpack) must be <= sizeof(struct port)");
/** Initialize a port to dump raw data. */
void
port_msgpack_create(struct port *port, const char *data, uint32_t data_sz);
/** Destroy a MessagePack port. */
void
port_msgpack_destroy(struct port *base);
/**
* Set plain text version of data in the given port. It is copied.
*/
int
port_msgpack_set_plain(struct port *base, const char *plain, uint32_t len);
/** Port for storing the result of a Lua CALL/EVAL. */
struct port_lua {
const struct port_vtab *vtab;
/** Lua state that stores the result. */
struct lua_State *L;
/** Reference to L in tarantool_L. */
int ref;
/** Number of entries dumped to the port. */
int size;
};
static_assert(sizeof(struct port_lua) <= sizeof(struct port),
"sizeof(struct port_lua) must be <= sizeof(struct port)");
/** Initialize a port to dump from Lua. */
void
port_lua_create(struct port *port, struct lua_State *L);
struct sql_value;
/** Port implementation used with vdbe memory variables. */
struct port_vdbemem {
const struct port_vtab *vtab;
struct sql_value *mem;
uint32_t mem_count;
};
static_assert(sizeof(struct port_vdbemem) <= sizeof(struct port),
"sizeof(struct port_vdbemem) must be <= sizeof(struct port)");
/** Initialize a port to dump data in sql vdbe memory. */
void
port_vdbemem_create(struct port *base, struct sql_value *mem,
uint32_t mem_count);
struct port_c_entry {
struct port_c_entry *next;
union {
/** Valid if mp_size is 0. */
struct tuple *tuple;
/**
* Valid if mp_size is > 0. MessagePack is
* allocated either on heap or on the port entry
* mempool, if it fits into a pool object.
*/
char *mp;
};
uint32_t mp_size;
};
/**
* C port is used by C functions from the public API. They can
* return tuples and arbitrary MessagePack.
*/
struct port_c {
const struct port_vtab *vtab;
struct port_c_entry *first;
struct port_c_entry *last;
struct port_c_entry first_entry;
int size;
};
static_assert(sizeof(struct port_c) <= sizeof(struct port),
"sizeof(struct port_c) must be <= sizeof(struct port)");
/** Create a C port object. */
void
port_c_create(struct port *base);
/** Append a tuple to the port. Tuple is referenced. */
int
port_c_add_tuple(struct port *port, struct tuple *tuple);
/** Append raw MessagePack to the port. It is copied. */
int
port_c_add_mp(struct port *port, const char *mp, const char *mp_end);
void
port_init(void);
void
port_free(void);
#if defined(__cplusplus)
} /* extern "C" */
#endif /* defined __cplusplus */
#endif /* INCLUDES_TARANTOOL_BOX_PORT_H */
|