WebSVN – HelenOS – Diff – /branches/network/uspace/srv/net/structures/packet/packet.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 map and queue.
 */
 
#ifndef __NET_PACKET_H__
#define __NET_PACKET_H__
 
/** Packet identifier type.
 *  Value zero (0) is used as an invalid identifier.
 */
typedef int packet_id_t;
 
/** Type definition of the packet.
 *  @see packet
 */
typedef struct packet * packet_t;
 
/** Type definition of the packet pointer.
 *  @see packet
 */
typedef packet_t *      packet_ref;
 
/** @name Packet management system interface
 */
/*@{*/
 
/** Finds the packet mapping.
 *  @param[in] packet_id The packet identifier to be found.
 *  @returns The found packet reference.
 *  @returns NULL if the mapping does not exist.
 */
packet_t    pm_find( packet_id_t packet_id );
 
/** Adds the packet mapping.
 *  @param[in] packet The packet to be remembered.
 *  @returns EOK on success.
 *  @returns EINVAL if the packet is not valid.
 *  @returns EINVAL if the packet map is not initialized.
 *  @returns ENOMEM if there is not enough memory left.
 */
int pm_add( packet_t packet );
 
/** Initializes the packet map.
 *  @returns EOK on success.
 *  @returns ENOMEM if there is not enough memory left.
 */
int pm_init( void );
 
/** Releases the packet map.
 */
void    pm_destroy( void );
 
/** Add packet to the sorted queue.
 *  The queue is sorted in the ascending order.
 *  The packet is inserted right before the packets of the same order value.
 *  @param[in] first The first packet of the queue. May be NULL.
 *  @param[in] packet The packet to be added.
 *  @param[in] order The packet order value.
 *  @param[in] metric The metric value of the packet.
 *  @returns The first packet of the queue. The original first packet may be shifted by the new packet.
 *  @returns NULL if the packet is not valid.
 */
packet_t    pq_add( packet_t first, packet_t packet, size_t order, size_t metric );
 
/** Finds the packet with the given order.
 *  @param[in] first The first packet of the queue.
 *  @param[in] order The packet order value.
 *  @returns The packet with the given order.
 *  @returns NULL if the first packet is not valid.
 *  @returns NULL if the packet is not found.
 */
packet_t    pq_find( packet_t first, size_t order );
 
/** Inserts packet after the given one.
 *  @param[in] packet The packet in the queue.
 *  @param[in] new_packet The new packet to be inserted.
 *  @returns EOK on success.
 *  @returns EINVAL if etiher of the packets is invalid.
 */
int pq_insert_after( packet_t packet, packet_t new_packet );
 
/** Detach the packet from the queue.
 *  @param[in] packet The packet to be detached.
 *  @returns The next packet in the queue. If the packet is the first one of the queue, this becomes the new first one.
 *  @returns NULL if there is no packet left.
 *  @returns NULL if the packet is not valid.
 */
packet_t    pq_detach( packet_t packet );
 
/** Sets the packet order and metric attributes.
 *  @param[in] packet The packet to be set.
 *  @param[in] order The packet order value.
 *  @param[in] metric The metric value of the packet.
 *  @returns EOK on success.
 *  @returns EINVAL if the packet is invalid..
 */
int pq_set_order( packet_t packet, size_t order, size_t metric );
 
/** Sets the packet order and metric attributes.
 *  @param[in] packet The packet to be set.
 *  @param[out] order The packet order value.
 *  @param[out] metric The metric value of the packet.
 *  @returns EOK on success.
 *  @returns EINVAL if the packet is invalid..
 */
int pq_get_order( packet_t packet, size_t * order, size_t * metric );
 
/** Releases the whole queue.
 *  Detaches all packets of the queue and calls the packet_release() for each of them.
 *  @param[in] first The first packet of the queue.
 *  @param[in] packet_release The releasing function called for each of the packets after its detachment.
 */
void    pq_destroy( packet_t first, void ( * packet_release )( packet_t packet ));
 
/** Returns the next packet in the queue.
 *  @param[in] packet The packet queue member.
 *  @returns The next packet in the queue.
 *  @returns NULL if there is no next packet.
 *  @returns NULL if the packet is not valid.
 */
packet_t    pq_next( packet_t packet );
 
/** Returns the previous packet in the queue.
 *  @param[in] packet The packet queue member.
 *  @returns The previous packet in the queue.
 *  @returns NULL if there is no previous packet.
 *  @returns NULL if the packet is not valid.
 */
packet_t    pq_previous( packet_t packet );
 
/*@}*/
 
#endif
 
/** @}
 */
 

Subversion Repositories HelenOS

(root)/branches/network/uspace/srv/net/structures/packet/packet.h – Rev 4743 → 4756

