Subversion Repositories HelenOS

Rev

Rev 3901 | Rev 4163 | Go to most recent revision | Blame | Compare with Previous | Last modification | View Log | Download | RSS feed

  1. /*
  2.  * Copyright (c) 2009 Lukas Mejdrech
  3.  * All rights reserved.
  4.  *
  5.  * Redistribution and use in source and binary forms, with or without
  6.  * modification, are permitted provided that the following conditions
  7.  * are met:
  8.  *
  9.  * - Redistributions of source code must retain the above copyright
  10.  *   notice, this list of conditions and the following disclaimer.
  11.  * - Redistributions in binary form must reproduce the above copyright
  12.  *   notice, this list of conditions and the following disclaimer in the
  13.  *   documentation and/or other materials provided with the distribution.
  14.  * - The name of the author may not be used to endorse or promote products
  15.  *   derived from this software without specific prior written permission.
  16.  *
  17.  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18.  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20.  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21.  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22.  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23.  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24.  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25.  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26.  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27.  */
  28.  
  29. /** @addtogroup arp
  30.  *  @{
  31.  */
  32.  
  33. /** @file
  34.  *  ARP module implementation.
  35.  *  @see arp.h
  36.  */
  37.  
  38. #include <as.h>
  39. #include <async.h>
  40. #include <malloc.h>
  41. #include <stdio.h>
  42. #include <string.h>
  43.  
  44. #include <ipc/ipc.h>
  45. #include <ipc/services.h>
  46.  
  47. #include "../../err.h"
  48. #include "../../messages.h"
  49. #include "../../modules.h"
  50.  
  51. #include "../../include/protocol_map.h"
  52. #include "../../netif/device.h"
  53.  
  54. #include "../../structures/measured_strings.h"
  55. #include "../../structures/packet/packet.h"
  56. #include "../../structures/packet/packet_client.h"
  57.  
  58. #include "arp.h"
  59. #include "arp_header.h"
  60. #include "arp_oc.h"
  61. //#include "arp_messages.h"
  62. #include "arp_module.h"
  63.  
  64. /** Returns the device identifier message parameter.
  65.  */
  66. #define IPC_GET_DEVICE( call )      ( device_id_t ) IPC_GET_ARG1( * call )
  67.  
  68. /** Returns the packet identifier message parameter.
  69.  */
  70. #define IPC_GET_PACKET( call )      ( packet_id_t ) IPC_GET_ARG2( * call )
  71.  
  72. /** Returns the protocol service message parameter.
  73.  */
  74. #define IPC_GET_PROTO( call )       ( services_t ) IPC_GET_ARG2( * call )
  75.  
  76. /** Returns the device driver service message parameter.
  77.  */
  78. #define IPC_GET_SERVICE( call )     ( services_t ) IPC_GET_ARG3( * call )
  79.  
  80. /** ARP global data.
  81.  */
  82. arp_globals_t   arp_globals;
  83.  
  84. /** Creates new protocol specific data.
  85.  *  @param proto Protocol specific data. Output parameter.
  86.  *  @param service Protocol module service. Input parameter.
  87.  *  @param address Actual protocol device address. Input parameter.
  88.  *  @returns EOK on success.
  89.  *  @returns ENOMEM if there is not enough memory left.
  90.  */
  91. int arp_proto_create( arp_proto_ref * proto, services_t service, measured_string_ref address );
  92.  
  93. /** Registers the device.
  94.  *  Creates new device entry in the cache or updates the protocol address if the device with the device identifier and the driver service exists.
  95.  *  @param device_id The device identifier. Input parameter.
  96.  *  @param service The device driver service. Input parameter.
  97.  *  @param protocol The protocol service. Input parameter.
  98.  *  @param address The actual device protocol address.
  99.  *  @returns EOK on success.
  100.  *  @returns EEXIST if another device with the same device identifier and different driver service exists.
  101.  *  @returns ENOMEM if there is not enough memory left.
  102.  *  @returns Other error codes as defined for the measured_strings_return() function.
  103.  */
  104. int arp_device_message( device_id_t device_id, services_t service, services_t protocol, measured_string_ref address );
  105.  
  106. /** Returns the hardware address for the given protocol address.
  107.  *  Sends the ARP request packet if the hardware address is not found in the cache.
  108.  *  @param device_id The device identifier. Input parameter.
  109.  *  @param protocol The protocol service. Input parameter.
  110.  *  @param target The target protocol address. Input parameter.
  111.  *  @returns The hardware address of the target.
  112.  *  @returns NULL if the target parameter is NULL.
  113.  *  @returns NULL if the device is not found.
  114.  *  @returns NULL if the device packet is too small to send a&nbsp;request.
  115.  *  @returns NULL if the hardware address is not found in the cache.
  116.  */
  117. measured_string_ref arp_translate_message( device_id_t device_id, services_t protocol, measured_string_ref target );
  118.  
  119. /** Processes the received ARP packet.
  120.  *  Updates the source hardware address if the source entry exists or the packet is targeted to my protocol address.
  121.  *  Responses to the ARP request if the packet is the ARP request and is targeted to my address.
  122.  *  @param device_id The source device identifier. Input parameter.
  123.  *  @param packet The received packet. Input/output parameter.
  124.  *  @returns EOK on success.
  125.  *  @returns EINVAL if the packet is too small to carry the ARP packet.
  126.  *  @returns EINVAL if the received address lengths differs from the registered values.
  127.  *  @returns ENOENT if the device is not found in the cache.
  128.  *  @returns ENOENT if the protocol for the device is not found in the cache.
  129.  *  @returns ENOMEM if there is not enough memory left.
  130.  */
  131. int arp_receive_message( device_id_t device_id, packet_t packet );
  132.  
  133. /** Clears the device specific data from the cache.
  134.  *  @param device_id The device identifier. Input parameter.
  135.  *  @returns EOK on success.
  136.  *  @returns ENOENT  if the device is not found in the cache.
  137.  */
  138. int arp_clear_device_message( device_id_t device_id );
  139.  
  140. /** Clears the device specific data.
  141.  *  @param device The device specific data.
  142.  */
  143. void    clear_device( arp_device_ref device );
  144.  
  145. /** Clears the whole cache.
  146.  *  @returns EOK on success.
  147.  */
  148. int arp_clean_cache_message( void );
  149.  
  150. /** Processes IPC messages from the registered device driver modules in an infinite loop.
  151.  *  @param iid The message identifier. Input parameter.
  152.  *  @param icall The message parameters. Input/output parameter.
  153.  */
  154. void    arp_receiver( ipc_callid_t iid, ipc_call_t * icall );
  155.  
  156. DEVICE_MAP_IMPLEMENT( arp_cache, arp_device_t )
  157.  
  158. INT_MAP_IMPLEMENT( arp_protos, arp_proto_t )
  159.  
  160. GENERIC_CHAR_MAP_IMPLEMENT( arp_addr, measured_string_t )
  161.  
  162. int arp_initialize( void ){
  163.     return arp_cache_initialize( & arp_globals.cache );
  164. }
  165.  
  166. int arp_proto_create( arp_proto_ref * proto, services_t service, measured_string_ref address ){
  167.     ERROR_DECLARE;
  168.  
  169.     * proto = ( arp_proto_ref ) malloc( sizeof( arp_proto_t ));
  170.     if( !( * proto )) return ENOMEM;
  171.     ( ** proto ).service = service;
  172.     ( ** proto ).addr = address;
  173.     ( ** proto ).addr_data = address->value;
  174.     if( ERROR_OCCURRED( arp_addr_initialize( &( ** proto).addresses ))){
  175.         free( * proto );
  176.         return ERROR_CODE;
  177.     }
  178.     return EOK;
  179. }
  180.  
  181. int arp_device_message( device_id_t device_id, services_t service, services_t protocol, measured_string_ref address ){
  182.     ERROR_DECLARE;
  183.  
  184.     arp_device_ref  device;
  185.     aid_t           message;
  186.     ipc_call_t      answer;
  187.     ipcarg_t        result;
  188.     arp_proto_ref   proto;
  189.  
  190.     // an existing device?
  191.     device = arp_cache_find( & arp_globals.cache, device_id );
  192.     if( device ){
  193.         if( device->service != service ) return EEXIST;
  194.         proto = arp_protos_find( & device->protos, protocol );
  195.         if( proto ){
  196.             free( proto->addr );
  197.             free( proto->addr_data );
  198.             proto->addr = address;
  199.             proto->addr_data = address->value;
  200.         }else{
  201.             ERROR_PROPAGATE( arp_proto_create( & proto, protocol, address ));
  202.             if( ERROR_OCCURRED( arp_protos_add( & device->protos, proto->service, proto ))){
  203.                 free( proto );
  204.                 return ERROR_CODE;
  205.             }
  206.         }
  207.         return EOK;
  208.     }else{
  209.         // create a new device
  210.         device = ( arp_device_ref ) malloc( sizeof( arp_device_t ));
  211.         if( ! device ) return ENOMEM;
  212.         device->device_id = device_id;
  213.         if( ERROR_OCCURRED( arp_protos_initialize( & device->protos ))
  214.         || ERROR_OCCURRED( arp_proto_create( & proto, protocol, address ))){
  215.             free( device );
  216.             return ERROR_CODE;
  217.         }
  218.         if( ERROR_OCCURRED( arp_protos_add( & device->protos, proto->service, proto ))){
  219.             arp_protos_destroy( & device->protos );
  220.             free( device );
  221.             return ERROR_CODE;
  222.         }
  223.         device->service = service;
  224.         // bind the new one
  225.         device->phone = bind_service( device->service, device->device_id, SERVICE_ARP, 0, arp_receiver );
  226.         // get packet dimensions
  227.         if( ERROR_OCCURRED( async_req_1_4( device->phone, NET_NIL_PACKET_SPACE, device_id, & device->addr_len, & device->prefix, & device->content, & device->suffix ))){
  228.             arp_protos_destroy( & device->protos );
  229.             free( device );
  230.             return ERROR_CODE;
  231.         }
  232.         // get hardware address
  233.         message = async_send_1( device->phone, NET_NIL_ADDR, device->device_id, & answer );
  234.         if( ERROR_OCCURRED( measured_strings_return( device->phone, & device->addr, & device->addr_data, 1 ))){
  235.             arp_protos_destroy( & device->protos );
  236.             free( device );
  237.             async_wait_for( message, NULL );
  238.             return ERROR_CODE;
  239.         }
  240.         async_wait_for( message, & result );
  241.         if( ERROR_OCCURRED( result )){
  242.             free( device->addr );
  243.             free( device->addr_data );
  244.             arp_protos_destroy( & device->protos );
  245.             free( device );
  246.             return ERROR_CODE;
  247.         }
  248.         // get broadcast address
  249.         message = async_send_1( device->phone, NET_NIL_BROADCAST_ADDR, device->device_id, & answer );
  250.         if( ERROR_OCCURRED( measured_strings_return( device->phone, & device->broadcast_addr, & device->broadcast_data, 1 ))){
  251.             free( device->addr );
  252.             free( device->addr_data );
  253.             arp_protos_destroy( & device->protos );
  254.             free( device );
  255.             async_wait_for( message, NULL );
  256.             return ERROR_CODE;
  257.         }
  258.         async_wait_for( message, & result );
  259.         // add to the cache
  260.         if( ERROR_OCCURRED( result )
  261.         || ERROR_OCCURRED( arp_cache_add( & arp_globals.cache, device->device_id, device ))){
  262.             free( device->addr );
  263.             free( device->addr_data );
  264.             free( device->broadcast_addr );
  265.             free( device->broadcast_data );
  266.             arp_protos_destroy( & device->protos );
  267.             free( device );
  268.             return ERROR_CODE;
  269.         }
  270.     }
  271.     return EOK;
  272. }
  273.  
  274. measured_string_ref arp_translate_message( device_id_t device_id, services_t protocol, measured_string_ref target ){
  275.     arp_device_ref      device;
  276.     arp_proto_ref       proto;
  277.     measured_string_ref addr;
  278.     size_t              length;
  279.     packet_t            packet;
  280.     arp_header_ref      header;
  281.  
  282.     if( ! target ) return NULL;
  283.     device = arp_cache_find( & arp_globals.cache, device_id );
  284.     if( ! device ) return NULL;
  285.     proto = arp_protos_find( & device->protos, protocol );
  286.     if(( ! proto ) || ( proto->addr->length != target->length )) return NULL;
  287.     addr = arp_addr_find( & proto->addresses, target->value, target->length );
  288.     if( addr ) return addr;
  289.     // ARP packet content size = header + ( address + translation ) * 2
  290.     length = 8 + ( CONVERT_SIZE( char, uint8_t, proto->addr->length ) + CONVERT_SIZE( char, uint8_t, device->addr->length )) * 2;
  291.     if( length > device->content ){
  292.         return NULL;
  293.     }
  294.     packet = packet_get_5( arp_globals.networking_phone, SERVICE_ARP, device->addr_len, device->prefix, length, device->suffix );
  295.     if( ! packet ) return NULL;
  296.     header = ( arp_header_ref ) packet_suffix( packet, length );
  297.     header->hardware = device->hardware;
  298.     header->hardware_length = device->addr->length;
  299.     header->protocol = protocol_map( device->service, protocol );
  300.     header->protocol_length = proto->addr->length;
  301.     header->operation = ARPOP_REQUEST;
  302.     length = sizeof( arp_header_t );
  303.     memcpy((( uint8_t * ) header ) + length, device->addr->value, device->addr->length );
  304.     length += device->addr->length;
  305.     memcpy((( uint8_t * ) header ) + length, proto->addr->value, proto->addr->length );
  306.     length += proto->addr->length;
  307.     memset((( uint8_t * ) header ) + length, 0, device->addr->length );
  308.     length += device->addr->length;
  309.     memcpy((( uint8_t * ) header ) + length, target->value, target->length );
  310.     packet_set_addr( packet, ( uint8_t * ) device->addr->value, ( uint8_t * ) device->broadcast_addr->value, CONVERT_SIZE( char, uint8_t, device->addr->length ));
  311.     async_msg_3( device->phone, NET_NETIF_SEND, device_id, SERVICE_ARP, packet_get_id( packet ));
  312.     return NULL;
  313. }
  314.  
  315. int arp_receive_message( device_id_t device_id, packet_t packet ){
  316.     ERROR_DECLARE;
  317.  
  318.     size_t              length;
  319.     arp_header_ref      header;
  320.     arp_device_ref      device;
  321.     arp_proto_ref       proto;
  322. //  arp_addr_ref        addr;
  323.     measured_string_ref hw_source;
  324. /*  measured_string_t   proto_target;
  325.     aid_t               message;
  326.     ipcarg_t            result;
  327.     int                 index;
  328.     ipc_call_t          answer;
  329. */  uint8_t *           src_hw;
  330.     uint8_t *           src_proto;
  331.     uint8_t *           des_hw;
  332.     uint8_t *           des_proto;
  333.  
  334.     length = packet_get_data_length( packet );
  335.     if( length <= sizeof( arp_header_t )) return EINVAL;
  336.     device = arp_cache_find( & arp_globals.cache, device_id );
  337.     if( ! device ) return ENOENT;
  338.     header = ( arp_header_ref ) packet_get_data( packet );
  339.     if( header->hardware != device->hardware ) return EINVAL;
  340.     if( length < sizeof( arp_header_t ) + ( header->hardware_length + header->protocol_length ) * 2 ) return EINVAL;
  341.     proto = arp_protos_find( & device->protos, protocol_unmap( device->service, header->protocol ));
  342.     if( ! proto ) return ENOENT;
  343.     src_hw = (( uint8_t * ) header ) + sizeof( arp_header_t );
  344.     src_proto = src_hw + header->hardware_length;
  345.     des_hw = src_proto + header->protocol_length;
  346.     des_proto = des_hw + header->hardware_length;
  347.     hw_source = arp_addr_find( & proto->addresses, ( char * ) src_proto, CONVERT_SIZE( uint8_t, char, header->protocol_length ));
  348.     // exists?
  349.     if( hw_source ){
  350.         if( hw_source->length != CONVERT_SIZE( uint8_t, char, header->hardware_length )) return EINVAL;
  351.         memcpy( hw_source->value, src_hw, hw_source->length );
  352.     }
  353.     // is my protocol address?
  354.     // TODO query protocol module?
  355. /*  proto_target.value = des_proto;
  356.     proto_target.length = header->protocol_length;
  357.     // TODO send necessary?
  358.     message = async_send_0( proto->phone, NET_IL_MY_ADDR, & answer );
  359.     if( ERROR_OCCURRED( measured_strings_send( device->phone, & proto_target, 1 ))){
  360.         async_wait_for( message, NULL );
  361.         return ERROR_CODE;
  362.     }
  363.     async_wait_for( message, & result );
  364.     if( result == EOK ){
  365. */  if( proto->addr->length != CONVERT_SIZE( uint8_t, char, header->hardware_length )) return EINVAL;
  366.     if( ! strncmp( proto->addr->value, ( char * ) des_proto, proto->addr->length )){
  367.         // not already upadted?
  368.         if( ! hw_source ){
  369.             hw_source = measured_string_create_bulk(( char * ) src_hw, CONVERT_SIZE( uint8_t, char, header->hardware_length ));
  370.             if( ! hw_source ) return ENOMEM;
  371.             ERROR_PROPAGATE( arp_addr_add( & proto->addresses, ( char * ) src_proto, CONVERT_SIZE( uint8_t, char, header->protocol_length ), hw_source ));
  372.         }
  373.         if( header->operation == ARPOP_REQUEST ){
  374.             header->operation = ARPOP_REPLY;
  375. /*          for( index = 0; index + header->hardware_length < header->protocol_length; index += header->hardware_length ){
  376.                 memcpy( src_hw, src_proto + index, header->hardware_length );
  377.                 memcpy( src_proto + index, des_proto + index, header->hardware_length );
  378.                 memcpy( des_proto + index, src_hw, header->hardware_length );
  379.             }
  380.             memcpy( src_hw, src_proto + index, header->hardware_length - header->protocol_length );
  381.             memcpy( src_proto + index, des_proto + index, header->hardware_length - header->protocol_length );
  382.             memcpy( des_proto + index, src_hw, header->hardware_length - header->protocol_length );
  383.             memcpy( src_hw, des_hw, header->hardware_length );
  384.             memcpy( des_hw, hw_source->value, hw_source->length );
  385. */          memcpy( des_proto, src_proto, header->protocol_length );
  386.             memcpy( src_proto, proto->addr->value, header->protocol_length );
  387.             memcpy( src_hw, des_hw, header->hardware_length );
  388.             memcpy( des_hw, hw_source->value, header->hardware_length );
  389.             packet_set_addr( packet, src_hw, des_hw, header->hardware_length );
  390.             async_msg_3( device->phone, NET_NETIF_SEND, device_id, SERVICE_ARP, packet_get_id( packet ));
  391.         }else{
  392.             packet_release( arp_globals.networking_phone, packet_get_id( packet ));
  393.         }
  394.     }
  395.     return EOK;
  396. }
  397.  
  398. int arp_clear_device_message( device_id_t device_id ){
  399.     arp_device_ref  device;
  400.  
  401.     device = arp_cache_find( & arp_globals.cache, device_id );
  402.     if( ! device ) return ENOENT;
  403.     clear_device( device );
  404.     return EOK;
  405. }
  406.  
  407. void clear_device( arp_device_ref device ){
  408.     int             count;
  409.     arp_proto_ref   proto;
  410.  
  411.     count = arp_protos_count( & device->protos );
  412.     while( count > 0 ){
  413.         proto = arp_protos_get_index( & device->protos, count );
  414.         if( proto->addr ) free( proto->addr );
  415.         if( proto->addr_data ) free( proto->addr_data );
  416.         arp_addr_destroy( & proto->addresses );
  417.         -- count;
  418.     }
  419.     arp_protos_clear( & device->protos );
  420. }
  421.  
  422. int arp_clean_cache_message( void ){
  423.     int             count;
  424.     arp_device_ref  device;
  425.  
  426.     count = arp_cache_count( & arp_globals.cache );
  427.     while( count > 0 ){
  428.         device = arp_cache_get_index( & arp_globals.cache, count );
  429.         if( device ){
  430.             clear_device( device );
  431.             if( device->addr_data ) free( device->addr_data );
  432.             if( device->broadcast_data ) free( device->broadcast_data );
  433.         }
  434.     }
  435.     arp_cache_clear( & arp_globals.cache );
  436.     return EOK;
  437. }
  438.  
  439. int arp_message( ipc_callid_t callid, ipc_call_t * call, ipc_call_t * answer, int * answer_count ){
  440.     ERROR_DECLARE;
  441.  
  442.     measured_string_ref address;
  443.     measured_string_ref translation;
  444.     char *              data;
  445.  
  446.     * answer_count = 0;
  447.     switch( IPC_GET_METHOD( * call )){
  448.         case IPC_M_PHONE_HUNGUP:
  449.             return EOK;
  450.         case NET_ARP_DEVICE:
  451.             ERROR_PROPAGATE( measured_strings_receive( & address, & data, 1 ));
  452.             if( ERROR_OCCURRED( arp_device_message( IPC_GET_DEVICE( call ), IPC_GET_SERVICE( call ), IPC_GET_PROTO( call ), address ))){
  453.                 free( address );
  454.                 free( data );
  455.             }
  456.             return ERROR_CODE;
  457.         case NET_ARP_TRANSLATE:
  458.             ERROR_PROPAGATE( measured_strings_receive( & address, & data, 1 ));
  459.             translation = arp_translate_message( IPC_GET_DEVICE( call ), IPC_GET_PROTO( call ), address );
  460.             free( address );
  461.             free( data );
  462.             if( ! translation ) return ENOENT;
  463.             return measured_strings_reply( translation, 1 );
  464.         case NET_ARP_CLEAR_DEVICE:
  465.             return arp_clear_device_message( IPC_GET_DEVICE( call ));
  466.         case NET_ARP_CLEAN_CACHE:
  467.             return arp_clean_cache_message();
  468.     }
  469.     return ENOTSUP;
  470. }
  471.  
  472. void arp_receiver( ipc_callid_t iid, ipc_call_t * icall ){
  473.     ERROR_DECLARE;
  474.  
  475.     packet_t        packet;
  476.  
  477.     while( true ){
  478.         switch( IPC_GET_METHOD( * icall )){
  479.             case NET_IL_DEVICE_STATE:
  480.                 //TODO clear device if off?
  481.                 break;
  482.             case NET_IL_RECEIVED:
  483.                 if( ! ERROR_OCCURRED( packet_translate( arp_globals.networking_phone, & packet, IPC_GET_PACKET( icall )))){
  484.                     ERROR_CODE = arp_receive_message( IPC_GET_DEVICE( icall ), packet );
  485.                 }
  486.                 ipc_answer_0( iid, ERROR_CODE );
  487.                 break;
  488.             default:
  489.                 ipc_answer_0( iid, ENOTSUP );
  490.         }
  491.         iid = async_get_call( icall );
  492.     }
  493. }
  494.  
  495. /** @}
  496.  */
  497.