flash_device.hh

Go to the documentation of this file.

/*
 * Copyright (c) 2013-2015 ARM Limited
 * All rights reserved
 *
 * The license below extends only to copyright in the software and shall
 * not be construed as granting a license to any other intellectual
 * property including but not limited to intellectual property relating
 * to a hardware implementation of the functionality of the software
 * licensed hereunder.  You may use the software subject to the license
 * terms below provided that you ensure that this notice is replicated
 * unmodified and in its entirety in all distributions of the software,
 * modified or unmodified, in source code or in binary form.
 *
 * 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 the copyright holders 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 THE COPYRIGHT HOLDERS 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 THE COPYRIGHT
 * OWNER 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.
 */
#ifndef __DEV_ARM_FLASH_DEVICE_HH__
#define __DEV_ARM_FLASH_DEVICE_HH__
 
#include <deque>
 
#include "base/statistics.hh"
#include "debug/FlashDevice.hh"
#include "dev/arm/abstract_nvm.hh"
#include "enums/DataDistribution.hh"
#include "sim/serialize.hh"
 
namespace gem5
{
 
struct FlashDeviceParams;

class FlashDevice : public AbstractNVM
{
  public:

    FlashDevice(const FlashDeviceParams &);
    ~FlashDevice();

    DrainState drain() override;
    void checkDrain();
 
    void serialize(CheckpointOut &cp) const override;
    void unserialize(CheckpointIn &cp) override;
 
  private:
    enum Actions
    {
        ActionRead,
        ActionWrite,
        ActionErase,
        ActionCopy
    };

    struct PageMapEntry
    {
        uint32_t page;
        uint32_t block;
    };
 
    struct CallBackEntry
    {
        Tick time;
        std::function<void()> function;
    };
 
    struct FlashDeviceStats : public statistics::Group
    {
        FlashDeviceStats(statistics::Group *parent);

        statistics::Scalar totalGCActivations;

        statistics::Histogram writeAccess;
        statistics::Histogram readAccess;
        statistics::Histogram fileSystemAccess;

        statistics::Histogram writeLatency;
        statistics::Histogram readLatency;
    };

    void
    initializeMemory(uint64_t disk_size, uint32_t sector_size) override
    {
        initializeFlash(disk_size, sector_size);
    }
 
    void
    readMemory(uint64_t address, uint32_t amount,
               const std::function<void()> &event) override
    {
        accessDevice(address, amount, event, ActionRead);
    }
 
    void
    writeMemory(uint64_t address, uint32_t amount,
                const std::function<void()> &event) override
    {
        accessDevice(address, amount, event, ActionWrite);
    }

    void initializeFlash(uint64_t disk_size, uint32_t sector_size);

    void accessDevice(uint64_t address, uint32_t amount,
                      const std::function<void()> &event, Actions action);

    void actionComplete();

    Tick remap(uint64_t logic_page_addr);

    Tick accessTimes(uint64_t address, Actions accesstype);

    void clearUnknownPages(uint32_t index);

    bool getUnknownPages(uint32_t index);

    uint64_t diskSize;
    const uint32_t blockSize;
    const uint32_t pageSize;

    const uint32_t GCActivePercentage;

    const Tick readLatency;
    const Tick writeLatency;
    const Tick eraseLatency;

    const enums::DataDistribution dataDistribution;
    const uint32_t numPlanes;

    struct FlashDeviceStats stats;

    uint32_t pagesPerBlock;
    uint32_t pagesPerDisk;
    uint32_t blocksPerDisk;
 
    uint32_t planeMask;

    std::vector<uint32_t> unknownPages;
    std::vector<struct PageMapEntry> locationTable;
    std::vector<uint32_t> blockValidEntries;
    std::vector<uint32_t> blockEmptyEntries;

    std::vector<std::deque<struct CallBackEntry> > planeEventQueue;

    EventFunctionWrapper planeEvent;
};
 
} // namespace gem5
 
#endif //__DEV_ARM_FLASH_DEVICE_HH__