2 * Copyright (c) 2001-2005 The Regents of The University of Michigan
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
7 * met: redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer;
9 * redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution;
12 * neither the name of the copyright holders nor the names of its
13 * contributors may be used to endorse or promote products derived from
14 * this software without specific prior written permission.
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 * Authors: Nathan Binkert
32 * Disk Image Interfaces
35 #ifndef __DEV_STORAGE_DISK_IMAGE_HH__
36 #define __DEV_STORAGE_DISK_IMAGE_HH__
39 #include <unordered_map>
41 #include "params/CowDiskImage.hh"
42 #include "params/DiskImage.hh"
43 #include "params/RawDiskImage.hh"
44 #include "sim/sim_object.hh"
46 #define SectorSize (512)
49 * Basic interface for accessing a disk image.
51 class DiskImage : public SimObject
57 typedef DiskImageParams Params;
58 DiskImage(const Params *p) : SimObject(p), initialized(false) {}
59 virtual ~DiskImage() {}
61 virtual std::streampos size() const = 0;
63 virtual std::streampos read(uint8_t *data,
64 std::streampos offset) const = 0;
65 virtual std::streampos write(const uint8_t *data,
66 std::streampos offset) = 0;
70 * Specialization for accessing a raw disk image
72 class RawDiskImage : public DiskImage
75 mutable std::fstream stream;
78 mutable std::streampos disk_size;
81 typedef RawDiskImageParams Params;
82 RawDiskImage(const Params *p);
85 void notifyFork() override;
88 void open(const std::string &filename, bool rd_only = false);
90 std::streampos size() const override;
92 std::streampos read(uint8_t *data, std::streampos offset) const override;
93 std::streampos write(const uint8_t *data, std::streampos offset) override;
97 * Specialization for accessing a copy-on-write disk image layer.
98 * A copy-on-write(COW) layer must be stacked on top of another disk
99 * image layer this layer can be another CowDiskImage, or a
102 * This object is designed to provide a mechanism for persistant
103 * changes to a main disk image, or to provide a place for temporary
104 * changes to the image to take place that later may be thrown away.
106 class CowDiskImage : public DiskImage
109 static const uint32_t VersionMajor;
110 static const uint32_t VersionMinor;
114 uint8_t data[SectorSize];
116 typedef std::unordered_map<uint64_t, Sector *> SectorTable;
119 std::string filename;
124 typedef CowDiskImageParams Params;
125 CowDiskImage(const Params *p);
128 void notifyFork() override;
130 void initSectorTable(int hash_size);
131 bool open(const std::string &file);
133 void save(const std::string &file) const;
136 void serialize(CheckpointOut &cp) const override;
137 void unserialize(CheckpointIn &cp) override;
139 std::streampos size() const override;
141 std::streampos read(uint8_t *data, std::streampos offset) const override;
142 std::streampos write(const uint8_t *data, std::streampos offset) override;
145 void SafeRead(std::ifstream &stream, void *data, int count);
148 void SafeRead(std::ifstream &stream, T &data);
151 void SafeReadSwap(std::ifstream &stream, T &data);
153 void SafeWrite(std::ofstream &stream, const void *data, int count);
156 void SafeWrite(std::ofstream &stream, const T &data);
159 void SafeWriteSwap(std::ofstream &stream, const T &data);
161 #endif // __DEV_STORAGE_DISK_IMAGE_HH__