Changeset 4687a26c in mainline for uspace/lib/net/tl/tl_common.c

Timestamp:

2010-11-02T18:29:01Z (13 years ago)

Author:

Jakub Jermar <jakub@…>

Branches:

lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export

Children:

4f35b9ff

Parents:

76e1121f (diff), 28f4adb (diff)
Note: this is a merge changeset, the changes displayed below correspond to the merge itself.
Use the (diff) links above to see all the changes relative to each parent.

Message:

Merge mainline changes.

File:

• uspace/lib/net/tl/tl_common.c (modified) (6 diffs)

uspace/lib/net/tl/tl_common.c

@@ -27 +27 @@
  */
 
-/** @addtogroup net_tl
- *  @{
+/** @addtogroup libnet 
+ * @{
  */
 
 /** @file
- *  Transport layer common functions implementation.
- *  @see tl_common.h
- */
+ * Transport layer common functions implementation.
+ * @see tl_common.h
+ */
+
+#include <tl_common.h>
+#include <packet_client.h>
+#include <packet_remote.h>
+#include <icmp_interface.h>
+#include <ip_remote.h>
+#include <ip_interface.h>
+#include <tl_interface.h>
+
+#include <net/socket_codes.h>
+#include <net/in.h>
+#include <net/in6.h>
+#include <net/inet.h>
+#include <net/device.h>
+#include <net/packet.h>
 
 #include <async.h>
 #include <ipc/services.h>
-
-#include <net_err.h>
-#include <packet/packet.h>
-#include <packet/packet_client.h>
-#include <packet_remote.h>
-#include <net_device.h>
-#include <icmp_interface.h>
-#include <in.h>
-#include <in6.h>
-#include <inet.h>
-#include <ip_local.h>
-#include <ip_remote.h>
-#include <socket_codes.h>
-#include <socket_errno.h>
-#include <ip_interface.h>
-#include <tl_interface.h>
-#include <tl_common.h>
+#include <errno.h>
+#include <err.h>
 
 DEVICE_MAP_IMPLEMENT(packet_dimensions, packet_dimension_t);
 
