src/util/client.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2001-2013 Christian Grothoff (and other contributing authors)
   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., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  19 */
  20
  21 /**
  22  * @file util/client.c
  23  * @brief code for access to services
  24  * @author Christian Grothoff
  25  *
  26  * Generic TCP code for reliable, record-oriented TCP
  27  * connections between clients and service providers.
  28  */
  29 #include "platform.h"
  30 #include "gnunet_protocols.h"
  31 #include "gnunet_util_lib.h"
  32
  33
  34 /**
  35  * How often do we re-try tranmsitting requests before giving up?
  36  * Note that if we succeeded transmitting a request but failed to read
  37  * a response, we do NOT re-try.
  38  */
  39 #define MAX_ATTEMPTS 50
  40
  41 #define LOG(kind,...) GNUNET_log_from (kind, "util",__VA_ARGS__)
  42
  43 /**
  44  * Handle for a transmission request.
  45  */
  46 struct GNUNET_CLIENT_TransmitHandle
  47 {
  48   /**
  49    * Connection state.
  50    */
  51   struct GNUNET_CLIENT_Connection *client;
  52
  53   /**
  54    * Function to call to get the data for transmission.
  55    */
  56   GNUNET_CONNECTION_TransmitReadyNotify notify;
  57
  58   /**
  59    * Closure for @e notify.
  60    */
  61   void *notify_cls;
  62
  63   /**
  64    * Handle to the transmission with the underlying
  65    * connection.
  66    */
  67   struct GNUNET_CONNECTION_TransmitHandle *th;
  68
  69   /**
  70    * If we are re-trying and are delaying to do so,
  71    * handle to the scheduled task managing the delay.
  72    */
  73   GNUNET_SCHEDULER_TaskIdentifier reconnect_task;
  74
  75   /**
  76    * Timeout for the operation overall.
  77    */
  78   struct GNUNET_TIME_Absolute timeout;
  79
  80   /**
  81    * Number of bytes requested.
  82    */
  83   size_t size;
  84
  85   /**
  86    * Are we allowed to re-try to connect without telling
  87    * the user (of this API) about the connection troubles?
  88    */
  89   int auto_retry;
  90
  91   /**
  92    * Number of attempts left for transmitting the request.  We may
  93    * fail the first time (say because the service is not yet up), in
  94    * which case (if auto_retry is set) we wait a bit and re-try
  95    * (timeout permitting).
  96    */
  97   unsigned int attempts_left;
  98
  99 };
 100
 101
 102 /**
 103  * Context for processing
 104  * "GNUNET_CLIENT_transmit_and_get_response" requests.
 105  */
 106 struct TransmitGetResponseContext
 107 {
 108   /**
 109    * Client handle.
 110    */
 111   struct GNUNET_CLIENT_Connection *client;
 112
 113   /**
 114    * Message to transmit; do not free, allocated
 115    * right after this struct.
 116    */
 117   const struct GNUNET_MessageHeader *hdr;
 118
 119   /**
 120    * Timeout to use.
 121    */
 122   struct GNUNET_TIME_Absolute timeout;
 123
 124   /**
 125    * Function to call when done.
 126    */
 127   GNUNET_CLIENT_MessageHandler rn;
 128
 129   /**
 130    * Closure for @e rn.
 131    */
 132   void *rn_cls;
 133 };
 134
 135 /**
 136  * Struct to refer to a GNUnet TCP connection.
 137  * This is more than just a socket because if the server
 138  * drops the connection, the client automatically tries
 139  * to reconnect (and for that needs connection information).
 140  */
 141 struct GNUNET_CLIENT_Connection
 142 {
 143
 144   /**
 145    * The connection handle, NULL if not live
 146    */
 147   struct GNUNET_CONNECTION_Handle *connection;
 148
 149   /**
 150    * Our configuration.
 151    */
 152   const struct GNUNET_CONFIGURATION_Handle *cfg;
 153
 154   /**
 155    * Name of the service we interact with.
 156    */
 157   char *service_name;
 158
 159   /**
 160    * Context of a transmit_and_get_response operation, NULL
 161    * if no such operation is pending.
 162    */
 163   struct TransmitGetResponseContext *tag;
 164
 165   /**
 166    * Handler for current receiver task.
 167    */
 168   GNUNET_CLIENT_MessageHandler receiver_handler;
 169
 170   /**
 171    * Closure for receiver_handler.
 172    */
 173   void *receiver_handler_cls;
 174
 175   /**
 176    * Handle for a pending transmission request, NULL if there is
 177    * none pending.
 178    */
 179   struct GNUNET_CLIENT_TransmitHandle *th;
 180
 181   /**
 182    * If we are re-trying and are delaying to do so,
 183    * handle to the scheduled task managing the delay.
 184    */
 185   GNUNET_SCHEDULER_TaskIdentifier receive_task;
 186
 187   /**
 188    * Buffer for received message.
 189    */
 190   char *received_buf;
 191
 192   /**
 193    * Timeout for receiving a response (absolute time).
 194    */
 195   struct GNUNET_TIME_Absolute receive_timeout;
 196
 197   /**
 198    * Current value for our incremental back-off (for
 199    * connect re-tries).
 200    */
 201   struct GNUNET_TIME_Relative back_off;
 202
 203   /**
 204    * Number of bytes in received_buf that are valid.
 205    */
 206   size_t received_pos;
 207
 208   /**
 209    * Size of received_buf.
 210    */
 211   unsigned int received_size;
 212
 213   /**
 214    * Do we have a complete response in received_buf?
 215    */
 216   int msg_complete;
 217
 218   /**
 219    * Are we currently busy doing receive-processing?
 220    * GNUNET_YES if so, GNUNET_NO if not.
 221    */
 222   int in_receive;
 223
 224   /**
 225    * Is this the first message we are sending to the service?
 226    */
 227   int first_message;
 228
 229   /**
 230    * How often have we tried to connect?
 231    */
 232   unsigned int attempts;
 233
 234 };
 235
 236
 237 /**
 238  * Try connecting to the server using UNIX domain sockets.
 239  *
 240  * @param service_name name of service to connect to
 241  * @param cfg configuration to use
 242  * @return NULL on error, connection to UNIX otherwise
 243  */
 244 static struct GNUNET_CONNECTION_Handle *
 245 try_unixpath (const char *service_name,
 246               const struct GNUNET_CONFIGURATION_Handle *cfg)
 247 {
 248 #if AF_UNIX
 249   struct GNUNET_CONNECTION_Handle *connection;
 250   char *unixpath;
 251   struct sockaddr_un s_un;
 252
 253   unixpath = NULL;
 254   if ((GNUNET_OK == GNUNET_CONFIGURATION_get_value_filename (cfg, service_name, "UNIXPATH", &unixpath)) &&
 255       (0 < strlen (unixpath)))
 256   {
 257     /* We have a non-NULL unixpath, need to validate it */
 258     if (strlen (unixpath) >= sizeof (s_un.sun_path))
 259     {
 260       LOG (GNUNET_ERROR_TYPE_WARNING,
 261            _("UNIXPATH `%s' too long, maximum length is %llu\n"), unixpath,
 262            (unsigned long long) sizeof (s_un.sun_path));
 263       unixpath = GNUNET_NETWORK_shorten_unixpath (unixpath);
 264       LOG (GNUNET_ERROR_TYPE_INFO,
 265            _("Using `%s' instead\n"), unixpath);
 266       if (NULL == unixpath)
 267         return NULL;
 268     }
 269     connection = GNUNET_CONNECTION_create_from_connect_to_unixpath (cfg, unixpath);
 270     if (NULL != connection)
 271     {
 272       LOG (GNUNET_ERROR_TYPE_DEBUG, "Connected to unixpath `%s'!\n",
 273            unixpath);
 274       GNUNET_free (unixpath);
 275       return connection;
 276     }
 277   }
 278   GNUNET_free_non_null (unixpath);
 279 #endif
 280   return NULL;
 281 }
 282
 283
 284 /**
 285  * Test whether the configuration has proper values for connection
 286  * (UNIXPATH || (PORT && HOSTNAME)).
 287  *
 288  * @param service_name name of service to connect to
 289  * @param cfg configuration to use
 290  * @return #GNUNET_OK if the configuration is valid, #GNUNET_SYSERR if not
 291  */
 292 static int
 293 test_service_configuration (const char *service_name,
 294                             const struct GNUNET_CONFIGURATION_Handle *cfg)
 295 {
 296   int ret = GNUNET_SYSERR;
 297   char *hostname = NULL;
 298   unsigned long long port;
 299 #if AF_UNIX
 300   char *unixpath = NULL;
 301
 302   if ((GNUNET_OK == GNUNET_CONFIGURATION_get_value_filename (cfg, service_name, "UNIXPATH", &unixpath)) &&
 303       (0 < strlen (unixpath)))
 304     ret = GNUNET_OK;
 305   GNUNET_free_non_null (unixpath);
 306 #endif
 307
 308   if ( (GNUNET_YES ==
 309         GNUNET_CONFIGURATION_have_value (cfg, service_name, "PORT")) &&
 310        (GNUNET_OK ==
 311         GNUNET_CONFIGURATION_get_value_number (cfg, service_name, "PORT", &port)) &&
 312        (port <= 65535) && (0 != port) &&
 313        (GNUNET_OK ==
 314         GNUNET_CONFIGURATION_get_value_string (cfg, service_name, "HOSTNAME",
 315                                                &hostname)) &&
 316        (0 != strlen (hostname)) )
 317     ret = GNUNET_OK;
 318   GNUNET_free_non_null (hostname);
 319   return ret;
 320 }
 321
 322
 323 /**
 324  * Try to connect to the service.
 325  *
 326  * @param service_name name of service to connect to
 327  * @param cfg configuration to use
 328  * @param attempt counter used to alternate between IP and UNIX domain sockets
 329  * @return NULL on error
 330  */
 331 static struct GNUNET_CONNECTION_Handle *
 332 do_connect (const char *service_name,
 333             const struct GNUNET_CONFIGURATION_Handle *cfg,
 334             unsigned int attempt)
 335 {
 336   struct GNUNET_CONNECTION_Handle *connection;
 337   char *hostname;
 338   unsigned long long port;
 339
 340   connection = NULL;
 341   if (0 == (attempt % 2))
 342   {
 343     /* on even rounds, try UNIX first */
 344     connection = try_unixpath (service_name, cfg);
 345     if (NULL != connection)
 346       return connection;
 347   }
 348   if (GNUNET_YES ==
 349       GNUNET_CONFIGURATION_have_value (cfg, service_name, "PORT"))
 350   {
 351     if ((GNUNET_OK !=
 352          GNUNET_CONFIGURATION_get_value_number (cfg, service_name, "PORT", &port))
 353         || (port > 65535) ||
 354         (GNUNET_OK !=
 355          GNUNET_CONFIGURATION_get_value_string (cfg, service_name, "HOSTNAME",
 356                                                 &hostname)))
 357     {
 358       LOG (GNUNET_ERROR_TYPE_WARNING,
 359            _
 360            ("Could not determine valid hostname and port for service `%s' from configuration.\n"),
 361            service_name);
 362       return NULL;
 363     }
 364     if (0 == strlen (hostname))
 365     {
 366       GNUNET_free (hostname);
 367       LOG (GNUNET_ERROR_TYPE_WARNING,
 368            _("Need a non-empty hostname for service `%s'.\n"), service_name);
 369       return NULL;
 370     }
 371   }
 372   else
 373   {
 374     /* unspecified means 0 (disabled) */
 375     port = 0;
 376     hostname = NULL;
 377   }
 378   if (0 == port)
 379   {
 380     /* if port is 0, try UNIX */
 381     connection = try_unixpath (service_name, cfg);
 382     if (NULL != connection)
 383     {
 384       GNUNET_free_non_null (hostname);
 385       return connection;
 386     }
 387     LOG (GNUNET_ERROR_TYPE_DEBUG,
 388          "Port is 0 for service `%s', UNIXPATH did not work, returning NULL!\n",
 389          service_name);
 390     GNUNET_free_non_null (hostname);
 391     return NULL;
 392   }
 393   connection = GNUNET_CONNECTION_create_from_connect (cfg, hostname, port);
 394   GNUNET_free (hostname);
 395   return connection;
 396 }
 397
 398
 399 /**
 400  * Get a connection with a service.
 401  *
 402  * @param service_name name of the service
 403  * @param cfg configuration to use
 404  * @return NULL on error (service unknown to configuration)
 405  */
 406 struct GNUNET_CLIENT_Connection *
 407 GNUNET_CLIENT_connect (const char *service_name,
 408                        const struct GNUNET_CONFIGURATION_Handle *cfg)
 409 {
 410   struct GNUNET_CLIENT_Connection *client;
 411   struct GNUNET_CONNECTION_Handle *connection;
 412
 413   if (GNUNET_OK !=
 414       test_service_configuration (service_name,
 415                                   cfg))
 416     return NULL;
 417   connection = do_connect (service_name, cfg, 0);
 418   client = GNUNET_new (struct GNUNET_CLIENT_Connection);
 419   client->first_message = GNUNET_YES;
 420   client->attempts = 1;
 421   client->connection = connection;
 422   client->service_name = GNUNET_strdup (service_name);
 423   client->cfg = cfg;
 424   client->back_off = GNUNET_TIME_UNIT_MILLISECONDS;
 425   return client;
 426 }
 427
 428
 429 /**
 430  * Destroy connection with the service.  This will automatically
 431  * cancel any pending "receive" request (however, the handler will
 432  * *NOT* be called, not even with a NULL message).  Any pending
 433  * transmission request will also be cancelled UNLESS the callback for
 434  * the transmission request has already been called, in which case the
 435  * transmission 'finish_pending_write' argument determines whether or
 436  * not the write is guaranteed to complete before the socket is fully
 437  * destroyed (unless, of course, there is an error with the server in
 438  * which case the message may still be lost).
 439  *
 440  * @param client handle to the service connection
 441  */
 442 void
 443 GNUNET_CLIENT_disconnect (struct GNUNET_CLIENT_Connection *client)
 444 {
 445   if (GNUNET_YES == client->in_receive)
 446   {
 447     GNUNET_CONNECTION_receive_cancel (client->connection);
 448     client->in_receive = GNUNET_NO;
 449   }
 450   if (NULL != client->th)
 451   {
 452     GNUNET_CLIENT_notify_transmit_ready_cancel (client->th);
 453     client->th = NULL;
 454   }
 455   if (NULL != client->connection)
 456   {
 457     GNUNET_CONNECTION_destroy (client->connection);
 458     client->connection = NULL;
 459   }
 460   if (GNUNET_SCHEDULER_NO_TASK != client->receive_task)
 461   {
 462     GNUNET_SCHEDULER_cancel (client->receive_task);
 463     client->receive_task = GNUNET_SCHEDULER_NO_TASK;
 464   }
 465   if (NULL != client->tag)
 466   {
 467     GNUNET_free (client->tag);
 468     client->tag = NULL;
 469   }
 470   client->receiver_handler = NULL;
 471   GNUNET_array_grow (client->received_buf, client->received_size, 0);
 472   GNUNET_free (client->service_name);
 473   GNUNET_free (client);
 474 }
 475
 476
 477 /**
 478  * Check if message is complete.  Sets the "msg_complete" member
 479  * in the client struct.
 480  *
 481  * @param client connection with the buffer to check
 482  */
 483 static void
 484 check_complete (struct GNUNET_CLIENT_Connection *client)
 485 {
 486   if ((client->received_pos >= sizeof (struct GNUNET_MessageHeader)) &&
 487       (client->received_pos >=
 488        ntohs (((const struct GNUNET_MessageHeader *) client->received_buf)->
 489               size)))
 490     client->msg_complete = GNUNET_YES;
 491 }
 492
 493
 494 /**
 495  * Callback function for data received from the network.  Note that
 496  * both @a available and @a errCode would be 0 if the read simply timed out.
 497  *
 498  * @param cls closure
 499  * @param buf pointer to received data
 500  * @param available number of bytes availabe in @a buf,
 501  *        possibly 0 (on errors)
 502  * @param addr address of the sender
 503  * @param addrlen size of @a addr
 504  * @param errCode value of errno (on errors receiving)
 505  */
 506 static void
 507 receive_helper (void *cls, const void *buf, size_t available,
 508                 const struct sockaddr *addr, socklen_t addrlen, int errCode)
 509 {
 510   struct GNUNET_CLIENT_Connection *client = cls;
 511   struct GNUNET_TIME_Relative remaining;
 512   GNUNET_CLIENT_MessageHandler receive_handler;
 513   void *receive_handler_cls;
 514
 515   GNUNET_assert (GNUNET_NO == client->msg_complete);
 516   GNUNET_assert (GNUNET_YES == client->in_receive);
 517   client->in_receive = GNUNET_NO;
 518   if ((0 == available) || (NULL == client->connection) || (0 != errCode))
 519   {
 520     /* signal timeout! */
 521     LOG (GNUNET_ERROR_TYPE_DEBUG,
 522          "Timeout in receive_helper, available %u, client->connection %s, errCode `%s'\n",
 523          (unsigned int) available, NULL == client->connection ? "NULL" : "non-NULL",
 524          STRERROR (errCode));
 525     if (NULL != (receive_handler = client->receiver_handler))
 526     {
 527       receive_handler_cls = client->receiver_handler_cls;
 528       client->receiver_handler = NULL;
 529       receive_handler (receive_handler_cls, NULL);
 530     }
 531     return;
 532   }
 533   /* FIXME: optimize for common fast case where buf contains the
 534    * entire message and we need no copying... */
 535
 536   /* slow path: append to array */
 537   if (client->received_size < client->received_pos + available)
 538     GNUNET_array_grow (client->received_buf, client->received_size,
 539                        client->received_pos + available);
 540   memcpy (&client->received_buf[client->received_pos], buf, available);
 541   client->received_pos += available;
 542   check_complete (client);
 543   /* check for timeout */
 544   remaining = GNUNET_TIME_absolute_get_remaining (client->receive_timeout);
 545   if (0 == remaining.rel_value_us)
 546   {
 547     /* signal timeout! */
 548     if (NULL != client->receiver_handler)
 549       client->receiver_handler (client->receiver_handler_cls, NULL);
 550     return;
 551   }
 552   /* back to receive -- either for more data or to call callback! */
 553   GNUNET_CLIENT_receive (client, client->receiver_handler,
 554                          client->receiver_handler_cls, remaining);
 555 }
 556
 557
 558 /**
 559  * Continuation to call the receive callback.
 560  *
 561  * @param cls  our handle to the client connection
 562  * @param tc scheduler context
 563  */
 564 static void
 565 receive_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 566 {
 567   struct GNUNET_CLIENT_Connection *client = cls;
 568   GNUNET_CLIENT_MessageHandler handler = client->receiver_handler;
 569   const struct GNUNET_MessageHeader *cmsg =
 570       (const struct GNUNET_MessageHeader *) client->received_buf;
 571   void *handler_cls = client->receiver_handler_cls;
 572   uint16_t msize = ntohs (cmsg->size);
 573   char mbuf[msize];
 574   struct GNUNET_MessageHeader *msg = (struct GNUNET_MessageHeader *) mbuf;
 575
 576   LOG (GNUNET_ERROR_TYPE_DEBUG, "Received message of type %u and size %u\n",
 577        ntohs (cmsg->type), msize);
 578   client->receive_task = GNUNET_SCHEDULER_NO_TASK;
 579   GNUNET_assert (GNUNET_YES == client->msg_complete);
 580   GNUNET_assert (client->received_pos >= msize);
 581   memcpy (msg, cmsg, msize);
 582   memmove (client->received_buf, &client->received_buf[msize],
 583            client->received_pos - msize);
 584   client->received_pos -= msize;
 585   client->msg_complete = GNUNET_NO;
 586   client->receiver_handler = NULL;
 587   check_complete (client);
 588   if (NULL != handler)
 589     handler (handler_cls, msg);
 590 }
 591
 592
 593 /**
 594  * Read from the service.
 595  *
 596  * @param client the service
 597  * @param handler function to call with the message
 598  * @param handler_cls closure for @a handler
 599  * @param timeout how long to wait until timing out
 600  */
 601 void
 602 GNUNET_CLIENT_receive (struct GNUNET_CLIENT_Connection *client,
 603                        GNUNET_CLIENT_MessageHandler handler,
 604                        void *handler_cls,
 605                        struct GNUNET_TIME_Relative timeout)
 606 {
 607   if (NULL == client->connection)
 608   {
 609     /* already disconnected, fail instantly! */
 610     GNUNET_break (0);           /* this should not happen in well-written code! */
 611     if (NULL != handler)
 612       handler (handler_cls, NULL);
 613     return;
 614   }
 615   client->receiver_handler = handler;
 616   client->receiver_handler_cls = handler_cls;
 617   client->receive_timeout = GNUNET_TIME_relative_to_absolute (timeout);
 618   if (GNUNET_YES == client->msg_complete)
 619   {
 620     GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == client->receive_task);
 621     client->receive_task = GNUNET_SCHEDULER_add_now (&receive_task, client);
 622   }
 623   else
 624   {
 625     LOG (GNUNET_ERROR_TYPE_DEBUG, "calling GNUNET_CONNECTION_receive\n");
 626     GNUNET_assert (GNUNET_NO == client->in_receive);
 627     client->in_receive = GNUNET_YES;
 628     GNUNET_CONNECTION_receive (client->connection, GNUNET_SERVER_MAX_MESSAGE_SIZE - 1,
 629                                timeout, &receive_helper, client);
 630   }
 631 }
 632
 633
 634 /**
 635  * Handle for a test to check if a service is running.
 636  */
 637 struct GNUNET_CLIENT_TestHandle
 638 {
 639   /**
 640    * Function to call with the result of the test.
 641    */
 642   GNUNET_CLIENT_TestResultCallback cb;
 643
 644   /**
 645    * Closure for @e cb.
 646    */
 647   void *cb_cls;
 648
 649   /**
 650    * Client connection we are using for the test, if any.
 651    */
 652   struct GNUNET_CLIENT_Connection *client;
 653
 654   /**
 655    * Handle for the transmission request, if any.
 656    */
 657   struct GNUNET_CLIENT_TransmitHandle *th;
 658
 659   /**
 660    * Deadline for calling @e cb.
 661    */
 662   struct GNUNET_TIME_Absolute test_deadline;
 663
 664   /**
 665    * ID of task used for asynchronous operations.
 666    */
 667   GNUNET_SCHEDULER_TaskIdentifier task;
 668
 669   /**
 670    * Final result to report back (once known).
 671    */
 672   int result;
 673 };
 674
 675
 676 /**
 677  * Abort testing for service.
 678  *
 679  * @param th test handle
 680  */
 681 void
 682 GNUNET_CLIENT_service_test_cancel (struct GNUNET_CLIENT_TestHandle *th)
 683 {
 684   if (NULL != th->th)
 685   {
 686     GNUNET_CLIENT_notify_transmit_ready_cancel (th->th);
 687     th->th = NULL;
 688   }
 689   if (NULL != th->client)
 690   {
 691     GNUNET_CLIENT_disconnect (th->client);
 692     th->client = NULL;
 693   }
 694   if (GNUNET_SCHEDULER_NO_TASK != th->task)
 695   {
 696     GNUNET_SCHEDULER_cancel (th->task);
 697     th->task = GNUNET_SCHEDULER_NO_TASK;
 698   }
 699   GNUNET_free (th);
 700 }
 701
 702
 703 /**
 704  * Task that reports back the result by calling the callback
 705  * and then cleans up.
 706  *
 707  * @param cls the `struct GNUNET_CLIENT_TestHandle`
 708  * @param tc scheduler context
 709  */
 710 static void
 711 report_result (void *cls,
 712                const struct GNUNET_SCHEDULER_TaskContext *tc)
 713 {
 714   struct GNUNET_CLIENT_TestHandle *th = cls;
 715
 716   th->task = GNUNET_SCHEDULER_NO_TASK;
 717   th->cb (th->cb_cls, th->result);
 718   GNUNET_CLIENT_service_test_cancel (th);
 719 }
 720
 721
 722 /**
 723  * Report service test result asynchronously back to callback.
 724  *
 725  * @param th test handle with the result and the callback
 726  * @param result result to report
 727  */
 728 static void
 729 service_test_report (struct GNUNET_CLIENT_TestHandle *th,
 730                      int result)
 731 {
 732   th->result = result;
 733   th->task = GNUNET_SCHEDULER_add_now (&report_result,
 734                                        th);
 735 }
 736
 737
 738 /**
 739  * Receive confirmation from test, service is up.
 740  *
 741  * @param cls closure with the `struct GNUNET_CLIENT_TestHandle`
 742  * @param msg message received, NULL on timeout or fatal error
 743  */
 744 static void
 745 confirm_handler (void *cls, const struct GNUNET_MessageHeader *msg)
 746 {
 747   struct GNUNET_CLIENT_TestHandle *th = cls;
 748
 749   /* We may want to consider looking at the reply in more
 750    * detail in the future, for example, is this the
 751    * correct service? FIXME! */
 752   if (NULL != msg)
 753   {
 754     LOG (GNUNET_ERROR_TYPE_DEBUG,
 755          "Received confirmation that service is running.\n");
 756     service_test_report (th, GNUNET_YES);
 757   }
 758   else
 759   {
 760     service_test_report (th, GNUNET_NO);
 761   }
 762 }
 763
 764
 765 /**
 766  * Send the 'TEST' message to the service.  If successful, prepare to
 767  * receive the reply.
 768  *
 769  * @param cls the `struct GNUNET_CLIENT_TestHandle` of the test
 770  * @param size number of bytes available in @a buf
 771  * @param buf where to write the message
 772  * @return number of bytes written to @a buf
 773  */
 774 static size_t
 775 write_test (void *cls, size_t size, void *buf)
 776 {
 777   struct GNUNET_CLIENT_TestHandle *th = cls;
 778   struct GNUNET_MessageHeader *msg;
 779
 780   th->th = NULL;
 781   if (size < sizeof (struct GNUNET_MessageHeader))
 782   {
 783     LOG (GNUNET_ERROR_TYPE_DEBUG,
 784          "Failed to transmit TEST request.\n");
 785     service_test_report (th, GNUNET_NO);
 786     return 0;                   /* client disconnected */
 787   }
 788   LOG (GNUNET_ERROR_TYPE_DEBUG,
 789        "Transmitting `%s' request.\n",
 790        "TEST");
 791   msg = (struct GNUNET_MessageHeader *) buf;
 792   msg->type = htons (GNUNET_MESSAGE_TYPE_TEST);
 793   msg->size = htons (sizeof (struct GNUNET_MessageHeader));
 794   GNUNET_CLIENT_receive (th->client,
 795                          &confirm_handler, th,
 796                          GNUNET_TIME_absolute_get_remaining
 797                          (th->test_deadline));
 798   return sizeof (struct GNUNET_MessageHeader);
 799 }
 800
 801
 802 /**
 803  * Test if the service is running.  If we are given a UNIXPATH or a
 804  * local address, we do this NOT by trying to connect to the service,
 805  * but by trying to BIND to the same port.  If the BIND fails, we know
 806  * the service is running.
 807  *
 808  * @param service name of the service to wait for
 809  * @param cfg configuration to use
 810  * @param timeout how long to wait at most
 811  * @param cb function to call with the result
 812  * @param cb_cls closure for @a cb
 813  * @return handle to cancel the test
 814  */
 815 struct GNUNET_CLIENT_TestHandle *
 816 GNUNET_CLIENT_service_test (const char *service,
 817                             const struct GNUNET_CONFIGURATION_Handle *cfg,
 818                             struct GNUNET_TIME_Relative timeout,
 819                             GNUNET_CLIENT_TestResultCallback cb,
 820                             void *cb_cls)
 821 {
 822   struct GNUNET_CLIENT_TestHandle *th;
 823   char *hostname;
 824   unsigned long long port;
 825   struct GNUNET_NETWORK_Handle *sock;
 826
 827   th = GNUNET_new (struct GNUNET_CLIENT_TestHandle);
 828   th->cb = cb;
 829   th->cb_cls = cb_cls;
 830   th->test_deadline = GNUNET_TIME_relative_to_absolute (timeout);
 831   LOG (GNUNET_ERROR_TYPE_DEBUG,
 832        "Testing if service `%s' is running.\n",
 833        service);
 834 #ifdef AF_UNIX
 835   {
 836     /* probe UNIX support */
 837     struct sockaddr_un s_un;
 838     char *unixpath;
 839
 840     unixpath = NULL;
 841     if ((GNUNET_OK ==
 842          GNUNET_CONFIGURATION_get_value_filename (cfg,
 843                                                   service,
 844                                                   "UNIXPATH",
 845                                                   &unixpath)) &&
 846         (0 < strlen (unixpath)))  /* We have a non-NULL unixpath, does that mean it's valid? */
 847     {
 848       if (strlen (unixpath) >= sizeof (s_un.sun_path))
 849       {
 850         LOG (GNUNET_ERROR_TYPE_WARNING,
 851              _("UNIXPATH `%s' too long, maximum length is %llu\n"),
 852              unixpath,
 853              (unsigned long long) sizeof (s_un.sun_path));
 854         unixpath = GNUNET_NETWORK_shorten_unixpath (unixpath);
 855         LOG (GNUNET_ERROR_TYPE_INFO,
 856              _("Using `%s' instead\n"), unixpath);
 857       }
 858     }
 859     if (NULL != unixpath)
 860     {
 861       if (GNUNET_OK !=
 862           GNUNET_DISK_directory_create_for_file (unixpath))
 863         GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
 864                                   "mkdir",
 865                                   unixpath);
 866       sock = GNUNET_NETWORK_socket_create (PF_UNIX, SOCK_STREAM, 0);
 867       if (NULL != sock)
 868       {
 869         memset (&s_un, 0, sizeof (s_un));
 870         s_un.sun_family = AF_UNIX;
 871         strncpy (s_un.sun_path, unixpath, sizeof (s_un.sun_path) - 1);
 872 #if HAVE_SOCKADDR_IN_SIN_LEN
 873         s_un.sun_len = (u_char) sizeof (struct sockaddr_un);
 874 #endif
 875         if (GNUNET_OK !=
 876             GNUNET_NETWORK_socket_bind (sock, (const struct sockaddr *) &s_un,
 877                                         sizeof (struct sockaddr_un)))
 878         {
 879           /* failed to bind => service must be running */
 880           GNUNET_free (unixpath);
 881           (void) GNUNET_NETWORK_socket_close (sock);
 882           service_test_report (th, GNUNET_YES);
 883           return th;
 884         }
 885         (void) GNUNET_NETWORK_socket_close (sock);
 886         /* let's try IP */
 887       }
 888     }
 889     GNUNET_free_non_null (unixpath);
 890   }
 891 #endif
 892
 893   hostname = NULL;
 894   if ((GNUNET_OK !=
 895        GNUNET_CONFIGURATION_get_value_number (cfg, service, "PORT", &port)) ||
 896       (port > 65535) ||
 897       (GNUNET_OK !=
 898        GNUNET_CONFIGURATION_get_value_string (cfg, service, "HOSTNAME",
 899                                               &hostname)))
 900   {
 901     /* UNIXPATH failed (if possible) AND IP failed => error */
 902     service_test_report (th, GNUNET_SYSERR);
 903     return th;
 904   }
 905
 906   if (0 == strcmp ("localhost", hostname)
 907 #if !LINUX
 908       && 0
 909 #endif
 910       )
 911   {
 912     /* can test using 'bind' */
 913     struct sockaddr_in s_in;
 914
 915     memset (&s_in, 0, sizeof (s_in));
 916 #if HAVE_SOCKADDR_IN_SIN_LEN
 917     s_in.sin_len = sizeof (struct sockaddr_in);
 918 #endif
 919     s_in.sin_family = AF_INET;
 920     s_in.sin_port = htons (port);
 921
 922     sock = GNUNET_NETWORK_socket_create (AF_INET, SOCK_STREAM, 0);
 923     if (NULL != sock)
 924     {
 925       if (GNUNET_OK !=
 926           GNUNET_NETWORK_socket_bind (sock, (const struct sockaddr *) &s_in,
 927                                       sizeof (s_in)))
 928       {
 929         /* failed to bind => service must be running */
 930         GNUNET_free (hostname);
 931         (void) GNUNET_NETWORK_socket_close (sock);
 932         service_test_report (th, GNUNET_YES);
 933         return th;
 934       }
 935       (void) GNUNET_NETWORK_socket_close (sock);
 936     }
 937   }
 938
 939   if (0 == strcmp ("ip6-localhost", hostname)
 940 #if !LINUX
 941       && 0
 942 #endif
 943       )
 944   {
 945     /* can test using 'bind' */
 946     struct sockaddr_in6 s_in6;
 947
 948     memset (&s_in6, 0, sizeof (s_in6));
 949 #if HAVE_SOCKADDR_IN_SIN_LEN
 950     s_in6.sin6_len = sizeof (struct sockaddr_in6);
 951 #endif
 952     s_in6.sin6_family = AF_INET6;
 953     s_in6.sin6_port = htons (port);
 954
 955     sock = GNUNET_NETWORK_socket_create (AF_INET6, SOCK_STREAM, 0);
 956     if (NULL != sock)
 957     {
 958       if (GNUNET_OK !=
 959           GNUNET_NETWORK_socket_bind (sock, (const struct sockaddr *) &s_in6,
 960                                       sizeof (s_in6)))
 961       {
 962         /* failed to bind => service must be running */
 963         GNUNET_free (hostname);
 964         (void) GNUNET_NETWORK_socket_close (sock);
 965         service_test_report (th, GNUNET_YES);
 966         return th;
 967       }
 968       (void) GNUNET_NETWORK_socket_close (sock);
 969     }
 970   }
 971
 972   if (((0 == strcmp ("localhost", hostname)) ||
 973        (0 == strcmp ("ip6-localhost", hostname)))
 974 #if !LINUX
 975       && 0
 976 #endif
 977       )
 978   {
 979     /* all binds succeeded => claim service not running right now */
 980     GNUNET_free_non_null (hostname);
 981     service_test_report (th, GNUNET_NO);
 982     return th;
 983   }
 984   GNUNET_free_non_null (hostname);
 985
 986   /* non-localhost, try 'connect' method */
 987   th->client = GNUNET_CLIENT_connect (service, cfg);
 988   if (NULL == th->client)
 989   {
 990     LOG (GNUNET_ERROR_TYPE_INFO,
 991          _("Could not connect to service `%s', configuration broken.\n"),
 992          service);
 993     service_test_report (th, GNUNET_SYSERR);
 994     return th;
 995   }
 996   th->th = GNUNET_CLIENT_notify_transmit_ready (th->client,
 997                                                 sizeof (struct GNUNET_MessageHeader),
 998                                                 timeout, GNUNET_YES,
 999                                                 &write_test, th);
