2 * Copyright (c) 2003-2006 The Regents of The University of Michigan
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
7 * met: redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer;
9 * redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution;
12 * neither the name of the copyright holders nor the names of its
13 * contributors may be used to endorse or promote products derived from
14 * this software without specific prior written permission.
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 * Copyright (c) 2007 The Hewlett-Packard Development Company
34 * All rights reserved.
36 * Redistribution and use of this software in source and binary forms,
37 * with or without modification, are permitted provided that the
38 * following conditions are met:
40 * The software must be used only for Non-Commercial Use which means any
41 * use which is NOT directed to receiving any direct monetary
42 * compensation for, or commercial advantage from such use. Illustrative
43 * examples of non-commercial use are academic research, personal study,
44 * teaching, education and corporate research & development.
45 * Illustrative examples of commercial use are distributing products for
46 * commercial advantage and providing services using the software for
47 * commercial advantage.
49 * If you wish to use this software or functionality therein that may be
50 * covered by patents for commercial use, please contact:
51 * Director of Intellectual Property Licensing
52 * Office of Strategy and Technology
53 * Hewlett-Packard Company
55 * Palo Alto, California 94304
57 * Redistributions of source code must retain the above copyright notice,
58 * this list of conditions and the following disclaimer. Redistributions
59 * in binary form must reproduce the above copyright notice, this list of
60 * conditions and the following disclaimer in the documentation and/or
61 * other materials provided with the distribution. Neither the name of
62 * the COPYRIGHT HOLDER(s), HEWLETT-PACKARD COMPANY, nor the names of its
63 * contributors may be used to endorse or promote products derived from
64 * this software without specific prior written permission. No right of
65 * sublicense is granted herewith. Derivatives of the software and
66 * output created using the software may be prepared, but only for
67 * Non-Commercial Uses. Derivatives of the software may be shared with
68 * others provided: (i) the others agree to abide by the list of
69 * conditions herein which includes the Non-Commercial Use restrictions;
70 * and (ii) such Derivatives of the software include the above copyright
71 * notice to acknowledge the contribution from this software where
72 * applicable, this list of conditions and the disclaimer below.
74 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
75 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
76 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
77 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
78 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
79 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
80 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
81 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
82 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
83 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
84 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
89 #include "arch/x86/isa_traits.hh"
90 #include "arch/x86/process.hh"
91 #include "arch/x86/types.hh"
92 #include "base/loader/object_file.hh"
93 #include "base/loader/elf_object.hh"
94 #include "base/misc.hh"
95 #include "cpu/thread_context.hh"
96 #include "mem/page_table.hh"
97 #include "mem/translating_port.hh"
98 #include "sim/process_impl.hh"
99 #include "sim/system.hh"
102 using namespace X86ISA
;
104 M5_64_auxv_t::M5_64_auxv_t(int64_t type
, int64_t val
)
106 a_type
= TheISA::htog(type
);
107 a_val
= TheISA::htog(val
);
110 X86LiveProcess::X86LiveProcess(const std::string
&nm
, ObjectFile
*objFile
,
111 System
*_system
, int stdin_fd
, int stdout_fd
, int stderr_fd
,
112 std::vector
<std::string
> &argv
, std::vector
<std::string
> &envp
,
113 const std::string
&cwd
,
114 uint64_t _uid
, uint64_t _euid
, uint64_t _gid
, uint64_t _egid
,
115 uint64_t _pid
, uint64_t _ppid
)
116 : LiveProcess(nm
, objFile
, _system
, stdin_fd
, stdout_fd
, stderr_fd
,
117 argv
, envp
, cwd
, _uid
, _euid
, _gid
, _egid
, _pid
, _ppid
)
119 brk_point
= objFile
->dataBase() + objFile
->dataSize() + objFile
->bssSize();
120 brk_point
= roundUp(brk_point
, VMPageSize
);
122 // Set pointer for next thread stack. Reserve 8M for main stack.
123 next_thread_stack_base
= stack_base
- (8 * 1024 * 1024);
125 // Set up stack. On SPARC Linux, stack goes from the top of memory
126 // downward, less the hole for the kernel address space.
127 stack_base
= (Addr
)0x80000000000ULL
;
129 // Set up region for mmaps. Tru64 seems to start just above 0 and
130 // grow up from there.
131 mmap_start
= mmap_end
= 0xfffff80000000000ULL
;
134 void X86LiveProcess::handleTrap(int trapNum
, ThreadContext
*tc
)
139 panic("Unimplemented trap to operating system: trap number %#x.\n", trapNum
);
144 X86LiveProcess::startup()
146 argsInit(sizeof(IntReg
), VMPageSize
);
148 //The AMD64 abi says that only rsp and rdx are defined at process
149 //startup. rsp will be set by argsInit, and I don't understand what
150 //rdx should be set to. The other floating point and integer registers
151 //will be zeroed by the register file constructors, but control registers
152 //should be initialized here. Since none of those are implemented, there
153 //isn't anything here.
157 X86LiveProcess::argsInit(int intSize
, int pageSize
)
159 typedef M5_64_auxv_t auxv_t
;
168 Addr alignmentMask
= ~(intSize
- 1);
170 // load object file into target memory
171 objFile
->loadSections(initVirtMem
);
173 //These are the auxilliary vector types
193 //Setup the auxilliary vectors. These will already have endian conversion.
194 //Auxilliary vectors are loaded only for elf formatted executables.
195 ElfObject
* elfObject
= dynamic_cast<ElfObject
*>(objFile
);
199 //Bits which describe the system hardware capabilities
200 auxv.push_back(auxv_t(SPARC_AT_HWCAP, hwcap));
201 //The system page size
202 auxv.push_back(auxv_t(SPARC_AT_PAGESZ, SparcISA::VMPageSize));
203 //Defined to be 100 in the kernel source.
204 //Frequency at which times() increments
205 auxv.push_back(auxv_t(SPARC_AT_CLKTCK, 100));
206 // For statically linked executables, this is the virtual address of the
207 // program header tables if they appear in the executable image
208 auxv.push_back(auxv_t(SPARC_AT_PHDR, elfObject->programHeaderTable()));
209 // This is the size of a program header entry from the elf file.
210 auxv.push_back(auxv_t(SPARC_AT_PHENT, elfObject->programHeaderSize()));
211 // This is the number of program headers from the original elf file.
212 auxv.push_back(auxv_t(SPARC_AT_PHNUM, elfObject->programHeaderCount()));
213 //This is the address of the elf "interpreter", It should be set
214 //to 0 for regular executables. It should be something else
215 //(not sure what) for dynamic libraries.
216 auxv.push_back(auxv_t(SPARC_AT_BASE, 0));
217 //This is hardwired to 0 in the elf loading code in the kernel
218 auxv.push_back(auxv_t(SPARC_AT_FLAGS, 0));
219 //The entry point to the program
220 auxv.push_back(auxv_t(SPARC_AT_ENTRY, objFile->entryPoint()));
221 //Different user and group IDs
222 auxv.push_back(auxv_t(SPARC_AT_UID, uid()));
223 auxv.push_back(auxv_t(SPARC_AT_EUID, euid()));
224 auxv.push_back(auxv_t(SPARC_AT_GID, gid()));
225 auxv.push_back(auxv_t(SPARC_AT_EGID, egid()));
226 //Whether to enable "secure mode" in the executable
227 auxv.push_back(auxv_t(SPARC_AT_SECURE, 0));*/
230 //Figure out how big the initial stack needs to be
232 // The unaccounted for 0 at the top of the stack
233 int mysterious_size
= intSize
;
235 //This is the name of the file which is present on the initial stack
236 //It's purpose is to let the user space linker examine the original file.
237 int file_name_size
= filename
.size() + 1;
239 int env_data_size
= 0;
240 for (int i
= 0; i
< envp
.size(); ++i
) {
241 env_data_size
+= envp
[i
].size() + 1;
243 int arg_data_size
= 0;
244 for (int i
= 0; i
< argv
.size(); ++i
) {
245 arg_data_size
+= argv
[i
].size() + 1;
248 //The info_block needs to be padded so it's size is a multiple of the
249 //alignment mask. Also, it appears that there needs to be at least some
250 //padding, so if the size is already a multiple, we need to increase it
252 int info_block_size
=
256 intSize
) & alignmentMask
;
258 int info_block_padding
=
264 //Each auxilliary vector is two 8 byte words
265 int aux_array_size
= intSize
* 2 * (auxv
.size() + 1);
267 int envp_array_size
= intSize
* (envp
.size() + 1);
268 int argv_array_size
= intSize
* (argv
.size() + 1);
270 int argc_size
= intSize
;
280 stack_min
= stack_base
- space_needed
;
281 stack_min
&= alignmentMask
;
282 stack_size
= stack_base
- stack_min
;
285 pTable
->allocate(roundDown(stack_min
, pageSize
),
286 roundUp(stack_size
, pageSize
));
288 // map out initial stack contents
289 Addr mysterious_base
= stack_base
- mysterious_size
;
290 Addr file_name_base
= mysterious_base
- file_name_size
;
291 Addr env_data_base
= file_name_base
- env_data_size
;
292 Addr arg_data_base
= env_data_base
- arg_data_size
;
293 Addr auxv_array_base
= arg_data_base
- aux_array_size
- info_block_padding
;
294 Addr envp_array_base
= auxv_array_base
- envp_array_size
;
295 Addr argv_array_base
= envp_array_base
- argv_array_size
;
296 Addr argc_base
= argv_array_base
- argc_size
;
298 DPRINTF(X86
, "The addresses of items on the initial stack:\n");
299 DPRINTF(X86
, "0x%x - file name\n", file_name_base
);
300 DPRINTF(X86
, "0x%x - env data\n", env_data_base
);
301 DPRINTF(X86
, "0x%x - arg data\n", arg_data_base
);
302 DPRINTF(X86
, "0x%x - auxv array\n", auxv_array_base
);
303 DPRINTF(X86
, "0x%x - envp array\n", envp_array_base
);
304 DPRINTF(X86
, "0x%x - argv array\n", argv_array_base
);
305 DPRINTF(X86
, "0x%x - argc \n", argc_base
);
306 DPRINTF(X86
, "0x%x - stack min\n", stack_min
);
308 // write contents to stack
311 uint64_t argc
= argv
.size();
312 uint64_t guestArgc
= TheISA::htog(argc
);
314 //Write out the mysterious 0
315 uint64_t mysterious_zero
= 0;
316 initVirtMem
->writeBlob(mysterious_base
,
317 (uint8_t*)&mysterious_zero
, mysterious_size
);
319 //Write the file name
320 initVirtMem
->writeString(file_name_base
, filename
.c_str());
323 for(int x
= 0; x
< auxv
.size(); x
++)
325 initVirtMem
->writeBlob(auxv_array_base
+ x
* 2 * intSize
,
326 (uint8_t*)&(auxv
[x
].a_type
), intSize
);
327 initVirtMem
->writeBlob(auxv_array_base
+ (x
* 2 + 1) * intSize
,
328 (uint8_t*)&(auxv
[x
].a_val
), intSize
);
330 //Write out the terminating zeroed auxilliary vector
331 const uint64_t zero
= 0;
332 initVirtMem
->writeBlob(auxv_array_base
+ 2 * intSize
* auxv
.size(),
333 (uint8_t*)&zero
, 2 * intSize
);
335 copyStringArray(envp
, envp_array_base
, env_data_base
, initVirtMem
);
336 copyStringArray(argv
, argv_array_base
, arg_data_base
, initVirtMem
);
338 initVirtMem
->writeBlob(argc_base
, (uint8_t*)&guestArgc
, intSize
);
340 //Set up the thread context to start running the process
341 assert(NumArgumentRegs
>= 2);
342 threadContexts
[0]->setIntReg(ArgumentReg
[0], argc
);
343 threadContexts
[0]->setIntReg(ArgumentReg
[1], argv_array_base
);
344 threadContexts
[0]->setIntReg(StackPointerReg
, stack_min
);
346 Addr prog_entry
= objFile
->entryPoint();
347 threadContexts
[0]->setPC(prog_entry
);
348 threadContexts
[0]->setNextPC(prog_entry
+ sizeof(MachInst
));
350 //Align the "stack_min" to a page boundary.
351 stack_min
= roundDown(stack_min
, pageSize
);