Rev 4722 | Details | Compare with Previous | Last modification | View Log | RSS feed
| Rev | Author | Line No. | Line |
|---|---|---|---|
| 4505 | mejdrech | 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 | |||
| 4704 | mejdrech | 33 | /** @file |
| 4756 | mejdrech | 34 | * IP client interface. |
| 4505 | mejdrech | 35 | */ |
| 36 | |||
| 37 | #ifndef __NET_IP_CLIENT_H__ |
||
| 38 | #define __NET_IP_CLIENT_H__ |
||
| 39 | |||
| 4558 | mejdrech | 40 | #include <sys/types.h> |
| 41 | |||
| 4505 | mejdrech | 42 | #include "../structures/packet/packet.h" |
| 43 | |||
| 4710 | mejdrech | 44 | #include "ip_codes.h" |
| 4722 | mejdrech | 45 | #include "ip_interface.h" |
| 46 | #include "socket_codes.h" |
||
| 4505 | mejdrech | 47 | |
| 4756 | mejdrech | 48 | /** Prepares the packet to be transfered via IP. |
| 49 | * The IP header is prefixed. |
||
| 50 | * @param[in,out] packet The packet to be prepared. |
||
| 51 | * @param[in] protocol The transport protocol. |
||
| 52 | * @param[in] ttl The time to live counter. The IPDEFTTL is set if zero (0). |
||
| 53 | * @param[in] tos The type of service. |
||
| 54 | * @param[in] dont_fragment The value indicating whether fragmentation is disabled. |
||
| 55 | * @param[in] ipopt_length The prefixed IP options length in bytes. |
||
| 56 | * @returns EOK on success. |
||
| 57 | * @returns ENOMEM if there is not enough memory left in the packet. |
||
| 58 | */ |
||
| 4558 | mejdrech | 59 | int ip_client_prepare_packet( packet_t packet, ip_protocol_t protocol, ip_ttl_t ttl, ip_tos_t tos, int dont_fragment, size_t ipopt_length ); |
| 4505 | mejdrech | 60 | |
| 4756 | mejdrech | 61 | /** Processes the received IP packet. |
| 62 | * Fills set header fields. |
||
| 63 | * Returns the prefixed IP header length. |
||
| 64 | * @param[in] packet The received packet. |
||
| 65 | * @param[out] protocol The transport protocol. May be NULL if not desired. |
||
| 66 | * @param[out] ttl The time to live counter. May be NULL if not desired. |
||
| 67 | * @param[out] tos The type of service. May be NULL if not desired. |
||
| 68 | * @param[out] dont_fragment The value indicating whether the fragmentation is disabled. May be NULL if not desired. |
||
| 69 | * @param[out] ipopt_length The IP options length in bytes. May be NULL if not desired. |
||
| 70 | * @returns The prefixed IP header length in bytes on success. |
||
| 71 | * @returns ENOMEM if the packet is too short to contain the IP header. |
||
| 72 | */ |
||
| 4589 | mejdrech | 73 | int ip_client_process_packet( packet_t packet, ip_protocol_t * protocol, ip_ttl_t * ttl, ip_tos_t * tos, int * dont_fragment, size_t * ipopt_length ); |
| 74 | |||
| 4707 | mejdrech | 75 | /** Returns the IP header length. |
| 4756 | mejdrech | 76 | * @param[in] packet The packet. |
| 4707 | mejdrech | 77 | * @returns The IP header length in bytes. |
| 4721 | mejdrech | 78 | * @returns Zero (0) if there is no IP header. |
| 4707 | mejdrech | 79 | */ |
| 4721 | mejdrech | 80 | size_t ip_client_header_length( packet_t packet ); |
| 4707 | mejdrech | 81 | |
| 4756 | mejdrech | 82 | /** Updates the IPv4 pseudo header data length field. |
| 83 | * @param[in,out] header The IPv4 pseudo header to be updated. |
||
| 84 | * @param[in] headerlen The length of the IP pseudo header in bytes. |
||
| 85 | * @param[in] data_length The data length to be set. |
||
| 86 | * @returns EOK on success. |
||
| 87 | * @returns EBADMEM if the header parameter is NULL. |
||
| 88 | * @returns EINVAL if the headerlen parameter is not IPv4 pseudo header length. |
||
| 4722 | mejdrech | 89 | */ |
| 90 | int ip_client_set_pseudo_header_data_length( ip_pseudo_header_ref header, size_t headerlen, size_t data_length ); |
||
| 91 | |||
| 4756 | mejdrech | 92 | /** Constructs the IPv4 pseudo header. |
| 93 | * @param[in] protocol The transport protocol. |
||
| 94 | * @param[in] src The source address. |
||
| 95 | * @param[in] srclen The source address length. |
||
| 96 | * @param[in] dest The destination address. |
||
| 97 | * @param[in] destlen The destination address length. |
||
| 98 | * @param[in] data_length The data length to be set. |
||
| 99 | * @param[out] header The constructed IPv4 pseudo header. |
||
| 100 | * @param[out] headerlen The length of the IP pseudo header in bytes. |
||
| 101 | * @returns EOK on success. |
||
| 102 | * @returns EBADMEM if the header and/or the headerlen parameter is NULL. |
||
| 103 | * @returns EINVAL if the source address and/or the destination address parameter is NULL. |
||
| 104 | * @returns EINVAL if the source address length is less than struct sockaddr length. |
||
| 105 | * @returns EINVAL if the source address length differs from the destination address length. |
||
| 106 | * @returns EINVAL if the source address family differs from the destination family. |
||
| 107 | * @returns EAFNOSUPPORT if the address family is not supported. |
||
| 108 | * @returns ENOMEM if there is not enough memory left. |
||
| 4722 | mejdrech | 109 | */ |
| 110 | int ip_client_get_pseudo_header( ip_protocol_t protocol, struct sockaddr * src, socklen_t srclen, struct sockaddr * dest, socklen_t destlen, size_t data_length, ip_pseudo_header_ref * header, size_t * headerlen ); |
||
| 111 | |||
| 4505 | mejdrech | 112 | // TODO ipopt manipulation |
| 113 | |||
| 114 | #endif |
||
| 115 | |||
| 116 | /** @} |
||
| 117 | */ |