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

 *  Internet protocol header and options definitions.

 *  Names according to the linux src/include/linux/ip.h header file.

 */

#ifndef __NET_IP_HEADER_H__

#define __NET_IP_HEADER_H__

#include <byteorder.h>

#include <types.h>

/** Type definition of the internet header.

 *  @see ip_header

 */

typedef struct ip_header	ip_header_t;

/** Type definition of the internet header pointer.

 *  @see ip_header

 */

typedef ip_header_t *		ip_header_ref;

/** Internet header.

 *  The variable options should be included after the header itself and indicated by the increased header length value.

 */

struct ip_header{

#ifdef ARCH_IS_BIG_ENDIAN

	/** The Version field indicates the format of the internet header.

	 */

	uint8_t:4	version;

	/** Internet Header Length is the length of the internet header in 32~bit words, and thus points to the beginning of the data.

	 *  Note that the minimum value for a~correct header is~5.

	 */

	uint8_t:4	ihl;

#else

	/** Internet Header Length is the length of the internet header in 32~bit words, and thus points to the beginning of the data.

	 *  Note that the minimum value for a~correct header is~5.

	 */

	uint8_t:4	ihl;

	/** The Version field indicates the format of the internet header.

	 */

	uint8_t:4	version;

#endif

	/** The Type of Service provides an indication of the abstract parameters of the quality of service desired.

	 *  These parameters are to be used to guide the selection of the actual service parameters when transmitting a~datagram through a~particular network.

	 *  Several networks offer service precedence, which somehow treats high precedence traffic as more important than other traffic (generally by accepting only traffic above a~certain precedence at time of high load).

	 *  The major choice is a~three way tradeoff between low-delay, high-reliability, and high-throughput.

	 */

	uint8_t		tos;

	/** Total Length is the length of the datagram, measured in octets, including internet header and data.

	 *  This field allows the length of a~datagram to be up to 65,535~octets.

	 */

	uint16_t	total_length;

	/** An identifying value assigned by the sender to aid in assembling the fragments of a~datagram.

	 */

	unit16_t	identification;

#ifdef ARCH_IS_BIG_ENDIAN

	/** Various control flags.

	 */

	uint_16:3	flags;

	/** This field indicates where in the datagram this fragment belongs.

	 */

	uint_16:13	fragment_offset;

#else

	/** This field indicates where in the datagram this fragment belongs.

	 */

	uint_16:13	fragment_offset;

	/** Various control flags.

	 */

	uint_16:3	flags;

#endif

	/** This field indicates the maximum time the datagram is allowed to remain in the internet system.

	 *  If this field contains the value zero, then the datagram must be destroyed.

	 *  This field is modified in internet header processing.

	 *  The time is measured in units of seconds, but since every module that processes a~datagram must decrease the TTL by at least one even if it process the datagram in less than a~second, the TTL must be thought of only as an upper bound on the time a~datagram may exist.

	 *  The intention is to cause undeliverable datagrams to be discarded, and to bound the maximum datagram lifetime.

	 */

	uint8_t		ttl;

	/** This field indicates the next level protocol used in the data portion of the internet datagram.

	 */

	uint8_t		protocol;

	/** A checksum on the header only.

	 *  Since some header fields change (e.g., time to live), this is recomputed and verified at each point that the internet header is processed.

	 *  The checksum algorithm is: The checksum field is the 16~bit one's complement of the one's complement sum of all 16~bit words in the header.

	 *  For purposes of computing the checksum, the value of the checksum field is zero.

	 */

	uint16_t	header_checksum;

	/** The source address.

	 */

	uint32_t	source_address;

	/** The destination address.

	 */

	uint32_t	destination_address;

};

typedef struct ip_option	ip_option_t;

typedef ip_option *		ip_option_ref;

/** Internet option header.

 *  Only type field is always valid.

 *  Other fields' validity depends on the option type.

 */

struct ip_option{

