WebSVN – HelenOS – Diff – /branches/network/uspace/srv/net/structures/packet/packet_header.h


/*
 * 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 packet
 *  @{
 */
 
/** @file
 *  Packet header.
 */
 
#ifndef __NET_PACKET_HEADER_H__
#define __NET_PACKET_HEADER_H__
 
#include "../../messages.h"
 
#include "packet.h"
 
/** Packet integrity check magic value.
 */
#define PACKET_MAGIC_VALUE  0x11227788
 
/** Packet header.
 */
struct packet{
    /** Packet identifier.
     */
    packet_id_t     packet_id;
    /** Packet queue sorting value.
     *  The packet queue is sorted the ascending order.
     */
    int             order;
    /** Packet metric.
     */
    size_t          metric;
    /** Previous packet in the queue.
     */
    packet_id_t     previous;
    /** Next packet in the queue.
     */
    packet_id_t     next;
    /** Total length of the packet.
     *  Contains the header, the addresses and the data of the packet.
     *  Corresponds to the mapped sharable memory block.
     */
    size_t          length;
    /** Source and destination addresses length.
     */
    size_t          addr_len;
    /** Souce address offset in bytes from the beginning of the packet header.
     */
    size_t          src_addr;
    /** Destination address offset in bytes from the beginning of the packet header.
     */
    size_t          dest_addr;
    /** Reserved data prefix length in bytes.
     */
    size_t          max_prefix;
    /** Reserved content length in bytes.
     */
    size_t          max_content;
    /** Actual data start offset in bytes from the beginning of the packet header.
     */
    size_t          data_start;
    /** Actual data end offset in bytes from the beginning of the packet header.
     */
    size_t          data_end;
    /** Integrity check magic value.
     */
    int             magic_value;
};
 
/** Returns whether the packet is valid.
 *  @param packet The packet to be checked. Input parameter.
 *  @returns true if the packet is not NULL and the magic value is correct.
 *  @returns false otherwise.
 */
static inline int   packet_is_valid( const packet_t packet ){
    return packet && ( packet->magic_value == PACKET_MAGIC_VALUE );
}
 
#endif
 
/** @}
 */
 

