semihosting.hh

Go to the documentation of this file.

/*
 * Copyright (c) 2018, 2019 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 __ARCH_GENERIC_SEMIHOSTING_HH__
#define __ARCH_GENERIC_SEMIHOSTING_HH__
 
#include <cstdio>
#include <functional>
#include <map>
#include <memory>
#include <optional>
#include <utility>
#include <vector>
 
#include "base/time.hh"
#include "cpu/thread_context.hh"
#include "mem/port_proxy.hh"
#include "sim/core.hh"
#include "sim/guest_abi.hh"
#include "sim/sim_object.hh"
 
namespace gem5
{
 
struct BaseSemihostingParams;
class SerialDevice;
 
class BaseSemihosting : public SimObject
{
    virtual PortProxy &portProxy(ThreadContext *tc) const = 0;
    virtual ByteOrder byteOrder(ThreadContext *tc) const = 0;
 
  public:
    struct AbiBase
    {
        template <typename Arg, class BaseSemihostingImpl>
        class StateBase
        {
          private:
            Addr argPointer;
            ByteOrder endian;
 
          public:
            StateBase(const ThreadContext *tc, Addr arg_pointer,
                    std::function<ByteOrder(const ThreadContext *tc)>
                            getByteOrder) :
                argPointer(arg_pointer), endian(getByteOrder(tc))
            {}
 
            /*
             * These two methods are used to both read an argument or its
             * address, and to move position on to the next location. Normally
             * State would be more passive, but since it behaves almost the
             * same no matter what the argument type is we can simplify and
             * consolidate a little bit by centralizing these methods.
             */
 
            // Return the address of an argument slot and move past it.
            Addr
            getAddr()
            {
                Addr addr = argPointer;
                argPointer += sizeof(Arg);
                return addr;
            }
 
            // Read the value in an argument slot and move past it.
            Arg
            get(ThreadContext *tc)
            {
                Arg arg = BaseSemihostingImpl::portProxyImpl(tc)
                                  .template read<Arg>(argPointer, endian);
                argPointer += sizeof(Arg);
                return arg;
            }
 
            using ArgType = Arg;
        };
    };
 
    // Use this argument type when you need to modify an argument in place.
    // This will give you the address of the argument itself and the size of
    // each argument slot, rather than the actual value of the argument.
    struct InPlaceArg
    {
        Addr addr;
        size_t size;
 
        InPlaceArg(Addr _addr, size_t _size) : addr(_addr), size(_size) {}
 
        // A helper function to read the argument since the guest ABI mechanism
        // didn't do that for us.
        uint64_t
        read(ThreadContext *tc, PortProxy &proxy, ByteOrder endian)
        {
            if (size == 8)
                return proxy.read<uint64_t>(addr, endian);
            else if (size == 4)
                return proxy.read<uint32_t>(addr, endian);
            else
                panic("Unexpected semihosting argument size %d.", size);
        }
 
        // A helper function to write to the argument's slot in the params.
        void
        write(ThreadContext *tc, PortProxy &proxy, uint64_t val,
                ByteOrder endian)
        {
            if (size == 8)
                proxy.write<uint64_t>(addr, val, endian);
            else if (size == 4)
                proxy.write<uint32_t>(addr, val, endian);
            else
                panic("Unexpected semihosting argument size %d.", size);
        }
    };
 
  protected:
    explicit BaseSemihosting(const BaseSemihostingParams &p);
 
  public: // SimObject and related interfaces
    void serialize(CheckpointOut &cp) const override;
    void unserialize(CheckpointIn &cp) override;
 
  protected: // Configuration
    const std::string cmdLine;
    const Addr memReserve;
    const Addr stackSize;
 
    const time_t timeBase;
 
    const unsigned tickShift;
 
  protected: // Internal state
    typedef uint64_t SemiErrno;
    SemiErrno semiErrno;
 
  protected: // File IO
    class FileBase : public Serializable
    {
      public:
        FileBase(BaseSemihosting &_parent, const char *name,
                const char *_mode) : parent(_parent), _name(name), mode(_mode)
        {}
        virtual ~FileBase(){};
 
        FileBase() = delete;
        FileBase(FileBase &) = delete;
 
        static std::unique_ptr<FileBase> create(BaseSemihosting &parent,
                const std::string &fname, const char *mode);
        static std::unique_ptr<FileBase> create(BaseSemihosting &parent,
                CheckpointIn &cp, const std::string &sec);
 
        void serialize(CheckpointOut &cp) const override;
        void unserialize(CheckpointIn &cp) override;
 
        const std::string &
        fileName()
        {
            return _name;
        }
 
      public:
        virtual int64_t
        open()
        {
            return 0;
        }
 
        virtual int64_t
        close()
        {
            return 0;
        }
 
        virtual bool
        isTTY() const
        {
            return false;
        }
 
        virtual int64_t read(uint8_t *buffer, uint64_t size);
 
        virtual int64_t write(const uint8_t *buffer, uint64_t size);
 
        virtual int64_t seek(uint64_t pos);
 
        virtual int64_t flen();
 
      protected:
        BaseSemihosting &parent;
        std::string _name;
        std::string mode;
    };
 
    class FileFeatures : public FileBase
    {
      public:
        FileFeatures(
                BaseSemihosting &_parent, const char *name, const char *mode);
 
        void serialize(CheckpointOut &cp) const override;
        void unserialize(CheckpointIn &cp) override;
 
        int64_t read(uint8_t *buffer, uint64_t size) override;
        int64_t seek(uint64_t pos) override;
        int64_t flen() override;
 
      protected:
        size_t pos = 0;
    };
 
    class File : public FileBase
    {
      public:
        File(BaseSemihosting &_parent, const char *name, const char *mode);
        ~File();
 
        void serialize(CheckpointOut &cp) const override;
        void unserialize(CheckpointIn &cp) override;
 
        int64_t
        open() override
        {
            return openImpl(false);
        }
        int64_t close() override;
        bool isTTY() const override;
        int64_t read(uint8_t *buffer, uint64_t size) override;
        int64_t write(const uint8_t *buffer, uint64_t size) override;
        int64_t seek(uint64_t pos) override;
        int64_t flen() override;
 
      protected:
        int64_t openImpl(bool unserialize);
        bool
        needClose() const
        {
            return !isTTY();
        }
 
        FILE *file;
    };
 
    std::string filesRootDir;
    std::vector<std::unique_ptr<FileBase>> files;
    using Handle = size_t;
    FILE *stdin;
    FILE *stdout;
    FILE *stderr;
 
  protected: // Helper functions
    unsigned
    calcTickShift() const
    {
        int msb = findMsbSet(sim_clock::Frequency);
        return msb > 31 ? msb - 31 : 0;
    }
    uint64_t
    semiTick(Tick tick) const
    {
        return tick >> tickShift;
    }
    void semiExit(uint64_t code, uint64_t subcode);
 
    std::optional<std::string> readString(ThreadContext *tc,
                                          Addr ptr, size_t len);
 
  public:
    typedef std::pair<uint64_t, SemiErrno> RetErrno;
 
  protected:
    static RetErrno
    retError(SemiErrno e)
    {
        return RetErrno((uint64_t)-1, e);
    }
 
    static RetErrno
    retOK(uint64_t r)
    {
        return RetErrno(r, 0);
    }
 
    template <typename Semihosting, typename Abi32, typename Abi64>
    struct SemiCallBase
    {
        const char *name;
 
        // A type for member functions implementing semihosting calls.
        template <typename Impl, typename... Args>
        using Implementation = RetErrno (Impl::*)(
                ThreadContext *tc, Args... args);
 
        // Since guest ABI doesn't know how to call member function pointers,
        // this template builds a wrapper that takes care of that.
        template <typename SemiImpl, typename... Args>
        static inline std::function<RetErrno(ThreadContext *tc, Args... args)>
        wrapImpl(SemiImpl *sh, Implementation<SemiImpl, Args...> impl)
        {
            return [sh, impl](ThreadContext *tc, Args... args) {
                return (sh->*impl)(tc, args...);
            };
        }
 
        // A type for functions which dispatch semihosting calls through the
        // guest ABI mechanism.
        using Dispatcher =
                std::function<RetErrno(Semihosting *sh, ThreadContext *tc)>;
        using Dumper = std::function<std::string(ThreadContext *tc)>;
 
        // Dispatchers for 32 and 64 bits.
        Dispatcher call32;
        Dispatcher call64;
 
        // Dumpers which print semihosting calls and their arguments.
        Dumper dump32;
        Dumper dump64;
 
        // A function which builds a dispatcher for a semihosting call.
        template <typename Abi, typename SemiImpl, typename... Args>
        static inline Dispatcher
        buildDispatcher(Implementation<SemiImpl, Args...> impl)
        {
            // This lambda is the dispatcher we're building.
            return [impl](SemiImpl *sh, ThreadContext *tc) {
                auto wrapper = wrapImpl<SemiImpl, Args...>(sh, impl);
                return invokeSimcall<Abi>(tc, wrapper);
            };
        }
 
        // A function which builds a dumper for a semihosting call.
        template <typename Abi, typename SemiImpl, typename... Args>
        static inline Dumper
        buildDumper(const char *name, Implementation<SemiImpl, Args...> impl)
        {
            // This lambda is the dumper we're building.
            return [name](ThreadContext *tc) -> std::string {
                return dumpSimcall<Abi, RetErrno, Args...>(name, tc);
            };
        }
 
        // When there's one implementation, use it for both 32 and 64 bits.
        template <typename SemiImpl, typename... Args>
        SemiCallBase(
                const char *_name, Implementation<SemiImpl, Args...> common) :
            name(_name), call32(buildDispatcher<Abi32>(common)),
            call64(buildDispatcher<Abi64>(common)),
            dump32(buildDumper<Abi32>(_name, common)),
            dump64(buildDumper<Abi64>(_name, common))
        {}
 
        // When there are two, use one for 32 bits and one for 64 bits.
        template <typename SemiImpl, typename... Args32, typename... Args64>
        SemiCallBase(const char *_name,
                Implementation<SemiImpl, Args32...> impl32,
                Implementation<SemiImpl, Args64...> impl64) :
            name(_name), call32(buildDispatcher<Abi32, SemiImpl>(impl32)),
            call64(buildDispatcher<Abi64, SemiImpl>(impl64)),
            dump32(buildDumper<Abi32, SemiImpl>(_name, impl32)),
            dump64(buildDumper<Abi64, SemiImpl>(_name, impl64))
        {}
    };
 
  public:
    RetErrno callOpen(ThreadContext *tc, const Addr name_base, int fmode,
            size_t name_size);
    RetErrno callClose(ThreadContext *tc, Handle handle);
    RetErrno callWriteC(ThreadContext *tc, InPlaceArg c);
    RetErrno callWrite0(ThreadContext *tc, InPlaceArg str);
    RetErrno callWrite(
            ThreadContext *tc, Handle handle, Addr buffer, size_t size);
    RetErrno callRead(
            ThreadContext *tc, Handle handle, Addr buffer, size_t size);
    RetErrno callReadC(ThreadContext *tc);
    RetErrno callIsError(ThreadContext *tc, int64_t status);
    RetErrno callIsTTY(ThreadContext *tc, Handle handle);
    RetErrno callSeek(ThreadContext *tc, Handle handle, uint64_t pos);
    RetErrno callFLen(ThreadContext *tc, Handle handle);
    RetErrno callTmpNam(
            ThreadContext *tc, Addr buffer, uint64_t id, size_t size);
    RetErrno callRemove(ThreadContext *tc, Addr name_base, size_t name_size);
    RetErrno callRename(ThreadContext *tc, Addr from_addr, size_t from_size,
            Addr to_addr, size_t to_size);
    RetErrno callClock(ThreadContext *tc);
    RetErrno callTime(ThreadContext *tc);
    RetErrno callSystem(ThreadContext *tc, Addr cmd_addr, size_t cmd_size);
    RetErrno callErrno(ThreadContext *tc);
    RetErrno callGetCmdLine(ThreadContext *tc, Addr addr, InPlaceArg size_arg);
 
    void gatherHeapInfo(ThreadContext *tc, bool aarch64, Addr &heap_base,
            Addr &heap_limit, Addr &stack_base, Addr &stack_limit);
    RetErrno callHeapInfo32(ThreadContext *tc, Addr block_addr);
    RetErrno callHeapInfo64(ThreadContext *tc, Addr block_addr);
    RetErrno callExit32(ThreadContext *tc, InPlaceArg code);
    RetErrno callExit64(ThreadContext *tc, uint64_t code, uint64_t subcode);
    RetErrno callExitExtended(
            ThreadContext *tc, uint64_t code, uint64_t subcode);
 
    RetErrno callElapsed32(ThreadContext *tc, InPlaceArg low, InPlaceArg high);
    RetErrno callElapsed64(ThreadContext *tc, InPlaceArg ticks);
    RetErrno callTickFreq(ThreadContext *tc);
 
    template <typename Abi>
    void
    unrecognizedCall(ThreadContext *tc, const char *format, uint64_t op)
    {
        warn(format, op);
        std::function<RetErrno(ThreadContext * tc)> retErr =
                [](ThreadContext *tc) { return retError(EINVAL); };
        invokeSimcall<Abi>(tc, retErr);
    }
 
    static FILE *getSTDIO(const char *stream_name, const std::string &name,
            const char *mode);
 
    static const std::vector<const char *> fmodes;
    static const std::map<uint64_t, const char *> exitCodes;
    static const std::array<uint8_t, 5> features;
    static const std::map<const std::string, FILE *> stdioMap;
 
    // used in callTmpNam() to deterministically generate a temp filename
    uint16_t tmpNameIndex = 0;
};
 
std::ostream &operator<<(
        std::ostream &os, const BaseSemihosting::InPlaceArg &ipa);
 
} // namespace gem5
 
#endif // __ARCH_GENERIC_SEMIHOSTING_HH__