disk_image.hh revision 56
112855Sgabeblack@google.com/* 212855Sgabeblack@google.com * Copyright (c) 2003 The Regents of The University of Michigan 312855Sgabeblack@google.com * All rights reserved. 412855Sgabeblack@google.com * 512855Sgabeblack@google.com * Redistribution and use in source and binary forms, with or without 612855Sgabeblack@google.com * modification, are permitted provided that the following conditions are 712855Sgabeblack@google.com * met: redistributions of source code must retain the above copyright 812855Sgabeblack@google.com * notice, this list of conditions and the following disclaimer; 912855Sgabeblack@google.com * redistributions in binary form must reproduce the above copyright 1012855Sgabeblack@google.com * notice, this list of conditions and the following disclaimer in the 1112855Sgabeblack@google.com * documentation and/or other materials provided with the distribution; 1212855Sgabeblack@google.com * neither the name of the copyright holders nor the names of its 1312855Sgabeblack@google.com * contributors may be used to endorse or promote products derived from 1412855Sgabeblack@google.com * this software without specific prior written permission. 1512855Sgabeblack@google.com * 1612855Sgabeblack@google.com * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 1712855Sgabeblack@google.com * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 1812855Sgabeblack@google.com * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 1912855Sgabeblack@google.com * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 2012855Sgabeblack@google.com * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 2112855Sgabeblack@google.com * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 2212855Sgabeblack@google.com * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 2312855Sgabeblack@google.com * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 2412855Sgabeblack@google.com * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 2512855Sgabeblack@google.com * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 2612855Sgabeblack@google.com * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 2712855Sgabeblack@google.com */ 2812855Sgabeblack@google.com 2912855Sgabeblack@google.com/* @file 3012855Sgabeblack@google.com * Disk Image Interfaces 3112855Sgabeblack@google.com */ 3212855Sgabeblack@google.com 3312855Sgabeblack@google.com#ifndef __DISK_IMAGE_HH__ 3412855Sgabeblack@google.com#define __DISK_IMAGE_HH__ 3512855Sgabeblack@google.com 3612855Sgabeblack@google.com#include <fstream> 3712855Sgabeblack@google.com 3812855Sgabeblack@google.com#include "base/hashmap.hh" 3912855Sgabeblack@google.com#include "sim/sim_object.hh" 4012855Sgabeblack@google.com 4112855Sgabeblack@google.com#define SectorSize (512) 4212855Sgabeblack@google.com 4312855Sgabeblack@google.com/* 4412855Sgabeblack@google.com * Basic interface for accessing a disk image. 4512855Sgabeblack@google.com */ 4612855Sgabeblack@google.comclass DiskImage : public SimObject 4712855Sgabeblack@google.com{ 4812855Sgabeblack@google.com protected: 4912855Sgabeblack@google.com bool initialized; 5012855Sgabeblack@google.com 5112855Sgabeblack@google.com public: 5212855Sgabeblack@google.com DiskImage(const std::string &name) : SimObject(name), initialized(false) {} 5312855Sgabeblack@google.com virtual ~DiskImage() {} 5412855Sgabeblack@google.com 5512855Sgabeblack@google.com virtual off_t size() const = 0; 5612855Sgabeblack@google.com 5712855Sgabeblack@google.com virtual off_t read(uint8_t *data, off_t offset) const = 0; 5812855Sgabeblack@google.com virtual off_t write(const uint8_t *data, off_t offset) = 0; 5912855Sgabeblack@google.com}; 6012855Sgabeblack@google.com 6112855Sgabeblack@google.com/* 6212855Sgabeblack@google.com * Specialization for accessing a raw disk image 6312855Sgabeblack@google.com */ 6412855Sgabeblack@google.comclass RawDiskImage : public DiskImage 6512855Sgabeblack@google.com{ 6612855Sgabeblack@google.com protected: 6712855Sgabeblack@google.com mutable std::fstream stream; 6812855Sgabeblack@google.com std::string file; 6912855Sgabeblack@google.com bool readonly; 7012855Sgabeblack@google.com mutable off_t disk_size; 7112855Sgabeblack@google.com 7212855Sgabeblack@google.com public: 7312855Sgabeblack@google.com RawDiskImage(const std::string &name, const std::string &filename, 7412855Sgabeblack@google.com bool rd_only); 7512855Sgabeblack@google.com ~RawDiskImage(); 7612855Sgabeblack@google.com 7712855Sgabeblack@google.com void close(); 7812855Sgabeblack@google.com void open(const std::string &filename, bool rd_only = false); 7912855Sgabeblack@google.com 8012855Sgabeblack@google.com virtual off_t size() const; 8112855Sgabeblack@google.com 8212855Sgabeblack@google.com virtual off_t read(uint8_t *data, off_t offset) const; 8312855Sgabeblack@google.com virtual off_t write(const uint8_t *data, off_t offset); 8412855Sgabeblack@google.com}; 8512855Sgabeblack@google.com 8612855Sgabeblack@google.com/* 8712855Sgabeblack@google.com * Specialization for accessing a copy-on-write disk image layer. 8812855Sgabeblack@google.com * A copy-on-write(COW) layer must be stacked on top of another disk 8912855Sgabeblack@google.com * image layer this layer can be another CowDiskImage, or a 9012855Sgabeblack@google.com * RawDiskImage. 9112855Sgabeblack@google.com * 9212855Sgabeblack@google.com * This object is designed to provide a mechanism for persistant 9312855Sgabeblack@google.com * changes to a main disk image, or to provide a place for temporary 9412855Sgabeblack@google.com * changes to the image to take place that later may be thrown away. 9512855Sgabeblack@google.com */ 9612855Sgabeblack@google.comclass CowDiskImage : public DiskImage 9712855Sgabeblack@google.com{ 9812855Sgabeblack@google.com public: 9912855Sgabeblack@google.com static const int VersionMajor; 10012855Sgabeblack@google.com static const int VersionMinor; 10112855Sgabeblack@google.com 102 protected: 103 struct Sector { 104 uint8_t data[SectorSize]; 105 }; 106 typedef m5::hash_map<uint64_t, Sector *> SectorTable; 107 108 protected: 109 std::string filename; 110 DiskImage *child; 111 SectorTable *table; 112 113 public: 114 CowDiskImage(const std::string &name, DiskImage *kid, int hash_size); 115 CowDiskImage(const std::string &name, DiskImage *kid, int hash_size, 116 const std::string &filename, bool read_only); 117 ~CowDiskImage(); 118 119 void init(int hash_size); 120 bool open(); 121 void save(); 122 void writeback(); 123 124 virtual off_t size() const; 125 126 virtual off_t read(uint8_t *data, off_t offset) const; 127 virtual off_t write(const uint8_t *data, off_t offset); 128}; 129 130#endif // __DISK_IMAGE_HH__ 131