src/grpc.cc

   1 /**
   2  * collectd - src/grpc.cc
   3  * Copyright (C) 2015-2016 Sebastian Harl
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining a
   6  * copy of this software and associated documentation files (the "Software"),
   7  * to deal in the Software without restriction, including without limitation
   8  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   9  * and/or sell copies of the Software, and to permit persons to whom the
  10  * Software is furnished to do so, subject to the following conditions:
  11  *
  12  * The above copyright notice and this permission notice shall be included in
  13  * all copies or substantial portions of the Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  18  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  21  * DEALINGS IN THE SOFTWARE.
  22  *
  23  * Authors:
  24  *   Sebastian Harl <sh at tokkee.org>
  25  **/
  26
  27 #include <grpc++/grpc++.h>
  28 #include <google/protobuf/util/time_util.h>
  29
  30 #include <fstream>
  31 #include <iostream>
  32 #include <vector>
  33
  34 #include "collectd.grpc.pb.h"
  35
  36 extern "C" {
  37 #include <fnmatch.h>
  38 #include <stdbool.h>
  39
  40 #include "collectd.h"
  41 #include "common.h"
  42 #include "configfile.h"
  43 #include "plugin.h"
  44
  45 #include "daemon/utils_cache.h"
  46 }
  47
  48 using collectd::Collectd;
  49
  50 using collectd::DispatchValuesRequest;
  51 using collectd::DispatchValuesReply;
  52 using collectd::QueryValuesRequest;
  53 using collectd::QueryValuesReply;
  54
  55 using google::protobuf::util::TimeUtil;
  56
  57 /*
  58  * private types
  59  */
  60
  61 struct Listener {
  62         grpc::string addr;
  63         grpc::string port;
  64
  65         grpc::SslServerCredentialsOptions *ssl;
  66 };
  67 static std::vector<Listener> listeners;
  68 static grpc::string default_addr("0.0.0.0:50051");
  69
  70 /*
  71  * helper functions
  72  */
  73
  74 static bool ident_matches(const value_list_t *vl, const value_list_t *matcher)
  75 {
  76         if (fnmatch(matcher->host, vl->host, 0))
  77                 return false;
  78
  79         if (fnmatch(matcher->plugin, vl->plugin, 0))
  80                 return false;
  81         if (fnmatch(matcher->plugin_instance, vl->plugin_instance, 0))
  82                 return false;
  83
  84         if (fnmatch(matcher->type, vl->type, 0))
  85                 return false;
  86         if (fnmatch(matcher->type_instance, vl->type_instance, 0))
  87                 return false;
  88
  89         return true;
  90 } /* ident_matches */
  91
  92 static grpc::string read_file(const char *filename)
  93 {
  94         std::ifstream f;
  95         grpc::string s, content;
  96
  97         f.open(filename);
  98         if (!f.is_open()) {
  99                 ERROR("grpc: Failed to open '%s'", filename);
 100                 return "";
 101         }
 102
 103         while (std::getline(f, s)) {
 104                 content += s;
 105                 content.push_back('\n');
 106         }
 107         f.close();
 108         return content;
 109 } /* read_file */
 110
 111 /*
 112  * proto conversion
 113  */
 114
 115 static void marshal_ident(const value_list_t *vl, collectd::types::Identifier *msg)
 116 {
 117         msg->set_host(vl->host);
 118         msg->set_plugin(vl->plugin);
 119         if (vl->plugin_instance[0] != '\0')
 120                 msg->set_plugin_instance(vl->plugin_instance);
 121         msg->set_type(vl->type);
 122         if (vl->type_instance[0] != '\0')
 123                 msg->set_type_instance(vl->type_instance);
 124 } /* marshal_ident */
 125
 126 static grpc::Status unmarshal_ident(const collectd::types::Identifier &msg, value_list_t *vl,
 127                 bool require_fields)
 128 {
 129         std::string s;
 130
 131         s = msg.host();
 132         if (!s.length() && require_fields)
 133                 return grpc::Status(grpc::StatusCode::INVALID_ARGUMENT,
 134                                 grpc::string("missing host name"));
 135         sstrncpy(vl->host, s.c_str(), sizeof(vl->host));
 136
 137         s = msg.plugin();
 138         if (!s.length() && require_fields)
 139                 return grpc::Status(grpc::StatusCode::INVALID_ARGUMENT,
 140                                 grpc::string("missing plugin name"));
 141         sstrncpy(vl->plugin, s.c_str(), sizeof(vl->plugin));
 142
 143         s = msg.type();
 144         if (!s.length() && require_fields)
 145                 return grpc::Status(grpc::StatusCode::INVALID_ARGUMENT,
 146                                 grpc::string("missing type name"));
 147         sstrncpy(vl->type, s.c_str(), sizeof(vl->type));
 148
 149         s = msg.plugin_instance();
 150         sstrncpy(vl->plugin_instance, s.c_str(), sizeof(vl->plugin_instance));
 151
 152         s = msg.type_instance();
 153         sstrncpy(vl->type_instance, s.c_str(), sizeof(vl->type_instance));
 154
 155         return grpc::Status::OK;
 156 } /* unmarshal_ident() */
 157
 158 static grpc::Status marshal_value_list(const value_list_t *vl, collectd::types::ValueList *msg)
 159 {
 160         auto id = msg->mutable_identifier();
 161         marshal_ident(vl, id);
 162
 163         auto ds = plugin_get_ds(vl->type);
 164         if ((ds == NULL) || (ds->ds_num != vl->values_len)) {
 165                 return grpc::Status(grpc::StatusCode::INTERNAL,
 166                                 grpc::string("failed to retrieve data-set for values"));
 167         }
 168
 169         auto t = TimeUtil::NanosecondsToTimestamp(CDTIME_T_TO_NS(vl->time));
 170         auto d = TimeUtil::NanosecondsToDuration(CDTIME_T_TO_NS(vl->interval));
 171         msg->set_allocated_time(new google::protobuf::Timestamp(t));
 172         msg->set_allocated_interval(new google::protobuf::Duration(d));
 173
 174         for (size_t i = 0; i < vl->values_len; ++i) {
 175                 auto v = msg->add_value();
 176                 switch (ds->ds[i].type) {
 177                         case DS_TYPE_COUNTER:
 178                                 v->set_counter(vl->values[i].counter);
 179                                 break;
 180                         case DS_TYPE_GAUGE:
 181                                 v->set_gauge(vl->values[i].gauge);
 182                                 break;
 183                         case DS_TYPE_DERIVE:
 184                                 v->set_derive(vl->values[i].derive);
 185                                 break;
 186                         case DS_TYPE_ABSOLUTE:
 187                                 v->set_absolute(vl->values[i].absolute);
 188                                 break;
 189                         default:
 190                                 return grpc::Status(grpc::StatusCode::INTERNAL,
 191                                                 grpc::string("unknown value type"));
 192                 }
 193         }
 194
 195         return grpc::Status::OK;
 196 } /* marshal_value_list */
 197
 198 static grpc::Status unmarshal_value_list(const collectd::types::ValueList &msg, value_list_t *vl)
 199 {
 200         vl->time = NS_TO_CDTIME_T(TimeUtil::TimestampToNanoseconds(msg.time()));
 201         vl->interval = NS_TO_CDTIME_T(TimeUtil::DurationToNanoseconds(msg.interval()));
 202
 203         auto status = unmarshal_ident(msg.identifier(), vl, true);
 204         if (!status.ok())
 205                 return status;
 206
 207         value_t *values = NULL;
 208         size_t values_len = 0;
 209
 210         status = grpc::Status::OK;
 211         for (auto v : msg.value()) {
 212                 value_t *val = (value_t *)realloc(values, (values_len + 1) * sizeof(*values));
 213                 if (!val) {
 214                         status = grpc::Status(grpc::StatusCode::RESOURCE_EXHAUSTED,
 215                                         grpc::string("failed to allocate values array"));
 216                         break;
 217                 }
 218
 219                 values = val;
 220                 val = values + values_len;
 221                 values_len++;
 222
 223                 switch (v.value_case()) {
 224                 case collectd::types::Value::ValueCase::kCounter:
 225                         val->counter = counter_t(v.counter());
 226                         break;
 227                 case collectd::types::Value::ValueCase::kGauge:
 228                         val->gauge = gauge_t(v.gauge());
 229                         break;
 230                 case collectd::types::Value::ValueCase::kDerive:
 231                         val->derive = derive_t(v.derive());
 232                         break;
 233                 case collectd::types::Value::ValueCase::kAbsolute:
 234                         val->absolute = absolute_t(v.absolute());
 235                         break;
 236                 default:
 237                         status = grpc::Status(grpc::StatusCode::INVALID_ARGUMENT,
 238                                         grpc::string("unknown value type"));
 239                         break;
 240                 }
 241
 242                 if (!status.ok())
 243                         break;
 244         }
 245         if (status.ok()) {
 246                 vl->values = values;
 247                 vl->values_len = values_len;
 248         }
 249         else if (values) {
 250                 free(values);
 251         }
 252
 253         return status;
 254 } /* unmarshal_value_list() */
 255
 256 /*
 257  * request call-backs and call objects
 258  */
 259
 260 static grpc::Status Process(grpc::ServerContext *ctx,
 261                 DispatchValuesRequest request, DispatchValuesReply *reply)
 262 {
 263         value_list_t vl = VALUE_LIST_INIT;
 264         auto status = unmarshal_value_list(request.values(), &vl);
 265         if (!status.ok())
 266                 return status;
 267
 268         if (plugin_dispatch_values(&vl))
 269                 status = grpc::Status(grpc::StatusCode::INTERNAL,
 270                                 grpc::string("failed to enqueue values for writing"));
 271         return status;
 272 } /* Process(): DispatchValues */
 273
 274 static grpc::Status Process(grpc::ServerContext *ctx,
 275                 QueryValuesRequest request, QueryValuesReply *reply)
 276 {
 277         uc_iter_t *iter;
 278         char *name = NULL;
 279
 280         value_list_t matcher;
 281         auto status = unmarshal_ident(request.identifier(), &matcher, false);
 282         if (!status.ok())
 283                 return status;
 284
 285         if ((iter = uc_get_iterator()) == NULL) {
 286                 return grpc::Status(grpc::StatusCode::INTERNAL,
 287                                 grpc::string("failed to query values: cannot create iterator"));
 288         }
 289
 290         status = grpc::Status::OK;
 291         while (uc_iterator_next(iter, &name) == 0) {
 292                 value_list_t res;
 293                 if (parse_identifier_vl(name, &res) != 0) {
 294                         status = grpc::Status(grpc::StatusCode::INTERNAL,
 295                                         grpc::string("failed to parse identifier"));
 296                         break;
 297                 }
 298
 299                 if (!ident_matches(&res, &matcher))
 300                         continue;
 301
 302                 if (uc_iterator_get_time(iter, &res.time) < 0) {
 303                         status = grpc::Status(grpc::StatusCode::INTERNAL,
 304                                         grpc::string("failed to retrieve value timestamp"));
 305                         break;
 306                 }
 307                 if (uc_iterator_get_interval(iter, &res.interval) < 0) {
 308                         status = grpc::Status(grpc::StatusCode::INTERNAL,
 309                                         grpc::string("failed to retrieve value interval"));
 310                         break;
 311                 }
 312                 if (uc_iterator_get_values(iter, &res.values, &res.values_len) < 0) {
 313                         status = grpc::Status(grpc::StatusCode::INTERNAL,
 314                                         grpc::string("failed to retrieve values"));
 315                         break;
 316                 }
 317
 318                 auto vl = reply->add_values();
 319                 status = marshal_value_list(&res, vl);
 320                 free(res.values);
 321                 if (!status.ok())
 322                         break;
 323         }
 324
 325         uc_iterator_destroy(iter);
 326
 327         return status;
 328 } /* Process(): QueryValues */
 329
 330 class Call
 331 {
 332 public:
 333         Call(Collectd::AsyncService *service, grpc::ServerCompletionQueue *cq)
 334                 : service_(service), cq_(cq), status_(CREATE)
 335         { }
 336
 337         virtual ~Call()
 338         { }
 339
 340         void Handle()
 341         {
 342                 if (status_ == CREATE) {
 343                         Create();
 344                         status_ = PROCESS;
 345                 }
 346                 else if (status_ == PROCESS) {
 347                         Process();
 348                         status_ = FINISH;
 349                 }
 350                 else {
 351                         GPR_ASSERT(status_ == FINISH);
 352                         Finish();
 353                 }
 354         } /* Handle() */
 355
 356 protected:
 357         virtual void Create() = 0;
 358         virtual void Process() = 0;
 359         virtual void Finish() = 0;
 360
 361         Collectd::AsyncService *service_;
 362         grpc::ServerCompletionQueue *cq_;
 363         grpc::ServerContext ctx_;
 364
 365 private:
 366         enum CallStatus { CREATE, PROCESS, FINISH };
 367         CallStatus status_;
 368 }; /* class Call */
 369
 370 template<typename RequestT, typename ReplyT>
 371 class RpcCall final : public Call
 372 {
 373         typedef void (Collectd::AsyncService::*CreatorT)(grpc::ServerContext *,
 374                         RequestT *, grpc::ServerAsyncResponseWriter<ReplyT> *,
 375                         grpc::CompletionQueue *, grpc::ServerCompletionQueue *, void *);
 376
 377 public:
 378         RpcCall(Collectd::AsyncService *service,
 379                         CreatorT creator, grpc::ServerCompletionQueue *cq)
 380                 : Call(service, cq), creator_(creator), responder_(&ctx_)
 381         {
 382                 Handle();
 383         } /* RpcCall() */
 384
 385         virtual ~RpcCall()
 386         { }
 387
 388 private:
 389         void Create()
 390         {
 391                 (service_->*creator_)(&ctx_, &request_, &responder_, cq_, cq_, this);
 392         } /* Create() */
 393
 394         void Process()
 395         {
 396                 // Add a new request object to the queue.
 397                 new RpcCall<RequestT, ReplyT>(service_, creator_, cq_);
 398                 grpc::Status status = ::Process(&ctx_, request_, &reply_);
 399                 responder_.Finish(reply_, status, this);
 400         } /* Process() */
 401
 402         void Finish()
 403         {
 404                 delete this;
 405         } /* Finish() */
 406
 407         CreatorT creator_;
 408
 409         RequestT request_;
 410         ReplyT reply_;
 411
 412         grpc::ServerAsyncResponseWriter<ReplyT> responder_;
 413 }; /* class RpcCall */
 414
 415 /*
 416  * gRPC server implementation
 417  */
 418
 419 class CollectdServer final
 420 {
 421 public:
 422         void Start()
 423         {
 424                 auto auth = grpc::InsecureServerCredentials();
 425
 426                 grpc::ServerBuilder builder;
 427
 428                 if (listeners.empty()) {
 429                         builder.AddListeningPort(default_addr, auth);
 430                         INFO("grpc: Listening on %s", default_addr.c_str());
 431                 }
 432                 else {
 433                         for (auto l : listeners) {
 434                                 grpc::string addr = l.addr + ":" + l.port;
 435
 436                                 auto use_ssl = grpc::string("");
 437                                 auto a = auth;
 438                                 if (l.ssl != nullptr) {
 439                                         use_ssl = grpc::string(" (SSL enabled)");
 440                                         a = grpc::SslServerCredentials(*l.ssl);
 441                                 }
 442
 443                                 builder.AddListeningPort(addr, a);
 444                                 INFO("grpc: Listening on %s%s", addr.c_str(), use_ssl.c_str());
 445                         }
 446                 }
 447
 448                 builder.RegisterService(&service_);
 449                 cq_ = builder.AddCompletionQueue();
 450                 server_ = builder.BuildAndStart();
 451         } /* Start() */
 452
 453         void Shutdown()
 454         {
 455                 server_->Shutdown();
 456                 cq_->Shutdown();
 457         } /* Shutdown() */
 458
 459         void Mainloop()
 460         {
 461                 // Register request types.
 462                 new RpcCall<DispatchValuesRequest, DispatchValuesReply>(&service_,
 463                                 &Collectd::AsyncService::RequestDispatchValues, cq_.get());
 464                 new RpcCall<QueryValuesRequest, QueryValuesReply>(&service_,
 465                                 &Collectd::AsyncService::RequestQueryValues, cq_.get());
 466
 467                 while (true) {
 468                         void *req = NULL;
 469                         bool ok = false;
 470
 471                         if (!cq_->Next(&req, &ok))
 472                                 break; // Queue shut down.
 473                         if (!ok) {
 474                                 ERROR("grpc: Failed to read from queue");
 475                                 break;
 476                         }
 477
 478                         static_cast<Call *>(req)->Handle();
 479                 }
 480         } /* Mainloop() */
 481
 482 private:
 483         Collectd::AsyncService service_;
 484
 485         std::unique_ptr<grpc::Server> server_;
 486         std::unique_ptr<grpc::ServerCompletionQueue> cq_;
 487 }; /* class CollectdServer */
 488
 489 static CollectdServer *server = nullptr;
 490
 491 /*
 492  * collectd plugin interface
 493  */
 494
 495 extern "C" {
 496         static pthread_t *workers;
 497         static size_t workers_num = 5;
 498
 499         static void *worker_thread(void *arg)
 500         {
 501                 CollectdServer *s = (CollectdServer *)arg;
 502                 s->Mainloop();
 503                 return NULL;
 504         } /* worker_thread() */
 505
 506         static int c_grpc_config_listen(oconfig_item_t *ci)
 507         {
 508                 if ((ci->values_num != 2)
 509                                 || (ci->values[0].type != OCONFIG_TYPE_STRING)
 510                                 || (ci->values[1].type != OCONFIG_TYPE_STRING)) {
 511                         ERROR("grpc: The `%s` config option needs exactly "
 512                                         "two string argument (address and port).", ci->key);
 513                         return -1;
 514                 }
 515
 516                 auto listener = Listener();
 517                 listener.addr = grpc::string(ci->values[0].value.string);
 518                 listener.port = grpc::string(ci->values[1].value.string);
 519                 listener.ssl = nullptr;
 520
 521                 auto ssl_opts = new(grpc::SslServerCredentialsOptions);
 522                 grpc::SslServerCredentialsOptions::PemKeyCertPair pkcp = {};
 523                 bool use_ssl = false;
 524
 525                 for (int i = 0; i < ci->children_num; i++) {
 526                         oconfig_item_t *child = ci->children + i;
 527
 528                         if (!strcasecmp("EnableSSL", child->key)) {
 529                                 if (cf_util_get_boolean(child, &use_ssl)) {
 530                                         ERROR("grpc: Option `%s` expects a boolean value",
 531                                                         child->key);
 532                                         return -1;
 533                                 }
 534                         }
 535                         else if (!strcasecmp("SSLRootCerts", child->key)) {
 536                                 char *certs = NULL;
 537                                 if (cf_util_get_string(child, &certs)) {
 538                                         ERROR("grpc: Option `%s` expects a string value",
 539                                                         child->key);
 540                                         return -1;
 541                                 }
 542                                 ssl_opts->pem_root_certs = read_file(certs);
 543                         }
 544                         else if (!strcasecmp("SSLServerKey", child->key)) {
 545                                 char *key = NULL;
 546                                 if (cf_util_get_string(child, &key)) {
 547                                         ERROR("grpc: Option `%s` expects a string value",
 548                                                         child->key);
 549                                         return -1;
 550                                 }
 551                                 pkcp.private_key = read_file(key);
 552                         }
 553                         else if (!strcasecmp("SSLServerCert", child->key)) {
 554                                 char *cert = NULL;
 555                                 if (cf_util_get_string(child, &cert)) {
 556                                         ERROR("grpc: Option `%s` expects a string value",
 557                                                         child->key);
 558                                         return -1;
 559                                 }
 560                                 pkcp.cert_chain = read_file(cert);
 561                         }
 562                         else {
 563                                 WARNING("grpc: Option `%s` not allowed in <%s> block.",
 564                                                 child->key, ci->key);
 565                         }
 566                 }
 567
 568                 ssl_opts->pem_key_cert_pairs.push_back(pkcp);
 569                 if (use_ssl)
 570                         listener.ssl = ssl_opts;
 571                 else
 572                         delete(ssl_opts);
 573
 574                 listeners.push_back(listener);
 575                 return 0;
 576         } /* c_grpc_config_listen() */
 577
 578         static int c_grpc_config(oconfig_item_t *ci)
 579         {
 580                 int i;
 581
 582                 for (i = 0; i < ci->children_num; i++) {
 583                         oconfig_item_t *child = ci->children + i;
 584
 585                         if (!strcasecmp("Listen", child->key)) {
 586                                 if (c_grpc_config_listen(child))
 587                                         return -1;
 588                         }
 589                         else if (!strcasecmp("WorkerThreads", child->key)) {
 590                                 int n;
 591                                 if (cf_util_get_int(child, &n))
 592                                         return -1;
 593                                 workers_num = (size_t)n;
 594                         }
 595                         else {
 596                                 WARNING("grpc: Option `%s` not allowed here.", child->key);
 597                         }
 598                 }
 599
 600                 return 0;
 601         } /* c_grpc_config() */
 602
 603         static int c_grpc_init(void)
 604         {
 605                 server = new CollectdServer();
 606                 size_t i;
 607
 608                 if (! server) {
 609                         ERROR("grpc: Failed to create server");
 610                         return -1;
 611                 }
 612
 613                 workers = (pthread_t *)calloc(workers_num, sizeof(*workers));
 614                 if (! workers) {
 615                         delete server;
 616                         server = nullptr;
 617
 618                         ERROR("grpc: Failed to allocate worker threads");
 619                         return -1;
 620                 }
 621
 622                 server->Start();
 623                 for (i = 0; i < workers_num; i++) {
 624                         plugin_thread_create(&workers[i], /* attr = */ NULL,
 625                                         worker_thread, server);
 626                 }
 627                 INFO("grpc: Started %zu workers", workers_num);
 628                 return 0;
 629         } /* c_grpc_init() */
 630
 631         static int c_grpc_shutdown(void)
 632         {
 633                 size_t i;
 634
 635                 if (!server)
 636                         return -1;
 637
 638                 server->Shutdown();
 639
 640                 INFO("grpc: Waiting for %zu workers to terminate", workers_num);
 641                 for (i = 0; i < workers_num; i++)
 642                         pthread_join(workers[i], NULL);
 643                 free(workers);
 644                 workers = NULL;
 645                 workers_num = 0;
 646
 647                 delete server;
 648                 server = nullptr;
 649
 650                 return 0;
 651         } /* c_grpc_shutdown() */
 652
 653         void module_register(void)
 654         {
 655                 plugin_register_complex_config("grpc", c_grpc_config);
 656                 plugin_register_init("grpc", c_grpc_init);
 657                 plugin_register_shutdown("grpc", c_grpc_shutdown);
 658         } /* module_register() */
 659 } /* extern "C" */
 660
 661 /* vim: set sw=4 ts=4 tw=78 noexpandtab : */