Subversion Repositories HelenOS

/*

 * Copyright (c) 2009 Lukas Mejdrech

 * All rights reserved.

 *

 * Redistribution and use in source and binary forms, with or without

 * modification, are permitted provided that the following conditions

 * are met:

 *

 * - Redistributions of source code must retain the above copyright

 *   notice, this list of conditions and the following disclaimer.

 * - Redistributions in binary form must reproduce the above copyright

 *   notice, this list of conditions and the following disclaimer in the

 *   documentation and/or other materials provided with the distribution.

 * - The name of the author may not be used to endorse or promote products

 *   derived from this software without specific prior written permission.

 *

 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR

 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES

 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.

 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,

 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT

 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,

 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY

 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF

 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

 */

/** @addtogroup ip

 *  @{

 */

/** @file

 *  IP module.

 */

#ifndef __NET_IP_H__

#define __NET_IP_H__

#include <fibril_sync.h>

#include <ipc/ipc.h>

#include <ipc/services.h>

#include "../../include/device.h"

#include "../../include/inet.h"

#include "../../include/ip_interface.h"

#include "../../structures/int_map.h"

#include "../../structures/generic_field.h"

#include "../../structures/module_map.h"

/** Type definition of the IP global data.

 *  @see ip_globals

 */

typedef struct ip_globals   ip_globals_t;

/** Type definition of the IP network interface specific data.

 *  @see ip_netif

 */

typedef struct ip_netif ip_netif_t;

/** Type definition of the IP network interface specific data pointer.

 *  @see ip_netif

 */

typedef ip_netif_t *    ip_netif_ref;

/** Type definition of the IP protocol specific data.

 *  @see ip_proto

 */

typedef struct ip_proto ip_proto_t;

/** Type definition of the IP protocol specific data pointer.

 *  @see ip_proto

 */

typedef ip_proto_t *    ip_proto_ref;

/** Type definition of the IP route specific data.

 *  @see ip_route

 */

typedef struct ip_route ip_route_t;

/** Type definition of the IP route specific data pointer.

 *  @see ip_route

 */

typedef ip_route_t *    ip_route_ref;

/** IP network interfaces.

 *  Maps devices to the IP network interface specific data.

 *  @see device.h

 */

DEVICE_MAP_DECLARE( ip_netifs, ip_netif_t )

/** IP registered protocols.

 *  Maps protocols to the IP protocol specific data.

 *  @see int_map.h

 */

INT_MAP_DECLARE( ip_protos, ip_proto_t )

/** IP routing table.

 *  @see generic_field.h

 */

GENERIC_FIELD_DECLARE( ip_routes, ip_route_t )

/** IP network interface specific data.

 */

struct  ip_netif{

    /** Device identifier.

     */

    device_id_t device_id;

    /** Netif module service.

     */

    services_t  service;

    /** Netif module phone.

     */

    int         phone;

    /** ARP module.

     *  Assigned if using ARP.

     */

    module_ref  arp;

    /** IP version.

     */

    int         ipv;

    /** Indicates whether using DHCP.

     */

    int         dhcp;

    /** Indicates whether IP routing is enabled.

     */

    int         routing;

    /** Device state.

     */

    device_state_t  state;

    /** Broadcast address.

     */

    in_addr_t   broadcast;

    /** First DNS address.

     */

    in_addr_t   dns1;

    /** Second DNS address.

     */

    in_addr_t   dns2;

    /** Routing table.

     */

    ip_routes_t routes;

    /** Reserved packet prefix length.

     */

    size_t              prefix;

    /** Maximal packet content length.

     */

    size_t              content;

    /** Reserved packet suffix length.

     */

    size_t              suffix;

    /** Packet address length.

     *  The hardware address length is used.

     */

    size_t              addr_len;

};

/** IP protocol specific data.

 */

struct ip_proto{

    /** Protocol number.

     */

    int protocol;

    /** Protocol module service.

     */

    services_t service;

    /** Protocol module phone.

     */

    int phone;

    /** Protocol packet receiving function.

     */

    tl_received_msg_t received_msg;

};

/** IP route specific data.

 */

struct ip_route{

    /** Target address.

     */

    in_addr_t       address;

    /** Target network mask.

     */

    in_addr_t       netmask;

    /** Gateway.

     */

    in_addr_t       gateway;

    /** Parent netif.

     */

    ip_netif_ref    netif;

};

/** IP global data.

 */

struct  ip_globals{

    /** Networking module phone.

     */

    int         net_phone;

    /** Registered network interfaces.

     */

    ip_netifs_t netifs;

    /** Netifs safeyt lock.

     */

    fibril_rwlock_t netifs_lock;

    /** Registered protocols.

     */

    ip_protos_t protos;

    /** Protocols safety lock.

     */

    fibril_rwlock_t protos_lock;

    /** Default gateway.

     */

    ip_route_t  gateway;

    /** Known support modules.

     */

    modules_t   modules;

    /** Default client connection function for support modules.

     */

    async_client_conn_t client_connection;

    /** Packet counter.

     */

    uint16_t    packet_counter;

    /** Safety lock.

     */

    fibril_rwlock_t lock;

};

#endif

/** @}

 */