fd_array.hh

Go to the documentation of this file.

/*
 * Copyright (c) 2016 Advanced Micro Devices, Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted 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.
 *
 * 3. Neither the name of the copyright holder 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 HOLDER 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 __FD_ARRAY_HH__
#define __FD_ARRAY_HH__
 
#include <array>
#include <map>
#include <memory>
#include <string>
 
#include "sim/fd_entry.hh"
#include "sim/serialize.hh"
 
namespace gem5
{
 
class Process;
 
class FDArray : public Serializable
{
  public:
    FDArray(std::string const& input, std::string const& output,
            std::string const& errout);
 
    void updateFileOffsets();
 
    void restoreFileOffsets();
 
    void setFDEntry(int tgt_fd, std::shared_ptr<FDEntry> fdep);
 
    std::shared_ptr<FDEntry>
    operator[](int tgt_fd)
    {
        return getFDEntry(tgt_fd);
    }
 
    int getSize() const { return _fdArray.size(); }
 
    int allocFD(std::shared_ptr<FDEntry> fdp);
 
    int closeFDEntry(int tgt_fd);
 
    /*
     * Serialization methods for file descriptors
     */
    void serialize(CheckpointOut &cp) const override;
    void unserialize(CheckpointIn &cp, Process* process_ptr );
    void unserialize(CheckpointIn &cp) override {
      unserialize(cp, nullptr);
    };
 
 
  private:
    int openFile(std::string const& file_name, int flags, mode_t mode) const;
    int openInputFile(std::string const& file_name) const;
    int openOutputFile(std::string const& file_name) const;
 
    std::shared_ptr<FDEntry> getFDEntry(int tgt_fd);
 
    static constexpr size_t _numFDs {1024};
    std::array<std::shared_ptr<FDEntry>, _numFDs> _fdArray;
 
    std::string _input;
    std::string _output;
    std::string _errout;
 
    std::map<std::string, int> _imap;
    std::map<std::string, int> _oemap;
};
 
} // namespace gem5
 
#endif // __FD_ARRAY_HH__