src/brains/BlockSnapshotManager.cpp

/*
 * Copyright (c) 2005 The University of Notre Dame. All Rights Reserved.
 *
 * The University of Notre Dame grants you ("Licensee") a
 * non-exclusive, royalty free, license to use, modify and
 * redistribute this software in source and binary code form, provided
 * that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. 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.
 *
 * This software is provided "AS IS," without a warranty of any
 * kind. All express or implied conditions, representations and
 * warranties, including any implied warranty of merchantability,
 * fitness for a particular purpose or non-infringement, are hereby
 * excluded.  The University of Notre Dame and its licensors shall not
 * be liable for any damages suffered by licensee as a result of
 * using, modifying or distributing the software or its
 * derivatives. In no event will the University of Notre Dame or its
 * licensors be liable for any lost revenue, profit or data, or for
 * direct, indirect, special, consequential, incidental or punitive
 * damages, however caused and regardless of the theory of liability,
 * arising out of the use of or inability to use software, even if the
 * University of Notre Dame has been advised of the possibility of
 * such damages.
 *
 * SUPPORT OPEN SCIENCE!  If you use OpenMD or its source code in your
 * research, please cite the appropriate papers when you publish your
 * work.  Good starting points are:
 *                                                                      
 * [1]  Meineke, et al., J. Comp. Chem. 26, 252-271 (2005).             
 * [2]  Fennell & Gezelter, J. Chem. Phys. 124, 234104 (2006).          
 * [3]  Sun, Lin & Gezelter, J. Chem. Phys. 128, 24107 (2008).          
 * [4]  Vardeman & Gezelter, in progress (2009).                        
 */
#include <algorithm>
#include "brains/BlockSnapshotManager.hpp"
#include "utils/residentMem.h"
#include "utils/physmem.h"
#include "utils/Algorithm.hpp"
#include "brains/SimInfo.hpp"
#include "io/DumpReader.hpp"

namespace OpenMD {
  BlockSnapshotManager::BlockSnapshotManager(SimInfo* info, const std::string& filename, 
                                             int storageLayout, int blockCapacity) 
    : SnapshotManager(storageLayout), info_(info), blockCapacity_(blockCapacity), 
      activeBlocks_(blockCapacity_, -1), activeRefCount_(blockCapacity_, 0) {

      nAtoms_ = info->getNGlobalAtoms();
      nRigidBodies_ = info->getNGlobalRigidBodies();

      RealType physMem = physmem_total();
      RealType rssMem = residentMem();
      RealType avaliablePhysMem = physMem - rssMem;

    
      int bytesPerStuntDouble = DataStorage::getBytesPerStuntDouble(storageLayout);

      int bytesPerFrame = (nRigidBodies_ + nAtoms_) * bytesPerStuntDouble;

      // total number of frames that can fit in memory
      RealType frameCapacity = avaliablePhysMem / bytesPerFrame;

      // number of frames in each block given the need to hold multiple blocks 
      // in memory at the same time:
      nSnapshotPerBlock_ = int(frameCapacity) / blockCapacity_;
      reader_ = new DumpReader(info, filename);
      nframes_ = reader_->getNFrames();
      int nblocks = nframes_ / nSnapshotPerBlock_;
      if (nframes_ % int(nSnapshotPerBlock_) != 0) {
        ++nblocks;
      }  
    
      for (int i = 0; i < nblocks; ++i) {
        blocks_.push_back(SnapshotBlock(i*nSnapshotPerBlock_, (i+1)*nSnapshotPerBlock_));    
      }
      //the last block may not have nSnapshotPerBlock frames, we need to consider this special situation
      blocks_.back().second = nframes_;

      snapshots_.insert(snapshots_.begin(), nframes_, static_cast<Snapshot*>(NULL));   

      std::cout << "-----------------------------------------------------"<<std::endl;
      std::cout << "BlockSnapshotManager memory report:" << std::endl;
      std::cout << "\n";
      std::cout << "  Physical Memory available:\t" << (unsigned long)physMem <<  " bytes" <<std::endl;
      std::cout << "     Resident Memory in use:\t" << (unsigned long)rssMem << " bytes" <<std::endl;
      std::cout << "Memory available for OpenMD:\t" << (unsigned long)avaliablePhysMem << " bytes" <<std::endl;
      std::cout << "      Bytes per StuntDouble:\t" << (unsigned long)bytesPerStuntDouble <<std::endl;
      std::cout << "            Bytes per Frame:\t" << (unsigned long)bytesPerFrame <<std::endl;
      std::cout << "             Frame Capacity:\t" << (unsigned long)frameCapacity <<std::endl;
      std::cout << "       Frames in trajectory:\t" << (unsigned long)nframes_ <<std::endl;
      std::cout << "        Snapshots per Block:\t" << (unsigned long)nSnapshotPerBlock_ <<std::endl;
      std::cout << "     Total number of Blocks:\t" << (unsigned long)nblocks << std::endl;
      std::cout << "-----------------------------------------------------"<<std::endl;
    
    }


