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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
|
/*
* Copyright (c) 2019, 2025, Oracle and/or its affiliates.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License, version 2.0,
* as published by the Free Software Foundation.
*
* This program is designed to work with certain software (including
* but not limited to OpenSSL) that is licensed under separate terms,
* as designated in a particular file or component or in included license
* documentation. The authors of MySQL hereby grant you an additional
* permission to link the program and your derivative works with the
* separately licensed software that they have either included with
* the program or referenced in the documentation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License, version 2.0, for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
#ifndef PLUGIN_X_PROTOCOL_ENCODERS_ENCODING_XMESSAGES_H_
#define PLUGIN_X_PROTOCOL_ENCODERS_ENCODING_XMESSAGES_H_
#include <cassert>
#include <cstdint>
#include <string>
#include <utility>
#include "my_dbug.h" // NOLINT(build/include_subdir)
#include "plugin/x/generated/encoding_descriptors.h"
#include "plugin/x/protocol/encoders/encoding_xprotocol.h"
#include "plugin/x/src/ngs/protocol/encode_column_info.h"
#include "plugin/x/src/ngs/protocol/protocol_protobuf.h"
namespace protocol {
template <typename Base_type>
class XMessage_encoder_base : public Base_type {
private:
constexpr static Mysqlx::Notice::Frame_Type k_state_change =
Mysqlx::Notice::Frame_Type_SESSION_STATE_CHANGED;
constexpr static Mysqlx::Notice::Frame_Scope k_local =
Mysqlx::Notice::Frame_Scope_LOCAL;
constexpr static Mysqlx::Notice::SessionStateChanged_Parameter k_message =
Mysqlx::Notice::SessionStateChanged::PRODUCED_MESSAGE;
constexpr static Mysqlx::Notice::SessionStateChanged_Parameter k_expired =
Mysqlx::Notice::SessionStateChanged::ACCOUNT_EXPIRED;
constexpr static Mysqlx::Notice::SessionStateChanged_Parameter
k_generated_insert_id =
Mysqlx::Notice::SessionStateChanged::GENERATED_INSERT_ID;
constexpr static Mysqlx::Datatypes::Scalar_Type k_string =
Mysqlx::Datatypes::Scalar_Type_V_STRING;
constexpr static Mysqlx::Datatypes::Scalar_Type k_v_uint =
Mysqlx::Datatypes::Scalar_Type_V_UINT;
constexpr static Mysqlx::Notice::SessionStateChanged_Parameter
k_rows_affected = Mysqlx::Notice::SessionStateChanged::ROWS_AFFECTED;
constexpr static Mysqlx::Notice::SessionStateChanged_Parameter k_client_id =
Mysqlx::Notice::SessionStateChanged::CLIENT_ID_ASSIGNED;
public:
// Constructor inheritance doesn't work in solaris
// for template<T> class X: T {...};
//
// ```using Base_type::Base_type;```
//
// Using template constructor instead:
template <typename... Args>
explicit XMessage_encoder_base(Args &&...args)
: Base_type(std::forward<Args>(args)...) {}
void encode_compact_metadata(const uint8_t type, const uint64_t *collation,
const uint32_t *decimals, const uint32_t *length,
const uint32_t *flags,
const uint32_t *content_type) {
using Tags = tags::ColumnMetaData;
// The buffer size is verified by UT in xmessage_buffer.cc
auto xmsg_start =
Base_type::template begin_xmessage<Tags::server_id, 100>();
Base_type::template encode_field_enum<Tags::type>(type);
Base_type::template encode_optional_field_var_uint64<Tags::collation>(
collation);
Base_type::template encode_optional_field_var_uint32<
Tags::fractional_digits>(decimals);
Base_type::template encode_optional_field_var_uint32<Tags::length>(length);
Base_type::template encode_optional_field_var_uint32<Tags::flags>(flags);
Base_type::template encode_optional_field_var_uint32<Tags::content_type>(
content_type);
Base_type::end_xmessage(xmsg_start);
}
void encode_full_metadata(const char *col_name, const char *org_col_name,
const char *table_name, const char *org_table_name,
const char *db_name, const char *catalog,
const uint8_t type, const uint64_t *collation,
const uint32_t *decimals, const uint32_t *length,
const uint32_t *flags,
const uint32_t *content_type) {
using Tags = tags::ColumnMetaData;
// The buffer size is verified by UT in xmessage_buffer.cc
auto xmsg_start =
Base_type::template begin_xmessage<Tags::server_id, 100>();
Base_type::template encode_field_enum<Tags::type>(type);
Base_type::template encode_optional_field_var_uint64<Tags::collation>(
collation);
Base_type::template encode_optional_field_var_uint32<
Tags::fractional_digits>(decimals);
Base_type::template encode_optional_field_var_uint32<Tags::length>(length);
Base_type::template encode_optional_field_var_uint32<Tags::flags>(flags);
Base_type::template encode_optional_field_var_uint32<Tags::content_type>(
content_type);
Base_type::template encode_field_string<Tags::name>(col_name);
Base_type::template encode_field_string<Tags::original_name>(org_col_name);
Base_type::template encode_field_string<Tags::table>(table_name);
Base_type::template encode_field_string<Tags::original_table>(
org_table_name);
Base_type::template encode_field_string<Tags::schema>(db_name);
Base_type::template encode_field_string<Tags::catalog>(catalog);
Base_type::end_xmessage(xmsg_start);
}
void encode_metadata(const ngs::Encode_column_info *column) {
using Tags = tags::ColumnMetaData;
// The buffer size is verified by UT in xmessage_buffer.cc
auto xmsg_start =
Base_type::template begin_xmessage<Tags::server_id, 100>();
Base_type::template encode_field_enum<Tags::type>(column->m_type);
Base_type::template encode_optional_field_var_uint64<Tags::collation>(
column->m_collation_ptr);
Base_type::template encode_optional_field_var_uint32<
Tags::fractional_digits>(column->m_decimals_ptr);
Base_type::template encode_optional_field_var_uint32<Tags::length>(
column->m_length_ptr);
Base_type::template encode_optional_field_var_uint32<Tags::flags>(
column->m_flags_ptr);
Base_type::template encode_optional_field_var_uint32<Tags::content_type>(
column->m_content_type_ptr);
if (!column->m_compact) {
Base_type::template encode_field_string<Tags::name>(column->m_col_name);
Base_type::template encode_field_string<Tags::original_name>(
column->m_org_col_name);
Base_type::template encode_field_string<Tags::table>(
column->m_table_name);
Base_type::template encode_field_string<Tags::original_table>(
column->m_org_table_name);
Base_type::template encode_field_string<Tags::schema>(column->m_db_name);
Base_type::template encode_field_string<Tags::catalog>(column->m_catalog);
}
Base_type::end_xmessage(xmsg_start);
}
void encode_notice_rows_affected(const uint64_t rows) {
using FrameTags = tags::Frame;
using StateTags = tags::SessionStateChanged;
using ScalarTags = tags::Scalar;
// The buffer size is verified by UT in xmessage_buffer.cc
auto xmsg_start =
Base_type::template begin_xmessage<FrameTags::server_id, 145>();
Base_type::template encode_field_const_var_uint<FrameTags::type,
k_state_change>();
Base_type::template encode_field_const_enum<FrameTags::scope, k_local>();
auto field_payload_start =
Base_type::template begin_delimited_field<FrameTags::payload>();
Base_type::template encode_field_const_enum<StateTags::param,
k_rows_affected>();
auto field_value_start =
Base_type::template begin_delimited_field<StateTags::value>();
Base_type::template encode_field_const_enum<ScalarTags::type, k_v_uint>();
Base_type::template encode_field_var_uint64<ScalarTags::v_unsigned_int>(
rows);
Base_type::end_delimited_field(field_value_start);
Base_type::end_delimited_field(field_payload_start);
Base_type::end_xmessage(xmsg_start);
}
void encode_notice_client_id(const uint64_t id) {
using FrameTags = tags::Frame;
using StateTags = tags::SessionStateChanged;
using ScalarTags = tags::Scalar;
// The buffer size is verified by UT in xmessage_buffer.cc
auto xmsg_start =
Base_type::template begin_xmessage<FrameTags::server_id, 145>();
Base_type::template encode_field_const_var_uint<FrameTags::type,
k_state_change>();
Base_type::template encode_field_const_enum<FrameTags::scope, k_local>();
auto field_payload_start =
Base_type::template begin_delimited_field<FrameTags::payload>();
Base_type::template encode_field_const_enum<StateTags::param,
k_client_id>();
auto field_value_start =
Base_type::template begin_delimited_field<StateTags::value>();
Base_type::template encode_field_const_enum<ScalarTags::type, k_v_uint>();
Base_type::template encode_field_var_uint64<ScalarTags::v_unsigned_int>(id);
Base_type::end_delimited_field(field_value_start);
Base_type::end_delimited_field(field_payload_start);
Base_type::end_xmessage(xmsg_start);
}
void encode_notice_expired() {
using FrameTags = tags::Frame;
using StateTags = tags::SessionStateChanged;
// The buffer size is verified by UT in xmessage_buffer.cc
auto xmsg_start =
Base_type::template begin_xmessage<FrameTags::server_id, 85>();
Base_type::template encode_field_const_var_uint<FrameTags::type,
k_state_change>();
Base_type::template encode_field_const_enum<FrameTags::scope, k_local>();
auto field_payload_start =
Base_type::template begin_delimited_field<FrameTags::payload>();
Base_type::template encode_field_const_enum<StateTags::param, k_expired>();
Base_type::end_delimited_field(field_payload_start);
Base_type::end_xmessage(xmsg_start);
}
void encode_notice_generated_insert_id(const uint64_t last_insert_id) {
using FrameTags = tags::Frame;
using StateTags = tags::SessionStateChanged;
using ScalarTags = tags::Scalar;
// The buffer size is verified by UT in xmessage_buffer.cc
auto xmsg_start =
Base_type::template begin_xmessage<FrameTags::server_id, 145>();
Base_type::template encode_field_const_var_uint<FrameTags::type,
k_state_change>();
Base_type::template encode_field_const_enum<FrameTags::scope, k_local>();
auto field_payload_start =
Base_type::template begin_delimited_field<FrameTags::payload>();
Base_type::template encode_field_const_enum<StateTags::param,
k_generated_insert_id>();
auto field_value_start =
Base_type::template begin_delimited_field<StateTags::value>();
Base_type::template encode_field_const_enum<ScalarTags::type, k_v_uint>();
Base_type::template encode_field_var_uint64<ScalarTags::v_unsigned_int>(
last_insert_id);
Base_type::end_delimited_field(field_value_start);
Base_type::end_delimited_field(field_payload_start);
Base_type::end_xmessage(xmsg_start);
}
void encode_notice_text_message(const std::string &message) {
using FrameTags = tags::Frame;
using StateTags = tags::SessionStateChanged;
using ScalarTags = tags::Scalar;
using StringTags = tags::String;
// The buffer size is verified by UT in xmessage_buffer.cc
auto xmsg_start =
Base_type::template begin_xmessage<FrameTags::server_id, 145>();
Base_type::template encode_field_const_var_uint<FrameTags::type,
k_state_change>();
Base_type::template encode_field_const_enum<FrameTags::scope, k_local>();
auto field_payload_start =
Base_type::template begin_delimited_field<FrameTags::payload, 4>();
Base_type::template encode_field_const_enum<StateTags::param, k_message>();
auto field_value_start =
Base_type::template begin_delimited_field<StateTags::value, 4>();
Base_type::template encode_field_const_enum<ScalarTags::type, k_string>();
auto string_start =
Base_type::template begin_delimited_field<ScalarTags::v_string, 4>();
Base_type::template encode_field_string<StringTags::value>(message);
Base_type::end_delimited_field(string_start);
Base_type::end_delimited_field(field_value_start);
Base_type::end_delimited_field(field_payload_start);
Base_type::end_xmessage(xmsg_start);
}
void encode_notice(const uint32_t type, const uint32_t scope,
const std::string &data) {
using FrameTags = tags::Frame;
// The buffer size is verified by UT in xmessage_buffer.cc
auto xmsg_start =
Base_type::template begin_xmessage<FrameTags::server_id, 40>();
Base_type::template encode_field_var_uint32<FrameTags::type>(type);
Base_type::template encode_field_enum<FrameTags::scope>(scope);
Base_type::template encode_field_string<FrameTags::payload>(data);
Base_type::end_xmessage(xmsg_start);
}
void encode_global_notice(const uint32_t type, const std::string &data) {
using FrameTags = tags::Frame;
// The buffer size is verified by UT in xmessage_buffer.cc
auto xmsg_start =
Base_type::template begin_xmessage<FrameTags::server_id, 25>();
Base_type::template encode_field_var_uint32<FrameTags::type>(type);
Base_type::template encode_field_string<FrameTags::payload>(data);
Base_type::end_xmessage(xmsg_start);
}
void encode_fetch_more_resultsets() {
Base_type::template empty_xmessage<
tags::FetchDoneMoreResultsets::server_id>();
}
void encode_fetch_out_params() {
Base_type::template empty_xmessage<
tags::FetchDoneMoreOutParams::server_id>();
}
void encode_fetch_suspended() {
Base_type::template empty_xmessage<tags::FetchSuspended::server_id>();
}
void encode_fetch_done() {
Base_type::template empty_xmessage<tags::FetchDone::server_id>();
}
void encode_stmt_execute_ok() {
Base_type::template empty_xmessage<tags::StmtExecuteOk::server_id>();
}
void encode_ok() {
Base_type::template empty_xmessage<tags::Ok::server_id>();
}
void encode_ok(const std::string &message) {
auto xmsg_start =
Base_type::template begin_xmessage<tags::Ok::server_id, 5>();
Base_type::template encode_field_string<tags::Ok::msg>(message);
Base_type::end_xmessage(xmsg_start);
}
void encode_error(const int severity, const uint32_t code,
const std::string &msg, const std::string &sql_state) {
auto xmsg_start =
Base_type::template begin_xmessage<tags::Error::server_id, 40>();
Base_type::template encode_field_enum<tags::Error::severity>(severity);
Base_type::template encode_field_var_uint32<tags::Error::code>(code);
Base_type::template encode_field_string<tags::Error::msg>(msg);
Base_type::template encode_field_string<tags::Error::sql_state>(sql_state);
Base_type::end_xmessage(xmsg_start);
}
template <uint8_t id>
void encode_xmessage(const std::string &serialized_xmessage) {
auto xmsg_start = Base_type::template begin_xmessage<id, 100>();
Base_type::encode_raw(
reinterpret_cast<const uint8_t *>(serialized_xmessage.c_str()),
serialized_xmessage.length());
Base_type::end_xmessage(xmsg_start);
}
};
class XMessage_encoder : public XMessage_encoder_base<XProtocol_encoder> {
public:
using XMessage_encoder_base<XProtocol_encoder>::XMessage_encoder_base;
};
} // namespace protocol
#endif // PLUGIN_X_PROTOCOL_ENCODERS_ENCODING_XMESSAGES_H_
|
