src/util/service_new.c

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2016 GNUnet e.V.
   4
   5      GNUnet is free software; you can redistribute it and/or modify
   6      it under the terms of the GNU General Public License as published
   7      by the Free Software Foundation; either version 3, or (at your
   8      option) any later version.
   9
  10      GNUnet is distributed in the hope that it will be useful, but
  11      WITHOUT ANY WARRANTY; without even the implied warranty of
  12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13      General Public License for more details.
  14
  15      You should have received a copy of the GNU General Public License
  16      along with GNUnet; see the file COPYING.  If not, write to the
  17      Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  18      Boston, MA 02110-1301, USA.
  19 */
  20
  21 /**
  22  * @file util/service_new.c
  23  * @brief functions related to starting services (redesign)
  24  * @author Christian Grothoff
  25  */
  26 #include "platform.h"
  27 #include "gnunet_util_lib.h"
  28 #include "gnunet_protocols.h"
  29 #include "gnunet_constants.h"
  30 #include "gnunet_resolver_service.h"
  31
  32
  33 /**
  34  * Information the service tracks per listen operation.
  35  */
  36 struct ServiceListenContext
  37 {
  38
  39   /**
  40    * Kept in a DLL.
  41    */
  42   struct ServiceListenContext *next;
  43
  44   /**
  45    * Kept in a DLL.
  46    */
  47   struct ServiceListenContext *prev;
  48
  49   /**
  50    * Service this listen context belongs to.
  51    */
  52   struct GNUNET_SERVICE_Handle *sh;
  53
  54   /**
  55    * Socket we are listening on.
  56    */
  57   struct GNUNET_NETWORK_Handle *listen_socket;
  58
  59   /**
  60    * Task scheduled to do the listening.
  61    */
  62   struct GNUNET_SCHEDULER_Task *listen_task;
  63
  64 };
  65
  66
  67 /**
  68  * Handle to a service.
  69  */
  70 struct GNUNET_SERVICE_Handle
  71 {
  72   /**
  73    * Our configuration.
  74    */
  75   const struct GNUNET_CONFIGURATION_Handle *cfg;
  76
  77   /**
  78    * Name of our service.
  79    */
  80   const char *service_name;
  81
  82   /**
  83    * Main service-specific task to run.
  84    */
  85   GNUNET_SERVICE_InitCallback service_init_cb;
  86
  87   /**
  88    * Function to call when clients connect.
  89    */
  90   GNUNET_SERVICE_ConnectHandler connect_cb;
  91
  92   /**
  93    * Function to call when clients disconnect / are disconnected.
  94    */
  95   GNUNET_SERVICE_DisconnectHandler disconnect_cb;
  96
  97   /**
  98    * Closure for @e service_init_cb, @e connect_cb, @e disconnect_cb.
  99    */
 100   void *cb_cls;
 101
 102   /**
 103    * DLL of listen sockets used to accept new connections.
 104    */
 105   struct ServiceListenContext *slc_head;
 106
 107   /**
 108    * DLL of listen sockets used to accept new connections.
 109    */
 110   struct ServiceListenContext *slc_tail;
 111
 112   /**
 113    * Our clients, kept in a DLL.
 114    */
 115   struct GNUNET_SERVICE_Client *clients_head;
 116
 117   /**
 118    * Our clients, kept in a DLL.
 119    */
 120   struct GNUNET_SERVICE_Client *clients_tail;
 121
 122   /**
 123    * Message handlers to use for all clients.
 124    */
 125   const struct GNUNET_MQ_MessageHandler *handlers;
 126
 127   /**
 128    * Closure for @e task.
 129    */
 130   void *task_cls;
 131
 132   /**
 133    * IPv4 addresses that are not allowed to connect.
 134    */
 135   struct GNUNET_STRINGS_IPv4NetworkPolicy *v4_denied;
 136
 137   /**
 138    * IPv6 addresses that are not allowed to connect.
 139    */
 140   struct GNUNET_STRINGS_IPv6NetworkPolicy *v6_denied;
 141
 142   /**
 143    * IPv4 addresses that are allowed to connect (if not
 144    * set, all are allowed).
 145    */
 146   struct GNUNET_STRINGS_IPv4NetworkPolicy *v4_allowed;
 147
 148   /**
 149    * IPv6 addresses that are allowed to connect (if not
 150    * set, all are allowed).
 151    */
 152   struct GNUNET_STRINGS_IPv6NetworkPolicy *v6_allowed;
 153
 154   /**
 155    * Do we require a matching UID for UNIX domain socket connections?
 156    * #GNUNET_NO means that the UID does not have to match (however,
 157    * @e match_gid may still impose other access control checks).
 158    */
 159   int match_uid;
 160
 161   /**
 162    * Do we require a matching GID for UNIX domain socket connections?
 163    * Ignored if @e match_uid is #GNUNET_YES.  Note that this is about
 164    * checking that the client's UID is in our group OR that the
 165    * client's GID is our GID.  If both "match_gid" and @e match_uid are
 166    * #GNUNET_NO, all users on the local system have access.
 167    */
 168   int match_gid;
 169
 170   /**
 171    * Set to #GNUNET_YES if we got a shutdown signal and terminate
 172    * the service if #have_non_monitor_clients() returns #GNUNET_YES.
 173    */
 174   int got_shutdown;
 175
 176   /**
 177    * Our options.
 178    */
 179   enum GNUNET_SERVICE_Options options;
 180
 181 };
 182
 183
 184 /**
 185  * Handle to a client that is connected to a service.
 186  */
 187 struct GNUNET_SERVICE_Client
 188 {
 189
 190   /**
 191    * Kept in a DLL.
 192    */
 193   struct GNUNET_SERVICE_Client *next;
 194
 195   /**
 196    * Kept in a DLL.
 197    */
 198   struct GNUNET_SERVICE_Client *prev;
 199
 200   /**
 201    * Server that this client belongs to.
 202    */
 203   struct GNUNET_SERVER_Handle *server;
 204
 205   /**
 206    * Task that warns about missing calls to
 207    * #GNUNET_SERVICE_client_continue().
 208    */
 209   struct GNUNET_SCHEDULER_Task *warn_task;
 210
 211   /**
 212    * User context value, value returned from
 213    * the connect callback.
 214    */
 215   void *user_context;
 216
 217   /**
 218    * Persist the file handle for this client no matter what happens,
 219    * force the OS to close once the process actually dies.  Should only
 220    * be used in special cases!
 221    */
 222   int persist;
 223
 224   /**
 225    * Is this client a 'monitor' client that should not be counted
 226    * when deciding on destroying the server during soft shutdown?
 227    * (see also #GNUNET_SERVICE_start)
 228    */
 229   int is_monitor;
 230
 231   /**
 232    * Type of last message processed (for warn_no_receive_done).
 233    */
 234   uint16_t warn_type;
 235 };
 236
 237
 238 /**
 239  * Check if any of the clients we have left are unrelated to
 240  * monitoring.
 241  *
 242  * @param sh service to check clients for
 243  * @return #GNUNET_YES if we have non-monitoring clients left
 244  */
 245 static int
 246 have_non_monitor_clients (struct GNUNET_SERVICE_Handle *sh)
 247 {
 248   struct GNUNET_SERVICE_Client *client;
 249
 250   for (client = sh->clients_head;NULL != client; client = client->next)
 251   {
 252     if (client->is_monitor)
 253       continue;
 254     return GNUNET_YES;
 255   }
 256   return GNUNET_NO;
 257 }
 258
 259
 260 /**
 261  * Shutdown task triggered when a service should be terminated.
 262  * This considers active clients and the service options to see
 263  * how this specific service is to be terminated, and depending
 264  * on this proceeds with the shutdown logic.
 265  *
 266  * @param cls our `struct GNUNET_SERVICE_Handle`
 267  */
 268 static void
 269 service_main (void *cls)
 270 {
 271   struct GNUNET_SERVICE_Handle *sh = cls;
 272   struct GNUNET_SERVICE_Client *client;
 273   int alive;
 274
 275   switch (sh->options)
 276   {
 277   case GNUNET_SERVICE_OPTION_NONE:
 278     GNUNET_SERVICE_shutdown (sh);
 279     break;
 280   case GNUNET_SERVICE_OPTION_MANUAL_SHUTDOWN:
 281     /* This task should never be run if we are using
 282        the manual shutdown. */
 283     GNUNET_assert (0);
 284     break;
 285   case GNUNET_SERVICE_OPTION_SOFT_SHUTDOWN:
 286     sh->got_shutdown = GNUNET_YES;
 287     GNUNET_SERVICE_suspend (sh);
 288     if (GNUNET_NO == have_non_monitor_clients (sh))
 289       GNUNET_SERVICE_shutdown (sh);
 290     break;
 291   }
 292 }
 293
 294
 295 /**
 296  * First task run by any service.  Initializes our shutdown task,
 297  * starts the listening operation on our listen sockets and launches
 298  * the custom logic of the application service.
 299  *
 300  * @param cls our `struct GNUNET_SERVICE_Handle`
 301  */
 302 static void
 303 service_main (void *cls)
 304 {
 305   struct GNUNET_SERVICE_Handle *sh = cls;
 306
 307   if (GNUNET_SERVICE_OPTION_MANUAL_SHUTDOWN != sh->options)
 308     GNUNET_SCHEDULER_add_shutdown (&service_shutdown,
 309                                    sh);
 310   GNUNET_SERVICE_resume (sh);
 311   sh->service_init_cb (sh->cb_cls,
 312                        sh->cfg,
 313                        sh);
 314 }
 315
 316
 317 /**
 318  * Creates the "main" function for a GNUnet service.  You
 319  * should almost always use the #GNUNET_SERVICE_MAIN macro
 320  * instead of calling this function directly (except
 321  * for ARM, which should call this function directly).
 322  *
 323  * The function will launch the service with the name @a service_name
 324  * using the @a service_options to configure its shutdown
 325  * behavior. Once the service is ready, the @a init_cb will be called
 326  * for service-specific initialization.  @a init_cb will be given the
 327  * service handler which can be used to control the service's
 328  * availability.  When clients connect or disconnect, the respective
 329  * @a connect_cb or @a disconnect_cb functions will be called. For
 330  * messages received from the clients, the respective @a handlers will
 331  * be invoked; for the closure of the handlers we use the return value
 332  * from the @a connect_cb invocation of the respective client.
 333  *
 334  * Each handler MUST call #GNUNET_SERVICE_client_continue() after each
 335  * message to receive further messages from this client.  If
 336  * #GNUNET_SERVICE_client_continue() is not called within a short
 337  * time, a warning will be logged. If delays are expected, services
 338  * should call #GNUNET_SERVICE_client_disable_continue_warning() to
 339  * disable the warning.
 340  *
 341  * Clients sending invalid messages (based on @a handlers) will be
 342  * dropped. Additionally, clients can be dropped at any time using
 343  * #GNUNET_SERVICE_client_drop().
 344  *
 345  * @param argc number of command-line arguments in @a argv
 346  * @param argv array of command-line arguments
 347  * @param service_name name of the service to run
 348  * @param options options controlling shutdown of the service
 349  * @param service_init_cb function to call once the service is ready
 350  * @param connect_cb function to call whenever a client connects
 351  * @param disconnect_cb function to call whenever a client disconnects
 352  * @param cls closure argument for @a service_init_cb, @a connect_cb and @a disconnect_cb
 353  * @param handlers NULL-terminated array of message handlers for the service,
 354  *                 the closure will be set to the value returned by
 355  *                 the @a connect_cb for the respective connection
 356  * @return 0 on success, non-zero on error
 357  */
 358 int
 359 GNUNET_SERVICE_ruN_ (int argc,
 360                      char *const *argv,
 361                      const char *service_name,
 362                      enum GNUNET_SERVICE_Options options,
 363                      GNUNET_SERVICE_InitCallback service_init_cb,
 364                      GNUNET_SERVICE_ConnectHandler connect_cb,
 365                      GNUNET_SERVICE_DisconnectHandler disconnect_cb,
 366                      void *cls,
 367                      const struct GNUNET_MQ_MessageHandler *handlers)
 368 {
 369   struct GNUNET_SERVICE_Handle sh;
 370
 371   // FIXME: setup (parse command line, configuration, init sh)
 372   GNUNET_SCHEDULER_run (&service_main,
 373                         &sh);
 374   // FIXME: cleanup
 375   return 1;
 376 }
 377
 378
 379 /**
 380  * Suspend accepting connections from the listen socket temporarily.
 381  * Resume activity using #GNUNET_SERVICE_resume.
 382  *
 383  * @param sh service to stop accepting connections.
 384  */
 385 void
 386 GNUNET_SERVICE_suspend (struct GNUNET_SERVICE_Handle *sh)
 387 {
 388   struct ServiceListenContext *slc;
 389
 390   for (slc = slc_head; NULL != slc; slc = slc->next)
 391   {
 392     if (NULL != slc->listen_task)
 393       {
 394         GNUNET_SCHEDULER_cancel (slc->listen_task);
 395         slc->listen_task = NULL;
 396       }
 397   }
 398 }
 399
 400
 401 /**
 402  * We have a client. Accept the incoming socket(s) (and reschedule
 403  * the listen task).
 404  */
 405 static void
 406 accept_client (void *cls)
 407 {
 408   struct ServiceListenContext *slc = cls;
 409
 410   slc->listen_task = NULL;
 411   // FIXME: accept!
 412   slc->listen_task = GNUNET_SCHEDULER_add_read (slc->listen_socket,
 413                                                 &accept_client,
 414                                                 slc);
 415 }
 416
 417
 418 /**
 419  * Resume accepting connections from the listen socket.
 420  *
 421  * @param sh service to resume accepting connections.
 422  */
 423 void
 424 GNUNET_SERVICE_resume (struct GNUNET_SERVICE_Handle *sh)
 425 {
 426   struct ServiceListenContext *slc;
 427
 428   for (slc = slc_head; NULL != slc; slc = slc->next)
 429   {
 430     GNUNET_assert (NULL == slc->listen_task);
 431     slc->listen_task = GNUNET_SCHEDULER_add_read (slc->listen_socket,
 432                                                   &accept_client,
 433                                                   slc);
 434   }
 435 }
 436
 437
 438 /**
 439  * Continue receiving further messages from the given client.
 440  * Must be called after each message received.
 441  *
 442  * @param c the client to continue receiving from
 443  */
 444 void
 445 GNUNET_SERVICE_client_continue (struct GNUNET_SERVICE_Client *c)
 446 {
 447   GNUNET_break (0); // not implemented
 448 }
 449
 450
 451 /**
 452  * Disable the warning the server issues if a message is not
 453  * acknowledged in a timely fashion.  Use this call if a client is
 454  * intentionally delayed for a while.  Only applies to the current
 455  * message.
 456  *
 457  * @param c client for which to disable the warning
 458  */
 459 void
 460 GNUNET_SERVICE_client_disable_continue_warning (struct GNUNET_SERVICE_Client *c)
 461 {
 462   GNUNET_break (NULL != c->warn_task);
 463   if (NULL != c->warn_task)
 464   {
 465     GNUNET_SCHEDULER_cancel (c->warn_task);
 466     c->warn_task = NULL;
 467   }
 468 }
 469
 470
 471 /**
 472  * Ask the server to disconnect from the given client.  This is the
 473  * same as returning #GNUNET_SYSERR within the check procedure when
 474  * handling a message, wexcept that it allows dropping of a client even
 475  * when not handling a message from that client.  The `disconnect_cb`
 476  * will be called on @a c even if the application closes the connection
 477  * using this function.
 478  *
 479  * @param c client to disconnect now
 480  */
 481 void
 482 GNUNET_SERVICE_client_drop (struct GNUNET_SERVICE_Client *c)
 483 {
 484   struct GNUNET_SERVICE_Handle *sh = c->sh;
 485
 486   GNUNET_CONTAINER_DLL_remove (sh->clients_head,
 487                                sh->clients_tail,
 488                                c);
 489   sh->disconnect_cb (sh->cb_cls,
 490                      c,
 491                      c->user_context);
 492   if (NULL != c->warn_task)
 493   {
 494     GNUNET_SCHEDULER_cancel (c->warn_task);
 495     c->warn_task = NULL;
 496   }
 497   if (GNUNET_NO == c->persist)
 498   {
 499     GNUNET_break (0); // FIXME: close socket, etc.
 500   }
 501   GNUNET_free (c);
 502   if ( (GNUNET_YES == sh->got_shutdown) &&
 503        (GNUNET_NO == have_non_monitor_clients (sh)) )
 504     GNUNET_SERVICE_shutdown (sh);
 505 }
 506
 507
 508 /**
 509  * Explicitly stops the service.
 510  *
 511  * @param sh server to shutdown
 512  */
 513 void
 514 GNUNET_SERVICE_shutdown (struct GNUNET_SERVICE_Handle *sh)
 515 {
 516   struct GNUNET_SERVICE_Client *client;
 517
 518   GNUNET_SERVICE_suspend (sh);
 519   sh->got_shutdown = GNUNET_NO;
 520   while (NULL != (client = sh->clients_head))
 521     GNUNET_SERVICE_client_drop (client);
 522 }
 523
 524
 525 /**
 526  * Set the 'monitor' flag on this client.  Clients which have been
 527  * marked as 'monitors' won't prevent the server from shutting down
 528  * once #GNUNET_SERVICE_stop_listening() has been invoked.  The idea is
 529  * that for "normal" clients we likely want to allow them to process
 530  * their requests; however, monitor-clients are likely to 'never'
 531  * disconnect during shutdown and thus will not be considered when
 532  * determining if the server should continue to exist after
 533  * shutdown has been triggered.
 534  *
 535  * @param c client to mark as a monitor
 536  */
 537 void
 538 GNUNET_SERVICE_client_mark_monitor (struct GNUNET_SERVICE_Client *c)
 539 {
 540   c->is_monitor = GNUNET_YES;
 541   if ( (GNUNET_YES == sh->got_shutdown) &&
 542        (GNUNET_NO == have_non_monitor_clients (sh)) )
 543     GNUNET_SERVICE_shutdown (sh);
 544 }
 545
 546
 547 /**
 548  * Set the persist option on this client.  Indicates that the
 549  * underlying socket or fd should never really be closed.  Used for
 550  * indicating process death.
 551  *
 552  * @param c client to persist the socket (never to be closed)
 553  */
 554 void
 555 GNUNET_SERVICE_client_persist (struct GNUNET_SERVICE_Client *c)
 556 {
 557   c->persist = GNUNET_YES;
 558 }
 559
 560
 561 /* end of service_new.c */