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    * Message handlers to use for all clients.
 114    */
 115   struct GNUNET_MQ_MessageHandler *handlers;
 116
 117   /**
 118    * Closure for @e task.
 119    */
 120   void *task_cls;
 121
 122   /**
 123    * IPv4 addresses that are not allowed to connect.
 124    */
 125   struct GNUNET_STRINGS_IPv4NetworkPolicy *v4_denied;
 126
 127   /**
 128    * IPv6 addresses that are not allowed to connect.
 129    */
 130   struct GNUNET_STRINGS_IPv6NetworkPolicy *v6_denied;
 131
 132   /**
 133    * IPv4 addresses that are allowed to connect (if not
 134    * set, all are allowed).
 135    */
 136   struct GNUNET_STRINGS_IPv4NetworkPolicy *v4_allowed;
 137
 138   /**
 139    * IPv6 addresses that are allowed to connect (if not
 140    * set, all are allowed).
 141    */
 142   struct GNUNET_STRINGS_IPv6NetworkPolicy *v6_allowed;
 143
 144   /**
 145    * Do we require a matching UID for UNIX domain socket connections?
 146    * #GNUNET_NO means that the UID does not have to match (however,
 147    * @e match_gid may still impose other access control checks).
 148    */
 149   int match_uid;
 150
 151   /**
 152    * Do we require a matching GID for UNIX domain socket connections?
 153    * Ignored if @e match_uid is #GNUNET_YES.  Note that this is about
 154    * checking that the client's UID is in our group OR that the
 155    * client's GID is our GID.  If both "match_gid" and @e match_uid are
 156    * #GNUNET_NO, all users on the local system have access.
 157    */
 158   int match_gid;
 159
 160   /**
 161    * Our options.
 162    */
 163   enum GNUNET_SERVICE_Options options;
 164
 165 };
 166
 167
 168 /**
 169  * Handle to a client that is connected to a service.
 170  */
 171 struct GNUNET_SERVICE_Client
 172 {
 173
 174   /**
 175    * Server that this client belongs to.
 176    */
 177   struct GNUNET_SERVER_Handle *server;
 178
 179   /**
 180    * Task that warns about missing calls to
 181    * #GNUNET_SERVICE_client_continue().
 182    */
 183   struct GNUNET_SCHEDULER_Task *warn_task;
 184
 185   /**
 186    * User context value, value returned from
 187    * the connect callback.
 188    */
 189   void *user_context;
 190
 191   /**
 192    * Persist the file handle for this client no matter what happens,
 193    * force the OS to close once the process actually dies.  Should only
 194    * be used in special cases!
 195    */
 196   int persist;
 197
 198   /**
 199    * Is this client a 'monitor' client that should not be counted
 200    * when deciding on destroying the server during soft shutdown?
 201    * (see also #GNUNET_SERVICE_start)
 202    */
 203   int is_monitor;
 204
 205   /**
 206    * Type of last message processed (for warn_no_receive_done).
 207    */
 208   uint16_t warn_type;
 209 };
 210
 211
 212 /**
 213  * Creates the "main" function for a GNUnet service.  You
 214  * should almost always use the #GNUNET_SERVICE_MAIN macro
 215  * instead of calling this function directly (except
 216  * for ARM, which should call this function directly).
 217  *
 218  * The function will launch the service with the name @a service_name
 219  * using the @a service_options to configure its shutdown
 220  * behavior. Once the service is ready, the @a init_cb will be called
 221  * for service-specific initialization.  @a init_cb will be given the
 222  * service handler which can be used to control the service's
 223  * availability.  When clients connect or disconnect, the respective
 224  * @a connect_cb or @a disconnect_cb functions will be called. For
 225  * messages received from the clients, the respective @a handlers will
 226  * be invoked; for the closure of the handlers we use the return value
 227  * from the @a connect_cb invocation of the respective client.
 228  *
 229  * Each handler MUST call #GNUNET_SERVICE_client_continue() after each
 230  * message to receive further messages from this client.  If
 231  * #GNUNET_SERVICE_client_continue() is not called within a short
 232  * time, a warning will be logged. If delays are expected, services
 233  * should call #GNUNET_SERVICE_client_disable_continue_warning() to
 234  * disable the warning.
 235  *
 236  * Clients sending invalid messages (based on @a handlers) will be
 237  * dropped. Additionally, clients can be dropped at any time using
 238  * #GNUNET_SERVICE_client_drop().
 239  *
 240  * @param argc number of command-line arguments in @a argv
 241  * @param argv array of command-line arguments
 242  * @param service_name name of the service to run
 243  * @param options options controlling shutdown of the service
 244  * @param service_init_cb function to call once the service is ready
 245  * @param connect_cb function to call whenever a client connects
 246  * @param disconnect_cb function to call whenever a client disconnects
 247  * @param cls closure argument for @a service_init_cb, @a connect_cb and @a disconnect_cb
 248  * @param handlers NULL-terminated array of message handlers for the service,
 249  *                 the closure will be set to the value returned by
 250  *                 the @a connect_cb for the respective connection
 251  * @return 0 on success, non-zero on error
 252  */
 253 int
 254 GNUNET_SERVICE_ruN_ (int argc,
 255                      char *const *argv,
 256                      const char *service_name,
 257                      enum GNUNET_SERVICE_Options options,
 258                      GNUNET_SERVICE_InitCallback service_init_cb,
 259                      GNUNET_SERVICE_ConnectHandler connect_cb,
 260                      GNUNET_SERVICE_DisconnectHandler disconnect_cb,
 261                      void *cls,
 262                      const struct GNUNET_MQ_MessageHandler *handlers)
 263 {
 264   GNUNET_break (0); // not implemented
 265   return 1;
 266 }
 267
 268
 269 /**
 270  * Suspend accepting connections from the listen socket temporarily.
 271  * Resume activity using #GNUNET_SERVICE_resume.
 272  *
 273  * @param sh service to stop accepting connections.
 274  */
 275 void
 276 GNUNET_SERVICE_suspend (struct GNUNET_SERVICE_Handle *sh)
 277 {
 278   GNUNET_break (0); // not implemented
 279 }
 280
 281
 282 /**
 283  * Resume accepting connections from the listen socket.
 284  *
 285  * @param sh service to resume accepting connections.
 286  */
 287 void
 288 GNUNET_SERVICE_resume (struct GNUNET_SERVICE_Handle *sh)
 289 {
 290   GNUNET_break (0); // not implemented
 291 }
 292
 293
 294 /**
 295  * Continue receiving further messages from the given client.
 296  * Must be called after each message received.
 297  *
 298  * @param c the client to continue receiving from
 299  */
 300 void
 301 GNUNET_SERVICE_client_continue (struct GNUNET_SERVICE_Client *c)
 302 {
 303   GNUNET_break (0); // not implemented
 304 }
 305
 306
 307 /**
 308  * Disable the warning the server issues if a message is not
 309  * acknowledged in a timely fashion.  Use this call if a client is
 310  * intentionally delayed for a while.  Only applies to the current
 311  * message.
 312  *
 313  * @param c client for which to disable the warning
 314  */
 315 void
 316 GNUNET_SERVICE_client_disable_continue_warning (struct GNUNET_SERVICE_Client *c)
 317 {
 318   GNUNET_break (NULL != c->warn_task);
 319   if (NULL != c->warn_task)
 320   {
 321     GNUNET_SCHEDULER_cancel (c->warn_task);
 322     c->warn_task = NULL;
 323   }
 324 }
 325
 326
 327 /**
 328  * Ask the server to disconnect from the given client.  This is the
 329  * same as returning #GNUNET_SYSERR within the check procedure when
 330  * handling a message, wexcept that it allows dropping of a client even
 331  * when not handling a message from that client.  The `disconnect_cb`
 332  * will be called on @a c even if the application closes the connection
 333  * using this function.
 334  *
 335  * @param c client to disconnect now
 336  */
 337 void
 338 GNUNET_SERVICE_client_drop (struct GNUNET_SERVICE_Client *c)
 339 {
 340   GNUNET_break (0); // not implemented
 341 }
 342
 343
 344 /**
 345  * Stop the listen socket and get ready to shutdown the server once
 346  * only clients marked using #GNUNET_SERVER_client_mark_monitor are
 347  * left.
 348  *
 349  * @param sh server to stop listening on
 350  */
 351 void
 352 GNUNET_SERVICE_stop_listening (struct GNUNET_SERVICE_Handle *sh)
 353 {
 354   GNUNET_break (0); // not implemented
 355 }
 356
 357
 358 /**
 359  * Set the 'monitor' flag on this client.  Clients which have been
 360  * marked as 'monitors' won't prevent the server from shutting down
 361  * once #GNUNET_SERVICE_stop_listening() has been invoked.  The idea is
 362  * that for "normal" clients we likely want to allow them to process
 363  * their requests; however, monitor-clients are likely to 'never'
 364  * disconnect during shutdown and thus will not be considered when
 365  * determining if the server should continue to exist after
 366  * shutdown has been triggered.
 367  *
 368  * @param c client to mark as a monitor
 369  */
 370 void
 371 GNUNET_SERVICE_client_mark_monitor (struct GNUNET_SERVICE_Client *c)
 372 {
 373   GNUNET_break (0); // not implemented
 374 }
 375
 376
 377 /**
 378  * Set the persist option on this client.  Indicates that the
 379  * underlying socket or fd should never really be closed.  Used for
 380  * indicating process death.
 381  *
 382  * @param c client to persist the socket (never to be closed)
 383  */
 384 void
 385 GNUNET_SERVICE_client_persist (struct GNUNET_SERVICE_Client *c)
 386 {
 387   GNUNET_break (0); // not implemented
 388 }
 389
 390
 391
 392 /* end of service_new.c */