xref: /haiku/src/add-ons/kernel/network/protocols/unix/UnixFifo.h (revision 6057b5ee44416b26f14a0b10c008889285c2a0bb)

/*
 * Copyright 2008, Ingo Weinhold, ingo_weinhold@gmx.de.
 * Distributed under the terms of the MIT License.
 */
#ifndef UNIX_FIFO_H
#define UNIX_FIFO_H

#include <Referenceable.h>

#include <condition_variable.h>
#include <lock.h>
#include <util/AutoLock.h>
#include <util/DoublyLinkedList.h>

#include <net_buffer.h>


#define UNIX_FIFO_SHUTDOWN_READ		1
#define UNIX_FIFO_SHUTDOWN_WRITE	2

#define UNIX_FIFO_SHUTDOWN			1
	// error code returned by Read()/Write()

#define UNIX_FIFO_MINIMAL_CAPACITY	1024
#define UNIX_FIFO_MAXIMAL_CAPACITY	(128 * 1024)


#define TRACE_BUFFER_QUEUE	0


class UnixBufferQueue {
public:
	UnixBufferQueue(size_t capacity);
	~UnixBufferQueue();

	size_t	Readable() const	{ return fSize; }
	size_t	Writable() const
		{ return fCapacity >= fSize ? fCapacity - fSize : 0; }

	status_t Read(size_t size, net_buffer** _buffer);
	status_t Write(net_buffer* buffer, size_t maxSize);

	size_t Capacity() const		{ return fCapacity; }
	void SetCapacity(size_t capacity);

#if TRACE_BUFFER_QUEUE
	void ParanoiaReadCheck(net_buffer* buffer);
	void PostReadWrite();
#endif

private:
	typedef DoublyLinkedList<net_buffer, DoublyLinkedListCLink<net_buffer> >
		BufferList;

	BufferList	fBuffers;
	size_t		fSize;
	size_t		fCapacity;
#if TRACE_BUFFER_QUEUE
	off_t		fWritten;
	off_t		fRead;
	uint8*		fParanoiaCheckBuffer;
	uint8*		fParanoiaCheckBuffer2;
#endif
};



class UnixFifo : public Referenceable {
public:
	UnixFifo(size_t capacity);
	~UnixFifo();

	status_t Init();

	bool Lock()
	{
		return benaphore_lock(&fLock) == B_OK;
	}

	void Unlock()
	{
		benaphore_unlock(&fLock);
	}

	void Shutdown(uint32 shutdown);

	bool IsReadShutdown() const
	{
		return (fShutdown & UNIX_FIFO_SHUTDOWN_READ);
	}

	bool IsWriteShutdown() const
	{
		return (fShutdown & UNIX_FIFO_SHUTDOWN_WRITE);
	}

	status_t Read(size_t numBytes, bigtime_t timeout, net_buffer** _buffer);
	status_t Write(net_buffer* buffer, bigtime_t timeout);

	size_t Readable() const;
	size_t Writable() const;

	void SetBufferCapacity(size_t capacity);

private:
	struct Request : DoublyLinkedListLinkImpl<Request> {
		Request(size_t size)
			:
			size(size)
		{
		}

		size_t		size;
	};

	typedef DoublyLinkedList<Request> RequestList;

private:
	status_t _Read(Request& request, size_t numBytes, bigtime_t timeout,
		net_buffer** _buffer);
	status_t _Write(Request& request, net_buffer* buffer, bigtime_t timeout,
		size_t& bytesWritten);
	status_t _WriteNonBlocking(Request& request, net_buffer* buffer,
		size_t& bytesWritten);

private:
	benaphore			fLock;
	UnixBufferQueue		fBuffer;
	RequestList			fReaders;
	RequestList			fWriters;
	size_t				fReadRequested;
	size_t				fWriteRequested;
	ConditionVariable	fReadCondition;
	ConditionVariable	fWriteCondition;
	uint32				fShutdown;
};


typedef AutoLocker<UnixFifo> UnixFifoLocker;


#endif	// UNIX_FIFO_H