  BlockSnapshotManager::~BlockSnapshotManager() {
    currentSnapshot_ = NULL;
    previousSnapshot_ = NULL;
    
    delete reader_;

    std::vector<int>::iterator i;
    for (i = activeBlocks_.begin(); i != activeBlocks_.end(); ++i) {
      if (*i != -1) {
        unloadBlock(*i);
      }
    }
  }

   Snapshot* BlockSnapshotManager::getSnapshot(int id) { 
    currentSnapshot_ = snapshots_[id]; 
    return snapshots_[id]; 
  }

  int BlockSnapshotManager::getNActiveBlocks() {
#ifdef __RWSTD   
    int count = 0;
    std::count_if(activeBlocks_.begin(), activeBlocks_.end(), std::bind2nd(std::not_equal_to<int>(), -1), count);
    return count;
#else
    return std::count_if(activeBlocks_.begin(), activeBlocks_.end(), std::bind2nd(std::not_equal_to<int>(), -1));
#endif
  }


  bool BlockSnapshotManager::loadBlock(int block) {
    std::vector<int>::iterator i = findActiveBlock(block);
    bool loadSuccess;
    if (i != activeBlocks_.end()) {
      //if block is already in memory, just increast the reference count
      ++activeRefCount_[i - activeBlocks_.begin()];
      loadSuccess = true;
    } else if (getNActiveBlocks() < blockCapacity_){
      //if number of active blocks is less than the block capacity, just load it
      internalLoad(block);
      loadSuccess = true;
    } else if (hasZeroRefBlock() > 0) {
      //if already reach the block capacity, need to unload a block with 0 reference
      int zeroRefBlock = getFirstZeroRefBlock();
      assert(zeroRefBlock != -1);
      internalUnload(zeroRefBlock);
      internalLoad(block);
    } else {
      //reach the capacity and all blocks in memory are not zero reference
      loadSuccess = false;
    }
    
    return loadSuccess;
  }

  bool BlockSnapshotManager::unloadBlock(int block) {
    bool unloadSuccess;
    std::vector<int>::iterator i = findActiveBlock(block);
    
    if (i != activeBlocks_.end()){
      --activeRefCount_[i - activeBlocks_.begin()];
      if (activeRefCount_[i - activeBlocks_.begin()] < 0) {
        //in case, unloadBlock called multiple times
        activeRefCount_[i - activeBlocks_.begin()]  = 0;
      }
        
      unloadSuccess = true;
    } else {
      unloadSuccess = false;
    }

    return unloadSuccess;
  }

  void BlockSnapshotManager::internalLoad(int block) {
        
    for (int i = blocks_[block].first; i < blocks_[block].second; ++i) {
      snapshots_[i] = loadFrame(i);
    }
    
    std::vector<int>::iterator j;
    j = std::find(activeBlocks_.begin(), activeBlocks_.end(), -1);
    assert(j != activeBlocks_.end());
    *j = block;    
    ++activeRefCount_[j - activeBlocks_.begin()];
  }

  void BlockSnapshotManager::internalUnload(int block) {
    for (int i = blocks_[block].first; i < blocks_[block].second; ++i) {
      delete snapshots_[i];
      snapshots_[i] = NULL;
    }
    std::vector<int>::iterator j;
    j = std::find(activeBlocks_.begin(), activeBlocks_.end(), block);
    assert(j != activeBlocks_.end());
    *j = -1;
  }

  bool BlockSnapshotManager::hasZeroRefBlock(){
    return std::find(activeRefCount_.begin(), activeRefCount_.end(), 0) != activeRefCount_.end() ?  true : false;
  }

  int BlockSnapshotManager::getFirstZeroRefBlock(){
    std::vector<int>::iterator i = std::find(activeRefCount_.begin(), activeRefCount_.end(), 0);
    return i != activeRefCount_.end() ? activeBlocks_[i - activeRefCount_.begin()] : -1;
  }

  std::vector<int> BlockSnapshotManager::getActiveBlocks() {
    std::vector<int> result;
    OpenMD::copy_if(activeBlocks_.begin(), activeBlocks_.end(), std::back_inserter(result), 
                   std::bind2nd(std::not_equal_to<int>(), -1));
    return result;    
  }

