- use proper signedness
[oweals/gnunet.git] / src / transport / plugin_transport_unix.c
index e80102a33f66afd6799bc8ea8ff07180665ed264..3a2fa6516f96af5c0f3af7901e5341b5fe339aef 100644 (file)
@@ -348,6 +348,7 @@ reschedule_session_timeout (struct Session *s);
 static void
 unix_plugin_select (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
 
+
 /**
  * Function called for a quick conversion of the binary address to
  * a numeric address.  Note that the caller must not free the
@@ -360,10 +361,47 @@ unix_plugin_select (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
  * @return string representing the same address
  */
 static const char *
-unix_address_to_string (void *cls, const void *addr, size_t addrlen);
+unix_address_to_string (void *cls, const void *addr, size_t addrlen)
+{
+  static char rbuf[1024];
+  struct UnixAddress *ua = (struct UnixAddress *) addr;
+  char *addrstr;
+  size_t addr_str_len;
+
+  if ((NULL == addr) || (sizeof (struct UnixAddress) > addrlen))
+  {
+    GNUNET_break(0);
+    return NULL ;
+  }
+  addrstr = (char *) &ua[1];
+  addr_str_len = ntohl (ua->addrlen);
+
+  if (addr_str_len != addrlen - sizeof(struct UnixAddress))
+  {
+    GNUNET_break(0);
+    return NULL ;
+  }
+
+  if ('\0' != addrstr[addr_str_len - 1])
+  {
+    GNUNET_break(0);
+    return NULL ;
+  }
+  if (strlen (addrstr) + 1 != addr_str_len)
+  {
+    GNUNET_break(0);
+    return NULL ;
+  }
+
+  GNUNET_snprintf (rbuf, sizeof(rbuf), "%s.%u.%s", PLUGIN_NAME,
+      ntohl (ua->options), addrstr);
+  return rbuf;
+}
+
 
 static struct sockaddr_un *
-unix_address_to_sockaddr (const char *unixpath , socklen_t *sock_len)
+unix_address_to_sockaddr (const char *unixpath,
+                          socklen_t *sock_len)
 {
   struct sockaddr_un *un;
   size_t slen;
@@ -380,14 +418,11 @@ unix_address_to_sockaddr (const char *unixpath , socklen_t *sock_len)
 #if HAVE_SOCKADDR_IN_SIN_LEN
   un->sun_len = (u_char) slen;
 #endif
-#if LINUX
-  un->sun_path[0] = '\0';
-#endif
-
   (*sock_len) = slen;
   return un;
 }
 
+
 /**
  * Re-schedule the main 'select' callback (unix_plugin_select)
  * for this plugin.
@@ -426,7 +461,7 @@ reschedule_select (struct Plugin * plugin)
 
 
 /**
- * Closure to 'lookup_session_it'.
+ * Closure to #lookup_session_it.
  */
 struct LookupCtx
 {
@@ -440,6 +475,9 @@ struct LookupCtx
    */
   const struct UnixAddress *ua;
 
+  /**
+   * Number of bytes in @e ua
+   */
   size_t ua_len;
 };
 
@@ -450,7 +488,7 @@ struct LookupCtx
  * @param cls the 'struct LookupCtx'
  * @param key peer we are looking for (unused)
  * @param value a session
- * @return GNUNET_YES if not found (continue looking), GNUNET_NO on success
+ * @return #GNUNET_YES if not found (continue looking), #GNUNET_NO on success
  */
 static int
 lookup_session_it (void *cls,
@@ -462,7 +500,7 @@ lookup_session_it (void *cls,
 
   if (t->addrlen != lctx->ua_len)
   {
-       GNUNET_break (0);
+    GNUNET_break (0);
     return GNUNET_YES;
   }
 
@@ -492,9 +530,6 @@ lookup_session (struct Plugin *plugin,
 {
   struct LookupCtx lctx;
 
-  GNUNET_assert (NULL != plugin);
-  GNUNET_assert (NULL != sender);
-  GNUNET_assert (NULL != ua);
   lctx.s = NULL;
   lctx.ua = ua;
   lctx.ua_len = ua_len;
@@ -510,12 +545,15 @@ lookup_session (struct Plugin *plugin,
  * to close a session due to a disconnect or failure to
  * establish a connection.
  *
+ * @param cls closure with the `struct Plugin`
  * @param s session to close down
+ * @return #GNUNET_OK on success
  */
-static void
-disconnect_session (struct Session *s)
+static int
+unix_session_disconnect (void *cls,
+                         struct Session *s)
 {
-  struct Plugin *plugin = s->plugin;
+  struct Plugin *plugin = cls;
   struct UNIXMessageWrapper *msgw;
   struct UNIXMessageWrapper *next;
   int removed;
@@ -557,6 +595,22 @@ disconnect_session (struct Session *s)
     s->timeout_task = GNUNET_SCHEDULER_NO_TASK;
   }
   GNUNET_free (s);
+  return GNUNET_OK;
+}
+
+
+/**
+ * Function that is called to get the keepalive factor.
+ * GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT is divided by this number to
+ * calculate the interval between keepalive packets.
+ *
+ * @param cls closure with the `struct Plugin`
+ * @return keepalive factor
+ */
+static unsigned int
+unix_query_keepalive_factor (void *cls)
+{
+  return 3;
 }
 
 
@@ -572,13 +626,13 @@ disconnect_session (struct Session *s)
  * @param priority how important is the message (ignored by UNIX)
  * @param timeout when should we time out (give up) if we can not transmit?
  * @param addr the addr to send the message to, needs to be a sockaddr for us
- * @param addrlen the len of addr
+ * @param addrlen the len of @a addr
  * @param payload bytes payload to send
  * @param cont continuation to call once the message has
  *        been transmitted (or if the transport is ready
  *        for the next transmission call; or if the
  *        peer disconnected...)
- * @param cont_cls closure for cont
+ * @param cont_cls closure for @a cont
  * @return on success the number of bytes written, RETRY for retry, -1 on errors
  */
 static ssize_t
@@ -599,7 +653,6 @@ unix_real_send (void *cls,
   socklen_t un_len;
   const char *unixpath;
 
-
   GNUNET_assert (NULL != plugin);
   if (NULL == send_handle)
   {
@@ -696,7 +749,7 @@ struct GetSessionIteratorContext
   const char *address;
 
   /**
-   * Number of bytes in 'address'
+   * Number of bytes in @e address
    */
   size_t addrlen;
 };
@@ -708,7 +761,7 @@ struct GetSessionIteratorContext
  * @param cls the 'struct LookupCtx'
  * @param key peer we are looking for (unused)
  * @param value a session
- * @return GNUNET_YES if not found (continue looking), GNUNET_NO on success
+ * @return #GNUNET_YES if not found (continue looking), #GNUNET_NO on success
  */
 static int
 get_session_it (void *cls,
@@ -746,7 +799,7 @@ session_timeout (void *cls,
        s,
        GNUNET_STRINGS_relative_time_to_string (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT,
                                               GNUNET_YES));
-  disconnect_session (s);
+  unix_session_disconnect (s->plugin, s);
 }
 
 
@@ -755,7 +808,7 @@ session_timeout (void *cls,
  *
  * @param cls closure ('struct Plugin*')
  * @param session the session
- * @return the network type in HBO or GNUNET_SYSERR
+ * @return the network type in HBO or #GNUNET_SYSERR
  */
 static enum GNUNET_ATS_Network_Type
 unix_get_network (void *cls,
@@ -853,6 +906,21 @@ unix_plugin_get_session (void *cls,
   return s;
 }
 
+static void
+unix_plugin_update_session_timeout (void *cls,
+                                  const struct GNUNET_PeerIdentity *peer,
+                                  struct Session *session)
+{
+  struct Plugin *plugin = cls;
+
+  if (GNUNET_OK !=
+      GNUNET_CONTAINER_multipeermap_contains_value (plugin->session_map,
+                                                    &session->target,
+                                                    session))
+    return;
+
+  reschedule_session_timeout (session);
+}
 
 /**
  * Function that can be used by the transport service to transmit
@@ -865,7 +933,7 @@ unix_plugin_get_session (void *cls,
  * @param cls closure
  * @param session which session must be used
  * @param msgbuf the message to transmit
- * @param msgbuf_size number of bytes in 'msgbuf'
+ * @param msgbuf_size number of bytes in @a msgbuf
  * @param priority how important is the message (most plugins will
  *                 ignore message priority and just FIFO)
  * @param to how long to wait at most for the transmission (does not
@@ -876,7 +944,7 @@ unix_plugin_get_session (void *cls,
  *        been transmitted (or if the transport is ready
  *        for the next transmission call; or if the
  *        peer disconnected...); can be NULL
- * @param cont_cls closure for cont
+ * @param cont_cls closure for @a cont
  * @return number of bytes used (on the physical network, with overheads);
  *         -1 on hard errors (i.e. address invalid); 0 is a legal value
  *         and does NOT mean that the message was not transmitted (DV)
@@ -894,9 +962,6 @@ unix_plugin_send (void *cls,
   struct UNIXMessage *message;
   int ssize;
 
-  GNUNET_assert (NULL != plugin);
-  GNUNET_assert (NULL != session);
-
   if (GNUNET_OK !=
       GNUNET_CONTAINER_multipeermap_contains_value (plugin->session_map,
                                                    &session->target,
@@ -921,8 +986,8 @@ unix_plugin_send (void *cls,
   memcpy (&message->sender, plugin->env->my_identity,
           sizeof (struct GNUNET_PeerIdentity));
   memcpy (&message[1], msgbuf, msgbuf_size);
-  reschedule_session_timeout (session);
-  wrapper = GNUNET_malloc (sizeof (struct UNIXMessageWrapper));
+
+  wrapper = GNUNET_new (struct UNIXMessageWrapper);
   wrapper->msg = message;
   wrapper->msgsize = ssize;
   wrapper->payload = msgbuf_size;
@@ -952,7 +1017,7 @@ unix_plugin_send (void *cls,
  * @param sender from which peer the message was received
  * @param currhdr pointer to the header of the message
  * @param ua address to look for
- * @param ua_len length of the address
+ * @param ua_len length of the address @a ua
  */
 static void
 unix_demultiplexer (struct Plugin *plugin, struct GNUNET_PeerIdentity *sender,
@@ -963,9 +1028,7 @@ unix_demultiplexer (struct Plugin *plugin, struct GNUNET_PeerIdentity *sender,
   struct GNUNET_HELLO_Address * addr;
 
   GNUNET_break (ntohl(plugin->ats_network.value) != GNUNET_ATS_NET_UNSPECIFIED);
-
   GNUNET_assert (ua_len >= sizeof (struct UnixAddress));
-
   LOG (GNUNET_ERROR_TYPE_DEBUG,
        "Received message from %s\n",
        unix_address_to_string(NULL, ua, ua_len));
@@ -1041,19 +1104,18 @@ unix_plugin_select_read (struct Plugin *plugin)
   }
   else
   {
-#if LINUX
-    un.sun_path[0] = '/';
-#endif
-    LOG (GNUNET_ERROR_TYPE_DEBUG, "Read %d bytes from socket %s\n", ret,
-                &un.sun_path[0]);
+    LOG (GNUNET_ERROR_TYPE_DEBUG,
+        "Read %d bytes from socket %s\n",
+        (int) ret,
+        un.sun_path);
   }
 
   GNUNET_assert (AF_UNIX == (un.sun_family));
-  ua_len = sizeof (struct UnixAddress) + strlen (&un.sun_path[0]) +1;
+  ua_len = sizeof (struct UnixAddress) + strlen (un.sun_path) + 1;
   ua = GNUNET_malloc (ua_len);
   ua->addrlen = htonl (strlen (&un.sun_path[0]) +1);
   ua->options = htonl (0);
-  memcpy (&ua[1], &un.sun_path[0], strlen (&un.sun_path[0]) +1);
+  memcpy (&ua[1], &un.sun_path[0], strlen (un.sun_path) + 1);
 
   msg = (struct UNIXMessage *) buf;
   csize = ntohs (msg->header.size);
@@ -1232,7 +1294,7 @@ unix_plugin_select (void *cls,
  * Create a slew of UNIX sockets.  If possible, use IPv6 and IPv4.
  *
  * @param cls closure for server start, should be a struct Plugin *
- * @return number of sockets created or GNUNET_SYSERR on error
+ * @return number of sockets created or #GNUNET_SYSERR on error
  */
 static int
 unix_transport_server_start (void *cls)
@@ -1250,8 +1312,8 @@ unix_transport_server_start (void *cls)
     GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "socket");
     return GNUNET_SYSERR;
   }
-  if (GNUNET_NETWORK_socket_bind (plugin->unix_sock.desc, (const struct sockaddr *)  un, un_len, 0)
-      != GNUNET_OK)
+  if (GNUNET_OK !=
+      GNUNET_NETWORK_socket_bind (plugin->unix_sock.desc, (const struct sockaddr *)  un, un_len))
   {
     GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "bind");
     GNUNET_NETWORK_socket_close (plugin->unix_sock.desc);
@@ -1273,55 +1335,6 @@ unix_transport_server_start (void *cls)
 }
 
 
-/**
- * Function called for a quick conversion of the binary address to
- * a numeric address.  Note that the caller must not free the
- * address and that the next call to this function is allowed
- * to override the address again.
- *
- * @param cls closure
- * @param addr binary address
- * @param addrlen length of the address
- * @return string representing the same address
- */
-static const char *
-unix_address_to_string (void *cls, const void *addr, size_t addrlen)
-{
-  static char rbuf[1024];
-  struct UnixAddress *ua = (struct UnixAddress *) addr;
-  char *addrstr;
-  size_t addr_str_len;
-
-  if ((NULL == addr) || (sizeof (struct UnixAddress) > addrlen))
-  {
-    GNUNET_break(0);
-    return NULL ;
-  }
-  addrstr = (char *) &ua[1];
-  addr_str_len = ntohl (ua->addrlen);
-
-  if (addr_str_len != addrlen - sizeof(struct UnixAddress))
-  {
-    GNUNET_break(0);
-    return NULL ;
-  }
-
-  if ('\0' != addrstr[addr_str_len - 1])
-  {
-    GNUNET_break(0);
-    return NULL ;
-  }
-  if (strlen (addrstr) + 1 != addr_str_len)
-  {
-    GNUNET_break(0);
-    return NULL ;
-  }
-
-  GNUNET_snprintf (rbuf, sizeof(rbuf), "%s.%u.%s", PLUGIN_NAME,
-      ntohl (ua->options), addrstr);
-  return rbuf;
-}
-
 /**
  * Function that will be called to check if a binary address for this
  * plugin is well-formed and corresponds to an address for THIS peer
@@ -1341,10 +1354,10 @@ unix_address_to_string (void *cls, const void *addr, size_t addrlen)
 static int
 unix_check_address (void *cls, const void *addr, size_t addrlen)
 {
-       struct Plugin* plugin = cls;
-       struct UnixAddress *ua = (struct UnixAddress *) addr;
-       char *addrstr;
-       size_t addr_str_len;
+  struct Plugin* plugin = cls;
+  struct UnixAddress *ua = (struct UnixAddress *) addr;
+  char *addrstr;
+  size_t addr_str_len;
 
   if ((NULL == addr) || (0 == addrlen) || (sizeof (struct UnixAddress) > addrlen))
   {
@@ -1378,11 +1391,11 @@ unix_check_address (void *cls, const void *addr, size_t addrlen)
  * @param type name of the transport that generated the address
  * @param addr one of the addresses of the host, NULL for the last address
  *        the specific address format depends on the transport
- * @param addrlen length of the address
+ * @param addrlen length of the @a addr
  * @param numeric should (IP) addresses be displayed in numeric form?
  * @param timeout after how long should we give up?
  * @param asc function to call on each string
- * @param asc_cls closure for asc
+ * @param asc_cls closure for @a asc
  */
 static void
 unix_plugin_address_pretty_printer (void *cls, const char *type,
@@ -1415,17 +1428,18 @@ unix_plugin_address_pretty_printer (void *cls, const char *type,
  *
  * @param cls closure ('struct Plugin*')
  * @param addr string address
- * @param addrlen length of the address (strlen(addr) + '\0')
+ * @param addrlen length of the @a addr (strlen(addr) + '\0')
  * @param buf location to store the buffer
- *        If the function returns GNUNET_SYSERR, its contents are undefined.
+ *        If the function returns #GNUNET_SYSERR, its contents are undefined.
  * @param added length of created address
- * @return GNUNET_OK on success, GNUNET_SYSERR on failure
+ * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
  */
 static int
-unix_string_to_address (void *cls, const char *addr, uint16_t addrlen,
-    void **buf, size_t *added)
+unix_string_to_address (void *cls,
+                        const char *addr, uint16_t addrlen,
+                        void **buf, size_t *added)
 {
-       struct UnixAddress *ua;
+  struct UnixAddress *ua;
   char *address;
   char *plugin;
   char *optionstr;
@@ -1461,7 +1475,7 @@ unix_string_to_address (void *cls, const char *addr, uint16_t addrlen,
     return GNUNET_SYSERR;
   }
   optionstr[0] = '\0';
-  optionstr ++;
+  optionstr++;
   options = atol (optionstr);
   address = strchr (optionstr, '.');
   if (NULL == address)
@@ -1471,7 +1485,7 @@ unix_string_to_address (void *cls, const char *addr, uint16_t addrlen,
     return GNUNET_SYSERR;
   }
   address[0] = '\0';
-  address ++;
+  address++;
   if (0 != strcmp(plugin, PLUGIN_NAME))
   {
     GNUNET_break (0);
@@ -1544,19 +1558,20 @@ reschedule_session_timeout (struct Session *s)
 /**
  * Function called on sessions to disconnect
  *
- * @param cls the plugin (unused)
+ * @param cls the plugin
  * @param key peer identity (unused)
  * @param value the 'struct Session' to disconnect
- * @return GNUNET_YES (always, continue to iterate)
+ * @return #GNUNET_YES (always, continue to iterate)
  */
 static int
 get_session_delete_it (void *cls,
                       const struct GNUNET_PeerIdentity *key,
                       void *value)
 {
+  struct Plugin *plugin = cls;
   struct Session *s = value;
 
-  disconnect_session (s);
+  unix_session_disconnect (plugin, s);
   return GNUNET_YES;
 }
 
@@ -1569,8 +1584,8 @@ get_session_delete_it (void *cls,
  * @return #GNUNET_OK on success, #GNUNET_SYSERR if the operation failed
  */
 static void
-unix_disconnect (void *cls,
-                const struct GNUNET_PeerIdentity *target)
+unix_peer_disconnect (void *cls,
+                      const struct GNUNET_PeerIdentity *target)
 {
   struct Plugin *plugin = cls;
 
@@ -1601,7 +1616,7 @@ libgnunet_plugin_transport_unix_init (void *cls)
   {
     /* run in 'stub' mode (i.e. as part of gnunet-peerinfo), don't fully
        initialze the plugin or the API */
-    api = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_PluginFunctions));
+    api = GNUNET_new (struct GNUNET_TRANSPORT_PluginFunctions);
     api->cls = NULL;
     api->address_pretty_printer = &unix_plugin_address_pretty_printer;
     api->address_to_string = &unix_address_to_string;
@@ -1612,7 +1627,7 @@ libgnunet_plugin_transport_unix_init (void *cls)
       GNUNET_CONFIGURATION_get_value_number (env->cfg, "transport-unix", "PORT",
                                              &port))
     port = UNIX_NAT_DEFAULT_PORT;
-  plugin = GNUNET_malloc (sizeof (struct Plugin));
+  plugin = GNUNET_new (struct Plugin);
   plugin->port = port;
   plugin->env = env;
   GNUNET_asprintf (&plugin->unix_socket_path,
@@ -1622,17 +1637,20 @@ libgnunet_plugin_transport_unix_init (void *cls)
   /* Initialize my flags */
   myoptions = 0;
 
-  api = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_PluginFunctions));
+  api = GNUNET_new (struct GNUNET_TRANSPORT_PluginFunctions);
   api->cls = plugin;
 
   api->get_session = &unix_plugin_get_session;
   api->send = &unix_plugin_send;
-  api->disconnect = &unix_disconnect;
+  api->disconnect_peer = &unix_peer_disconnect;
+  api->disconnect_session = &unix_session_disconnect;
+  api->query_keepalive_factor = &unix_query_keepalive_factor;
   api->address_pretty_printer = &unix_plugin_address_pretty_printer;
   api->address_to_string = &unix_address_to_string;
   api->check_address = &unix_check_address;
   api->string_to_address = &unix_string_to_address;
   api->get_network = &unix_get_network;
+  api->update_session_timeout = &unix_plugin_update_session_timeout;
   sockets_created = unix_transport_server_start (plugin);
   if (0 == sockets_created)
     LOG (GNUNET_ERROR_TYPE_WARNING,