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/the_isa.hh"
44 #include "cpu/thread_context.hh"
45 #include "mem/page_table.hh"
46 #include "mem/physical.hh"
47 #include "mem/translating_port.hh"
48 #include "params/LiveProcess.hh"
49 #include "params/Process.hh"
50 #include "sim/debug.hh"
51 #include "sim/process.hh"
52 #include "sim/process_impl.hh"
53 #include "sim/stats.hh"
54 #include "sim/syscall_emul.hh"
55 #include "sim/system.hh"
57 #if THE_ISA == ALPHA_ISA
58 #include "arch/alpha/linux/process.hh"
59 #include "arch/alpha/tru64/process.hh"
60 #elif THE_ISA == SPARC_ISA
61 #include "arch/sparc/linux/process.hh"
62 #include "arch/sparc/solaris/process.hh"
63 #elif THE_ISA == MIPS_ISA
64 #include "arch/mips/linux/process.hh"
65 #elif THE_ISA == ARM_ISA
66 #include "arch/arm/linux/process.hh"
67 #elif THE_ISA == X86_ISA
68 #include "arch/x86/linux/process.hh"
69 #elif THE_ISA == POWER_ISA
70 #include "arch/power/linux/process.hh"
72 #error "THE_ISA not set"
77 using namespace TheISA
;
79 // current number of allocated processes
80 int num_processes
= 0;
82 template<class IntType
>
83 AuxVector
<IntType
>::AuxVector(IntType type
, IntType val
)
85 a_type
= TheISA::htog(type
);
86 a_val
= TheISA::htog(val
);
89 template class AuxVector
<uint32_t>;
90 template class AuxVector
<uint64_t>;
92 Process::Process(ProcessParams
* params
)
93 : SimObject(params
), system(params
->system
),
94 max_stack_size(params
->max_stack_size
)
96 string in
= params
->input
;
97 string out
= params
->output
;
98 string err
= params
->errout
;
100 // initialize file descriptors to default: same as simulator
101 int stdin_fd
, stdout_fd
, stderr_fd
;
103 if (in
== "stdin" || in
== "cin")
104 stdin_fd
= STDIN_FILENO
;
105 else if (in
== "None")
108 stdin_fd
= Process::openInputFile(in
);
110 if (out
== "stdout" || out
== "cout")
111 stdout_fd
= STDOUT_FILENO
;
112 else if (out
== "stderr" || out
== "cerr")
113 stdout_fd
= STDERR_FILENO
;
114 else if (out
== "None")
117 stdout_fd
= Process::openOutputFile(out
);
119 if (err
== "stdout" || err
== "cout")
120 stderr_fd
= STDOUT_FILENO
;
121 else if (err
== "stderr" || err
== "cerr")
122 stderr_fd
= STDERR_FILENO
;
123 else if (err
== "None")
126 stderr_fd
= stdout_fd
;
128 stderr_fd
= Process::openOutputFile(err
);
130 M5_pid
= system
->allocatePID();
131 // initialize first 3 fds (stdin, stdout, stderr)
132 Process::FdMap
*fdo
= &fd_map
[STDIN_FILENO
];
135 fdo
->flags
= O_RDONLY
;
139 fdo
= &fd_map
[STDOUT_FILENO
];
142 fdo
->flags
= O_WRONLY
| O_CREAT
| O_TRUNC
;
146 fdo
= &fd_map
[STDERR_FILENO
];
149 fdo
->flags
= O_WRONLY
;
154 // mark remaining fds as free
155 for (int i
= 3; i
<= MAX_FD
; ++i
) {
156 Process::FdMap
*fdo
= &fd_map
[i
];
160 mmap_start
= mmap_end
= 0;
161 nxm_start
= nxm_end
= 0;
162 pTable
= new PageTable(this);
163 // other parameters will be initialized when the program is loaded
170 using namespace Stats
;
173 .name(name() + ".num_syscalls")
174 .desc("Number of system calls")
179 // static helper functions
182 Process::openInputFile(const string
&filename
)
184 int fd
= open(filename
.c_str(), O_RDONLY
);
188 cerr
<< "unable to open \"" << filename
<< "\" for reading\n";
189 fatal("can't open input file");
197 Process::openOutputFile(const string
&filename
)
199 int fd
= open(filename
.c_str(), O_WRONLY
| O_CREAT
| O_TRUNC
, 0664);
203 cerr
<< "unable to open \"" << filename
<< "\" for writing\n";
204 fatal("can't open output file");
211 Process::findFreeContext()
213 int size
= contextIds
.size();
215 for (int i
= 0; i
< size
; ++i
) {
216 tc
= system
->getThreadContext(contextIds
[i
]);
217 if (tc
->status() == ThreadContext::Halted
) {
218 // inactive context, free to use
228 if (contextIds
.empty())
229 fatal("Process %s is not associated with any HW contexts!\n", name());
231 // first thread context for this process... initialize & enable
232 ThreadContext
*tc
= system
->getThreadContext(contextIds
[0]);
234 // mark this context as active so it will start ticking.
238 mem_port
= system
->physmem
->getPort("functional");
239 initVirtMem
= new TranslatingPort("process init port", this,
240 TranslatingPort::Always
);
241 mem_port
->setPeer(initVirtMem
);
242 initVirtMem
->setPeer(mem_port
);
245 // map simulator fd sim_fd to target fd tgt_fd
247 Process::dup_fd(int sim_fd
, int tgt_fd
)
249 if (tgt_fd
< 0 || tgt_fd
> MAX_FD
)
250 panic("Process::dup_fd tried to dup past MAX_FD (%d)", tgt_fd
);
252 Process::FdMap
*fdo
= &fd_map
[tgt_fd
];
257 // generate new target fd for sim_fd
259 Process::alloc_fd(int sim_fd
, string filename
, int flags
, int mode
, bool pipe
)
261 // in case open() returns an error, don't allocate a new fd
265 // find first free target fd
266 for (int free_fd
= 0; free_fd
<= MAX_FD
; ++free_fd
) {
267 Process::FdMap
*fdo
= &fd_map
[free_fd
];
270 fdo
->filename
= filename
;
275 fdo
->readPipeSource
= 0;
280 panic("Process::alloc_fd: out of file descriptors!");
284 // free target fd (e.g., after close)
286 Process::free_fd(int tgt_fd
)
288 Process::FdMap
*fdo
= &fd_map
[tgt_fd
];
290 warn("Process::free_fd: request to free unused fd %d", tgt_fd
);
293 fdo
->filename
= "NULL";
298 fdo
->readPipeSource
= 0;
302 // look up simulator fd for given target fd
304 Process::sim_fd(int tgt_fd
)
306 if (tgt_fd
< 0 || tgt_fd
> MAX_FD
)
309 return fd_map
[tgt_fd
].fd
;
313 Process::sim_fd_obj(int tgt_fd
)
315 if (tgt_fd
< 0 || tgt_fd
> MAX_FD
)
318 return &fd_map
[tgt_fd
];
322 Process::fixupStackFault(Addr vaddr
)
324 // Check if this is already on the stack and there's just no page there
326 if (vaddr
>= stack_min
&& vaddr
< stack_base
) {
327 pTable
->allocate(roundDown(vaddr
, VMPageSize
), VMPageSize
);
331 // We've accessed the next page of the stack, so extend it to include
333 if (vaddr
< stack_min
&& vaddr
>= stack_base
- max_stack_size
) {
334 while (vaddr
< stack_min
) {
335 stack_min
-= TheISA::PageBytes
;
336 if (stack_base
- stack_min
> max_stack_size
)
337 fatal("Maximum stack size exceeded\n");
338 if (stack_base
- stack_min
> 8 * 1024 * 1024)
339 fatal("Over max stack size for one thread\n");
340 pTable
->allocate(stack_min
, TheISA::PageBytes
);
341 inform("Increasing stack size by one page.");
345 warn("Not extending stack: address %#x isn't at the end of the stack.",
350 // find all offsets for currently open files and save them
352 Process::fix_file_offsets()
354 Process::FdMap
*fdo_stdin
= &fd_map
[STDIN_FILENO
];
355 Process::FdMap
*fdo_stdout
= &fd_map
[STDOUT_FILENO
];
356 Process::FdMap
*fdo_stderr
= &fd_map
[STDERR_FILENO
];
357 string in
= fdo_stdin
->filename
;
358 string out
= fdo_stdout
->filename
;
359 string err
= fdo_stderr
->filename
;
361 // initialize file descriptors to default: same as simulator
362 int stdin_fd
, stdout_fd
, stderr_fd
;
364 if (in
== "stdin" || in
== "cin")
365 stdin_fd
= STDIN_FILENO
;
366 else if (in
== "None")
369 // open standard in and seek to the right location
370 stdin_fd
= Process::openInputFile(in
);
371 if (lseek(stdin_fd
, fdo_stdin
->fileOffset
, SEEK_SET
) < 0)
372 panic("Unable to seek to correct location in file: %s", in
);
375 if (out
== "stdout" || out
== "cout")
376 stdout_fd
= STDOUT_FILENO
;
377 else if (out
== "stderr" || out
== "cerr")
378 stdout_fd
= STDERR_FILENO
;
379 else if (out
== "None")
382 stdout_fd
= Process::openOutputFile(out
);
383 if (lseek(stdout_fd
, fdo_stdout
->fileOffset
, SEEK_SET
) < 0)
384 panic("Unable to seek to correct location in file: %s", out
);
387 if (err
== "stdout" || err
== "cout")
388 stderr_fd
= STDOUT_FILENO
;
389 else if (err
== "stderr" || err
== "cerr")
390 stderr_fd
= STDERR_FILENO
;
391 else if (err
== "None")
394 stderr_fd
= stdout_fd
;
396 stderr_fd
= Process::openOutputFile(err
);
397 if (lseek(stderr_fd
, fdo_stderr
->fileOffset
, SEEK_SET
) < 0)
398 panic("Unable to seek to correct location in file: %s", err
);
401 fdo_stdin
->fd
= stdin_fd
;
402 fdo_stdout
->fd
= stdout_fd
;
403 fdo_stderr
->fd
= stderr_fd
;
406 for (int free_fd
= 3; free_fd
<= MAX_FD
; ++free_fd
) {
407 Process::FdMap
*fdo
= &fd_map
[free_fd
];
410 if (fdo
->filename
== "PIPE-WRITE")
413 assert (fdo
->filename
== "PIPE-READ");
416 int pipe_retval
= pipe(fds
);
418 if (pipe_retval
< 0) {
420 panic("Unable to create new pipe.");
422 fdo
->fd
= fds
[0]; //set read pipe
423 Process::FdMap
*fdo_write
= &fd_map
[fdo
->readPipeSource
];
424 if (fdo_write
->filename
!= "PIPE-WRITE")
425 panic ("Couldn't find write end of the pipe");
427 fdo_write
->fd
= fds
[1];//set write pipe
431 int fd
= open(fdo
->filename
.c_str(), fdo
->flags
, fdo
->mode
);
434 panic("Unable to open file: %s", fdo
->filename
);
437 //Seek to correct location before checkpoint
438 if (lseek(fd
,fdo
->fileOffset
, SEEK_SET
) < 0)
439 panic("Unable to seek to correct location in file: %s",
447 Process::find_file_offsets()
449 for (int free_fd
= 0; free_fd
<= MAX_FD
; ++free_fd
) {
450 Process::FdMap
*fdo
= &fd_map
[free_fd
];
452 fdo
->fileOffset
= lseek(fdo
->fd
, 0, SEEK_CUR
);
454 fdo
->filename
= "NULL";
461 Process::setReadPipeSource(int read_pipe_fd
, int source_fd
)
463 Process::FdMap
*fdo
= &fd_map
[read_pipe_fd
];
464 fdo
->readPipeSource
= source_fd
;
468 Process::FdMap::serialize(std::ostream
&os
)
470 SERIALIZE_SCALAR(fd
);
471 SERIALIZE_SCALAR(isPipe
);
472 SERIALIZE_SCALAR(filename
);
473 SERIALIZE_SCALAR(flags
);
474 SERIALIZE_SCALAR(readPipeSource
);
475 SERIALIZE_SCALAR(fileOffset
);
479 Process::FdMap::unserialize(Checkpoint
*cp
, const std::string
§ion
)
481 UNSERIALIZE_SCALAR(fd
);
482 UNSERIALIZE_SCALAR(isPipe
);
483 UNSERIALIZE_SCALAR(filename
);
484 UNSERIALIZE_SCALAR(flags
);
485 UNSERIALIZE_SCALAR(readPipeSource
);
486 UNSERIALIZE_SCALAR(fileOffset
);
490 Process::serialize(std::ostream
&os
)
492 SERIALIZE_SCALAR(brk_point
);
493 SERIALIZE_SCALAR(stack_base
);
494 SERIALIZE_SCALAR(stack_size
);
495 SERIALIZE_SCALAR(stack_min
);
496 SERIALIZE_SCALAR(next_thread_stack_base
);
497 SERIALIZE_SCALAR(mmap_start
);
498 SERIALIZE_SCALAR(mmap_end
);
499 SERIALIZE_SCALAR(nxm_start
);
500 SERIALIZE_SCALAR(nxm_end
);
502 pTable
->serialize(os
);
503 for (int x
= 0; x
<= MAX_FD
; x
++) {
504 nameOut(os
, csprintf("%s.FdMap%d", name(), x
));
505 fd_map
[x
].serialize(os
);
507 SERIALIZE_SCALAR(M5_pid
);
512 Process::unserialize(Checkpoint
*cp
, const std::string
§ion
)
514 UNSERIALIZE_SCALAR(brk_point
);
515 UNSERIALIZE_SCALAR(stack_base
);
516 UNSERIALIZE_SCALAR(stack_size
);
517 UNSERIALIZE_SCALAR(stack_min
);
518 UNSERIALIZE_SCALAR(next_thread_stack_base
);
519 UNSERIALIZE_SCALAR(mmap_start
);
520 UNSERIALIZE_SCALAR(mmap_end
);
521 UNSERIALIZE_SCALAR(nxm_start
);
522 UNSERIALIZE_SCALAR(nxm_end
);
523 pTable
->unserialize(cp
, section
);
524 for (int x
= 0; x
<= MAX_FD
; x
++) {
525 fd_map
[x
].unserialize(cp
, csprintf("%s.FdMap%d", section
, x
));
528 UNSERIALIZE_OPT_SCALAR(M5_pid
);
529 // The above returns a bool so that you could do something if you don't
530 // find the param in the checkpoint if you wanted to, like set a default
531 // but in this case we'll just stick with the instantianted value if not
536 ////////////////////////////////////////////////////////////////////////
538 // LiveProcess member definitions
540 ////////////////////////////////////////////////////////////////////////
543 LiveProcess::LiveProcess(LiveProcessParams
* params
, ObjectFile
*_objFile
)
544 : Process(params
), objFile(_objFile
),
545 argv(params
->cmd
), envp(params
->env
), cwd(params
->cwd
)
548 __euid
= params
->euid
;
550 __egid
= params
->egid
;
552 __ppid
= params
->ppid
;
554 prog_fname
= params
->cmd
[0];
556 // load up symbols, if any... these may be used for debugging or
558 if (!debugSymbolTable
) {
559 debugSymbolTable
= new SymbolTable();
560 if (!objFile
->loadGlobalSymbols(debugSymbolTable
) ||
561 !objFile
->loadLocalSymbols(debugSymbolTable
)) {
562 // didn't load any symbols
563 delete debugSymbolTable
;
564 debugSymbolTable
= NULL
;
570 LiveProcess::syscall(int64_t callnum
, ThreadContext
*tc
)
574 SyscallDesc
*desc
= getDesc(callnum
);
576 fatal("Syscall %d out of range", callnum
);
578 desc
->doSyscall(callnum
, this, tc
);
582 LiveProcess::getSyscallArg(ThreadContext
*tc
, int &i
, int width
)
584 return getSyscallArg(tc
, i
);
588 LiveProcess::create(LiveProcessParams
* params
)
590 LiveProcess
*process
= NULL
;
593 params
->executable
== "" ? params
->cmd
[0] : params
->executable
;
594 ObjectFile
*objFile
= createObjectFile(executable
);
595 if (objFile
== NULL
) {
596 fatal("Can't load object file %s", executable
);
599 if (objFile
->isDynamic())
600 fatal("Object file is a dynamic executable however only static "
601 "executables are supported!\n Please recompile your "
602 "executable as a static binary and try again.\n");
604 #if THE_ISA == ALPHA_ISA
605 if (objFile
->getArch() != ObjectFile::Alpha
)
606 fatal("Object file architecture does not match compiled ISA (Alpha).");
608 switch (objFile
->getOpSys()) {
609 case ObjectFile::Tru64
:
610 process
= new AlphaTru64Process(params
, objFile
);
613 case ObjectFile::UnknownOpSys
:
614 warn("Unknown operating system; assuming Linux.");
616 case ObjectFile::Linux
:
617 process
= new AlphaLinuxProcess(params
, objFile
);
621 fatal("Unknown/unsupported operating system.");
623 #elif THE_ISA == SPARC_ISA
624 if (objFile
->getArch() != ObjectFile::SPARC64
&&
625 objFile
->getArch() != ObjectFile::SPARC32
)
626 fatal("Object file architecture does not match compiled ISA (SPARC).");
627 switch (objFile
->getOpSys()) {
628 case ObjectFile::UnknownOpSys
:
629 warn("Unknown operating system; assuming Linux.");
631 case ObjectFile::Linux
:
632 if (objFile
->getArch() == ObjectFile::SPARC64
) {
633 process
= new Sparc64LinuxProcess(params
, objFile
);
635 process
= new Sparc32LinuxProcess(params
, objFile
);
640 case ObjectFile::Solaris
:
641 process
= new SparcSolarisProcess(params
, objFile
);
645 fatal("Unknown/unsupported operating system.");
647 #elif THE_ISA == X86_ISA
648 if (objFile
->getArch() != ObjectFile::X86_64
&&
649 objFile
->getArch() != ObjectFile::I386
)
650 fatal("Object file architecture does not match compiled ISA (x86).");
651 switch (objFile
->getOpSys()) {
652 case ObjectFile::UnknownOpSys
:
653 warn("Unknown operating system; assuming Linux.");
655 case ObjectFile::Linux
:
656 if (objFile
->getArch() == ObjectFile::X86_64
) {
657 process
= new X86_64LinuxProcess(params
, objFile
);
659 process
= new I386LinuxProcess(params
, objFile
);
664 fatal("Unknown/unsupported operating system.");
666 #elif THE_ISA == MIPS_ISA
667 if (objFile
->getArch() != ObjectFile::Mips
)
668 fatal("Object file architecture does not match compiled ISA (MIPS).");
669 switch (objFile
->getOpSys()) {
670 case ObjectFile::UnknownOpSys
:
671 warn("Unknown operating system; assuming Linux.");
673 case ObjectFile::Linux
:
674 process
= new MipsLinuxProcess(params
, objFile
);
678 fatal("Unknown/unsupported operating system.");
680 #elif THE_ISA == ARM_ISA
681 if (objFile
->getArch() != ObjectFile::Arm
&&
682 objFile
->getArch() != ObjectFile::Thumb
)
683 fatal("Object file architecture does not match compiled ISA (ARM).");
684 switch (objFile
->getOpSys()) {
685 case ObjectFile::UnknownOpSys
:
686 warn("Unknown operating system; assuming Linux.");
688 case ObjectFile::Linux
:
689 process
= new ArmLinuxProcess(params
, objFile
, objFile
->getArch());
691 case ObjectFile::LinuxArmOABI
:
692 fatal("M5 does not support ARM OABI binaries. Please recompile with an"
695 fatal("Unknown/unsupported operating system.");
697 #elif THE_ISA == POWER_ISA
698 if (objFile
->getArch() != ObjectFile::Power
)
699 fatal("Object file architecture does not match compiled ISA (Power).");
700 switch (objFile
->getOpSys()) {
701 case ObjectFile::UnknownOpSys
:
702 warn("Unknown operating system; assuming Linux.");
704 case ObjectFile::Linux
:
705 process
= new PowerLinuxProcess(params
, objFile
);
709 fatal("Unknown/unsupported operating system.");
712 #error "THE_ISA not set"
716 fatal("Unknown error creating process object.");
721 LiveProcessParams::create()
723 return LiveProcess::create(this);