Subversion Repositories HelenOS

Rev

Rev 4704 | 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 ip
  30.  *  @{
  31.  */
  32.  
  33. /** @file
  34.  *  IP module.
  35.  */
  36.  
  37. #ifndef __NET_IP_H__
  38. #define __NET_IP_H__
  39.  
  40. #include <fibril_sync.h>
  41.  
  42. #include <ipc/ipc.h>
  43. #include <ipc/services.h>
  44.  
  45. #include "../../include/device.h"
  46. #include "../../include/inet.h"
  47. #include "../../include/ip_interface.h"
  48.  
  49. #include "../../structures/int_map.h"
  50. #include "../../structures/generic_field.h"
  51. #include "../../structures/module_map.h"
  52.  
  53. /** Type definition of the IP global data.
  54.  *  @see ip_globals
  55.  */
  56. typedef struct ip_globals   ip_globals_t;
  57.  
  58. /** Type definition of the IP network interface specific data.
  59.  *  @see ip_netif
  60.  */
  61. typedef struct ip_netif ip_netif_t;
  62.  
  63. /** Type definition of the IP network interface specific data pointer.
  64.  *  @see ip_netif
  65.  */
  66. typedef ip_netif_t *    ip_netif_ref;
  67.  
  68. /** Type definition of the IP protocol specific data.
  69.  *  @see ip_proto
  70.  */
  71. typedef struct ip_proto ip_proto_t;
  72.  
  73. /** Type definition of the IP protocol specific data pointer.
  74.  *  @see ip_proto
  75.  */
  76. typedef ip_proto_t *    ip_proto_ref;
  77.  
  78. /** Type definition of the IP route specific data.
  79.  *  @see ip_route
  80.  */
  81. typedef struct ip_route ip_route_t;
  82.  
  83. /** Type definition of the IP route specific data pointer.
  84.  *  @see ip_route
  85.  */
  86. typedef ip_route_t *    ip_route_ref;
  87.  
  88. /** IP network interfaces.
  89.  *  Maps devices to the IP network interface specific data.
  90.  *  @see device.h
  91.  */
  92. DEVICE_MAP_DECLARE( ip_netifs, ip_netif_t )
  93.  
  94. /** IP registered protocols.
  95.  *  Maps protocols to the IP protocol specific data.
  96.  *  @see int_map.h
  97.  */
  98. INT_MAP_DECLARE( ip_protos, ip_proto_t )
  99.  
  100. /** IP routing table.
  101.  *  @see generic_field.h
  102.  */
  103. GENERIC_FIELD_DECLARE( ip_routes, ip_route_t )
  104.  
  105. /** IP network interface specific data.
  106.  */
  107. struct  ip_netif{
  108.     /** Device identifier.
  109.      */
  110.     device_id_t device_id;
  111.     /** Netif module service.
  112.      */
  113.     services_t  service;
  114.     /** Netif module phone.
  115.      */
  116.     int         phone;
  117.     /** ARP module.
  118.      *  Assigned if using ARP.
  119.      */
  120.     module_ref  arp;
  121.     /** IP version.
  122.      */
  123.     int         ipv;
  124.     /** Indicates whether using DHCP.
  125.      */
  126.     int         dhcp;
  127.     /** Indicates whether IP routing is enabled.
  128.      */
  129.     int         routing;
  130.     /** Device state.
  131.      */
  132.     device_state_t  state;
  133.     /** Broadcast address.
  134.      */
  135.     in_addr_t   broadcast;
  136.     /** Routing table.
  137.      */
  138.     ip_routes_t routes;
  139.     /** Reserved packet prefix length.
  140.      */
  141.     size_t              prefix;
  142.     /** Maximal packet content length.
  143.      */
  144.     size_t              content;
  145.     /** Reserved packet suffix length.
  146.      */
  147.     size_t              suffix;
  148.     /** Packet address length.
  149.      *  The hardware address length is used.
  150.      */
  151.     size_t              addr_len;
  152. };
  153.  
  154. /** IP protocol specific data.
  155.  */
  156. struct ip_proto{
  157.     /** Protocol number.
  158.      */
  159.     int protocol;
  160.     /** Protocol module service.
  161.      */
  162.     services_t service;
  163.     /** Protocol module phone.
  164.      */
  165.     int phone;
  166.     /** Protocol packet receiving function.
  167.      */
  168.     tl_received_msg_t received_msg;
  169. };
  170.  
  171. /** IP route specific data.
  172.  */
  173. struct ip_route{
  174.     /** Target address.
  175.      */
  176.     in_addr_t       address;
  177.     /** Target network mask.
  178.      */
  179.     in_addr_t       netmask;
  180.     /** Gateway.
  181.      */
  182.     in_addr_t       gateway;
  183.     /** Parent netif.
  184.      */
  185.     ip_netif_ref    netif;
  186. };
  187.  
  188. /** IP global data.
  189.  */
  190. struct  ip_globals{
  191.     /** Networking module phone.
  192.      */
  193.     int         net_phone;
  194.     /** Registered network interfaces.
  195.      */
  196.     ip_netifs_t netifs;
  197.     /** Netifs safeyt lock.
  198.      */
  199.     fibril_rwlock_t netifs_lock;
  200.     /** Registered protocols.
  201.      */
  202.     ip_protos_t protos;
  203.     /** Protocols safety lock.
  204.      */
  205.     fibril_rwlock_t protos_lock;
  206.     /** Default gateway.
  207.      */
  208.     ip_route_t  gateway;
  209.     /** Known support modules.
  210.      */
  211.     modules_t   modules;
  212.     /** Default client connection function for support modules.
  213.      */
  214.     async_client_conn_t client_connection;
  215.     /** Packet counter.
  216.      */
  217.     uint16_t    packet_counter;
  218.     /** Safety lock.
  219.      */
  220.     fibril_rwlock_t lock;
  221. };
  222.  
  223. #endif
  224.  
  225. /** @}
  226.  */
  227.