2 * Copyright (c) 2001-2005 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.
28 * Authors: Nathan Binkert
39 #include "base/loader/object_file.hh"
40 #include "base/loader/symtab.hh"
41 #include "base/intmath.hh"
42 #include "base/statistics.hh"
43 #include "config/full_system.hh"
44 #include "config/the_isa.hh"
45 #include "cpu/thread_context.hh"
46 #include "mem/page_table.hh"
47 #include "mem/physical.hh"
48 #include "mem/translating_port.hh"
49 #include "params/LiveProcess.hh"
50 #include "params/Process.hh"
51 #include "sim/debug.hh"
52 #include "sim/process.hh"
53 #include "sim/process_impl.hh"
54 #include "sim/stats.hh"
55 #include "sim/syscall_emul.hh"
56 #include "sim/system.hh"
58 #if THE_ISA == ALPHA_ISA
59 #include "arch/alpha/linux/process.hh"
60 #include "arch/alpha/tru64/process.hh"
61 #elif THE_ISA == SPARC_ISA
62 #include "arch/sparc/linux/process.hh"
63 #include "arch/sparc/solaris/process.hh"
64 #elif THE_ISA == MIPS_ISA
65 #include "arch/mips/linux/process.hh"
66 #elif THE_ISA == ARM_ISA
67 #include "arch/arm/linux/process.hh"
68 #elif THE_ISA == X86_ISA
69 #include "arch/x86/linux/process.hh"
70 #elif THE_ISA == POWER_ISA
71 #include "arch/power/linux/process.hh"
73 #error "THE_ISA not set"
78 using namespace TheISA
;
81 // The purpose of this code is to fake the loader & syscall mechanism
82 // when there's no OS: thus there's no resone to use it in FULL_SYSTEM
83 // mode when we do have an OS
86 #error "process.cc not compatible with FULL_SYSTEM"
89 // current number of allocated processes
90 int num_processes
= 0;
92 template<class IntType
>
93 AuxVector
<IntType
>::AuxVector(IntType type
, IntType val
)
95 a_type
= TheISA::htog(type
);
96 a_val
= TheISA::htog(val
);
99 template class AuxVector
<uint32_t>;
100 template class AuxVector
<uint64_t>;
102 Process::Process(ProcessParams
* params
)
103 : SimObject(params
), system(params
->system
),
104 max_stack_size(params
->max_stack_size
)
106 string in
= params
->input
;
107 string out
= params
->output
;
108 string err
= params
->errout
;
110 // initialize file descriptors to default: same as simulator
111 int stdin_fd
, stdout_fd
, stderr_fd
;
113 if (in
== "stdin" || in
== "cin")
114 stdin_fd
= STDIN_FILENO
;
115 else if (in
== "None")
118 stdin_fd
= Process::openInputFile(in
);
120 if (out
== "stdout" || out
== "cout")
121 stdout_fd
= STDOUT_FILENO
;
122 else if (out
== "stderr" || out
== "cerr")
123 stdout_fd
= STDERR_FILENO
;
124 else if (out
== "None")
127 stdout_fd
= Process::openOutputFile(out
);
129 if (err
== "stdout" || err
== "cout")
130 stderr_fd
= STDOUT_FILENO
;
131 else if (err
== "stderr" || err
== "cerr")
132 stderr_fd
= STDERR_FILENO
;
133 else if (err
== "None")
136 stderr_fd
= stdout_fd
;
138 stderr_fd
= Process::openOutputFile(err
);
140 M5_pid
= system
->allocatePID();
141 // initialize first 3 fds (stdin, stdout, stderr)
142 Process::FdMap
*fdo
= &fd_map
[STDIN_FILENO
];
145 fdo
->flags
= O_RDONLY
;
149 fdo
= &fd_map
[STDOUT_FILENO
];
152 fdo
->flags
= O_WRONLY
| O_CREAT
| O_TRUNC
;
156 fdo
= &fd_map
[STDERR_FILENO
];
159 fdo
->flags
= O_WRONLY
;
164 // mark remaining fds as free
165 for (int i
= 3; i
<= MAX_FD
; ++i
) {
166 Process::FdMap
*fdo
= &fd_map
[i
];
170 mmap_start
= mmap_end
= 0;
171 nxm_start
= nxm_end
= 0;
172 pTable
= new PageTable(name(), M5_pid
);
173 // other parameters will be initialized when the program is loaded
180 using namespace Stats
;
183 .name(name() + ".num_syscalls")
184 .desc("Number of system calls")
189 // static helper functions
192 Process::openInputFile(const string
&filename
)
194 int fd
= open(filename
.c_str(), O_RDONLY
);
198 cerr
<< "unable to open \"" << filename
<< "\" for reading\n";
199 fatal("can't open input file");
207 Process::openOutputFile(const string
&filename
)
209 int fd
= open(filename
.c_str(), O_WRONLY
| O_CREAT
| O_TRUNC
, 0664);
213 cerr
<< "unable to open \"" << filename
<< "\" for writing\n";
214 fatal("can't open output file");
221 Process::findFreeContext()
223 int size
= contextIds
.size();
225 for (int i
= 0; i
< size
; ++i
) {
226 tc
= system
->getThreadContext(contextIds
[i
]);
227 if (tc
->status() == ThreadContext::Halted
) {
228 // inactive context, free to use
238 if (contextIds
.empty())
239 fatal("Process %s is not associated with any HW contexts!\n", name());
241 // first thread context for this process... initialize & enable
242 ThreadContext
*tc
= system
->getThreadContext(contextIds
[0]);
244 // mark this context as active so it will start ticking.
248 mem_port
= system
->physmem
->getPort("functional");
249 initVirtMem
= new TranslatingPort("process init port", this,
250 TranslatingPort::Always
);
251 mem_port
->setPeer(initVirtMem
);
252 initVirtMem
->setPeer(mem_port
);
255 // map simulator fd sim_fd to target fd tgt_fd
257 Process::dup_fd(int sim_fd
, int tgt_fd
)
259 if (tgt_fd
< 0 || tgt_fd
> MAX_FD
)
260 panic("Process::dup_fd tried to dup past MAX_FD (%d)", tgt_fd
);
262 Process::FdMap
*fdo
= &fd_map
[tgt_fd
];
267 // generate new target fd for sim_fd
269 Process::alloc_fd(int sim_fd
, string filename
, int flags
, int mode
, bool pipe
)
271 // in case open() returns an error, don't allocate a new fd
275 // find first free target fd
276 for (int free_fd
= 0; free_fd
<= MAX_FD
; ++free_fd
) {
277 Process::FdMap
*fdo
= &fd_map
[free_fd
];
280 fdo
->filename
= filename
;
285 fdo
->readPipeSource
= 0;
290 panic("Process::alloc_fd: out of file descriptors!");
294 // free target fd (e.g., after close)
296 Process::free_fd(int tgt_fd
)
298 Process::FdMap
*fdo
= &fd_map
[tgt_fd
];
300 warn("Process::free_fd: request to free unused fd %d", tgt_fd
);
303 fdo
->filename
= "NULL";
308 fdo
->readPipeSource
= 0;
312 // look up simulator fd for given target fd
314 Process::sim_fd(int tgt_fd
)
316 if (tgt_fd
< 0 || tgt_fd
> MAX_FD
)
319 return fd_map
[tgt_fd
].fd
;
323 Process::sim_fd_obj(int tgt_fd
)
325 if (tgt_fd
< 0 || tgt_fd
> MAX_FD
)
328 return &fd_map
[tgt_fd
];
332 Process::allocateMem(Addr vaddr
, int64_t size
, bool clobber
)
334 int npages
= divCeil(size
, (int64_t)VMPageSize
);
335 Addr paddr
= system
->allocPhysPages(npages
);
336 pTable
->map(vaddr
, paddr
, size
, clobber
);
340 Process::fixupStackFault(Addr vaddr
)
342 // Check if this is already on the stack and there's just no page there
344 if (vaddr
>= stack_min
&& vaddr
< stack_base
) {
345 allocateMem(roundDown(vaddr
, VMPageSize
), VMPageSize
);
349 // We've accessed the next page of the stack, so extend it to include
351 if (vaddr
< stack_min
&& vaddr
>= stack_base
- max_stack_size
) {
352 while (vaddr
< stack_min
) {
353 stack_min
-= TheISA::PageBytes
;
354 if (stack_base
- stack_min
> max_stack_size
)
355 fatal("Maximum stack size exceeded\n");
356 if (stack_base
- stack_min
> 8 * 1024 * 1024)
357 fatal("Over max stack size for one thread\n");
358 allocateMem(stack_min
, TheISA::PageBytes
);
359 inform("Increasing stack size by one page.");
363 warn("Not extending stack: address %#x isn't at the end of the stack.",
368 // find all offsets for currently open files and save them
370 Process::fix_file_offsets()
372 Process::FdMap
*fdo_stdin
= &fd_map
[STDIN_FILENO
];
373 Process::FdMap
*fdo_stdout
= &fd_map
[STDOUT_FILENO
];
374 Process::FdMap
*fdo_stderr
= &fd_map
[STDERR_FILENO
];
375 string in
= fdo_stdin
->filename
;
376 string out
= fdo_stdout
->filename
;
377 string err
= fdo_stderr
->filename
;
379 // initialize file descriptors to default: same as simulator
380 int stdin_fd
, stdout_fd
, stderr_fd
;
382 if (in
== "stdin" || in
== "cin")
383 stdin_fd
= STDIN_FILENO
;
384 else if (in
== "None")
387 // open standard in and seek to the right location
388 stdin_fd
= Process::openInputFile(in
);
389 if (lseek(stdin_fd
, fdo_stdin
->fileOffset
, SEEK_SET
) < 0)
390 panic("Unable to seek to correct location in file: %s", in
);
393 if (out
== "stdout" || out
== "cout")
394 stdout_fd
= STDOUT_FILENO
;
395 else if (out
== "stderr" || out
== "cerr")
396 stdout_fd
= STDERR_FILENO
;
397 else if (out
== "None")
400 stdout_fd
= Process::openOutputFile(out
);
401 if (lseek(stdout_fd
, fdo_stdout
->fileOffset
, SEEK_SET
) < 0)
402 panic("Unable to seek to correct location in file: %s", out
);
405 if (err
== "stdout" || err
== "cout")
406 stderr_fd
= STDOUT_FILENO
;
407 else if (err
== "stderr" || err
== "cerr")
408 stderr_fd
= STDERR_FILENO
;
409 else if (err
== "None")
412 stderr_fd
= stdout_fd
;
414 stderr_fd
= Process::openOutputFile(err
);
415 if (lseek(stderr_fd
, fdo_stderr
->fileOffset
, SEEK_SET
) < 0)
416 panic("Unable to seek to correct location in file: %s", err
);
419 fdo_stdin
->fd
= stdin_fd
;
420 fdo_stdout
->fd
= stdout_fd
;
421 fdo_stderr
->fd
= stderr_fd
;
424 for (int free_fd
= 3; free_fd
<= MAX_FD
; ++free_fd
) {
425 Process::FdMap
*fdo
= &fd_map
[free_fd
];
428 if (fdo
->filename
== "PIPE-WRITE")
431 assert (fdo
->filename
== "PIPE-READ");
434 int pipe_retval
= pipe(fds
);
436 if (pipe_retval
< 0) {
438 panic("Unable to create new pipe.");
440 fdo
->fd
= fds
[0]; //set read pipe
441 Process::FdMap
*fdo_write
= &fd_map
[fdo
->readPipeSource
];
442 if (fdo_write
->filename
!= "PIPE-WRITE")
443 panic ("Couldn't find write end of the pipe");
445 fdo_write
->fd
= fds
[1];//set write pipe
449 int fd
= open(fdo
->filename
.c_str(), fdo
->flags
, fdo
->mode
);
452 panic("Unable to open file: %s", fdo
->filename
);
455 //Seek to correct location before checkpoint
456 if (lseek(fd
,fdo
->fileOffset
, SEEK_SET
) < 0)
457 panic("Unable to seek to correct location in file: %s",
465 Process::find_file_offsets()
467 for (int free_fd
= 0; free_fd
<= MAX_FD
; ++free_fd
) {
468 Process::FdMap
*fdo
= &fd_map
[free_fd
];
470 fdo
->fileOffset
= lseek(fdo
->fd
, 0, SEEK_CUR
);
472 fdo
->filename
= "NULL";
479 Process::setReadPipeSource(int read_pipe_fd
, int source_fd
)
481 Process::FdMap
*fdo
= &fd_map
[read_pipe_fd
];
482 fdo
->readPipeSource
= source_fd
;
486 Process::FdMap::serialize(std::ostream
&os
)
488 SERIALIZE_SCALAR(fd
);
489 SERIALIZE_SCALAR(isPipe
);
490 SERIALIZE_SCALAR(filename
);
491 SERIALIZE_SCALAR(flags
);
492 SERIALIZE_SCALAR(readPipeSource
);
493 SERIALIZE_SCALAR(fileOffset
);
497 Process::FdMap::unserialize(Checkpoint
*cp
, const std::string
§ion
)
499 UNSERIALIZE_SCALAR(fd
);
500 UNSERIALIZE_SCALAR(isPipe
);
501 UNSERIALIZE_SCALAR(filename
);
502 UNSERIALIZE_SCALAR(flags
);
503 UNSERIALIZE_SCALAR(readPipeSource
);
504 UNSERIALIZE_SCALAR(fileOffset
);
508 Process::serialize(std::ostream
&os
)
510 SERIALIZE_SCALAR(brk_point
);
511 SERIALIZE_SCALAR(stack_base
);
512 SERIALIZE_SCALAR(stack_size
);
513 SERIALIZE_SCALAR(stack_min
);
514 SERIALIZE_SCALAR(next_thread_stack_base
);
515 SERIALIZE_SCALAR(mmap_start
);
516 SERIALIZE_SCALAR(mmap_end
);
517 SERIALIZE_SCALAR(nxm_start
);
518 SERIALIZE_SCALAR(nxm_end
);
520 pTable
->serialize(os
);
521 for (int x
= 0; x
<= MAX_FD
; x
++) {
522 nameOut(os
, csprintf("%s.FdMap%d", name(), x
));
523 fd_map
[x
].serialize(os
);
525 SERIALIZE_SCALAR(M5_pid
);
530 Process::unserialize(Checkpoint
*cp
, const std::string
§ion
)
532 UNSERIALIZE_SCALAR(brk_point
);
533 UNSERIALIZE_SCALAR(stack_base
);
534 UNSERIALIZE_SCALAR(stack_size
);
535 UNSERIALIZE_SCALAR(stack_min
);
536 UNSERIALIZE_SCALAR(next_thread_stack_base
);
537 UNSERIALIZE_SCALAR(mmap_start
);
538 UNSERIALIZE_SCALAR(mmap_end
);
539 UNSERIALIZE_SCALAR(nxm_start
);
540 UNSERIALIZE_SCALAR(nxm_end
);
541 pTable
->unserialize(cp
, section
);
542 for (int x
= 0; x
<= MAX_FD
; x
++) {
543 fd_map
[x
].unserialize(cp
, csprintf("%s.FdMap%d", section
, x
));
546 UNSERIALIZE_OPT_SCALAR(M5_pid
);
547 // The above returns a bool so that you could do something if you don't
548 // find the param in the checkpoint if you wanted to, like set a default
549 // but in this case we'll just stick with the instantianted value if not
554 ////////////////////////////////////////////////////////////////////////
556 // LiveProcess member definitions
558 ////////////////////////////////////////////////////////////////////////
561 LiveProcess::LiveProcess(LiveProcessParams
* params
, ObjectFile
*_objFile
)
562 : Process(params
), objFile(_objFile
),
563 argv(params
->cmd
), envp(params
->env
), cwd(params
->cwd
)
566 __euid
= params
->euid
;
568 __egid
= params
->egid
;
570 __ppid
= params
->ppid
;
572 prog_fname
= params
->cmd
[0];
574 // load up symbols, if any... these may be used for debugging or
576 if (!debugSymbolTable
) {
577 debugSymbolTable
= new SymbolTable();
578 if (!objFile
->loadGlobalSymbols(debugSymbolTable
) ||
579 !objFile
->loadLocalSymbols(debugSymbolTable
)) {
580 // didn't load any symbols
581 delete debugSymbolTable
;
582 debugSymbolTable
= NULL
;
588 LiveProcess::syscall(int64_t callnum
, ThreadContext
*tc
)
592 SyscallDesc
*desc
= getDesc(callnum
);
594 fatal("Syscall %d out of range", callnum
);
596 desc
->doSyscall(callnum
, this, tc
);
600 LiveProcess::getSyscallArg(ThreadContext
*tc
, int &i
, int width
)
602 return getSyscallArg(tc
, i
);
606 LiveProcess::create(LiveProcessParams
* params
)
608 LiveProcess
*process
= NULL
;
611 params
->executable
== "" ? params
->cmd
[0] : params
->executable
;
612 ObjectFile
*objFile
= createObjectFile(executable
);
613 if (objFile
== NULL
) {
614 fatal("Can't load object file %s", executable
);
617 if (objFile
->isDynamic())
618 fatal("Object file is a dynamic executable however only static "
619 "executables are supported!\n Please recompile your "
620 "executable as a static binary and try again.\n");
622 #if THE_ISA == ALPHA_ISA
623 if (objFile
->getArch() != ObjectFile::Alpha
)
624 fatal("Object file architecture does not match compiled ISA (Alpha).");
626 switch (objFile
->getOpSys()) {
627 case ObjectFile::Tru64
:
628 process
= new AlphaTru64Process(params
, objFile
);
631 case ObjectFile::UnknownOpSys
:
632 warn("Unknown operating system; assuming Linux.");
634 case ObjectFile::Linux
:
635 process
= new AlphaLinuxProcess(params
, objFile
);
639 fatal("Unknown/unsupported operating system.");
641 #elif THE_ISA == SPARC_ISA
642 if (objFile
->getArch() != ObjectFile::SPARC64
&&
643 objFile
->getArch() != ObjectFile::SPARC32
)
644 fatal("Object file architecture does not match compiled ISA (SPARC).");
645 switch (objFile
->getOpSys()) {
646 case ObjectFile::UnknownOpSys
:
647 warn("Unknown operating system; assuming Linux.");
649 case ObjectFile::Linux
:
650 if (objFile
->getArch() == ObjectFile::SPARC64
) {
651 process
= new Sparc64LinuxProcess(params
, objFile
);
653 process
= new Sparc32LinuxProcess(params
, objFile
);
658 case ObjectFile::Solaris
:
659 process
= new SparcSolarisProcess(params
, objFile
);
663 fatal("Unknown/unsupported operating system.");
665 #elif THE_ISA == X86_ISA
666 if (objFile
->getArch() != ObjectFile::X86_64
&&
667 objFile
->getArch() != ObjectFile::I386
)
668 fatal("Object file architecture does not match compiled ISA (x86).");
669 switch (objFile
->getOpSys()) {
670 case ObjectFile::UnknownOpSys
:
671 warn("Unknown operating system; assuming Linux.");
673 case ObjectFile::Linux
:
674 if (objFile
->getArch() == ObjectFile::X86_64
) {
675 process
= new X86_64LinuxProcess(params
, objFile
);
677 process
= new I386LinuxProcess(params
, objFile
);
682 fatal("Unknown/unsupported operating system.");
684 #elif THE_ISA == MIPS_ISA
685 if (objFile
->getArch() != ObjectFile::Mips
)
686 fatal("Object file architecture does not match compiled ISA (MIPS).");
687 switch (objFile
->getOpSys()) {
688 case ObjectFile::UnknownOpSys
:
689 warn("Unknown operating system; assuming Linux.");
691 case ObjectFile::Linux
:
692 process
= new MipsLinuxProcess(params
, objFile
);
696 fatal("Unknown/unsupported operating system.");
698 #elif THE_ISA == ARM_ISA
699 if (objFile
->getArch() != ObjectFile::Arm
&&
700 objFile
->getArch() != ObjectFile::Thumb
)
701 fatal("Object file architecture does not match compiled ISA (ARM).");
702 switch (objFile
->getOpSys()) {
703 case ObjectFile::UnknownOpSys
:
704 warn("Unknown operating system; assuming Linux.");
706 case ObjectFile::Linux
:
707 process
= new ArmLinuxProcess(params
, objFile
, objFile
->getArch());
709 case ObjectFile::LinuxArmOABI
:
710 fatal("M5 does not support ARM OABI binaries. Please recompile with an"
713 fatal("Unknown/unsupported operating system.");
715 #elif THE_ISA == POWER_ISA
716 if (objFile
->getArch() != ObjectFile::Power
)
717 fatal("Object file architecture does not match compiled ISA (Power).");
718 switch (objFile
->getOpSys()) {
719 case ObjectFile::UnknownOpSys
:
720 warn("Unknown operating system; assuming Linux.");
722 case ObjectFile::Linux
:
723 process
= new PowerLinuxProcess(params
, objFile
);
727 fatal("Unknown/unsupported operating system.");
730 #error "THE_ISA not set"
735 fatal("Unknown error creating process object.");
740 LiveProcessParams::create()
742 return LiveProcess::create(this);