/*
 * Copyright 2006-2010, Haiku, Inc. All Rights Reserved.
 * Distributed under the terms of the MIT License.
 */
#ifndef NET_BUFFER_H
#define NET_BUFFER_H


#include <util/list.h>

#include <module.h>
#include <sys/socket.h>


#define NET_BUFFER_MODULE_NAME "network/stack/buffer/v1"


typedef struct net_buffer {
	struct list_link link;

	// TODO: we should think about moving the address fields into the buffer
	// data itself via associated data or something like this. Or this
	// structure as a whole, too...

	struct sockaddr *source;
	struct sockaddr *destination;
	struct net_interface *interface;
	int32 type;
	union {
		struct {
			uint16	start;
			uint16	end;
		}		fragment;
		uint32	sequence;
		uint32	offset;
	};
	uint32	flags;
	uint32	size;
	uint8	protocol;
	
	// TODO: these two should go away again
	uint8	hoplimit;
	void *	network_header;
} net_buffer;

struct ancillary_data_container;

struct net_buffer_module_info {
	module_info info;

	net_buffer *	(*create)(size_t headerSpace);
	void 			(*free)(net_buffer *buffer);

	net_buffer *	(*duplicate)(net_buffer *from);
	net_buffer *	(*clone)(net_buffer *from, bool shareFreeSpace);
	net_buffer *	(*split)(net_buffer *from, uint32 offset);
	status_t		(*merge)(net_buffer *buffer, net_buffer *with, bool after);

	status_t		(*prepend_size)(net_buffer *buffer, size_t size,
						void **_contiguousBuffer);
	status_t		(*prepend)(net_buffer *buffer, const void *data,
						size_t bytes);
	status_t		(*append_size)(net_buffer *buffer, size_t size,
						void **_contiguousBuffer);
	status_t		(*append)(net_buffer *buffer, const void *data,
						size_t bytes);
	status_t		(*insert)(net_buffer *buffer, uint32 offset,
						const void *data, size_t bytes, uint32 flags);
	status_t		(*remove)(net_buffer *buffer, uint32 offset,
						size_t bytes);
	status_t		(*remove_header)(net_buffer *buffer, size_t bytes);
	status_t		(*remove_trailer)(net_buffer *buffer, size_t bytes);
	status_t		(*trim)(net_buffer *buffer, size_t newSize);
	status_t		(*append_cloned)(net_buffer *buffer, net_buffer *source,
						uint32 offset, size_t bytes);

	status_t		(*associate_data)(net_buffer *buffer, void *data);

	void			(*set_ancillary_data)(net_buffer *buffer,
						struct ancillary_data_container *container);
	struct ancillary_data_container* (*get_ancillary_data)(net_buffer *buffer);
	void *			(*transfer_ancillary_data)(net_buffer *from,
						net_buffer *to);

	status_t		(*direct_access)(net_buffer *buffer, uint32 offset,
						size_t bytes, void **_data);
	status_t 		(*read)(net_buffer *buffer, uint32 offset, void *data,
						size_t bytes);
	status_t		(*write)(net_buffer *buffer, uint32 offset,
						const void *data, size_t bytes);

	int32			(*checksum)(net_buffer *buffer, uint32 offset, size_t bytes,
						bool finalize);
	status_t		(*get_memory_map)(net_buffer *buffer,
						struct iovec *iovecs, uint32 vecCount);
	uint32 			(*get_iovecs)(net_buffer *buffer,
						struct iovec *iovecs, uint32 vecCount);
	uint32 			(*count_iovecs)(net_buffer *buffer);

	void			(*swap_addresses)(net_buffer *buffer);

	void			(*dump)(net_buffer *buffer);
};


#endif	// NET_BUFFER_H