process.cc revision 12431:000549e1f497 
1/*
2 * Copyright (c) 2007-2008 The Florida State University
3 * Copyright (c) 2009 The University of Edinburgh
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are
8 * met: redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer;
10 * redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution;
13 * neither the name of the copyright holders nor the names of its
14 * contributors may be used to endorse or promote products derived from
15 * this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 *
29 * Authors: Stephen Hines
30 *          Timothy M. Jones
31 */
32
33#include "arch/power/process.hh"
34
35#include "arch/power/isa_traits.hh"
36#include "arch/power/types.hh"
37#include "base/loader/elf_object.hh"
38#include "base/loader/object_file.hh"
39#include "base/logging.hh"
40#include "cpu/thread_context.hh"
41#include "debug/Stack.hh"
42#include "mem/page_table.hh"
43#include "params/Process.hh"
44#include "sim/aux_vector.hh"
45#include "sim/process_impl.hh"
46#include "sim/syscall_return.hh"
47#include "sim/system.hh"
48
49using namespace std;
50using namespace PowerISA;
51
52PowerProcess::PowerProcess(ProcessParams *params, ObjectFile *objFile)
53    : Process(params, new FuncPageTable(params->name, params->pid), objFile)
54{
55    fatal_if(!params->useArchPT, "Arch page tables not implemented.");
56    // Set up break point (Top of Heap)
57    Addr brk_point = objFile->dataBase() + objFile->dataSize() +
58                     objFile->bssSize();
59    brk_point = roundUp(brk_point, PageBytes);
60
61    Addr stack_base = 0xbf000000L;
62
63    Addr max_stack_size = 8 * 1024 * 1024;
64
65    // Set pointer for next thread stack.  Reserve 8M for main stack.
66    Addr next_thread_stack_base = stack_base - max_stack_size;
67
68    // Set up region for mmaps. For now, start at bottom of kuseg space.
69    Addr mmap_end = 0x70000000L;
70
71    memState = make_shared<MemState>(brk_point, stack_base, max_stack_size,
72                                     next_thread_stack_base, mmap_end);
73}
74
75void
76PowerProcess::initState()
77{
78    Process::initState();
79
80    argsInit(MachineBytes, PageBytes);
81}
82
83void
84PowerProcess::argsInit(int intSize, int pageSize)
85{
86    typedef AuxVector<uint32_t> auxv_t;
87    std::vector<auxv_t> auxv;
88
89    string filename;
90    if (argv.size() < 1)
91        filename = "";
92    else
93        filename = argv[0];
94
95    //We want 16 byte alignment
96    uint64_t align = 16;
97
98    // Patch the ld_bias for dynamic executables.
99    updateBias();
100
101    // load object file into target memory
102    objFile->loadSections(initVirtMem);
103
104    //Setup the auxilliary vectors. These will already have endian conversion.
105    //Auxilliary vectors are loaded only for elf formatted executables.
106    ElfObject * elfObject = dynamic_cast<ElfObject *>(objFile);
107    if (elfObject) {
108        uint32_t features = 0;
109
110        //Bits which describe the system hardware capabilities
111        //XXX Figure out what these should be
112        auxv.push_back(auxv_t(M5_AT_HWCAP, features));
113        //The system page size
114        auxv.push_back(auxv_t(M5_AT_PAGESZ, PowerISA::PageBytes));
115        //Frequency at which times() increments
116        auxv.push_back(auxv_t(M5_AT_CLKTCK, 0x64));
117        // For statically linked executables, this is the virtual address of the
118        // program header tables if they appear in the executable image
119        auxv.push_back(auxv_t(M5_AT_PHDR, elfObject->programHeaderTable()));
120        // This is the size of a program header entry from the elf file.
121        auxv.push_back(auxv_t(M5_AT_PHENT, elfObject->programHeaderSize()));
122        // This is the number of program headers from the original elf file.
123        auxv.push_back(auxv_t(M5_AT_PHNUM, elfObject->programHeaderCount()));
124        // This is the base address of the ELF interpreter; it should be
125        // zero for static executables or contain the base address for
126        // dynamic executables.
127        auxv.push_back(auxv_t(M5_AT_BASE, getBias()));
128        //XXX Figure out what this should be.
129        auxv.push_back(auxv_t(M5_AT_FLAGS, 0));
130        //The entry point to the program
131        auxv.push_back(auxv_t(M5_AT_ENTRY, objFile->entryPoint()));
132        //Different user and group IDs
133        auxv.push_back(auxv_t(M5_AT_UID, uid()));
134        auxv.push_back(auxv_t(M5_AT_EUID, euid()));
135        auxv.push_back(auxv_t(M5_AT_GID, gid()));
136        auxv.push_back(auxv_t(M5_AT_EGID, egid()));
137        //Whether to enable "secure mode" in the executable
138        auxv.push_back(auxv_t(M5_AT_SECURE, 0));
139        //The filename of the program
140        auxv.push_back(auxv_t(M5_AT_EXECFN, 0));
141        //The string "v51" with unknown meaning
142        auxv.push_back(auxv_t(M5_AT_PLATFORM, 0));
143    }
144
145    //Figure out how big the initial stack nedes to be
146
147    // A sentry NULL void pointer at the top of the stack.
148    int sentry_size = intSize;
149
150    string platform = "v51";
151    int platform_size = platform.size() + 1;
152
153    // The aux vectors are put on the stack in two groups. The first group are
154    // the vectors that are generated as the elf is loaded. The second group
155    // are the ones that were computed ahead of time and include the platform
156    // string.
157    int aux_data_size = filename.size() + 1;
158
159    int env_data_size = 0;
160    for (int i = 0; i < envp.size(); ++i) {
161        env_data_size += envp[i].size() + 1;
162    }
163    int arg_data_size = 0;
164    for (int i = 0; i < argv.size(); ++i) {
165        arg_data_size += argv[i].size() + 1;
166    }
167
168    int info_block_size =
169        sentry_size + env_data_size + arg_data_size +
170        aux_data_size + platform_size;
171
172    //Each auxilliary vector is two 4 byte words
173    int aux_array_size = intSize * 2 * (auxv.size() + 1);
174
175    int envp_array_size = intSize * (envp.size() + 1);
176    int argv_array_size = intSize * (argv.size() + 1);
177
178    int argc_size = intSize;
179
180    //Figure out the size of the contents of the actual initial frame
181    int frame_size =
182        info_block_size +
183        aux_array_size +
184        envp_array_size +
185        argv_array_size +
186        argc_size;
187
188    //There needs to be padding after the auxiliary vector data so that the
189    //very bottom of the stack is aligned properly.
190    int partial_size = frame_size;
191    int aligned_partial_size = roundUp(partial_size, align);
192    int aux_padding = aligned_partial_size - partial_size;
193
194    int space_needed = frame_size + aux_padding;
195
196    Addr stack_min = memState->getStackBase() - space_needed;
197    stack_min = roundDown(stack_min, align);
198
199    memState->setStackSize(memState->getStackBase() - stack_min);
200
201    // map memory
202    allocateMem(roundDown(stack_min, pageSize),
203                roundUp(memState->getStackSize(), pageSize));
204
205    // map out initial stack contents
206    uint32_t sentry_base = memState->getStackBase() - sentry_size;
207    uint32_t aux_data_base = sentry_base - aux_data_size;
208    uint32_t env_data_base = aux_data_base - env_data_size;
209    uint32_t arg_data_base = env_data_base - arg_data_size;
210    uint32_t platform_base = arg_data_base - platform_size;
211    uint32_t auxv_array_base = platform_base - aux_array_size - aux_padding;
212    uint32_t envp_array_base = auxv_array_base - envp_array_size;
213    uint32_t argv_array_base = envp_array_base - argv_array_size;
214    uint32_t argc_base = argv_array_base - argc_size;
215
216    DPRINTF(Stack, "The addresses of items on the initial stack:\n");
217    DPRINTF(Stack, "0x%x - aux data\n", aux_data_base);
218    DPRINTF(Stack, "0x%x - env data\n", env_data_base);
219    DPRINTF(Stack, "0x%x - arg data\n", arg_data_base);
220    DPRINTF(Stack, "0x%x - platform base\n", platform_base);
221    DPRINTF(Stack, "0x%x - auxv array\n", auxv_array_base);
222    DPRINTF(Stack, "0x%x - envp array\n", envp_array_base);
223    DPRINTF(Stack, "0x%x - argv array\n", argv_array_base);
224    DPRINTF(Stack, "0x%x - argc \n", argc_base);
225    DPRINTF(Stack, "0x%x - stack min\n", stack_min);
226
227    // write contents to stack
228
229    // figure out argc
230    uint32_t argc = argv.size();
231    uint32_t guestArgc = PowerISA::htog(argc);
232
233    //Write out the sentry void *
234    uint32_t sentry_NULL = 0;
235    initVirtMem.writeBlob(sentry_base,
236            (uint8_t*)&sentry_NULL, sentry_size);
237
238    //Fix up the aux vectors which point to other data
239    for (int i = auxv.size() - 1; i >= 0; i--) {
240        if (auxv[i].a_type == M5_AT_PLATFORM) {
241            auxv[i].a_val = platform_base;
242            initVirtMem.writeString(platform_base, platform.c_str());
243        } else if (auxv[i].a_type == M5_AT_EXECFN) {
244            auxv[i].a_val = aux_data_base;
245            initVirtMem.writeString(aux_data_base, filename.c_str());
246        }
247    }
248
249    //Copy the aux stuff
250    for (int x = 0; x < auxv.size(); x++)
251    {
252        initVirtMem.writeBlob(auxv_array_base + x * 2 * intSize,
253                (uint8_t*)&(auxv[x].a_type), intSize);
254        initVirtMem.writeBlob(auxv_array_base + (x * 2 + 1) * intSize,
255                (uint8_t*)&(auxv[x].a_val), intSize);
256    }
257    //Write out the terminating zeroed auxilliary vector
258    const uint64_t zero = 0;
259    initVirtMem.writeBlob(auxv_array_base + 2 * intSize * auxv.size(),
260            (uint8_t*)&zero, 2 * intSize);
261
262    copyStringArray(envp, envp_array_base, env_data_base, initVirtMem);
263    copyStringArray(argv, argv_array_base, arg_data_base, initVirtMem);
264
265    initVirtMem.writeBlob(argc_base, (uint8_t*)&guestArgc, intSize);
266
267    ThreadContext *tc = system->getThreadContext(contextIds[0]);
268
269    //Set the stack pointer register
270    tc->setIntReg(StackPointerReg, stack_min);
271
272    tc->pcState(getStartPC());
273
274    //Align the "stack_min" to a page boundary.
275    memState->setStackMin(roundDown(stack_min, pageSize));
276}
277
278PowerISA::IntReg
279PowerProcess::getSyscallArg(ThreadContext *tc, int &i)
280{
281    assert(i < 5);
282    return tc->readIntReg(ArgumentReg0 + i++);
283}
284
285void
286PowerProcess::setSyscallArg(ThreadContext *tc, int i, PowerISA::IntReg val)
287{
288    assert(i < 5);
289    tc->setIntReg(ArgumentReg0 + i, val);
290}
291
292void
293PowerProcess::setSyscallReturn(ThreadContext *tc, SyscallReturn sysret)
294{
295    Cr cr = tc->readIntReg(INTREG_CR);
296    if (sysret.successful()) {
297        cr.cr0.so = 0;
298    } else {
299        cr.cr0.so = 1;
300    }
301    tc->setIntReg(INTREG_CR, cr);
302    tc->setIntReg(ReturnValueReg, sysret.encodedValue());
303}
304