Rev 3990	Rev 4307
1	/*	1	/*
2	* Copyright (c) 2009 Lukas Mejdrech	2	* Copyright (c) 2009 Lukas Mejdrech
3	* All rights reserved.	3	* All rights reserved.
4	*	4	*
5	* Redistribution and use in source and binary forms, with or without	5	* Redistribution and use in source and binary forms, with or without
6	* modification, are permitted provided that the following conditions	6	* modification, are permitted provided that the following conditions
7	* are met:	7	* are met:
8	*	8	*
9	* - Redistributions of source code must retain the above copyright	9	* - Redistributions of source code must retain the above copyright
10	* notice, this list of conditions and the following disclaimer.	10	* notice, this list of conditions and the following disclaimer.
11	* - Redistributions in binary form must reproduce the above copyright	11	* - Redistributions in binary form must reproduce the above copyright
12	* notice, this list of conditions and the following disclaimer in the	12	* notice, this list of conditions and the following disclaimer in the
13	* documentation and/or other materials provided with the distribution.	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	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.	15	* derived from this software without specific prior written permission.
16	*	16	*
17	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR	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	18	* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.	19	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20	* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,	20	* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT	21	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22	* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,	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	23	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT	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	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.	26	* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27	*/	27	*/
28		28
29	/** @addtogroup packet	29	/** @addtogroup packet
30	* @{	30	* @{
31	*/	31	*/
32		32
33	/** @file	33	/** @file
34	* Packet header.	34	* Packet header.
35	*/	35	*/
36		36
37	#ifndef __NET_PACKET_HEADER_H__	37	#ifndef __NET_PACKET_HEADER_H__
38	#define __NET_PACKET_HEADER_H__	38	#define __NET_PACKET_HEADER_H__
39		39
-		40	#include "../../messages.h"
-		41
40	#include "packet.h"	42	#include "packet.h"
41		43
42	/** Packet integrity check magic value.	44	/** Packet integrity check magic value.
43	*/	45	*/
44	#define PACKET_MAGIC_VALUE 0x11227788	46	#define PACKET_MAGIC_VALUE 0x11227788
45		47
46	/** Packet header.	48	/** Packet header.
47	*/	49	*/
48	struct packet{	50	struct packet{
49	/** Packet identifier.	51	/** Packet identifier.
50	*/	52	*/
51	packet_id_t packet_id;	53	packet_id_t packet_id;
52	/** Packet queue sorting value.	54	/** Packet queue sorting value.
53	* The packet queue is sorted the ascending order.	55	* The packet queue is sorted the ascending order.
54	*/	56	*/
55	int order;	57	int order;
56	/** Packet metric.	58	/** Packet metric.
57	*/	59	*/
58	size_t metric;	60	size_t metric;
59	/** Previous packet in the queue.	61	/** Previous packet in the queue.
60	*/	62	*/
61	packet_id_t previous;	63	packet_id_t previous;
62	/** Next packet in the queue.	64	/** Next packet in the queue.
63	*/	65	*/
64	packet_id_t next;	66	packet_id_t next;
65	/** Total length of the packet.	67	/** Total length of the packet.
66	* Contains the header, the addresses and the data of the packet.	68	* Contains the header, the addresses and the data of the packet.
67	* Corresponds to the mapped sharable memory block.	69	* Corresponds to the mapped sharable memory block.
68	*/	70	*/
69	size_t length;	71	size_t length;
70	/** Source and destination addresses length.	72	/** Source and destination addresses length.
71	*/	73	*/
72	size_t addr_len;	74	size_t addr_len;
73	/** Souce address offset in bytes from the beginning of the packet header.	75	/** Souce address offset in bytes from the beginning of the packet header.
74	*/	76	*/
75	size_t src_addr;	77	size_t src_addr;
76	/** Destination address offset in bytes from the beginning of the packet header.	78	/** Destination address offset in bytes from the beginning of the packet header.
77	*/	79	*/
78	size_t dest_addr;	80	size_t dest_addr;
79	/** Reserved data prefix length in bytes.	81	/** Reserved data prefix length in bytes.
80	*/	82	*/
81	size_t max_prefix;	83	size_t max_prefix;
82	/** Reserved content length in bytes.	84	/** Reserved content length in bytes.
83	*/	85	*/
84	size_t max_content;	86	size_t max_content;
85	/** Actual data start offset in bytes from the beginning of the packet header.	87	/** Actual data start offset in bytes from the beginning of the packet header.
86	*/	88	*/
87	size_t data_start;	89	size_t data_start;
88	/** Actual data end offset in bytes from the beginning of the packet header.	90	/** Actual data end offset in bytes from the beginning of the packet header.
89	*/	91	*/
90	size_t data_end;	92	size_t data_end;
91	/** Integrity check magic value.	93	/** Integrity check magic value.
92	*/	94	*/
93	int magic_value;	95	int magic_value;
94	};	96	};
95		97
96	/** Returns whether the packet is valid.	98	/** Returns whether the packet is valid.
97	* @param packet The packet to be checked. Input parameter.	99	* @param packet The packet to be checked. Input parameter.
98	* @returns true if the packet is not NULL and the magic value is correct.	100	* @returns true if the packet is not NULL and the magic value is correct.
99	* @returns false otherwise.	101	* @returns false otherwise.
100	*/	102	*/
101	static inline int packet_is_valid( const packet_t packet ){	103	static inline int packet_is_valid( const packet_t packet ){
102	return packet && ( packet->magic_value == PACKET_MAGIC_VALUE );	104	return packet && ( packet->magic_value == PACKET_MAGIC_VALUE );
103	}	105	}
104		106
105	#endif	107	#endif
106		108
107	/** @}	109	/** @}
108	*/	110	*/
109		111

Subversion Repositories HelenOS

(root)/branches/network/uspace/srv/net/structures/packet/packet_header.h – Rev 3990 → 4307