-
Notifications
You must be signed in to change notification settings - Fork 82
/
Copy pathGRPCServer.cpp
1827 lines (1586 loc) · 69.3 KB
/
GRPCServer.cpp
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
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#include "GRPCServer.h"
#include <limits>
#include <memory>
#if USE_GRPC
#include <Columns/ColumnString.h>
#include <Columns/ColumnsNumber.h>
#include <Common/CurrentThread.h>
#include <Common/SettingsChanges.h>
#include <Common/setThreadName.h>
#include <Common/Stopwatch.h>
#include <Processors/Transforms/AddingDefaultsTransform.h>
#include <DataTypes/DataTypeFactory.h>
#include <QueryPipeline/ProfileInfo.h>
#include <Interpreters/Context.h>
#include <Interpreters/InternalTextLogsQueue.h>
#include <Interpreters/executeQuery.h>
#include <Interpreters/Session.h>
#include <IO/CompressionMethod.h>
#include <IO/ConcatReadBuffer.h>
#include <IO/ReadBufferFromString.h>
#include <IO/ReadHelpers.h>
#include <Parsers/parseQuery.h>
#include <Parsers/ASTIdentifier_fwd.h>
#include <Parsers/ASTInsertQuery.h>
#include <Parsers/ASTQueryWithOutput.h>
#include <Parsers/ParserQuery.h>
#include <Processors/Executors/PullingAsyncPipelineExecutor.h>
#include <Processors/Executors/PullingPipelineExecutor.h>
#include <Processors/Executors/PushingPipelineExecutor.h>
#include <Processors/Executors/CompletedPipelineExecutor.h>
#include <Processors/Executors/PipelineExecutor.h>
#include <Processors/Formats/IInputFormat.h>
#include <Processors/Formats/IOutputFormat.h>
#include <Processors/Sinks/SinkToStorage.h>
#include <Processors/Sinks/EmptySink.h>
#include <QueryPipeline/QueryPipelineBuilder.h>
#include <Server/IServer.h>
#include <Storages/IStorage.h>
#include <Poco/FileStream.h>
#include <Poco/StreamCopier.h>
#include <Poco/Util/LayeredConfiguration.h>
#include <base/range.h>
#include <Common/logger_useful.h>
#include <grpc++/security/server_credentials.h>
#include <grpc++/server.h>
#include <grpc++/server_builder.h>
using GRPCService = proton::grpc::Proton::AsyncService;
using GRPCQueryInfo = proton::grpc::QueryInfo;
using GRPCResult = proton::grpc::Result;
using GRPCException = proton::grpc::Exception;
using GRPCProgress = proton::grpc::Progress;
namespace DB
{
namespace ErrorCodes
{
extern const int INVALID_CONFIG_PARAMETER;
extern const int INVALID_GRPC_QUERY_INFO;
extern const int INVALID_SESSION_TIMEOUT;
extern const int LOGICAL_ERROR;
extern const int NETWORK_ERROR;
extern const int NO_DATA_TO_INSERT;
extern const int SUPPORT_IS_DISABLED;
extern const int BAD_REQUEST_PARAMETER;
}
namespace
{
/// Make grpc to pass logging messages to ClickHouse logging system.
void initGRPCLogging(const Poco::Util::AbstractConfiguration & config)
{
static std::once_flag once_flag;
std::call_once(once_flag, [&config]
{
static Poco::Logger * logger = &Poco::Logger::get("grpc");
gpr_set_log_function([](gpr_log_func_args* args)
{
if (args->severity == GPR_LOG_SEVERITY_DEBUG)
LOG_DEBUG(logger, "{} ({}:{})", args->message, args->file, args->line);
else if (args->severity == GPR_LOG_SEVERITY_INFO)
LOG_INFO(logger, "{} ({}:{})", args->message, args->file, args->line);
else if (args->severity == GPR_LOG_SEVERITY_ERROR)
LOG_ERROR(logger, "{} ({}:{})", args->message, args->file, args->line);
});
if (config.getBool("grpc.verbose_logs", false))
{
gpr_set_log_verbosity(GPR_LOG_SEVERITY_DEBUG);
grpc_tracer_set_enabled("all", true);
}
else if (logger->is(Poco::Message::PRIO_DEBUG))
{
gpr_set_log_verbosity(GPR_LOG_SEVERITY_DEBUG);
}
else if (logger->is(Poco::Message::PRIO_INFORMATION))
{
gpr_set_log_verbosity(GPR_LOG_SEVERITY_INFO);
}
});
}
grpc_compression_algorithm parseCompressionAlgorithm(const String & str)
{
if (str == "none")
return GRPC_COMPRESS_NONE;
else if (str == "deflate")
return GRPC_COMPRESS_DEFLATE;
else if (str == "gzip")
return GRPC_COMPRESS_GZIP;
else if (str == "stream_gzip")
throw Exception(ErrorCodes::INVALID_GRPC_QUERY_INFO, "STREAM_GZIP is no longer supported"); /// was flagged experimental in gRPC, removed as per v1.44
else
throw Exception("Unknown compression algorithm: '" + str + "'", ErrorCodes::INVALID_CONFIG_PARAMETER);
}
grpc_compression_level parseCompressionLevel(const String & str)
{
if (str == "none")
return GRPC_COMPRESS_LEVEL_NONE;
else if (str == "low")
return GRPC_COMPRESS_LEVEL_LOW;
else if (str == "medium")
return GRPC_COMPRESS_LEVEL_MED;
else if (str == "high")
return GRPC_COMPRESS_LEVEL_HIGH;
else
throw Exception("Unknown compression level: '" + str + "'", ErrorCodes::INVALID_CONFIG_PARAMETER);
}
grpc_compression_algorithm convertCompressionAlgorithm(const ::proton::grpc::CompressionAlgorithm & algorithm)
{
if (algorithm == ::proton::grpc::NO_COMPRESSION)
return GRPC_COMPRESS_NONE;
else if (algorithm == ::proton::grpc::DEFLATE)
return GRPC_COMPRESS_DEFLATE;
else if (algorithm == ::proton::grpc::GZIP)
return GRPC_COMPRESS_GZIP;
else if (algorithm == ::proton::grpc::STREAM_GZIP)
throw Exception(ErrorCodes::INVALID_GRPC_QUERY_INFO, "STREAM_GZIP is no longer supported"); /// was flagged experimental in gRPC, removed as per v1.44
else
throw Exception("Unknown compression algorithm: '" + ::proton::grpc::CompressionAlgorithm_Name(algorithm) + "'", ErrorCodes::INVALID_GRPC_QUERY_INFO);
}
grpc_compression_level convertCompressionLevel(const ::proton::grpc::CompressionLevel & level)
{
if (level == ::proton::grpc::COMPRESSION_NONE)
return GRPC_COMPRESS_LEVEL_NONE;
else if (level == ::proton::grpc::COMPRESSION_LOW)
return GRPC_COMPRESS_LEVEL_LOW;
else if (level == ::proton::grpc::COMPRESSION_MEDIUM)
return GRPC_COMPRESS_LEVEL_MED;
else if (level == ::proton::grpc::COMPRESSION_HIGH)
return GRPC_COMPRESS_LEVEL_HIGH;
else
throw Exception("Unknown compression level: '" + ::proton::grpc::CompressionLevel_Name(level) + "'", ErrorCodes::INVALID_GRPC_QUERY_INFO);
}
/// Gets file's contents as a string, throws an exception if failed.
String readFile(const String & filepath)
{
Poco::FileInputStream ifs(filepath);
String res;
Poco::StreamCopier::copyToString(ifs, res);
return res;
}
/// Makes credentials based on the server config.
std::shared_ptr<grpc::ServerCredentials> makeCredentials(const Poco::Util::AbstractConfiguration & config)
{
if (config.getBool("grpc.enable_ssl", false))
{
#if USE_SSL
grpc::SslServerCredentialsOptions options;
grpc::SslServerCredentialsOptions::PemKeyCertPair key_cert_pair;
key_cert_pair.private_key = readFile(config.getString("grpc.ssl_key_file"));
key_cert_pair.cert_chain = readFile(config.getString("grpc.ssl_cert_file"));
options.pem_key_cert_pairs.emplace_back(std::move(key_cert_pair));
if (config.getBool("grpc.ssl_require_client_auth", false))
{
options.client_certificate_request = GRPC_SSL_REQUEST_AND_REQUIRE_CLIENT_CERTIFICATE_AND_VERIFY;
if (config.has("grpc.ssl_ca_cert_file"))
options.pem_root_certs = readFile(config.getString("grpc.ssl_ca_cert_file"));
}
return grpc::SslServerCredentials(options);
#else
throw DB::Exception(
"Can't use SSL in grpc, because proton was built without SSL library",
DB::ErrorCodes::SUPPORT_IS_DISABLED);
#endif
}
return grpc::InsecureServerCredentials();
}
/// Gets session's timeout from query info or from the server config.
std::chrono::steady_clock::duration getSessionTimeout(const GRPCQueryInfo & query_info, const Poco::Util::AbstractConfiguration & config)
{
auto session_timeout = query_info.session_timeout();
if (session_timeout)
{
auto max_session_timeout = config.getUInt("max_session_timeout", 3600);
if (session_timeout > max_session_timeout)
throw Exception(
"Session timeout '" + std::to_string(session_timeout) + "' is larger than max_session_timeout: "
+ std::to_string(max_session_timeout) + ". Maximum session timeout could be modified in configuration file.",
ErrorCodes::INVALID_SESSION_TIMEOUT);
}
else
session_timeout = config.getInt("default_session_timeout", 60);
return std::chrono::seconds(session_timeout);
}
/// Generates a description of a query by a specified query info.
/// This description is used for logging only.
String getQueryDescription(const GRPCQueryInfo & query_info)
{
String str;
if (!query_info.query().empty())
{
std::string_view query = query_info.query();
constexpr size_t max_query_length_to_log = 64;
if (query.length() > max_query_length_to_log)
query.remove_suffix(query.length() - max_query_length_to_log);
if (size_t format_pos = query.find(" FORMAT "); format_pos != String::npos)
query.remove_suffix(query.length() - format_pos - strlen(" FORMAT "));
str.append("\"").append(query);
if (query != query_info.query())
str.append("...");
str.append("\"");
}
if (!query_info.query_id().empty())
str.append(str.empty() ? "" : ", ").append("query_id: ").append(query_info.query_id());
if (!query_info.input_data().empty())
str.append(str.empty() ? "" : ", ").append("input_data: ").append(std::to_string(query_info.input_data().size())).append(" bytes");
if (query_info.external_tables_size())
str.append(str.empty() ? "" : ", ").append("external tables: ").append(std::to_string(query_info.external_tables_size()));
return str;
}
/// Generates a description of a result.
/// This description is used for logging only.
String getResultDescription(const GRPCResult & result)
{
String str;
if (!result.output().empty())
str.append("output: ").append(std::to_string(result.output().size())).append(" bytes");
if (!result.totals().empty())
str.append(str.empty() ? "" : ", ").append("totals");
if (!result.extremes().empty())
str.append(str.empty() ? "" : ", ").append("extremes");
if (result.has_progress())
str.append(str.empty() ? "" : ", ").append("progress");
if (result.logs_size())
str.append(str.empty() ? "" : ", ").append("logs: ").append(std::to_string(result.logs_size())).append(" entries");
if (result.cancelled())
str.append(str.empty() ? "" : ", ").append("cancelled");
if (result.has_exception())
str.append(str.empty() ? "" : ", ").append("exception");
/// proton: starts.
if (result.query_id().empty())
str.append(str.empty() ? "" : ", ").append("query_id");
/// proton: ends.
return str;
}
using CompletionCallback = std::function<void(bool)>;
/// Requests a connection and provides low-level interface for reading and writing.
class BaseResponder
{
public:
virtual ~BaseResponder() = default;
virtual void start(GRPCService & grpc_service,
grpc::ServerCompletionQueue & new_call_queue,
grpc::ServerCompletionQueue & notification_queue,
const CompletionCallback & callback) = 0;
virtual void read(GRPCQueryInfo & query_info_, const CompletionCallback & callback) = 0;
virtual void write(const GRPCResult & result, const CompletionCallback & callback) = 0;
virtual void writeAndFinish(const GRPCResult & result, const grpc::Status & status, const CompletionCallback & callback) = 0;
Poco::Net::SocketAddress getClientAddress() const
{
String peer = grpc_context.peer();
return Poco::Net::SocketAddress{peer.substr(peer.find(':') + 1)};
}
void setResultCompression(grpc_compression_algorithm algorithm, grpc_compression_level level)
{
grpc_context.set_compression_algorithm(algorithm);
grpc_context.set_compression_level(level);
}
void setResultCompression(const ::proton::grpc::Compression & compression)
{
setResultCompression(convertCompressionAlgorithm(compression.algorithm()), convertCompressionLevel(compression.level()));
}
grpc::ServerContext grpc_context;
protected:
CompletionCallback * getCallbackPtr(const CompletionCallback & callback)
{
/// It would be better to pass callbacks to gRPC calls.
/// However gRPC calls can be tagged with `void *` tags only.
/// The map `callbacks` here is used to keep callbacks until they're called.
std::lock_guard lock{mutex};
size_t callback_id = next_callback_id++;
auto & callback_in_map = callbacks[callback_id];
callback_in_map = [this, callback, callback_id](bool ok)
{
CompletionCallback callback_to_call;
{
std::lock_guard lock2{mutex};
callback_to_call = callback;
callbacks.erase(callback_id);
}
callback_to_call(ok);
};
return &callback_in_map;
}
private:
grpc::ServerAsyncReaderWriter<GRPCResult, GRPCQueryInfo> reader_writer{&grpc_context};
std::unordered_map<size_t, CompletionCallback> callbacks;
size_t next_callback_id = 0;
std::mutex mutex;
};
enum CallType
{
CALL_SIMPLE, /// ExecuteQuery() call
CALL_WITH_STREAM_INPUT, /// ExecuteQueryWithStreamInput() call
CALL_WITH_STREAM_OUTPUT, /// ExecuteQueryWithStreamOutput() call
CALL_WITH_STREAM_IO, /// ExecuteQueryWithStreamIO() call
CALL_MAX,
};
const char * getCallName(CallType call_type)
{
switch (call_type)
{
case CALL_SIMPLE: return "ExecuteQuery()";
case CALL_WITH_STREAM_INPUT: return "ExecuteQueryWithStreamInput()";
case CALL_WITH_STREAM_OUTPUT: return "ExecuteQueryWithStreamOutput()";
case CALL_WITH_STREAM_IO: return "ExecuteQueryWithStreamIO()";
case CALL_MAX: break;
}
__builtin_unreachable();
}
bool isInputStreaming(CallType call_type)
{
return (call_type == CALL_WITH_STREAM_INPUT) || (call_type == CALL_WITH_STREAM_IO);
}
bool isOutputStreaming(CallType call_type)
{
return (call_type == CALL_WITH_STREAM_OUTPUT) || (call_type == CALL_WITH_STREAM_IO);
}
template <enum CallType call_type>
class Responder;
template<>
class Responder<CALL_SIMPLE> : public BaseResponder
{
public:
void start(GRPCService & grpc_service,
grpc::ServerCompletionQueue & new_call_queue,
grpc::ServerCompletionQueue & notification_queue,
const CompletionCallback & callback) override
{
grpc_service.RequestExecuteQuery(&grpc_context, &query_info.emplace(), &response_writer, &new_call_queue, ¬ification_queue, getCallbackPtr(callback));
}
void read(GRPCQueryInfo & query_info_, const CompletionCallback & callback) override
{
if (!query_info.has_value())
callback(false);
query_info_ = std::move(query_info).value();
query_info.reset();
callback(true);
}
void write(const GRPCResult &, const CompletionCallback &) override
{
throw Exception("Responder<CALL_SIMPLE>::write() should not be called", ErrorCodes::LOGICAL_ERROR);
}
void writeAndFinish(const GRPCResult & result, const grpc::Status & status, const CompletionCallback & callback) override
{
response_writer.Finish(result, status, getCallbackPtr(callback));
}
private:
grpc::ServerAsyncResponseWriter<GRPCResult> response_writer{&grpc_context};
std::optional<GRPCQueryInfo> query_info;
};
template<>
class Responder<CALL_WITH_STREAM_INPUT> : public BaseResponder
{
public:
void start(GRPCService & grpc_service,
grpc::ServerCompletionQueue & new_call_queue,
grpc::ServerCompletionQueue & notification_queue,
const CompletionCallback & callback) override
{
grpc_service.RequestExecuteQueryWithStreamInput(&grpc_context, &reader, &new_call_queue, ¬ification_queue, getCallbackPtr(callback));
}
void read(GRPCQueryInfo & query_info_, const CompletionCallback & callback) override
{
reader.Read(&query_info_, getCallbackPtr(callback));
}
void write(const GRPCResult &, const CompletionCallback &) override
{
throw Exception("Responder<CALL_WITH_STREAM_INPUT>::write() should not be called", ErrorCodes::LOGICAL_ERROR);
}
void writeAndFinish(const GRPCResult & result, const grpc::Status & status, const CompletionCallback & callback) override
{
reader.Finish(result, status, getCallbackPtr(callback));
}
private:
grpc::ServerAsyncReader<GRPCResult, GRPCQueryInfo> reader{&grpc_context};
};
template<>
class Responder<CALL_WITH_STREAM_OUTPUT> : public BaseResponder
{
public:
void start(GRPCService & grpc_service,
grpc::ServerCompletionQueue & new_call_queue,
grpc::ServerCompletionQueue & notification_queue,
const CompletionCallback & callback) override
{
grpc_service.RequestExecuteQueryWithStreamOutput(&grpc_context, &query_info.emplace(), &writer, &new_call_queue, ¬ification_queue, getCallbackPtr(callback));
}
void read(GRPCQueryInfo & query_info_, const CompletionCallback & callback) override
{
if (!query_info.has_value())
callback(false);
query_info_ = std::move(query_info).value();
query_info.reset();
callback(true);
}
void write(const GRPCResult & result, const CompletionCallback & callback) override
{
writer.Write(result, getCallbackPtr(callback));
}
void writeAndFinish(const GRPCResult & result, const grpc::Status & status, const CompletionCallback & callback) override
{
writer.WriteAndFinish(result, {}, status, getCallbackPtr(callback));
}
private:
grpc::ServerAsyncWriter<GRPCResult> writer{&grpc_context};
std::optional<GRPCQueryInfo> query_info;
};
template<>
class Responder<CALL_WITH_STREAM_IO> : public BaseResponder
{
public:
void start(GRPCService & grpc_service,
grpc::ServerCompletionQueue & new_call_queue,
grpc::ServerCompletionQueue & notification_queue,
const CompletionCallback & callback) override
{
grpc_service.RequestExecuteQueryWithStreamIO(&grpc_context, &reader_writer, &new_call_queue, ¬ification_queue, getCallbackPtr(callback));
}
void read(GRPCQueryInfo & query_info_, const CompletionCallback & callback) override
{
reader_writer.Read(&query_info_, getCallbackPtr(callback));
}
void write(const GRPCResult & result, const CompletionCallback & callback) override
{
reader_writer.Write(result, getCallbackPtr(callback));
}
void writeAndFinish(const GRPCResult & result, const grpc::Status & status, const CompletionCallback & callback) override
{
reader_writer.WriteAndFinish(result, {}, status, getCallbackPtr(callback));
}
private:
grpc::ServerAsyncReaderWriter<GRPCResult, GRPCQueryInfo> reader_writer{&grpc_context};
};
std::unique_ptr<BaseResponder> makeResponder(CallType call_type)
{
switch (call_type)
{
case CALL_SIMPLE: return std::make_unique<Responder<CALL_SIMPLE>>();
case CALL_WITH_STREAM_INPUT: return std::make_unique<Responder<CALL_WITH_STREAM_INPUT>>();
case CALL_WITH_STREAM_OUTPUT: return std::make_unique<Responder<CALL_WITH_STREAM_OUTPUT>>();
case CALL_WITH_STREAM_IO: return std::make_unique<Responder<CALL_WITH_STREAM_IO>>();
case CALL_MAX: break;
}
__builtin_unreachable();
}
/// Implementation of ReadBuffer, which just calls a callback.
class ReadBufferFromCallback : public ReadBuffer
{
public:
explicit ReadBufferFromCallback(const std::function<std::pair<const void *, size_t>(void)> & callback_)
: ReadBuffer(nullptr, 0), callback(callback_) {}
private:
bool nextImpl() override
{
const void * new_pos;
size_t new_size;
std::tie(new_pos, new_size) = callback();
if (!new_size)
return false;
BufferBase::set(static_cast<BufferBase::Position>(const_cast<void *>(new_pos)), new_size, 0);
return true;
}
std::function<std::pair<const void *, size_t>(void)> callback;
};
/// A boolean state protected by mutex able to wait until other thread sets it to a specific value.
class BoolState
{
public:
explicit BoolState(bool initial_value) : value(initial_value) {}
bool get() const
{
std::lock_guard lock{mutex};
return value;
}
void set(bool new_value)
{
std::lock_guard lock{mutex};
if (value == new_value)
return;
value = new_value;
changed.notify_all();
}
void wait(bool wanted_value) const
{
std::unique_lock lock{mutex};
changed.wait(lock, [this, wanted_value]() { return value == wanted_value; });
}
private:
bool value;
mutable std::mutex mutex;
mutable std::condition_variable changed;
};
/// Handles a connection after a responder is started (i.e. after getting a new call).
class Call
{
public:
Call(CallType call_type_, std::unique_ptr<BaseResponder> responder_, IServer & iserver_, Poco::Logger * log_);
~Call();
void start(const std::function<void(void)> & on_finish_call_callback);
private:
void run();
void receiveQuery();
void executeQuery();
void processInput();
void initializeBlockInputStream(const Block & header);
void createExternalTables();
void generateOutput();
void finishQuery();
void onException(const Exception & exception);
[[maybe_unused]] void onFatalError();
void releaseQueryIDAndSessionID();
void close();
void readQueryInfo();
void throwIfFailedToReadQueryInfo();
bool isQueryCancelled();
void addProgressToResult();
void addTotalsToResult(const Block & totals);
void addExtremesToResult(const Block & extremes);
void addProfileInfoToResult(const ProfileInfo & info);
void addLogsToResult();
void sendResult();
void throwIfFailedToSendResult();
void sendException(const Exception & exception);
/// proton: starts.
void addQueryIdToResult()
{
result.set_query_id(query_context->getCurrentQueryId());
}
/// proton: ends.
const CallType call_type;
std::unique_ptr<BaseResponder> responder;
IServer & iserver;
Poco::Logger * log = nullptr;
std::optional<Session> session;
ContextMutablePtr query_context;
std::optional<CurrentThread::QueryScope> query_scope;
String query_text;
ASTPtr ast;
ASTInsertQuery * insert_query = nullptr;
String input_format;
String input_data_delimiter;
PODArray<char> output;
String output_format;
CompressionMethod compression_method = CompressionMethod::None;
int compression_level = 0;
uint64_t interactive_delay = 100000;
bool send_exception_with_stacktrace = true;
bool input_function_is_used = false;
BlockIO io;
Progress progress;
InternalTextLogsQueuePtr logs_queue;
GRPCQueryInfo query_info; /// We reuse the same messages multiple times.
GRPCResult result;
bool initial_query_info_read = false;
bool finalize = false;
bool responder_finished = false;
bool cancelled = false;
std::unique_ptr<ReadBuffer> read_buffer;
std::unique_ptr<WriteBuffer> write_buffer;
WriteBufferFromVector<PODArray<char>> * nested_write_buffer = nullptr;
WriteBuffer * compressing_write_buffer = nullptr;
std::unique_ptr<QueryPipeline> pipeline;
std::unique_ptr<PullingPipelineExecutor> pipeline_executor;
std::shared_ptr<IOutputFormat> output_format_processor;
bool need_input_data_from_insert_query = true;
bool need_input_data_from_query_info = true;
bool need_input_data_delimiter = false;
Stopwatch query_time;
UInt64 waited_for_client_reading = 0;
UInt64 waited_for_client_writing = 0;
/// The following fields are accessed both from call_thread and queue_thread.
BoolState reading_query_info{false};
std::atomic<bool> failed_to_read_query_info = false;
GRPCQueryInfo next_query_info_while_reading;
std::atomic<bool> want_to_cancel = false;
std::atomic<bool> check_query_info_contains_cancel_only = false;
BoolState sending_result{false};
std::atomic<bool> failed_to_send_result = false;
ThreadFromGlobalPool call_thread;
};
Call::Call(CallType call_type_, std::unique_ptr<BaseResponder> responder_, IServer & iserver_, Poco::Logger * log_)
: call_type(call_type_), responder(std::move(responder_)), iserver(iserver_), log(log_)
{
}
Call::~Call()
{
if (call_thread.joinable())
call_thread.join();
}
void Call::start(const std::function<void(void)> & on_finish_call_callback)
{
auto runner_function = [this, on_finish_call_callback]
{
try
{
run();
}
catch (...)
{
tryLogCurrentException("GRPCServer");
}
on_finish_call_callback();
};
call_thread = ThreadFromGlobalPool(runner_function);
}
void Call::run()
{
try
{
setThreadName("GRPCServerCall");
receiveQuery();
executeQuery();
processInput();
generateOutput();
finishQuery();
}
catch (Exception & exception)
{
onException(exception);
}
catch (Poco::Exception & exception)
{
onException(Exception{Exception::CreateFromPocoTag{}, exception});
}
catch (std::exception & exception)
{
onException(Exception{Exception::CreateFromSTDTag{}, exception});
}
}
void Call::receiveQuery()
{
LOG_INFO(log, "Handling call {}", getCallName(call_type));
readQueryInfo();
if (query_info.cancel())
throw Exception("Initial query info cannot set the 'cancel' field", ErrorCodes::INVALID_GRPC_QUERY_INFO);
LOG_DEBUG(log, "Received initial QueryInfo: {}", getQueryDescription(query_info));
}
void Call::executeQuery()
{
/// Retrieve user credentials.
std::string user = query_info.user_name();
std::string password = query_info.password();
std::string quota_key = query_info.quota();
Poco::Net::SocketAddress user_address = responder->getClientAddress();
if (user.empty())
{
user = "default";
password = "";
}
/// Authentication.
session.emplace(iserver.context(), ClientInfo::Interface::GRPC);
session->authenticate(user, password, user_address);
session->getClientInfo().quota_key = quota_key;
// Parse the OpenTelemetry traceparent header.
ClientInfo client_info = session->getClientInfo();
const auto & client_metadata = responder->grpc_context.client_metadata();
auto traceparent = client_metadata.find("traceparent");
if (traceparent != client_metadata.end())
{
grpc::string_ref parent_ref = traceparent->second;
std::string opentelemetry_traceparent(parent_ref.data(), parent_ref.length());
std::string error;
if (!client_info.client_trace_context.parseTraceparentHeader(
opentelemetry_traceparent, error))
{
throw Exception(ErrorCodes::BAD_REQUEST_PARAMETER,
"Failed to parse OpenTelemetry traceparent header '{}': {}",
opentelemetry_traceparent, error);
}
auto tracestate = client_metadata.find("tracestate");
if (tracestate != client_metadata.end())
{
grpc::string_ref state_ref = tracestate->second;
client_info.client_trace_context.tracestate =
std::string(state_ref.data(), state_ref.length());
}
else
{
client_info.client_trace_context.tracestate = "";
}
}
/// The user could specify session identifier and session timeout.
/// It allows to modify settings, create temporary tables and reuse them in subsequent requests.
if (!query_info.session_id().empty())
{
session->makeSessionContext(
query_info.session_id(), getSessionTimeout(query_info, iserver.config()), query_info.session_check());
}
query_context = session->makeQueryContext(std::move(client_info));
/// Prepare settings.
SettingsChanges settings_changes;
for (const auto & [key, value] : query_info.settings())
{
settings_changes.push_back({key, value});
}
query_context->checkSettingsConstraints(settings_changes);
query_context->applySettingsChanges(settings_changes);
query_context->setCurrentQueryId(query_info.query_id());
/// proton: starts. Disable send_logs_level
query_scope.emplace(query_context);
/// [this]{ onFatalError(); });
/// proton: ends.
/// Prepare for sending exceptions and logs.
const Settings & settings = query_context->getSettingsRef();
send_exception_with_stacktrace = settings.calculate_text_stack_trace;
/// proton: starts. Disable send_logs_level
// const auto client_logs_level = settings.send_logs_level;
// if (client_logs_level != LogsLevel::none)
// {
// logs_queue = std::make_shared<InternalTextLogsQueue>();
// logs_queue->max_priority = Poco::Logger::parseLevel(client_logs_level.toString());
// CurrentThread::attachInternalTextLogsQueue(logs_queue, client_logs_level);
// }
/// proton: ends.
/// Set the current database if specified.
if (!query_info.database().empty())
query_context->setCurrentDatabase(query_info.database());
/// Apply compression settings for this call.
if (query_info.has_result_compression())
responder->setResultCompression(query_info.result_compression());
/// The interactive delay will be used to show progress.
interactive_delay = settings.interactive_delay;
query_context->setProgressCallback([this](const Progress & value) { return progress.incrementPiecewiseAtomically(value); });
/// Parse the query.
query_text = std::move(*(query_info.mutable_query()));
const char * begin = query_text.data();
const char * end = begin + query_text.size();
ParserQuery parser(end);
ast = parseQuery(parser, begin, end, "", settings.max_query_size, settings.max_parser_depth);
/// Choose input format.
insert_query = ast->as<ASTInsertQuery>();
if (insert_query)
{
input_format = insert_query->format;
if (input_format.empty())
input_format = "Values";
}
input_data_delimiter = query_info.input_data_delimiter();
/// Choose output format.
query_context->setDefaultFormat(query_info.output_format());
if (const auto * ast_query_with_output = dynamic_cast<const ASTQueryWithOutput *>(ast.get());
ast_query_with_output && ast_query_with_output->format)
{
output_format = getIdentifierName(ast_query_with_output->format);
}
if (output_format.empty())
output_format = query_context->getDefaultFormat();
/// Choose compression.
compression_method = chooseCompressionMethod("", query_info.compression_type());
compression_level = query_info.compression_level();
/// Set callback to create and fill external tables
query_context->setExternalTablesInitializer([this] (ContextPtr context)
{
if (context != query_context)
throw Exception("Unexpected context in external tables initializer", ErrorCodes::LOGICAL_ERROR);
createExternalTables();
});
/// Set callbacks to execute function input().
query_context->setInputInitializer([this] (ContextPtr context, const StoragePtr & input_storage)
{
if (context != query_context)
throw Exception("Unexpected context in Input initializer", ErrorCodes::LOGICAL_ERROR);
input_function_is_used = true;
initializeBlockInputStream(input_storage->getInMemoryMetadataPtr()->getSampleBlock());
});
query_context->setInputBlocksReaderCallback([this](ContextPtr context) -> Block
{
if (context != query_context)
throw Exception("Unexpected context in InputBlocksReader", ErrorCodes::LOGICAL_ERROR);
Block block;
while (!block && pipeline_executor->pull(block));
return block;
});
/// Start executing the query.
const auto * query_end = end;
if (insert_query && insert_query->data)
{
query_end = insert_query->data;
}
String query(begin, query_end);
io = ::DB::executeQuery(true, query, query_context);
}
void Call::processInput()
{
if (!io.pipeline.pushing())
return;
bool has_data_to_insert = (insert_query && insert_query->data)
|| !query_info.input_data().empty() || query_info.next_query_info();
if (!has_data_to_insert)
{
if (!insert_query)
throw Exception("Query requires data to insert, but it is not an INSERT query", ErrorCodes::NO_DATA_TO_INSERT);
else
throw Exception("No data to insert", ErrorCodes::NO_DATA_TO_INSERT);
}
/// This is significant, because parallel parsing may be used.
/// So we mustn't touch the input stream from other thread.
initializeBlockInputStream(io.pipeline.getHeader());
PushingPipelineExecutor executor(io.pipeline);
executor.start();
Block block;
while (pipeline_executor->pull(block))
{
if (block)
executor.push(block);
}
executor.finish();
}
void Call::initializeBlockInputStream(const Block & header)
{
assert(!read_buffer);
read_buffer = std::make_unique<ReadBufferFromCallback>([this]() -> std::pair<const void *, size_t>
{
if (need_input_data_from_insert_query)
{
need_input_data_from_insert_query = false;
if (insert_query && insert_query->data && (insert_query->data != insert_query->end))
{
need_input_data_delimiter = !input_data_delimiter.empty();
return {insert_query->data, insert_query->end - insert_query->data};
}
}
while (true)
{
if (need_input_data_from_query_info)
{
if (need_input_data_delimiter && !query_info.input_data().empty())
{
need_input_data_delimiter = false;
return {input_data_delimiter.data(), input_data_delimiter.size()};
}
need_input_data_from_query_info = false;
if (!query_info.input_data().empty())
{
need_input_data_delimiter = !input_data_delimiter.empty();
return {query_info.input_data().data(), query_info.input_data().size()};
}
}
if (!query_info.next_query_info())
break;
if (!isInputStreaming(call_type))
throw Exception("next_query_info is allowed to be set only for streaming input", ErrorCodes::INVALID_GRPC_QUERY_INFO);
readQueryInfo();
if (!query_info.query().empty() || !query_info.query_id().empty() || !query_info.settings().empty()
|| !query_info.database().empty() || !query_info.input_data_delimiter().empty() || !query_info.output_format().empty()
|| query_info.external_tables_size() || !query_info.user_name().empty() || !query_info.password().empty()
|| !query_info.quota().empty() || !query_info.session_id().empty())
{
throw Exception("Extra query infos can be used only to add more input data. "
"Only the following fields can be set: input_data, next_query_info, cancel",
ErrorCodes::INVALID_GRPC_QUERY_INFO);
}
if (isQueryCancelled())
break;
LOG_DEBUG(log, "Received extra QueryInfo: input_data: {} bytes", query_info.input_data().size());