111723Sar4jc@virginia.edu/*
211723Sar4jc@virginia.edu * Copyright (c) 2004-2005 The Regents of The University of Michigan
311723Sar4jc@virginia.edu * Copyright (c) 2016 The University of Virginia
411723Sar4jc@virginia.edu * All rights reserved.
511723Sar4jc@virginia.edu *
611723Sar4jc@virginia.edu * Redistribution and use in source and binary forms, with or without
711723Sar4jc@virginia.edu * modification, are permitted provided that the following conditions are
811723Sar4jc@virginia.edu * met: redistributions of source code must retain the above copyright
911723Sar4jc@virginia.edu * notice, this list of conditions and the following disclaimer;
1011723Sar4jc@virginia.edu * redistributions in binary form must reproduce the above copyright
1111723Sar4jc@virginia.edu * notice, this list of conditions and the following disclaimer in the
1211723Sar4jc@virginia.edu * documentation and/or other materials provided with the distribution;
1311723Sar4jc@virginia.edu * neither the name of the copyright holders nor the names of its
1411723Sar4jc@virginia.edu * contributors may be used to endorse or promote products derived from
1511723Sar4jc@virginia.edu * this software without specific prior written permission.
1611723Sar4jc@virginia.edu *
1711723Sar4jc@virginia.edu * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
1811723Sar4jc@virginia.edu * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
1911723Sar4jc@virginia.edu * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
2011723Sar4jc@virginia.edu * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
2111723Sar4jc@virginia.edu * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
2211723Sar4jc@virginia.edu * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
2311723Sar4jc@virginia.edu * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
2411723Sar4jc@virginia.edu * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
2511723Sar4jc@virginia.edu * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
2611723Sar4jc@virginia.edu * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
2711723Sar4jc@virginia.edu * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
2811723Sar4jc@virginia.edu *
2911723Sar4jc@virginia.edu * Authors: Gabe Black
3011723Sar4jc@virginia.edu *          Ali Saidi
3111723Sar4jc@virginia.edu *          Korey Sewell
3211723Sar4jc@virginia.edu *          Alec Roelke
3311723Sar4jc@virginia.edu */
3411723Sar4jc@virginia.edu#include "arch/riscv/process.hh"
3511723Sar4jc@virginia.edu
3611964Sar4jc@virginia.edu#include <algorithm>
3711964Sar4jc@virginia.edu#include <cstddef>
3811964Sar4jc@virginia.edu#include <iostream>
3912394Sar4jc@virginia.edu#include <iterator>
4011964Sar4jc@virginia.edu#include <map>
4111964Sar4jc@virginia.edu#include <string>
4211723Sar4jc@virginia.edu#include <vector>
4311723Sar4jc@virginia.edu
4412695Sar4jc@virginia.edu#include "arch/riscv/isa.hh"
4511723Sar4jc@virginia.edu#include "arch/riscv/isa_traits.hh"
4612695Sar4jc@virginia.edu#include "arch/riscv/registers.hh"
4711723Sar4jc@virginia.edu#include "base/loader/elf_object.hh"
4811723Sar4jc@virginia.edu#include "base/loader/object_file.hh"
4912334Sgabeblack@google.com#include "base/logging.hh"
5012394Sar4jc@virginia.edu#include "base/random.hh"
5111723Sar4jc@virginia.edu#include "cpu/thread_context.hh"
5211964Sar4jc@virginia.edu#include "debug/Stack.hh"
5311723Sar4jc@virginia.edu#include "mem/page_table.hh"
5411964Sar4jc@virginia.edu#include "params/Process.hh"
5511854Sbrandon.potter@amd.com#include "sim/aux_vector.hh"
5611723Sar4jc@virginia.edu#include "sim/process.hh"
5711723Sar4jc@virginia.edu#include "sim/process_impl.hh"
5811800Sbrandon.potter@amd.com#include "sim/syscall_return.hh"
5911723Sar4jc@virginia.edu#include "sim/system.hh"
6011723Sar4jc@virginia.edu
6111723Sar4jc@virginia.eduusing namespace std;
6211723Sar4jc@virginia.eduusing namespace RiscvISA;
6311723Sar4jc@virginia.edu
6412431Sgabeblack@google.comRiscvProcess::RiscvProcess(ProcessParams *params, ObjectFile *objFile) :
6512448Sgabeblack@google.com        Process(params,
6612448Sgabeblack@google.com                new EmulationPageTable(params->name, params->pid, PageBytes),
6712432Sgabeblack@google.com                objFile)
6811723Sar4jc@virginia.edu{
6912441Sgabeblack@google.com    fatal_if(params->useArchPT, "Arch page tables not implemented.");
7013634Saustinharris@utexas.edu}
7113634Saustinharris@utexas.edu
7213634Saustinharris@utexas.eduRiscvProcess64::RiscvProcess64(ProcessParams *params, ObjectFile *objFile) :
7313634Saustinharris@utexas.edu        RiscvProcess(params, objFile)
7413634Saustinharris@utexas.edu{
7511970Sar4jc@virginia.edu    const Addr stack_base = 0x7FFFFFFFFFFFFFFFL;
7612393Sar4jc@virginia.edu    const Addr max_stack_size = 8 * 1024 * 1024;
7711964Sar4jc@virginia.edu    const Addr next_thread_stack_base = stack_base - max_stack_size;
7811964Sar4jc@virginia.edu    const Addr brk_point = roundUp(objFile->bssBase() + objFile->bssSize(),
7911964Sar4jc@virginia.edu            PageBytes);
8011970Sar4jc@virginia.edu    const Addr mmap_end = 0x4000000000000000L;
8111905SBrandon.Potter@amd.com    memState = make_shared<MemState>(brk_point, stack_base, max_stack_size,
8211964Sar4jc@virginia.edu            next_thread_stack_base, mmap_end);
8311723Sar4jc@virginia.edu}
8411723Sar4jc@virginia.edu
8513634Saustinharris@utexas.eduRiscvProcess32::RiscvProcess32(ProcessParams *params, ObjectFile *objFile) :
8613634Saustinharris@utexas.edu        RiscvProcess(params, objFile)
8713634Saustinharris@utexas.edu{
8813634Saustinharris@utexas.edu    const Addr stack_base = 0x7FFFFFFF;
8913634Saustinharris@utexas.edu    const Addr max_stack_size = 8 * 1024 * 1024;
9013634Saustinharris@utexas.edu    const Addr next_thread_stack_base = stack_base - max_stack_size;
9113634Saustinharris@utexas.edu    const Addr brk_point = roundUp(objFile->bssBase() + objFile->bssSize(),
9213634Saustinharris@utexas.edu            PageBytes);
9313634Saustinharris@utexas.edu    const Addr mmap_end = 0x40000000L;
9413634Saustinharris@utexas.edu    memState = make_shared<MemState>(brk_point, stack_base, max_stack_size,
9513634Saustinharris@utexas.edu                                     next_thread_stack_base, mmap_end);
9613634Saustinharris@utexas.edu}
9713634Saustinharris@utexas.edu
9811723Sar4jc@virginia.eduvoid
9913634Saustinharris@utexas.eduRiscvProcess64::initState()
10011723Sar4jc@virginia.edu{
10111851Sbrandon.potter@amd.com    Process::initState();
10211723Sar4jc@virginia.edu
10311723Sar4jc@virginia.edu    argsInit<uint64_t>(PageBytes);
10412695Sar4jc@virginia.edu    for (ContextID ctx: contextIds)
10512695Sar4jc@virginia.edu        system->getThreadContext(ctx)->setMiscRegNoEffect(MISCREG_PRV, PRV_U);
10611723Sar4jc@virginia.edu}
10711723Sar4jc@virginia.edu
10813634Saustinharris@utexas.eduvoid
10913634Saustinharris@utexas.eduRiscvProcess32::initState()
11013634Saustinharris@utexas.edu{
11113634Saustinharris@utexas.edu    Process::initState();
11213634Saustinharris@utexas.edu
11313634Saustinharris@utexas.edu    argsInit<uint32_t>(PageBytes);
11413634Saustinharris@utexas.edu    for (ContextID ctx: contextIds) {
11513634Saustinharris@utexas.edu        system->getThreadContext(ctx)->setMiscRegNoEffect(MISCREG_PRV, PRV_U);
11613634Saustinharris@utexas.edu        PCState pc = system->getThreadContext(ctx)->pcState();
11713634Saustinharris@utexas.edu        pc.rv32(true);
11813634Saustinharris@utexas.edu        system->getThreadContext(ctx)->pcState(pc);
11913634Saustinharris@utexas.edu    }
12013634Saustinharris@utexas.edu}
12113634Saustinharris@utexas.edu
12211723Sar4jc@virginia.edutemplate<class IntType> void
12311851Sbrandon.potter@amd.comRiscvProcess::argsInit(int pageSize)
12411723Sar4jc@virginia.edu{
12512394Sar4jc@virginia.edu    const int RandomBytes = 16;
12613634Saustinharris@utexas.edu    const int addrSize = sizeof(IntType);
12712394Sar4jc@virginia.edu
12811723Sar4jc@virginia.edu    updateBias();
12911964Sar4jc@virginia.edu    objFile->loadSections(initVirtMem);
13011964Sar4jc@virginia.edu    ElfObject* elfObject = dynamic_cast<ElfObject*>(objFile);
13111964Sar4jc@virginia.edu    memState->setStackMin(memState->getStackBase());
13211723Sar4jc@virginia.edu
13311964Sar4jc@virginia.edu    // Determine stack size and populate auxv
13411964Sar4jc@virginia.edu    Addr stack_top = memState->getStackMin();
13512394Sar4jc@virginia.edu    stack_top -= RandomBytes;
13611964Sar4jc@virginia.edu    for (const string& arg: argv)
13711964Sar4jc@virginia.edu        stack_top -= arg.size() + 1;
13811964Sar4jc@virginia.edu    for (const string& env: envp)
13911964Sar4jc@virginia.edu        stack_top -= env.size() + 1;
14013634Saustinharris@utexas.edu    stack_top &= -addrSize;
14111723Sar4jc@virginia.edu
14213894Sgabeblack@google.com    vector<AuxVector<IntType>> auxv;
14311964Sar4jc@virginia.edu    if (elfObject != nullptr) {
14413894Sgabeblack@google.com        auxv.emplace_back(M5_AT_ENTRY, objFile->entryPoint());
14513894Sgabeblack@google.com        auxv.emplace_back(M5_AT_PHNUM, elfObject->programHeaderCount());
14613894Sgabeblack@google.com        auxv.emplace_back(M5_AT_PHENT, elfObject->programHeaderSize());
14713894Sgabeblack@google.com        auxv.emplace_back(M5_AT_PHDR, elfObject->programHeaderTable());
14813894Sgabeblack@google.com        auxv.emplace_back(M5_AT_PAGESZ, PageBytes);
14913894Sgabeblack@google.com        auxv.emplace_back(M5_AT_SECURE, 0);
15013894Sgabeblack@google.com        auxv.emplace_back(M5_AT_RANDOM, stack_top);
15113894Sgabeblack@google.com        auxv.emplace_back(M5_AT_NULL, 0);
15211964Sar4jc@virginia.edu    }
15313634Saustinharris@utexas.edu    stack_top -= (1 + argv.size()) * addrSize +
15413634Saustinharris@utexas.edu                   (1 + envp.size()) * addrSize +
15513634Saustinharris@utexas.edu                   addrSize + 2 * sizeof(IntType) * auxv.size();
15613634Saustinharris@utexas.edu    stack_top &= -2*addrSize;
15711964Sar4jc@virginia.edu    memState->setStackSize(memState->getStackBase() - stack_top);
15811964Sar4jc@virginia.edu    allocateMem(roundDown(stack_top, pageSize),
15911964Sar4jc@virginia.edu            roundUp(memState->getStackSize(), pageSize));
16011964Sar4jc@virginia.edu
16112394Sar4jc@virginia.edu    // Copy random bytes (for AT_RANDOM) to stack
16212394Sar4jc@virginia.edu    memState->setStackMin(memState->getStackMin() - RandomBytes);
16312394Sar4jc@virginia.edu    uint8_t at_random[RandomBytes];
16412394Sar4jc@virginia.edu    generate(begin(at_random), end(at_random),
16512394Sar4jc@virginia.edu             [&]{ return random_mt.random(0, 0xFF); });
16612394Sar4jc@virginia.edu    initVirtMem.writeBlob(memState->getStackMin(), at_random, RandomBytes);
16712039Sar4jc@virginia.edu
16811964Sar4jc@virginia.edu    // Copy argv to stack
16911964Sar4jc@virginia.edu    vector<Addr> argPointers;
17011964Sar4jc@virginia.edu    for (const string& arg: argv) {
17111964Sar4jc@virginia.edu        memState->setStackMin(memState->getStackMin() - (arg.size() + 1));
17211964Sar4jc@virginia.edu        initVirtMem.writeString(memState->getStackMin(), arg.c_str());
17311964Sar4jc@virginia.edu        argPointers.push_back(memState->getStackMin());
17411964Sar4jc@virginia.edu        if (DTRACE(Stack)) {
17511964Sar4jc@virginia.edu            string wrote;
17611964Sar4jc@virginia.edu            initVirtMem.readString(wrote, argPointers.back());
17711964Sar4jc@virginia.edu            DPRINTFN("Wrote arg \"%s\" to address %p\n",
17811964Sar4jc@virginia.edu                    wrote, (void*)memState->getStackMin());
17911964Sar4jc@virginia.edu        }
18011964Sar4jc@virginia.edu    }
18111964Sar4jc@virginia.edu    argPointers.push_back(0);
18211964Sar4jc@virginia.edu
18311964Sar4jc@virginia.edu    // Copy envp to stack
18411964Sar4jc@virginia.edu    vector<Addr> envPointers;
18511964Sar4jc@virginia.edu    for (const string& env: envp) {
18611964Sar4jc@virginia.edu        memState->setStackMin(memState->getStackMin() - (env.size() + 1));
18711964Sar4jc@virginia.edu        initVirtMem.writeString(memState->getStackMin(), env.c_str());
18811964Sar4jc@virginia.edu        envPointers.push_back(memState->getStackMin());
18911964Sar4jc@virginia.edu        DPRINTF(Stack, "Wrote env \"%s\" to address %p\n",
19011964Sar4jc@virginia.edu                env, (void*)memState->getStackMin());
19111964Sar4jc@virginia.edu    }
19211964Sar4jc@virginia.edu    envPointers.push_back(0);
19311964Sar4jc@virginia.edu
19411964Sar4jc@virginia.edu    // Align stack
19513634Saustinharris@utexas.edu    memState->setStackMin(memState->getStackMin() & -addrSize);
19611964Sar4jc@virginia.edu
19711964Sar4jc@virginia.edu    // Calculate bottom of stack
19811964Sar4jc@virginia.edu    memState->setStackMin(memState->getStackMin() -
19913634Saustinharris@utexas.edu            ((1 + argv.size()) * addrSize +
20013634Saustinharris@utexas.edu             (1 + envp.size()) * addrSize +
20113634Saustinharris@utexas.edu             addrSize + 2 * sizeof(IntType) * auxv.size()));
20213894Sgabeblack@google.com    memState->setStackMin(memState->getStackMin() & (-2 * addrSize));
20311964Sar4jc@virginia.edu    Addr sp = memState->getStackMin();
20411964Sar4jc@virginia.edu    const auto pushOntoStack =
20513894Sgabeblack@google.com        [this, &sp](IntType data) {
20613894Sgabeblack@google.com            initVirtMem.write(sp, data, GuestByteOrder);
20713894Sgabeblack@google.com            sp += sizeof(data);
20811964Sar4jc@virginia.edu        };
20911964Sar4jc@virginia.edu
21011964Sar4jc@virginia.edu    // Push argc and argv pointers onto stack
21113894Sgabeblack@google.com    IntType argc = argv.size();
21213894Sgabeblack@google.com    DPRINTF(Stack, "Wrote argc %d to address %#x\n", argc, sp);
21313894Sgabeblack@google.com    pushOntoStack(argc);
21413894Sgabeblack@google.com
21511964Sar4jc@virginia.edu    for (const Addr& argPointer: argPointers) {
21613894Sgabeblack@google.com        DPRINTF(Stack, "Wrote argv pointer %#x to address %#x\n",
21713894Sgabeblack@google.com                argPointer, sp);
21813894Sgabeblack@google.com        pushOntoStack(argPointer);
21911723Sar4jc@virginia.edu    }
22011723Sar4jc@virginia.edu
22111964Sar4jc@virginia.edu    // Push env pointers onto stack
22211964Sar4jc@virginia.edu    for (const Addr& envPointer: envPointers) {
22313894Sgabeblack@google.com        DPRINTF(Stack, "Wrote envp pointer %#x to address %#x\n",
22413894Sgabeblack@google.com                envPointer, sp);
22513894Sgabeblack@google.com        pushOntoStack(envPointer);
22611723Sar4jc@virginia.edu    }
22711723Sar4jc@virginia.edu
22811964Sar4jc@virginia.edu    // Push aux vector onto stack
22911964Sar4jc@virginia.edu    std::map<IntType, string> aux_keys = {
23011964Sar4jc@virginia.edu        {M5_AT_ENTRY, "M5_AT_ENTRY"},
23111964Sar4jc@virginia.edu        {M5_AT_PHNUM, "M5_AT_PHNUM"},
23211964Sar4jc@virginia.edu        {M5_AT_PHENT, "M5_AT_PHENT"},
23311964Sar4jc@virginia.edu        {M5_AT_PHDR, "M5_AT_PHDR"},
23411964Sar4jc@virginia.edu        {M5_AT_PAGESZ, "M5_AT_PAGESZ"},
23511964Sar4jc@virginia.edu        {M5_AT_SECURE, "M5_AT_SECURE"},
23611964Sar4jc@virginia.edu        {M5_AT_RANDOM, "M5_AT_RANDOM"},
23711964Sar4jc@virginia.edu        {M5_AT_NULL, "M5_AT_NULL"}
23811964Sar4jc@virginia.edu    };
23913894Sgabeblack@google.com    for (const auto &aux: auxv) {
24013894Sgabeblack@google.com        DPRINTF(Stack, "Wrote aux key %s to address %#x\n",
24113894Sgabeblack@google.com                aux_keys[aux.type], sp);
24213894Sgabeblack@google.com        pushOntoStack(aux.type);
24313894Sgabeblack@google.com        DPRINTF(Stack, "Wrote aux value %x to address %#x\n", aux.val, sp);
24413894Sgabeblack@google.com        pushOntoStack(aux.val);
24511723Sar4jc@virginia.edu    }
24611723Sar4jc@virginia.edu
24711723Sar4jc@virginia.edu    ThreadContext *tc = system->getThreadContext(contextIds[0]);
24811905SBrandon.Potter@amd.com    tc->setIntReg(StackPointerReg, memState->getStackMin());
24911723Sar4jc@virginia.edu    tc->pcState(getStartPC());
25011964Sar4jc@virginia.edu
25111964Sar4jc@virginia.edu    memState->setStackMin(roundDown(memState->getStackMin(), pageSize));
25211723Sar4jc@virginia.edu}
25311723Sar4jc@virginia.edu
25413612Sgabeblack@google.comRegVal
25511851Sbrandon.potter@amd.comRiscvProcess::getSyscallArg(ThreadContext *tc, int &i)
25611723Sar4jc@virginia.edu{
25712412Sar4jc@virginia.edu    // If a larger index is requested than there are syscall argument
25812412Sar4jc@virginia.edu    // registers, return 0
25913612Sgabeblack@google.com    RegVal retval = 0;
26012412Sar4jc@virginia.edu    if (i < SyscallArgumentRegs.size())
26111806Sar4jc@virginia.edu        retval = tc->readIntReg(SyscallArgumentRegs[i]);
26211806Sar4jc@virginia.edu    i++;
26311806Sar4jc@virginia.edu    return retval;
26411723Sar4jc@virginia.edu}
26511723Sar4jc@virginia.edu
26611723Sar4jc@virginia.eduvoid
26713612Sgabeblack@google.comRiscvProcess::setSyscallArg(ThreadContext *tc, int i, RegVal val)
26811723Sar4jc@virginia.edu{
26911723Sar4jc@virginia.edu    tc->setIntReg(SyscallArgumentRegs[i], val);
27011723Sar4jc@virginia.edu}
27111723Sar4jc@virginia.edu
27211723Sar4jc@virginia.eduvoid
27311851Sbrandon.potter@amd.comRiscvProcess::setSyscallReturn(ThreadContext *tc, SyscallReturn sysret)
27411723Sar4jc@virginia.edu{
27511723Sar4jc@virginia.edu    if (sysret.successful()) {
27611723Sar4jc@virginia.edu        // no error
27711723Sar4jc@virginia.edu        tc->setIntReg(SyscallPseudoReturnReg, sysret.returnValue());
27811723Sar4jc@virginia.edu    } else {
27911723Sar4jc@virginia.edu        // got an error, return details
28013648Sqtt2@cornell.edu        tc->setIntReg(SyscallPseudoReturnReg, sysret.encodedValue());
28111723Sar4jc@virginia.edu    }
28211723Sar4jc@virginia.edu}
283