	/** A single octet of option-type.

	 */

	uint8_t		type;

	/** An option length octet.

	 */

	uint8_t		length;

	/** A~pointer.

	 */

	uint8_t		pointer;

#ifdef ARCH_IS_BIG_ENDIAN

	/** The number of IP modules that cannot register timestamps due to lack of space.

	 */

	uint8_t:4	overflow;

	/** Various internet timestamp control flags.

	 */

	uint8_t:4	flags;

#else

	/** Various internet timestamp control flags.

	 */

	uint8_t:4	flags;

	/** The number of IP modules that cannot register timestamps due to lack of space.

	 */

	uint8_t:4	overflow;

#endif

};

#define IPTOS_TOS_MASK				0x1E

#define IPTOS_PRECEDENCE_SHIFT		5

#define IPTOS_DELAY_SHIFT			4

#define IPTOS_THROUGHPUT_SHIFT		3

#define IPTOS_RELIABILITY_SHIFT		2

#define IPTOS_COST_SHIFT			1

#define IPTOS_NORMALDELAY			( 0x0 << IPTOS_DELAY_SHIFT )

#define IPTOS_LOWDELAY				( 0x1 << IPTOS_DELAY_SHIFT )

#define IPTOS_NORMALTHROUGHPUT		( 0x0 << IPTOS_THROUGHPUT_SHIFT )

#define IPTOS_THROUGHPUT			( 0x1 << IPTOS_THROUGHPUT_SHIFT )

#define IPTOS_NORMALRELIABILITY		( 0x0 << IPTOS_RELIABILITY_SHIFT )

#define IPTOS_RELIABILITY			( 0x1 << IPTOS_RELIABILITY_SHIFT )

#define IPTOS_NORMALCOST			( 0x0 << IPTOS_COST_SHIFT )

#define IPTOS_MICNCOST				( 0x1 << IPTOS_COST_SHIFT )

#define IPTOS_PREC_MASK				0xE0

#define IPTOS_PREC_ROUTINE			( 0x0 << IPTOS_PRECEDENCE_SHIFT )

#define IPTOS_PREC_PRIORITY			( 0x1 << IPTOS_PRECEDENCE_SHIFT )

#define IPTOS_PREC_IMMEDIATE		( 0x2 << IPTOS_PRECEDENCE_SHIFT )

#define IPTOS_PREC_FLASH			( 0x3 << IPTOS_PRECEDENCE_SHIFT )

#define IPTOS_PREC_FLASHOVERRIDE	( 0x4 << IPTOS_PRECEDENCE_SHIFT )

#define IPTOS_PREC_CRITIC_ECP		( 0x5 << IPTOS_PRECEDENCE_SHIFT )

#define IPTOS_PREC_INTERNETCONTROL	( 0x6 << IPTOS_PRECEDENCE_SHIFT )

#define IPTOS_PREC_NETCONTROL		( 0x7 << IPTOS_PRECEDENCE_SHIFT )

#define IPFLAG_FRAGMENT_SHIFT		1

#define IPFLAG_FRAGMENTED_SHIFT		0

#define IPFLAG_MAY_FRAGMENT			( 0x0 << IPFLAG_FRAGMENT_SHIFT )

#define IPFLAG_DONT_FRAGMENT		( 0x1 << IPFLAG_FRAGMENT_SHIFT )

#define IPFLAG_LAST_FRAGMENT		( 0x0 << IPFLAG_FRAGMENTED_SHIFT )

#define IPFLAG_MORE_FRAGMENTS		( 0x1 << IPFLAG_FRAGMENTED_SHIFT )

#define IPOPT_COPY_SHIFT			7

#define IPOPT_CLASS_SHIFT			5

#define IPOPT_NUMBER_SHIFT			0

#define IPOPT_CLASS_MASK			0x60

#define IPOPT_NUMBER_MASK			0x1F

#define IPOPT_COPY					( 1 << IPOPT_COPY_SHIFT )