1000   if (NULL == th->th)
1001   {
1002     LOG (GNUNET_ERROR_TYPE_WARNING,
1003          _("Failure to transmit request to service `%s'\n"), service);
1004     service_test_report (th, GNUNET_SYSERR);
1005     return th;
1006   }
1007   return th;
1008 }
1009
1010
1011 /**
1012  * Connection notifies us about failure or success of
1013  * a transmission request.  Either pass it on to our
1014  * user or, if possible, retry.
1015  *
1016  * @param cls our `struct GNUNET_CLIENT_TransmissionHandle`
1017  * @param size number of bytes available for transmission
1018  * @param buf where to write them
1019  * @return number of bytes written to buf
1020  */
1021 static size_t
1022 client_notify (void *cls, size_t size, void *buf);
1023
1024
1025 /**
1026  * This task is run if we should re-try connection to the
1027  * service after a while.
1028  *
1029  * @param cls our `struct GNUNET_CLIENT_TransmitHandle` of the request
1030  * @param tc unused
1031  */
1032 static void
1033 client_delayed_retry (void *cls,
1034                       const struct GNUNET_SCHEDULER_TaskContext *tc)
1035 {
1036   struct GNUNET_CLIENT_TransmitHandle *th = cls;
1037   struct GNUNET_TIME_Relative delay;
1038
1039   th->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
1040   if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
1041   {
1042     /* give up, was shutdown */
1043     th->client->th = NULL;
1044     th->notify (th->notify_cls, 0, NULL);
1045     GNUNET_free (th);
1046     return;
1047   }
1048   th->client->connection =
1049     do_connect (th->client->service_name,
1050                 th->client->cfg,
1051                 th->client->attempts++);
1052   th->client->first_message = GNUNET_YES;
1053   if (NULL == th->client->connection)
1054   {
1055     /* could happen if we're out of sockets */
1056     delay =
1057         GNUNET_TIME_relative_min (GNUNET_TIME_absolute_get_remaining
1058                                   (th->timeout), th->client->back_off);
1059     th->client->back_off =
1060         GNUNET_TIME_relative_min (GNUNET_TIME_relative_multiply
1061                                   (th->client->back_off, 2),
1062                                   GNUNET_TIME_UNIT_SECONDS);
1063     LOG (GNUNET_ERROR_TYPE_DEBUG,
1064          "Transmission failed %u times, trying again in %s.\n",
1065          MAX_ATTEMPTS - th->attempts_left,
1066          GNUNET_STRINGS_relative_time_to_string (delay, GNUNET_YES));
1067     th->reconnect_task =
1068         GNUNET_SCHEDULER_add_delayed (delay, &client_delayed_retry, th);
1069     return;
1070   }
1071   th->th =
1072       GNUNET_CONNECTION_notify_transmit_ready (th->client->connection, th->size,
1073                                                GNUNET_TIME_absolute_get_remaining
1074                                                (th->timeout), &client_notify,
1075                                                th);
1076   if (NULL == th->th)
1077   {
1078     GNUNET_break (0);
1079     th->client->th = NULL;
1080     th->notify (th->notify_cls, 0, NULL);
1081     GNUNET_free (th);
1082     return;
1083   }
1084 }
1085
1086
1087 /**
1088  * Connection notifies us about failure or success of a transmission
1089  * request.  Either pass it on to our user or, if possible, retry.
1090  *
1091  * @param cls our `struct GNUNET_CLIENT_TransmissionHandle`
1092  * @param size number of bytes available for transmission
1093  * @param buf where to write them
1094  * @return number of bytes written to @a buf
1095  */
1096 static size_t
1097 client_notify (void *cls, size_t size, void *buf)
1098 {
1099   struct GNUNET_CLIENT_TransmitHandle *th = cls;
1100   struct GNUNET_CLIENT_Connection *client = th->client;
1101   size_t ret;
1102   struct GNUNET_TIME_Relative delay;
1103
1104   LOG (GNUNET_ERROR_TYPE_DEBUG,
1105        "client_notify is running\n");
1106   th->th = NULL;
1107   client->th = NULL;
1108   if (NULL == buf)
1109   {
1110     delay = GNUNET_TIME_absolute_get_remaining (th->timeout);
1111     delay.rel_value_us /= 2;
1112     if ((GNUNET_YES != th->auto_retry) || (0 == --th->attempts_left) ||
1113         (delay.rel_value_us < 1)||
1114         (0 != (GNUNET_SCHEDULER_get_reason() & GNUNET_SCHEDULER_REASON_SHUTDOWN)))
1115     {
1116       LOG (GNUNET_ERROR_TYPE_DEBUG,
1117            "Transmission failed %u times, giving up.\n",
1118            MAX_ATTEMPTS - th->attempts_left);
1119       GNUNET_break (0 == th->notify (th->notify_cls, 0, NULL));
1120       GNUNET_free (th);
1121       return 0;
1122     }
1123     /* auto-retry */
1124     LOG (GNUNET_ERROR_TYPE_DEBUG,
1125          "Failed to connect to `%s', automatically trying again.\n",
1126          client->service_name);
1127     if (GNUNET_YES == client->in_receive)
1128     {
1129       GNUNET_CONNECTION_receive_cancel (client->connection);
1130       client->in_receive = GNUNET_NO;
1131     }
1132     GNUNET_CONNECTION_destroy (client->connection);
1133     client->connection = NULL;
1134     delay = GNUNET_TIME_relative_min (delay, client->back_off);
1135     client->back_off =
1136         GNUNET_TIME_relative_min (GNUNET_TIME_relative_multiply
1137                                   (client->back_off, 2),
1138                                   GNUNET_TIME_UNIT_SECONDS);
1139     LOG (GNUNET_ERROR_TYPE_DEBUG,
1140          "Transmission failed %u times, trying again in %s.\n",
1141          MAX_ATTEMPTS - th->attempts_left,
1142          GNUNET_STRINGS_relative_time_to_string (delay, GNUNET_YES));
1143     client->th = th;
1144     th->reconnect_task =
1145         GNUNET_SCHEDULER_add_delayed (delay, &client_delayed_retry, th);
1146     return 0;
1147   }
1148   GNUNET_assert (size >= th->size);
1149   ret = th->notify (th->notify_cls, size, buf);
1150   GNUNET_free (th);
1151   return ret;
1152 }
1153
1154
1155 /**
1156  * Ask the client to call us once the specified number of bytes
1157  * are free in the transmission buffer.  May call the notify
1158  * method immediately if enough space is available.
1159  *
1160  * @param client connection to the service
1161  * @param size number of bytes to send
1162  * @param timeout after how long should we give up (and call
1163  *        notify with buf NULL and size 0)?
1164  * @param auto_retry if the connection to the service dies, should we
1165  *        automatically re-connect and retry (within the timeout period)
1166  *        or should we immediately fail in this case?  Pass GNUNET_YES
1167  *        if the caller does not care about temporary connection errors,
1168  *        for example because the protocol is stateless
1169  * @param notify function to call
1170  * @param notify_cls closure for @a notify
1171  * @return NULL if our buffer will never hold size bytes,
1172  *         a handle if the notify callback was queued (can be used to cancel)
1173  */
1174 struct GNUNET_CLIENT_TransmitHandle *
1175 GNUNET_CLIENT_notify_transmit_ready (struct GNUNET_CLIENT_Connection *client,
1176                                      size_t size,
1177                                      struct GNUNET_TIME_Relative timeout,
1178                                      int auto_retry,
1179                                      GNUNET_CONNECTION_TransmitReadyNotify notify,
1180                                      void *notify_cls)
1181 {
1182   struct GNUNET_CLIENT_TransmitHandle *th;
1183
1184   if (NULL != client->th)
1185   {
1186     /* If this breaks, you most likley called this function twice without waiting
1187      * for completion or canceling the request */
1188     GNUNET_break (0);
1189     return NULL;
1190   }
1191   th = GNUNET_malloc (sizeof (struct GNUNET_CLIENT_TransmitHandle));
1192   th->client = client;
1193   th->size = size;
1194   th->timeout = GNUNET_TIME_relative_to_absolute (timeout);
1195   /* always auto-retry on first message to service */
1196   th->auto_retry = (GNUNET_YES == client->first_message) ? GNUNET_YES : auto_retry;
1197   client->first_message = GNUNET_NO;
1198   th->notify = notify;
1199   th->notify_cls = notify_cls;
1200   th->attempts_left = MAX_ATTEMPTS;
1201   client->th = th;
1202   if (NULL == client->connection)
1203   {
1204     th->reconnect_task =
1205         GNUNET_SCHEDULER_add_delayed (client->back_off, &client_delayed_retry,
1206                                       th);
1207
1208   }
1209   else
1210   {
1211     th->th =
1212         GNUNET_CONNECTION_notify_transmit_ready (client->connection, size, timeout,
1213                                                  &client_notify, th);
1214     if (NULL == th->th)
1215     {
1216       GNUNET_break (0);
1217       GNUNET_free (th);
1218       client->th = NULL;
1219       return NULL;
1220     }
1221   }
1222   return th;
1223 }
1224
1225
1226 /**
1227  * Cancel a request for notification.
1228  *
1229  * @param th handle from the original request.
1230  */
1231 void
1232 GNUNET_CLIENT_notify_transmit_ready_cancel (struct GNUNET_CLIENT_TransmitHandle *th)
1233 {
1234   if (GNUNET_SCHEDULER_NO_TASK != th->reconnect_task)
1235   {
1236     GNUNET_assert (NULL == th->th);
1237     GNUNET_SCHEDULER_cancel (th->reconnect_task);
1238     th->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
1239   }
1240   else
1241   {
1242     GNUNET_assert (NULL != th->th);
1243     GNUNET_CONNECTION_notify_transmit_ready_cancel (th->th);
1244   }
1245   th->client->th = NULL;
1246   GNUNET_free (th);
1247 }
1248
1249
1250 /**
1251  * Function called to notify a client about the socket
1252  * begin ready to queue the message.  @a buf will be
1253  * NULL and @a size zero if the socket was closed for
1254  * writing in the meantime.
1255  *
1256  * @param cls closure of type "struct TransmitGetResponseContext*"
1257  * @param size number of bytes available in @a buf
1258  * @param buf where the callee should write the message
1259  * @return number of bytes written to @a buf
1260  */
1261 static size_t
1262 transmit_for_response (void *cls,
1263                        size_t size,
1264                        void *buf)
1265 {
1266   struct TransmitGetResponseContext *tc = cls;
1267   uint16_t msize;
1268
1269   tc->client->tag = NULL;
1270   msize = ntohs (tc->hdr->size);
1271   if (NULL == buf)
1272   {
1273     LOG (GNUNET_ERROR_TYPE_DEBUG,
1274          _("Could not submit request, not expecting to receive a response.\n"));
1275     if (NULL != tc->rn)
1276       tc->rn (tc->rn_cls, NULL);
1277     GNUNET_free (tc);
1278     return 0;
1279   }
1280   GNUNET_assert (size >= msize);
1281   memcpy (buf, tc->hdr, msize);
1282   GNUNET_CLIENT_receive (tc->client, tc->rn, tc->rn_cls,
1283                          GNUNET_TIME_absolute_get_remaining (tc->timeout));
1284   GNUNET_free (tc);
1285   return msize;
1286 }
1287
1288
1289 /**
1290  * Convenience API that combines sending a request
1291  * to the service and waiting for a response.
1292  * If either operation times out, the callback
1293  * will be called with a "NULL" response (in which
1294  * case the connection should probably be destroyed).
1295  *
1296  * @param client connection to use
1297  * @param hdr message to transmit
1298  * @param timeout when to give up (for both transmission
1299  *         and for waiting for a response)
1300  * @param auto_retry if the connection to the service dies, should we
1301  *        automatically re-connect and retry (within the timeout period)
1302  *        or should we immediately fail in this case?  Pass GNUNET_YES
1303  *        if the caller does not care about temporary connection errors,
1304  *        for example because the protocol is stateless
1305  * @param rn function to call with the response
1306  * @param rn_cls closure for @a rn
1307  * @return #GNUNET_OK on success, #GNUNET_SYSERR if a request
1308  *         is already pending
1309  */
1310 int
1311 GNUNET_CLIENT_transmit_and_get_response (struct GNUNET_CLIENT_Connection *client,
1312                                          const struct GNUNET_MessageHeader *hdr,
1313                                          struct GNUNET_TIME_Relative timeout,
1314                                          int auto_retry,
1315                                          GNUNET_CLIENT_MessageHandler rn,
1316                                          void *rn_cls)
1317 {
1318   struct TransmitGetResponseContext *tc;
1319   uint16_t msize;
1320
1321   if (NULL != client->th)
1322     return GNUNET_SYSERR;
1323   GNUNET_assert (NULL == client->tag);
1324   msize = ntohs (hdr->size);
1325   tc = GNUNET_malloc (sizeof (struct TransmitGetResponseContext) + msize);
1326   tc->client = client;
1327   tc->hdr = (const struct GNUNET_MessageHeader *) &tc[1];
1328   memcpy (&tc[1], hdr, msize);
1329   tc->timeout = GNUNET_TIME_relative_to_absolute (timeout);
1330   tc->rn = rn;
1331   tc->rn_cls = rn_cls;
1332   if (NULL ==
1333       GNUNET_CLIENT_notify_transmit_ready (client, msize, timeout, auto_retry,
1334                                            &transmit_for_response, tc))
1335   {
1336     GNUNET_break (0);
1337     GNUNET_free (tc);
1338     return GNUNET_SYSERR;
1339   }
1340   client->tag = tc;
1341   return GNUNET_OK;
1342 }
1343
1344
1345 /*  end of client.c */