/*

Copyright (c) 2002-2005, Yauheni Akhotnikau
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.

*/

/*!
	\file
	\since v.1.4.0
	\brief Реализация интерфейса кэша основного файла хранилища.
*/
#if !defined( _OESS_1__DB__STORAGE__IMPL__STD_CACHE_HPP_ )
#define _OESS_1__DB__STORAGE__IMPL__STD_CACHE_HPP_

#include <map>

#include <oess_1/db/storage/impl/h/cache.hpp>

namespace oess_1 {

namespace db {

namespace storage {

namespace impl {

/*!
	\since v.1.4.0
	\brief Реализация интерфейса кэша основного файла хранилища.
*/
class	std_cache_t
	:	public	cache_t
	{
	public :
		std_cache_t();
		virtual ~std_cache_t();

	//! \name Реализация унаследованных методов.
	//! \{
		virtual void
		reinit(
			oess_1::uint_t cache_size,
			oess_1::uint_t page_size );

		virtual void
		cleanup();

		virtual const oess_1::char_t *
		read_access(
			oess_1::uint_t ordinal );

		virtual oess_1::char_t *
		write_access(
			oess_1::uint_t ordinal );

		virtual oess_1::char_t *
		push(
			const ref_loaded_page_t & page,
			dirty_page_storage_t & storage,
			bool is_read_only_access );

		virtual void
		copy_all_dirties(
			dirty_page_storage_t & storage );

		virtual void
		clear_all_dirties();

		virtual void
		throw_away_all_dirties();
	//! \}

		/*!
			Тип элемента кэша.
		*/
		struct	page_t
			{
				//! Значение страницы.
				ref_loaded_page_t m_page;

				//! Время последнего доступа к странице.
				unsigned long	m_last_access_time;

				//! Признак того, что страница 'грязная'.
				bool	m_is_dirty;

				//! Конструктор, который необходим для std::map.
				page_t()
					:	m_last_access_time( 0 )
					,	m_is_dirty( false )
					{}

				//! Инициализирующий конструктор.
				page_t(
					//! Значение страницы. Если у страницы нет предыдущего
					//! значения, то страница объявляется грязной.
					const ref_loaded_page_t & page,
					//! Текущее время.
					unsigned long last_access_time )
					:	m_page( page )
					,	m_last_access_time( last_access_time )
					,	m_is_dirty( true )
					{
						if( m_page->has_previous() )
							m_is_dirty = false;
					}

				//! Получить весь объект ref_loaded_page_t.
				const ref_loaded_page_t &
				page() const
					{
						return m_page;
					}

				//! Получить доступ к текущему значению с обновлением
				//! времени доступа.
				oess_1::char_t *
				current(
					unsigned long last_access_time )
					{
						m_last_access_time = last_access_time;
						return m_page->current();
					}

				//! Получить доступ к текущему значению без обновления
				//! времени доступа.
				const oess_1::char_t *
				current() const
					{
						return m_page->current();
					}

				//! Получить время последнего доступа.
				unsigned long
				last_access_time() const
					{
						return m_last_access_time;
					}

				//! Является ли страница грязной?
				bool
				is_dirty() const
					{
						return m_is_dirty;
					}

				//! Объявить страницу грязной.
				void
				make_dirty()
					{
						m_is_dirty = true;
					}

				//! Объявить страницу чистой.
				/*!
					Текущее значение страницы автоматически становится
					предыдущим значением.
				*/
				void
				make_clear()
					{
						m_is_dirty = false;
						m_page->change_previous_by_current();
					}
			};

		//! Тип карты страниц в кэше.
		typedef std::map< oess_1::uint_t, page_t >	page_map_t;

	private :
		//! Максимальный размер кэша.
		oess_1::uint_t	m_max_size;
		//! Размер одной страницы.
		oess_1::uint_t	m_page_size;

		//! Счетчик времени доступа к страницам.
		unsigned int	m_timer;

		//! Содержимое кэша.
		page_map_t	m_pages;

	//! \name Средства для оптимизации работы кэша.
	//! \{
		//! Номер страницы, к которой осуществлялся доступ в последний раз.	
		oess_1::uint_t	m_last_accessed_page_index;
		//! Сама страница, к которой в последний раз осуществлялся доступ.
		page_t *	m_last_accessed_page;
	//! \}

		//! Вытеснить какую-нибудь страницу из кэша чтобы	
		//! освободить место для новой страницы.
		void
		push_out_some_page(
			//! Приемник грязных страниц.
			dirty_page_storage_t & storage );
	};

} /* namespace impl */

} /* namespace storage */

} /* namespace db */

} /* namespace oess_1 */

#endif

