/*
 *	PROGRAM:	Firebird Trace Services
 *	MODULE:		TraceConfigStorage.h
 *	DESCRIPTION:	Trace API shared configurations storage
 *
 *  The contents of this file are subject to the Initial
 *  Developer's Public License Version 1.0 (the "License");
 *  you may not use this file except in compliance with the
 *  License. You may obtain a copy of the License at
 *  http://www.ibphoenix.com/main.nfs?a=ibphoenix&page=ibp_idpl.
 *
 *  Software distributed under the License is distributed AS IS,
 *  WITHOUT WARRANTY OF ANY KIND, either express or implied.
 *  See the License for the specific language governing rights
 *  and limitations under the License.
 *
 *  The Original Code was created by Khorsun Vladyslav
 *  for the Firebird Open Source RDBMS project.
 *
 *  Copyright (c) 2008 Khorsun Vladyslav <hvlad@users.sourceforge.net>
 *  and all contributors signed below.
 *
 *  All Rights Reserved.
 *  Contributor(s): ______________________________________.
 *
 */

#ifndef JRD_TRACECONFIGSTORAGE_H
#define JRD_TRACECONFIGSTORAGE_H

#include "../../common/classes/array.h"
#include "../../common/classes/fb_string.h"
#include "../../common/classes/init.h"
#include "../../common/classes/RefCounted.h"
#include "../../common/classes/semaphore.h"
#include "../../jrd/isc.h"
#include "../../jrd/ThreadStart.h"
#include "../../jrd/trace/TraceSession.h"

namespace Jrd {

class StorageInstance;

class ConfigStorage : public Firebird::GlobalStorage
{
friend class StorageInstance;

private:
	ConfigStorage();
	~ConfigStorage();

public:
	void addSession(Firebird::TraceSession& session);
	bool getNextSession(Firebird::TraceSession& session);
	void removeSession(ULONG id);
	void restart();
	void updateSession(Firebird::TraceSession& session);

	ULONG getChangeNumber() const
	{ return m_base ? m_base->change_number : 0; }

	void acquire();
	void release();

	void shutdown();

private:
	static void checkMutex(const TEXT*, int);
	static void initShMem(void*, sh_mem*, bool);

	void checkFile();
	void touchFile();

	static THREAD_ENTRY_DECLARE touchThread(THREAD_ENTRY_PARAM arg);
	void touchThreadFunc();

	void checkDirty()
	{
		if (m_dirty)
		{
			//_commit(m_cfg_file);
			m_dirty = false;
		}
	}

	void setDirty()
	{
		if (!m_dirty)
		{
			m_base->change_number++;
			m_dirty = true;
		}
	}

	struct ShMemHeader
	{
		ULONG version;
		volatile ULONG change_number;
		volatile ULONG session_number;
		ULONG cnt_uses;
		char  cfg_file_name[MAXPATHLEN];
#ifndef WIN_NT
		struct mtx mutex;
#endif
		SINT64 touch_time;
	};

	// items in every session record at sessions file
	enum ITEM
	{
		tagID = 1,			// session ID
		tagName,			// session Name
		tagUserName,		// creator user name
		tagFlags,			// session flags
		tagConfig,			// configuration
		tagStartTS,			// date+time when started
		tagLogFile,			// log file name, if any
		tagEnd
	};

	void putItem(ITEM tag, ULONG len, const void* data);
	bool getItemLength(ITEM& tag, ULONG& len);

	sh_mem m_handle;
	ShMemHeader* m_base;
#ifdef WIN_NT
	struct mtx m_winMutex;
#endif
	struct mtx* m_mutex;
	int m_recursive;
	FB_THREAD_ID m_mutexTID;
	int  m_cfg_file;
	bool m_dirty;
	bool m_shutdown;
	Firebird::Semaphore m_touchStart;
	Firebird::Semaphore m_touchStop;
	Firebird::AnyRef<Firebird::Semaphore>* m_touchSemaphore;
	Firebird::Reference  m_touchSemRef;
};


class StorageInstance
{
private:
	Firebird::Mutex initMtx;
	ConfigStorage* storage;

public:
	explicit StorageInstance(Firebird::MemoryPool&) :
		storage(NULL)
	{}

	~StorageInstance();

	ConfigStorage* getStorage();

	bool initialized()
	{
		Firebird::MutexLockGuard guard(initMtx);
		return (storage != NULL);
	}
};



class StorageGuard
{
public:
	explicit StorageGuard(ConfigStorage* storage) :
		m_storage(storage)
	{
		m_storage->acquire();
	}

	~StorageGuard()
	{
		m_storage->release();
	}
private:
	ConfigStorage* m_storage;
};

}

#endif
