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

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

Subversion Repositories HelenOS

(root)/branches/network/uspace/srv/net/structures/packet/packet.h – Rev 4731