-int tl_get_address_port(const struct sockaddr * addr, int addrlen, uint16_t * port){
-        const struct sockaddr_in * address_in;
-        const struct sockaddr_in6 * address_in6;
-
-        if((addrlen <= 0) || ((size_t) addrlen < sizeof(struct sockaddr))){
-                return EINVAL;
-        }
-        switch(addr->sa_family){
-                case AF_INET:
-                        if(addrlen != sizeof(struct sockaddr_in)){
-                                return EINVAL;
-                        }
-                        address_in = (struct sockaddr_in *) addr;
-                        *port = ntohs(address_in->sin_port);
-                        break;
-                case AF_INET6:
-                        if(addrlen != sizeof(struct sockaddr_in6)){
-                                return EINVAL;
-                        }
-                        address_in6 = (struct sockaddr_in6 *) addr;
-                        *port = ntohs(address_in6->sin6_port);
-                        break;
-                default:
-                        return EAFNOSUPPORT;
-        }
+/** Gets the address port.
+ *
+ * Supports AF_INET and AF_INET6 address families.
+ *
+ * @param[in,out] addr  The address to be updated.
+ * @param[in] addrlen   The address length.
+ * @param[out] port     The set port.
+ * @returns             EOK on success.
+ * @returns             EINVAL if the address length does not match the address
+ *                      family.
+ * @returns             EAFNOSUPPORT if the address family is not supported.
+ */
+int
+tl_get_address_port(const struct sockaddr *addr, int addrlen, uint16_t *port)
+{
+        const struct sockaddr_in *address_in;
+        const struct sockaddr_in6 *address_in6;
+
+        if ((addrlen <= 0) || ((size_t) addrlen < sizeof(struct sockaddr)))
+                return EINVAL;
+
+        switch (addr->sa_family) {
+        case AF_INET:
+                if (addrlen != sizeof(struct sockaddr_in))
+                        return EINVAL;
+
+                address_in = (struct sockaddr_in *) addr;
+                *port = ntohs(address_in->sin_port);
+                break;
+        
+        case AF_INET6:
+                if (addrlen != sizeof(struct sockaddr_in6))
+                        return EINVAL;
+
+                address_in6 = (struct sockaddr_in6 *) addr;
+                *port = ntohs(address_in6->sin6_port);
+                break;
+        
+        default:
+                return EAFNOSUPPORT;
+        }
+
         return EOK;
 }
@@ -91 +108 @@
  * The reply is cached then.
  *
- * @param[in]  ip_phone          The IP moduel phone for (semi)remote calls.
- * @param[in]  packet_dimensions The packet dimensions cache.
- * @param[in]  device_id         The device identifier.
- * @param[out] packet_dimension  The IP packet dimensions.
- *
- * @return EOK on success.
- * @return EBADMEM if the packet_dimension parameter is NULL.
- * @return ENOMEM if there is not enough memory left.
- * @return EINVAL if the packet_dimensions cache is not valid.
- * @return Other codes as defined for the ip_packet_size_req() function.
- *
- */
-int tl_get_ip_packet_dimension(int ip_phone,
+ * @param[in] ip_phone  The IP moduel phone for (semi)remote calls.
+ * @param[in] packet_dimensions The packet dimensions cache.
+ * @param[in] device_id The device identifier.
+ * @param[out] packet_dimension The IP packet dimensions.
+ * @return              EOK on success.
+ * @return              EBADMEM if the packet_dimension parameter is NULL.
+ * @return              ENOMEM if there is not enough memory left.
+ * @return              EINVAL if the packet_dimensions cache is not valid.
+ * @return              Other codes as defined for the ip_packet_size_req()
+ *                      function.
+ */
+int
+tl_get_ip_packet_dimension(int ip_phone,
     packet_dimensions_ref packet_dimensions, device_id_t device_id,
     packet_dimension_ref *packet_dimension)
@@ -112 +129 @@
                 return EBADMEM;
         
-        *packet_dimension = packet_dimensions_find(packet_dimensions, device_id);
+        *packet_dimension = packet_dimensions_find(packet_dimensions,
+            device_id);
         if (!*packet_dimension) {
                 /* Ask for and remember them if not found */
@@ -136 +154 @@
 }
 
-int tl_update_ip_packet_dimension(packet_dimensions_ref packet_dimensions, device_id_t device_id, size_t content){
+/** Updates IP device packet dimensions cache.
+ *
+ * @param[in,out] packet_dimensions The packet dimensions cache.
+ * @param[in] device_id The device identifier.
+ * @param[in] content   The new maximum content size.
+ * @returns             EOK on success.
+ * @return              ENOENT if the packet dimension is not cached.
+ */
+int
+tl_update_ip_packet_dimension(packet_dimensions_ref packet_dimensions,
+    device_id_t device_id, size_t content)
+{
         packet_dimension_ref packet_dimension;
 
         packet_dimension = packet_dimensions_find(packet_dimensions, device_id);
-        if(! packet_dimension){
+        if (!packet_dimension)
                 return ENOENT;
-        }
+
         packet_dimension->content = content;
-        if(device_id != DEVICE_INVALID_ID){
-                packet_dimension = packet_dimensions_find(packet_dimensions, DEVICE_INVALID_ID);
-                if(packet_dimension){
-                        if(packet_dimension->content >= content){
+
+        if (device_id != DEVICE_INVALID_ID) {
+                packet_dimension = packet_dimensions_find(packet_dimensions,
+                    DEVICE_INVALID_ID);
+
+                if (packet_dimension) {
+                        if (packet_dimension->content >= content)
                                 packet_dimension->content = content;
-                        }else{
-                                packet_dimensions_exclude(packet_dimensions, DEVICE_INVALID_ID);
-                        }
+                        else
+                                packet_dimensions_exclude(packet_dimensions,
+                                    DEVICE_INVALID_ID);
                 }
         }
+
         return EOK;
 }
 
-int tl_set_address_port(struct sockaddr * addr, int addrlen, uint16_t port){
-        struct sockaddr_in * address_in;
-        struct sockaddr_in6 * address_in6;
+/** Sets the address port.
+ *
+ * Supports AF_INET and AF_INET6 address families.
+ *
+ * @param[in,out] addr  The address to be updated.
+ * @param[in] addrlen   The address length.
+ * @param[in] port      The port to be set.
+ * @returns             EOK on success.
+ * @returns             EINVAL if the address length does not match the address
+ *                      family.
+ * @returns             EAFNOSUPPORT if the address family is not supported.
+ */
+int tl_set_address_port(struct sockaddr * addr, int addrlen, uint16_t port)
+{
+        struct sockaddr_in *address_in;
+        struct sockaddr_in6 *address_in6;
         size_t length;
 
-        if(addrlen < 0){
-                return EINVAL;
-        }
+        if (addrlen < 0)
+                return EINVAL;
+        
         length = (size_t) addrlen;
-        if(length < sizeof(struct sockaddr)){
-                return EINVAL;
-        }
-        switch(addr->sa_family){
-                case AF_INET:
-                        if(length != sizeof(struct sockaddr_in)){
+        if (length < sizeof(struct sockaddr))
+                return EINVAL;
+
+        switch (addr->sa_family) {
+        case AF_INET:
+                if (length != sizeof(struct sockaddr_in))
+                        return EINVAL;
+                address_in = (struct sockaddr_in *) addr;
+                address_in->sin_port = htons(port);
+                return EOK;
+        
+        case AF_INET6:
+                if (length != sizeof(struct sockaddr_in6))
                                 return EINVAL;
-                        }
-                        address_in = (struct sockaddr_in *) addr;
-                        address_in->sin_port = htons(port);
-                        return EOK;
-                case AF_INET6:
-                        if(length != sizeof(struct sockaddr_in6)){
-                                return EINVAL;
-                        }
-                        address_in6 = (struct sockaddr_in6 *) addr;
-                        address_in6->sin6_port = htons(port);
-                        return EOK;
-                default:
-                        return EAFNOSUPPORT;
-        }
-}
-
-int tl_prepare_icmp_packet(int packet_phone, int icmp_phone, packet_t packet, services_t error){
+                address_in6 = (struct sockaddr_in6 *) addr;
+                address_in6->sin6_port = htons(port);
+                return EOK;
+        
+        default:
+                return EAFNOSUPPORT;
+        }
+}
+
+/** Prepares the packet for ICMP error notification.
+ *
+ * Keeps the first packet and releases all the others.
+ * Releases all the packets on error.
+ *
+ * @param[in] packet_phone The packet server module phone.
+ * @param[in] icmp_phone The ICMP module phone.
+ * @param[in] packet    The packet to be send.
+ * @param[in] error     The packet error reporting service. Prefixes the
+ *                      received packet.
+ * @returns             EOK on success.
+ * @returns             ENOENT if no packet may be sent.
+ */
+int
+tl_prepare_icmp_packet(int packet_phone, int icmp_phone, packet_t packet,
+    services_t error)
+{
         packet_t next;
-        uint8_t * src;
+        uint8_t *src;
         int length;
 
@@ -200 +262 @@
         
         length = packet_get_addr(packet, &src, NULL);
-        if((length > 0)
-                && (! error)
-                && (icmp_phone >= 0)
-        // set both addresses to the source one (avoids the source address deletion before setting the destination one)
-                && (packet_set_addr(packet, src, src, (size_t) length) == EOK)){
+        if ((length > 0) && (!error) && (icmp_phone >= 0) &&
+            // set both addresses to the source one (avoids the source address
+            // deletion before setting the destination one)
+            (packet_set_addr(packet, src, src, (size_t) length) == EOK)) {
                 return EOK;
-        }else{
+        } else
                 pq_release_remote(packet_phone, packet_get_id(packet));
-        }
+
         return ENOENT;
 }
 
-int tl_socket_read_packet_data(int packet_phone, packet_ref packet, size_t prefix, const packet_dimension_ref dimension, const struct sockaddr * addr, socklen_t addrlen){
+/** Receives data from the socket into a packet.
+ *
+ * @param[in] packet_phone The packet server module phone.
+ * @param[out] packet   The new created packet.
+ * @param[in] prefix    Reserved packet data prefix length.
+ * @param[in] dimension The packet dimension.
+ * @param[in] addr      The destination address.
+ * @param[in] addrlen   The address length.
+ * @returns             Number of bytes received.
+ * @returns             EINVAL if the client does not send data.
+ * @returns             ENOMEM if there is not enough memory left.
+ * @returns             Other error codes as defined for the
+ *                      async_data_read_finalize() function.
+ */
+int
+tl_socket_read_packet_data(int packet_phone, packet_ref packet, size_t prefix,
+    const packet_dimension_ref dimension, const struct sockaddr *addr,
+    socklen_t addrlen)
+{
         ERROR_DECLARE;
 
@@ -219 +298 @@
         void * data;
 
-        if(! dimension){
-                return EINVAL;
-        }
+        if (!dimension)
+                return EINVAL;
+
         // get the data length
-        if(! async_data_write_receive(&callid, &length)){
-                return EINVAL;
-        }
+        if (!async_data_write_receive(&callid, &length))
+                return EINVAL;
+
         // get a new packet
-        *packet = packet_get_4_remote(packet_phone, length, dimension->addr_len, prefix + dimension->prefix, dimension->suffix);
-        if(! packet){
+        *packet = packet_get_4_remote(packet_phone, length, dimension->addr_len,
+            prefix + dimension->prefix, dimension->suffix);
+        if (!packet)
                 return ENOMEM;
-        }
+
         // allocate space in the packet
         data = packet_suffix(*packet, length);
-        if(! data){
+        if (!data) {
                 pq_release_remote(packet_phone, packet_get_id(*packet));
                 return ENOMEM;
         }
+
         // read the data into the packet
-        if(ERROR_OCCURRED(async_data_write_finalize(callid, data, length))
-        // set the packet destination address
-                || ERROR_OCCURRED(packet_set_addr(*packet, NULL, (uint8_t *) addr, addrlen))){
+        if (ERROR_OCCURRED(async_data_write_finalize(callid, data, length)) ||
+            // set the packet destination address
+            ERROR_OCCURRED(packet_set_addr(*packet, NULL, (uint8_t *) addr,
+            addrlen))) {
                 pq_release_remote(packet_phone, packet_get_id(*packet));
                 return ERROR_CODE;
         }
+
         return (int) length;
 }