include/lwip/ip.h

0001 /*
0002  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
0003  * All rights reserved.
0004  *
0005  * Redistribution and use in source and binary forms, with or without modification,
0006  * are permitted provided that the following conditions are met:
0007  *
0008  * 1. Redistributions of source code must retain the above copyright notice,
0009  *    this list of conditions and the following disclaimer.
0010  * 2. Redistributions in binary form must reproduce the above copyright notice,
0011  *    this list of conditions and the following disclaimer in the documentation
0012  *    and/or other materials provided with the distribution.
0013  * 3. The name of the author may not be used to endorse or promote products
0014  *    derived from this software without specific prior written permission.
0015  *
0016  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
0017  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
0018  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
0019  * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
0020  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
0021  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0022  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0023  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
0024  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
0025  * OF SUCH DAMAGE.
0026  *
0027  * This file is part of the lwIP TCP/IP stack.
0028  *
0029  * Author: Adam Dunkels <adam@sics.se>
0030  *
0031  */
0032 #ifndef __LWIP_IP_H__
0033 #define __LWIP_IP_H__
0034
0035 #include "lwip/opt.h"
0036
0037 #include "lwip/def.h"
0038 #include "lwip/pbuf.h"
0039 #include "lwip/ip_addr.h"
0040 #include "lwip/err.h"
0041 #include "lwip/netif.h"
0042
0043 #ifdef __cplusplus
0044 extern "C" {
0045 #endif
0046
0047 /** Currently, the function ip_output_if_opt() is only used with IGMP */
0048 #define IP_OPTIONS_SEND   LWIP_IGMP
0049
0050 #define IP_HLEN 20
0051
0052 #define IP_PROTO_ICMP    1
0053 #define IP_PROTO_UDP     17
0054 #define IP_PROTO_UDPLITE 136
0055 #define IP_PROTO_TCP     6
0056
0057 /* This is passed as the destination address to ip_output_if (not
0058    to ip_output), meaning that an IP header already is constructed
0059    in the pbuf. This is used when TCP retransmits. */
0060 #ifdef IP_HDRINCL
0061 #undef IP_HDRINCL
0062 #endif /* IP_HDRINCL */
0063 #define IP_HDRINCL  NULL
0064
0065 #if LWIP_NETIF_HWADDRHINT
0066 #define IP_PCB_ADDRHINT ;u8_t addr_hint
0067 #else
0068 #define IP_PCB_ADDRHINT
0069 #endif /* LWIP_NETIF_HWADDRHINT */
0070
0071 /* This is the common part of all PCB types. It needs to be at the
0072    beginning of a PCB type definition. It is located here so that
0073    changes to this common part are made in one location instead of
0074    having to change all PCB structs. */
0075 #define IP_PCB \
0076   /* ip addresses in network byte order */ \
0077   struct ip_addr local_ip; \
0078   struct ip_addr remote_ip; \
0079    /* Socket options */  \
0080   u16_t so_options;      \
0081    /* Type Of Service */ \
0082   u8_t tos;              \
0083   /* Time To Live */     \
0084   u8_t ttl               \
0085   /* link layer address resolution hint */ \
0086   IP_PCB_ADDRHINT
0087
0088 struct ip_pcb {
0089 /* Common members of all PCB types */
0090   IP_PCB;
0091 };
0092
0093 /*
0094  * Option flags per-socket. These are the same like SO_XXX.
0095  */
0096 #define SOF_DEBUG       (u16_t)0x0001U    /* turn on debugging info recording */
0097 #define SOF_ACCEPTCONN  (u16_t)0x0002U    /* socket has had listen() */
0098 #define SOF_REUSEADDR   (u16_t)0x0004U    /* allow local address reuse */
0099 #define SOF_KEEPALIVE   (u16_t)0x0008U    /* keep connections alive */
0100 #define SOF_DONTROUTE   (u16_t)0x0010U    /* just use interface addresses */
0101 #define SOF_BROADCAST   (u16_t)0x0020U    /* permit to send and to receive broadcast messages (see IP_SOF_BROADCAST option) */
0102 #define SOF_USELOOPBACK (u16_t)0x0040U    /* bypass hardware when possible */
0103 #define SOF_LINGER      (u16_t)0x0080U    /* linger on close if data present */
0104 #define SOF_OOBINLINE   (u16_t)0x0100U    /* leave received OOB data in line */
0105 #define SOF_REUSEPORT   (u16_t)0x0200U    /* allow local address & port reuse */
0106
0107
0108 #ifdef PACK_STRUCT_USE_INCLUDES
0109 #  include "arch/bpstruct.h"
0110 #endif
0111 PACK_STRUCT_BEGIN
0112 struct ip_hdr {
0113   /* version / header length / type of service */
0114   PACK_STRUCT_FIELD(u16_t _v_hl_tos);
0115   /* total length */
0116   PACK_STRUCT_FIELD(u16_t _len);
0117   /* identification */
0118   PACK_STRUCT_FIELD(u16_t _id);
0119   /* fragment offset field */
0120   PACK_STRUCT_FIELD(u16_t _offset);
0121 #define IP_RF 0x8000        /* reserved fragment flag */
0122 #define IP_DF 0x4000        /* dont fragment flag */
0123 #define IP_MF 0x2000        /* more fragments flag */
0124 #define IP_OFFMASK 0x1fff   /* mask for fragmenting bits */
0125   /* time to live / protocol*/
0126   PACK_STRUCT_FIELD(u16_t _ttl_proto);
0127   /* checksum */
0128   PACK_STRUCT_FIELD(u16_t _chksum);
0129   /* source and destination IP addresses */
0130   PACK_STRUCT_FIELD(struct ip_addr src);
0131   PACK_STRUCT_FIELD(struct ip_addr dest);
0132 } PACK_STRUCT_STRUCT;
0133 PACK_STRUCT_END
0134 #ifdef PACK_STRUCT_USE_INCLUDES
0135 #  include "arch/epstruct.h"
0136 #endif
0137
0138 #define IPH_V(hdr)  (ntohs((hdr)->_v_hl_tos) >> 12)
0139 #define IPH_HL(hdr) ((ntohs((hdr)->_v_hl_tos) >> 8) & 0x0f)
0140 #define IPH_TOS(hdr) (ntohs((hdr)->_v_hl_tos) & 0xff)
0141 #define IPH_LEN(hdr) ((hdr)->_len)
0142 #define IPH_ID(hdr) ((hdr)->_id)
0143 #define IPH_OFFSET(hdr) ((hdr)->_offset)
0144 #define IPH_TTL(hdr) (ntohs((hdr)->_ttl_proto) >> 8)
0145 #define IPH_PROTO(hdr) (ntohs((hdr)->_ttl_proto) & 0xff)
0146 #define IPH_CHKSUM(hdr) ((hdr)->_chksum)
0147
0148 #define IPH_VHLTOS_SET(hdr, v, hl, tos) (hdr)->_v_hl_tos = (htons(((v) << 12) | ((hl) << 8) | (tos)))
0149 #define IPH_LEN_SET(hdr, len) (hdr)->_len = (len)
0150 #define IPH_ID_SET(hdr, id) (hdr)->_id = (id)
0151 #define IPH_OFFSET_SET(hdr, off) (hdr)->_offset = (off)
0152 #define IPH_TTL_SET(hdr, ttl) (hdr)->_ttl_proto = (htons(IPH_PROTO(hdr) | ((u16_t)(ttl) << 8)))
0153 #define IPH_PROTO_SET(hdr, proto) (hdr)->_ttl_proto = (htons((proto) | (IPH_TTL(hdr) << 8)))
0154 #define IPH_CHKSUM_SET(hdr, chksum) (hdr)->_chksum = (chksum)
0155
0156 /** The interface that provided the packet for the current callback invocation. */
0157 extern struct netif *current_netif;
0158 /** Header of the input packet currently being processed. */
0159 extern const struct ip_hdr *current_header;
0160
0161 #define ip_init() /* Compatibility define, not init needed. */
0162 struct netif *ip_route(struct ip_addr *dest);
0163 err_t ip_input(struct pbuf *p, struct netif *inp);
0164 err_t ip_output(struct pbuf *p, struct ip_addr *src, struct ip_addr *dest,
0165        u8_t ttl, u8_t tos, u8_t proto);
0166 err_t ip_output_if(struct pbuf *p, struct ip_addr *src, struct ip_addr *dest,
0167        u8_t ttl, u8_t tos, u8_t proto,
0168        struct netif *netif);
0169 #if LWIP_NETIF_HWADDRHINT
0170 err_t ip_output_hinted(struct pbuf *p, struct ip_addr *src, struct ip_addr *dest,
0171        u8_t ttl, u8_t tos, u8_t proto, u8_t *addr_hint);
0172 #endif /* LWIP_NETIF_HWADDRHINT */
0173 #if IP_OPTIONS_SEND
0174 err_t ip_output_if_opt(struct pbuf *p, struct ip_addr *src, struct ip_addr *dest,
0175        u8_t ttl, u8_t tos, u8_t proto, struct netif *netif, void *ip_options,
0176        u16_t optlen);
0177 #endif /* IP_OPTIONS_SEND */
0178 /** Get the interface that received the current packet.
0179  * This function must only be called from a receive callback (udp_recv,
0180  * raw_recv, tcp_accept). It will return NULL otherwise. */
0181 #define ip_current_netif()  (current_netif)
0182 /** Get the IP header of the current packet.
0183  * This function must only be called from a receive callback (udp_recv,
0184  * raw_recv, tcp_accept). It will return NULL otherwise. */
0185 #define ip_current_header() (current_header)
0186 #if IP_DEBUG
0187 void ip_debug_print(struct pbuf *p);
0188 #else
0189 #define ip_debug_print(p)
0190 #endif /* IP_DEBUG */
0191
0192 #ifdef __cplusplus
0193 }
0194 #endif
0195
0196 #endif /* __LWIP_IP_H__ */
0197
0198