Rev 4743		Rev 4756
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 map and queue.	34	* Packet map and queue.
35	*/	35	*/
36		36
37	#ifndef __NET_PACKET_H__	37	#ifndef __NET_PACKET_H__
38	#define __NET_PACKET_H__	38	#define __NET_PACKET_H__
39		39
40	/** Packet identifier type.	40	/** Packet identifier type.
41	* Value zero (0) is used as an invalid identifier.	41	* Value zero (0) is used as an invalid identifier.
42	*/	42	*/
43	typedef int packet_id_t;	43	typedef int packet_id_t;
44		44
45	/** Type definition of the packet.	45	/** Type definition of the packet.
46	* @see packet	46	* @see packet
47	*/	47	*/
48	typedef struct packet * packet_t;	48	typedef struct packet * packet_t;
49		49
50	/** Type definition of the packet pointer.	50	/** Type definition of the packet pointer.
51	* @see packet	51	* @see packet
52	*/	52	*/
53	typedef packet_t * packet_ref;	53	typedef packet_t * packet_ref;
54		54
55	/** @name Packet management system interface	55	/** @name Packet management system interface
56	*/	56	*/
57	/@{/	57	/@{/
58		58
59	/** Finds the packet mapping.	59	/** Finds the packet mapping.
60	* @param packet_id The packet identifier to be found. Input parameter.	60	* @param[in] packet_id The packet identifier to be found.
61	* @returns The found packet reference.	61	* @returns The found packet reference.
62	* @returns NULL if the mapping does not exist.	62	* @returns NULL if the mapping does not exist.
63	*/	63	*/
64	packet_t pm_find( packet_id_t packet_id );	64	packet_t pm_find( packet_id_t packet_id );
65		65
66	/** Adds the packet mapping.	66	/** Adds the packet mapping.
67	* @param packet The packet to be remembered. Input parameter.	67	* @param[in] packet The packet to be remembered.
68	* @returns EOK on success.	68	* @returns EOK on success.
69	* @returns EINVAL if the packet is not valid.	69	* @returns EINVAL if the packet is not valid.
70	* @returns EINVAL if the packet map is not initialized.	70	* @returns EINVAL if the packet map is not initialized.
71	* @returns ENOMEM if there is not enough memory left.	71	* @returns ENOMEM if there is not enough memory left.
72	*/	72	*/
73	int pm_add( packet_t packet );	73	int pm_add( packet_t packet );
74		74
75	/** Initializes the packet map.	75	/** Initializes the packet map.
76	* @returns EOK on success.	76	* @returns EOK on success.
77	* @returns ENOMEM if there is not enough memory left.	77	* @returns ENOMEM if there is not enough memory left.
78	*/	78	*/
79	int pm_init( void );	79	int pm_init( void );
80		80
81	/** Releases the packet map.	81	/** Releases the packet map.
82	*/	82	*/
83	void pm_destroy( void );	83	void pm_destroy( void );
84		84
85	/** Add packet to the sorted queue.	85	/** Add packet to the sorted queue.
86	* The queue is sorted in the ascending order.	86	* The queue is sorted in the ascending order.
87	* The packet is inserted right before the packets of the same order value.	87	* The packet is inserted right before the packets of the same order value.
88	* @param first The first packet of the queue. May be NULL. Input parameter.	88	* @param[in] first The first packet of the queue. May be NULL.
89	* @param packet The packet to be added. Input parameter.	89	* @param[in] packet The packet to be added.
90	* @param order The packet order value. Input parameter.	90	* @param[in] order The packet order value.
91	* @param metric The metric value of the packet. Input parameter.	91	* @param[in] metric The metric value of the packet.
92	* @returns The first packet of the queue. The original first packet may be shifted by the new packet.	92	* @returns The first packet of the queue. The original first packet may be shifted by the new packet.
93	* @returns NULL if the packet is not valid.	93	* @returns NULL if the packet is not valid.
94	*/	94	*/
95	packet_t pq_add( packet_t first, packet_t packet, size_t order, size_t metric );	95	packet_t pq_add( packet_t first, packet_t packet, size_t order, size_t metric );
96		96
97	/** Finds the packet with the given order.	97	/** Finds the packet with the given order.
98	* @param first The first packet of the queue. Input parameter.	98	* @param[in] first The first packet of the queue.
99	* @param order The packet order value. Input parameter.	99	* @param[in] order The packet order value.
100	* @returns The packet with the given order.	100	* @returns The packet with the given order.
101	* @returns NULL if the first packet is not valid.	101	* @returns NULL if the first packet is not valid.
102	* @returns NULL if the packet is not found.	102	* @returns NULL if the packet is not found.
103	*/	103	*/
104	packet_t pq_find( packet_t first, size_t order );	104	packet_t pq_find( packet_t first, size_t order );
105		105
106	/** Inserts packet after the given one.	106	/** Inserts packet after the given one.
107	* @param packet The packet in the queue. Input parameter.	107	* @param[in] packet The packet in the queue.
108	* @param new_packet The new packet to be inserted. Input parameter.	108	* @param[in] new_packet The new packet to be inserted.
109	* @returns EOK on success.	109	* @returns EOK on success.
110	* @returns EINVAL if etiher of the packets is invalid.	110	* @returns EINVAL if etiher of the packets is invalid.
111	*/	111	*/
112	int pq_insert_after( packet_t packet, packet_t new_packet );	112	int pq_insert_after( packet_t packet, packet_t new_packet );
113		113
114	/** Detach the packet from the queue.	114	/** Detach the packet from the queue.
115	* @param packet The packet to be detached. Input parameter.	115	* @param[in] packet The packet to be detached.
116	* @returns The next packet in the queue. If the packet is the first one of the queue, this becomes the new first one.	116	* @returns The next packet in the queue. If the packet is the first one of the queue, this becomes the new first one.
117	* @returns NULL if there is no packet left.	117	* @returns NULL if there is no packet left.
118	* @returns NULL if the packet is not valid.	118	* @returns NULL if the packet is not valid.
119	*/	119	*/
120	packet_t pq_detach( packet_t packet );	120	packet_t pq_detach( packet_t packet );
121		121
122	/** Sets the packet order and metric attributes.	122	/** Sets the packet order and metric attributes.
123	* @param packet The packet to be set. Input parameter.	123	* @param[in] packet The packet to be set.
124	* @param order The packet order value. Input parameter.	124	* @param[in] order The packet order value.
125	* @param metric The metric value of the packet. Input parameter.	125	* @param[in] metric The metric value of the packet.
126	* @returns EOK on success.	126	* @returns EOK on success.
127	* @returns EINVAL if the packet is invalid..	127	* @returns EINVAL if the packet is invalid..
128	*/	128	*/
129	int pq_set_order( packet_t packet, size_t order, size_t metric );	129	int pq_set_order( packet_t packet, size_t order, size_t metric );
130		130
131	/** Sets the packet order and metric attributes.	131	/** Sets the packet order and metric attributes.
132	* @param packet The packet to be set. Input parameter.	132	* @param[in] packet The packet to be set.
133	* @param order The packet order value. Output parameter.	133	* @param[out] order The packet order value.
134	* @param metric The metric value of the packet. Ouput parameter.	134	* @param[out] metric The metric value of the packet.
135	* @returns EOK on success.	135	* @returns EOK on success.
136	* @returns EINVAL if the packet is invalid..	136	* @returns EINVAL if the packet is invalid..
137	*/	137	*/
138	int pq_get_order( packet_t packet, size_t * order, size_t * metric );	138	int pq_get_order( packet_t packet, size_t * order, size_t * metric );
139		139
140	/** Releases the whole queue.	140	/** Releases the whole queue.
141	* Detaches all packets of the queue and calls the packet_release() for each of them.	141	* Detaches all packets of the queue and calls the packet_release() for each of them.
142	* @param first The first packet of the queue. Input parameter.	142	* @param[in] first The first packet of the queue.
143	* @param packet_release The releasing function called for each of the packets after its detachment. Input parameter.	143	* @param[in] packet_release The releasing function called for each of the packets after its detachment.
144	*/	144	*/
145	void pq_destroy( packet_t first, void ( * packet_release )( packet_t packet ));	145	void pq_destroy( packet_t first, void ( * packet_release )( packet_t packet ));
146		146
147	/** Returns the next packet in the queue.	147	/** Returns the next packet in the queue.
148	* @param packet The packet queue member. Input parameter.	148	* @param[in] packet The packet queue member.
149	* @returns The next packet in the queue.	149	* @returns The next packet in the queue.
150	* @returns NULL if there is no next packet.	150	* @returns NULL if there is no next packet.
151	* @returns NULL if the packet is not valid.	151	* @returns NULL if the packet is not valid.
152	*/	152	*/
153	packet_t pq_next( packet_t packet );	153	packet_t pq_next( packet_t packet );
154		154
155	/** Returns the previous packet in the queue.	155	/** Returns the previous packet in the queue.
156	* @param packet The packet queue member. Input parameter.	156	* @param[in] packet The packet queue member.
157	* @returns The previous packet in the queue.	157	* @returns The previous packet in the queue.
158	* @returns NULL if there is no previous packet.	158	* @returns NULL if there is no previous packet.
159	* @returns NULL if the packet is not valid.	159	* @returns NULL if the packet is not valid.
160	*/	160	*/
161	packet_t pq_previous( packet_t packet );	161	packet_t pq_previous( packet_t packet );
162		162
163	/@}/	163	/@}/
164		164
165	#endif	165	#endif
166		166
167	/** @}	167	/** @}
168	*/	168	*/
169		169