#define IPOPT_TYPE( copy, class, number )	((( copy ) & IPOPT_COPY ) | (( class ) & IPOPT_CLASS_MASK ) | (( number << IPOPT_NUMBER_SHIFT ) & IPOPT_NUMBER_MASK ))

#define	IPOPT_COPIED( o )			(( o ) & IPOPT_COPY )

#define	IPOPT_CLASS( o )			(( o ) & IPOPT_CLASS_MASK )

#define	IPOPT_NUMBER( o )			(( o ) & IPOPT_NUMBER_MASK )

#define	IPOPT_CONTROL				( 1 << IPOPT_CLASS_SHIFT )

#define	IPOPT_RESERVED1				( 2 << IPOPT_CLASS_SHIFT )

#define	IPOPT_MEASUREMENT			( 3 << IPOPT_CLASS_SHIFT )

#define	IPOPT_RESERVED2				( 4 << IPOPT_CLASS_SHIFT )

//#define IPOPT_END_OF_LIST		0x0

#define IPOPT_END					IPOPT_TYPE( 0, IPOPT_CONTROL, 0 )

//#define IPOPT_NO_OPERATION		0x1

#define IPOPT_NOOP					IPOPT_TYPE( 0, IPOPT_CONTROL, 1 )

//#define IPOPT_SECURITY			0x82

#define IPOPT_SEC					IPOPT_TYPE( IPOPT_COPY, IPOPT_CONTROL, 2 )

#define IPOPT_SEC_LENGTH			11

#define IPOPT_SEC_UNCLASIFIED		0x0

#define IPOPT_SEC_CONFIDENTIAL		0xF035

#define IPOPT_SEC_EFTO				0x789A

#define IPOPT_SEC_MMMM				0xBC4D

#define IPOPT_SEC_PROG				0x5E26

#define IPOPT_SEC_RESTRICTED		0xAF13

#define IPOPT_SEC_SECRET			0xD788

#define IPOPT_SEC_TOP_SECRET		0x6BC5

//#define IPOPT_LOOSE_SOURCE		0x83

#define IPOPT_LSRR					IPOPT_TYPE( IPOPT_COPY, IPOPT_CONTROL, 3 )

//#define IPOPT_STRICT_SOURCE		0x89

#define IPOPT_SSRR					IPOPT_TYPE( IPOPT_COPY, IPOPT_CONTROL, 9 )

//#define IPOPT_RECORD_ROUTE		0x07

#define IPOPT_RR					IPOPT_TYPE( IPOPT_COPY, IPOPT_CONTROL, 7 )

//#define IPOPT_STREAM_IDENTIFIER	0x88

#define IPOPT_SID					IPOPT_TYPE( IPOPT_COPY, IPOPT_CONTROL, 8 )

#define IPOPT_SID_LENGTH			4

//#define IPOPT_INTERNET_TIMESTAMP	0x44

#define IPOPT_TIMESTAMP				IPOPT_TYPE( IPOPT_COPY, IPOPT_MEASUREMENT, 4 )

#define IPOPT_CIPSO					IPOPT_TYPE( IPOPT_COPY, IPOPT_CONTROL, 5 )

#define IPVERSION	4

#define MAXTTL		255

#define IPDEFTTL	64

#define IPOPT_OPTVAL 0

#define IPOPT_OLEN   1

#define IPOPT_OFFSET 2

#define IPOPT_MINOFF 4

#define MAX_IPOPTLEN 40

#define IPOPT_NOP IPOPT_NOOP

#define IPOPT_EOL IPOPT_END

#define IPOPT_TS  IPOPT_TIMESTAMP

#define	IPOPT_TS_TSONLY		0		/* timestamps only */

#define	IPOPT_TS_TSANDADDR	1		/* timestamps and addresses */

#define	IPOPT_TS_PRESPEC	3		/* specified modules only */

#endif

/** @}

 */