VersatileMemoryPage.hpp

Go to the documentation of this file.

// -*-Mode: C++;-*-

// * BeginRiceCopyright *****************************************************
//
// $HeadURL: https://hpctoolkit.googlecode.com/svn/branches/hpctoolkit-hpcserver/src/tool/hpcserver/VersatileMemoryPage.hpp $
// $Id: VersatileMemoryPage.hpp 4373 2013-10-03 03:51:56Z felipet1326@gmail.com $
//
// --------------------------------------------------------------------------
// Part of HPCToolkit (hpctoolkit.org)
//
// Information about sources of support for research and development of
// HPCToolkit is at 'hpctoolkit.org' and in 'README.Acknowledgments'.
// --------------------------------------------------------------------------
//
// Copyright ((c)) 2002-2019, Rice University
// 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.
//
// * Neither the name of Rice University (RICE) nor the names of its
//   contributors may be used to endorse or promote products derived from
//   this software without specific prior written permission.
//
// This software is provided by RICE and contributors "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 RICE or contributors 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.
//
// ******************************************************* EndRiceCopyright *

//***************************************************************************
//
// File:
//   $HeadURL: https://hpctoolkit.googlecode.com/svn/branches/hpctoolkit-hpcserver/src/tool/hpcserver/VersatileMemoryPage.hpp $
//
// Purpose:
//   [The purpose of this file]
//
// Description:
//   [The set of functions, macros, etc. defined in the file]
//
//***************************************************************************

#ifndef VERSATILEMEMORYPAGE_H_
#define VERSATILEMEMORYPAGE_H_


#include <sys/mman.h>
#include "FileUtils.hpp" //FileOffset
#include "LRUList.hpp"

using namespace std;
namespace TraceviewerServer
{

        class VersatileMemoryPage
        {
        public:
                VersatileMemoryPage();
                VersatileMemoryPage(FileOffset, int, FileDescriptor, LRUList<VersatileMemoryPage>* pageManagementList);
                virtual ~VersatileMemoryPage();
                static void setMaxPages(int);
                char* get();
        private:
                void mapPage();
                void unmapPage();

                FileOffset startPoint;
                int size;
                char* page;
                int index;
                FileDescriptor file;

                bool isMapped;
                LRUList<VersatileMemoryPage>* mostRecentlyUsed;

                // Use MAP_POPULATE if available
#ifdef MAP_POPULATE
                static const int MAP_FLAGS = MAP_SHARED | MAP_POPULATE;
#else
                static const int MAP_FLAGS = MAP_SHARED
#endif
                static const int MAP_PROT = PROT_READ;
        };

} /* namespace TraceviewerServer */
#endif /* VERSATILEMEMORYPAGE_H_ */