src/base/loader/memory_image.hh

   1 /*
   2  * Copyright (c) 2002-2004 The Regents of The University of Michigan
   3  * All rights reserved.
   4  *
   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.
  15  *
  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.
  27  *
  28  * Authors: Nathan Binkert
  29  *          Steve Reinhardt
  30  */
  31
  32 #ifndef __BASE_LOADER_MEMORY_IMAGE_HH__
  33 #define __BASE_LOADER_MEMORY_IMAGE_HH__
  34
  35 #include <functional>
  36 #include <initializer_list>
  37 #include <memory>
  38 #include <string>
  39 #include <vector>
  40
  41 #include "base/logging.hh"
  42 #include "base/types.hh"
  43
  44 class PortProxy;
  45 class Process;
  46 class ProcessParams;
  47 class SymbolTable;
  48
  49 class MemoryImage
  50 {
  51   public:
  52     struct Segment
  53     {
  54         std::string name;
  55         Addr base;
  56         uint8_t *data;
  57         size_t size;
  58     };
  59
  60     MemoryImage() {}
  61
  62     MemoryImage(std::initializer_list<Segment> new_segs)
  63     {
  64         for (auto &seg: new_segs)
  65             addSegment(seg);
  66     }
  67
  68   private:
  69     std::vector<Segment> _segments;
  70     bool writeSegment(const Segment &seg, const PortProxy &proxy) const;
  71
  72   public:
  73     const std::vector<Segment> &
  74     segments() const
  75     {
  76         return _segments;
  77     }
  78
  79     void
  80     addSegment(const Segment &seg)
  81     {
  82         _segments.emplace_back(seg);
  83     }
  84
  85     void
  86     addSegment(std::string name, Addr base, uint8_t *data, size_t size)
  87     {
  88         _segments.push_back(Segment({name, base, data, size}));
  89     }
  90
  91     bool write(const PortProxy &proxy) const;
  92     MemoryImage &move(std::function<Addr(Addr)> mapper);
  93     MemoryImage &
  94     offset(Addr by)
  95     {
  96         return move([by](Addr a){ return by + a; });
  97     }
  98     MemoryImage &
  99     mask(Addr m) {
 100         return move([m](Addr a) { return a & m; });
 101     }
 102
 103     Addr
 104     maxAddr() const
 105     {
 106         Addr max = 0;
 107         for (auto &seg: _segments) {
 108             Addr end = seg.base + seg.size;
 109             if (end > max)
 110                 max = end;
 111         }
 112         return max;
 113     }
 114
 115     Addr
 116     minAddr() const
 117     {
 118         Addr min = MaxAddr;
 119         for (auto &seg: _segments)
 120             if (seg.base < min)
 121                 min = seg.base;
 122         return min;
 123     }
 124
 125     bool
 126     contains(Addr addr) const
 127     {
 128         for (auto &seg: _segments) {
 129             Addr start = seg.base;
 130             Addr end = seg.base + seg.size;
 131             if (addr >= start && addr < end)
 132                 return true;
 133         }
 134         return false;
 135     }
 136 };
 137
 138 static inline std::ostream &
 139 operator << (std::ostream &os, const MemoryImage::Segment &seg)
 140 {
 141     ccprintf(os, "%s: %#x %d", seg.name, seg.base, seg.size);
 142     return os;
 143 }
 144
 145
 146 #endif // __BASE_LOADER_MEMORY_IMAGE_HH__