  Snapshot* BlockSnapshotManager::loadFrame(int frame){
    Snapshot* snapshot = new Snapshot(nAtoms_, nRigidBodies_, getStorageLayout());
    snapshot->setID(frame);
    
    /** @todo fixed me */
    Snapshot* oldSnapshot = currentSnapshot_;
    currentSnapshot_ = snapshot;   
    reader_->readFrame(frame);

    // What was this for?  It doesn't make sense!
    //currentSnapshot_ = oldSnapshot;

    return snapshot;
  }

  int BlockSnapshotManager::getNFrames() {
    return reader_->getNFrames();
  }

  void BlockSnapshotManager::needCOMprops(bool ncp) {
    reader_->setNeedCOMprops(ncp);
  }

}
Revision:	1390
Committed:	Wed Nov 25 20:02:06 2009 UTC (15 years, 5 months ago) by gezelter
File size:	9383 byte(s)
Log Message:	Almost all of the changes necessary to create OpenMD out of our old project (OOPSE-4)
#	User	Rev	Content
1	tim	318	/*
2			* Copyright (c) 2005 The University of Notre Dame. All Rights Reserved.
3			*
4			* The University of Notre Dame grants you ("Licensee") a
5			* non-exclusive, royalty free, license to use, modify and
6			* redistribute this software in source and binary code form, provided
7			* that the following conditions are met:
8			*
9	gezelter	1390	* 1. Redistributions of source code must retain the above copyright
10	tim	318	* notice, this list of conditions and the following disclaimer.
11			*
12	gezelter	1390	* 2. Redistributions in binary form must reproduce the above copyright
13	tim	318	* notice, this list of conditions and the following disclaimer in the
14			* documentation and/or other materials provided with the
15			* distribution.
16			*
17			* This software is provided "AS IS," without a warranty of any
18			* kind. All express or implied conditions, representations and
19			* warranties, including any implied warranty of merchantability,
20			* fitness for a particular purpose or non-infringement, are hereby
21			* excluded. The University of Notre Dame and its licensors shall not
22			* be liable for any damages suffered by licensee as a result of
23			* using, modifying or distributing the software or its
24			* derivatives. In no event will the University of Notre Dame or its
25			* licensors be liable for any lost revenue, profit or data, or for
26			* direct, indirect, special, consequential, incidental or punitive
27			* damages, however caused and regardless of the theory of liability,
28			* arising out of the use of or inability to use software, even if the
29			* University of Notre Dame has been advised of the possibility of
30			* such damages.
31	gezelter	1390	*
32			* SUPPORT OPEN SCIENCE! If you use OpenMD or its source code in your
33			* research, please cite the appropriate papers when you publish your
34			* work. Good starting points are:
35			*
36			* [1] Meineke, et al., J. Comp. Chem. 26, 252-271 (2005).
37			* [2] Fennell & Gezelter, J. Chem. Phys. 124, 234104 (2006).
38			* [3] Sun, Lin & Gezelter, J. Chem. Phys. 128, 24107 (2008).
39			* [4] Vardeman & Gezelter, in progress (2009).
40	tim	318	*/
41			#include <algorithm>
42			#include "brains/BlockSnapshotManager.hpp"
43	tim	354	#include "utils/residentMem.h"
44	tim	322	#include "utils/physmem.h"
45	tim	324	#include "utils/Algorithm.hpp"
46	tim	318	#include "brains/SimInfo.hpp"
47			#include "io/DumpReader.hpp"
48
49	gezelter	1390	namespace OpenMD {
50	gezelter	507	BlockSnapshotManager::BlockSnapshotManager(SimInfo* info, const std::string& filename,
51			int storageLayout, int blockCapacity)
52	tim	351	: SnapshotManager(storageLayout), info_(info), blockCapacity_(blockCapacity),
53			activeBlocks_(blockCapacity_, -1), activeRefCount_(blockCapacity_, 0) {
54	tim	318
55	gezelter	507	nAtoms_ = info->getNGlobalAtoms();
56			nRigidBodies_ = info->getNGlobalRigidBodies();
57	tim	318
58	tim	963	RealType physMem = physmem_total();
59			RealType rssMem = residentMem();
60			RealType avaliablePhysMem = physMem - rssMem;
61	xsun	1215
62	tim	355
63	gezelter	507	int bytesPerStuntDouble = DataStorage::getBytesPerStuntDouble(storageLayout);
64	tim	318
65	gezelter	507	int bytesPerFrame = (nRigidBodies_ + nAtoms_) * bytesPerStuntDouble;
66	tim	318
67	xsun	1215	// total number of frames that can fit in memory
68			RealType frameCapacity = avaliablePhysMem / bytesPerFrame;
69
70			// number of frames in each block given the need to hold multiple blocks
71			// in memory at the same time:
72			nSnapshotPerBlock_ = int(frameCapacity) / blockCapacity_;
73	gezelter	507	reader_ = new DumpReader(info, filename);
74			nframes_ = reader_->getNFrames();
75			int nblocks = nframes_ / nSnapshotPerBlock_;
76	xsun	1215	if (nframes_ % int(nSnapshotPerBlock_) != 0) {
77	tim	318	++nblocks;
78	gezelter	507	}
79	tim	318
80	gezelter	507	for (int i = 0; i < nblocks; ++i) {
81	tim	337	blocks_.push_back(SnapshotBlock(inSnapshotPerBlock_, (i+1)nSnapshotPerBlock_));
82	gezelter	507	}
83			//the last block may not have nSnapshotPerBlock frames, we need to consider this special situation
84			blocks_.back().second = nframes_;
85	tim	318
86	gezelter	507	snapshots_.insert(snapshots_.begin(), nframes_, static_cast<Snapshot*>(NULL));
87	tim	358
88	xsun	1215	std::cout << "-----------------------------------------------------"<<std::endl;
89			std::cout << "BlockSnapshotManager memory report:" << std::endl;
90			std::cout << "\n";
91	gezelter	1390	std::cout << " Physical Memory available:\t" << (unsigned long)physMem << " bytes" <<std::endl;
92			std::cout << " Resident Memory in use:\t" << (unsigned long)rssMem << " bytes" <<std::endl;
93			std::cout << "Memory available for OpenMD:\t" << (unsigned long)avaliablePhysMem << " bytes" <<std::endl;
94			std::cout << " Bytes per StuntDouble:\t" << (unsigned long)bytesPerStuntDouble <<std::endl;
95			std::cout << " Bytes per Frame:\t" << (unsigned long)bytesPerFrame <<std::endl;
96			std::cout << " Frame Capacity:\t" << (unsigned long)frameCapacity <<std::endl;
97			std::cout << " Frames in trajectory:\t" << (unsigned long)nframes_ <<std::endl;
98			std::cout << " Snapshots per Block:\t" << (unsigned long)nSnapshotPerBlock_ <<std::endl;
99			std::cout << " Total number of Blocks:\t" << (unsigned long)nblocks << std::endl;
100	xsun	1215	std::cout << "-----------------------------------------------------"<<std::endl;
101	tim	318
102	gezelter	507	}
103	tim	318
104
105	gezelter	507	BlockSnapshotManager::~BlockSnapshotManager() {
106	tim	318	currentSnapshot_ = NULL;
107			previousSnapshot_ = NULL;
108
109			delete reader_;
110	tim	324
111			std::vector<int>::iterator i;
112			for (i = activeBlocks_.begin(); i != activeBlocks_.end(); ++i) {
113	gezelter	507	if (*i != -1) {
114			unloadBlock(*i);
115			}
116	tim	324	}
117	gezelter	507	}
118	tim	318
119	gezelter	1249	Snapshot* BlockSnapshotManager::getSnapshot(int id) {
120			currentSnapshot_ = snapshots_[id];
121			return snapshots_[id];
122			}
123	xsun	1215
124	gezelter	507	int BlockSnapshotManager::getNActiveBlocks() {
125	tim	347	#ifdef __RWSTD
126			int count = 0;
127			std::count_if(activeBlocks_.begin(), activeBlocks_.end(), std::bind2nd(std::not_equal_to<int>(), -1), count);
128			return count;
129			#else
130	tim	324	return std::count_if(activeBlocks_.begin(), activeBlocks_.end(), std::bind2nd(std::not_equal_to<int>(), -1));
131	tim	347	#endif
132	gezelter	507	}
133	tim	318
134
135	tim	351
136	gezelter	507	bool BlockSnapshotManager::loadBlock(int block) {
137	tim	351	std::vector<int>::iterator i = findActiveBlock(block);
138	tim	318	bool loadSuccess;
139	tim	351	if (i != activeBlocks_.end()) {
140	gezelter	507	//if block is already in memory, just increast the reference count
141			++activeRefCount_[i - activeBlocks_.begin()];
142			loadSuccess = true;
143	tim	318	} else if (getNActiveBlocks() < blockCapacity_){
144	gezelter	507	//if number of active blocks is less than the block capacity, just load it
145			internalLoad(block);
146			loadSuccess = true;
147	tim	351	} else if (hasZeroRefBlock() > 0) {
148	gezelter	507	//if already reach the block capacity, need to unload a block with 0 reference
149			int zeroRefBlock = getFirstZeroRefBlock();
150			assert(zeroRefBlock != -1);
151			internalUnload(zeroRefBlock);
152			internalLoad(block);
153	tim	351	} else {
154	gezelter	507	//reach the capacity and all blocks in memory are not zero reference
155			loadSuccess = false;
156	tim	318	}
157	tim	351
158	tim	318	return loadSuccess;
159	gezelter	507	}
160	tim	318
161	gezelter	507	bool BlockSnapshotManager::unloadBlock(int block) {
162	tim	318	bool unloadSuccess;
163	tim	351	std::vector<int>::iterator i = findActiveBlock(block);
164
165			if (i != activeBlocks_.end()){
166	gezelter	507	--activeRefCount_[i - activeBlocks_.begin()];
167			if (activeRefCount_[i - activeBlocks_.begin()] < 0) {
168			//in case, unloadBlock called multiple times
169			activeRefCount_[i - activeBlocks_.begin()] = 0;
170			}
171	tim	351
172	gezelter	507	unloadSuccess = true;
173	tim	351	} else {
174	gezelter	507	unloadSuccess = false;
175	tim	318	}
176	tim	324
177			return unloadSuccess;
178	gezelter	507	}
179	tim	318
180	gezelter	507	void BlockSnapshotManager::internalLoad(int block) {
181	tim	351
182			for (int i = blocks_[block].first; i < blocks_[block].second; ++i) {
183	gezelter	507	snapshots_[i] = loadFrame(i);
184	tim	351	}
185
186			std::vector<int>::iterator j;
187			j = std::find(activeBlocks_.begin(), activeBlocks_.end(), -1);
188			assert(j != activeBlocks_.end());
189			*j = block;
190			++activeRefCount_[j - activeBlocks_.begin()];
191	gezelter	507	}
192	tim	351
193	gezelter	507	void BlockSnapshotManager::internalUnload(int block) {
194	tim	351	for (int i = blocks_[block].first; i < blocks_[block].second; ++i) {
195	gezelter	507	delete snapshots_[i];
196			snapshots_[i] = NULL;
197	tim	351	}
198			std::vector<int>::iterator j;
199			j = std::find(activeBlocks_.begin(), activeBlocks_.end(), block);
200			assert(j != activeBlocks_.end());
201			*j = -1;
202	gezelter	507	}
203	tim	351
204	gezelter	507	bool BlockSnapshotManager::hasZeroRefBlock(){
205	tim	352	return std::find(activeRefCount_.begin(), activeRefCount_.end(), 0) != activeRefCount_.end() ? true : false;
206	gezelter	507	}
207	tim	351
208	gezelter	507	int BlockSnapshotManager::getFirstZeroRefBlock(){
209			std::vector<int>::iterator i = std::find(activeRefCount_.begin(), activeRefCount_.end(), 0);
210			return i != activeRefCount_.end() ? activeBlocks_[i - activeRefCount_.begin()] : -1;
211			}
212	tim	351
213	gezelter	507	std::vector<int> BlockSnapshotManager::getActiveBlocks() {
214	tim	318	std::vector<int> result;
215	gezelter	1390	OpenMD::copy_if(activeBlocks_.begin(), activeBlocks_.end(), std::back_inserter(result),
216	gezelter	507	std::bind2nd(std::not_equal_to<int>(), -1));
217	tim	324	return result;
218	gezelter	507	}
219	tim	318
220	gezelter	507	Snapshot* BlockSnapshotManager::loadFrame(int frame){
221	tim	318	Snapshot* snapshot = new Snapshot(nAtoms_, nRigidBodies_, getStorageLayout());
222			snapshot->setID(frame);
223	tim	324
224			/** @todo fixed me */
225			Snapshot* oldSnapshot = currentSnapshot_;
226			currentSnapshot_ = snapshot;
227	tim	318	reader_->readFrame(frame);
228	xsun	1215
229			// What was this for? It doesn't make sense!
230			//currentSnapshot_ = oldSnapshot;
231
232	tim	318	return snapshot;
233	gezelter	507	}
234	tim	318
235	gezelter	507	int BlockSnapshotManager::getNFrames() {
236	tim	322	return reader_->getNFrames();
237	gezelter	507	}
238	tim	322
239	gezelter	1106	void BlockSnapshotManager::needCOMprops(bool ncp) {
240			reader_->setNeedCOMprops(ncp);
241			}
242
243	tim	322	}