syscall_emul.hh revision 8852 
1/*
2 * Copyright (c) 2003-2005 The Regents of The University of Michigan
3 * All rights reserved.
4 *
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.
15 *
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.
27 *
28 * Authors: Steve Reinhardt
29 *          Kevin Lim
30 */
31
32#ifndef __SIM_SYSCALL_EMUL_HH__
33#define __SIM_SYSCALL_EMUL_HH__
34
35#define NO_STAT64 (defined(__APPLE__) || defined(__OpenBSD__) || \
36                   defined(__FreeBSD__) || defined(__CYGWIN__))
37
38///
39/// @file syscall_emul.hh
40///
41/// This file defines objects used to emulate syscalls from the target
42/// application on the host machine.
43
44#ifdef __CYGWIN32__
45#include <sys/fcntl.h>  // for O_BINARY
46#endif
47#include <sys/stat.h>
48#include <sys/time.h>
49#include <sys/uio.h>
50#include <fcntl.h>
51
52#include <cerrno>
53#include <string>
54
55#include "base/chunk_generator.hh"
56#include "base/intmath.hh"      // for RoundUp
57#include "base/misc.hh"
58#include "base/trace.hh"
59#include "base/types.hh"
60#include "config/the_isa.hh"
61#include "cpu/base.hh"
62#include "cpu/thread_context.hh"
63#include "debug/SyscallVerbose.hh"
64#include "mem/page_table.hh"
65#include "mem/se_translating_port_proxy.hh"
66#include "sim/byteswap.hh"
67#include "sim/process.hh"
68#include "sim/syscallreturn.hh"
69#include "sim/system.hh"
70
71///
72/// System call descriptor.
73///
74class SyscallDesc {
75
76  public:
77
78    /// Typedef for target syscall handler functions.
79    typedef SyscallReturn (*FuncPtr)(SyscallDesc *, int num,
80                           LiveProcess *, ThreadContext *);
81
82    const char *name;   //!< Syscall name (e.g., "open").
83    FuncPtr funcPtr;    //!< Pointer to emulation function.
84    int flags;          //!< Flags (see Flags enum).
85
86    /// Flag values for controlling syscall behavior.
87    enum Flags {
88        /// Don't set return regs according to funcPtr return value.
89        /// Used for syscalls with non-standard return conventions
90        /// that explicitly set the ThreadContext regs (e.g.,
91        /// sigreturn).
92        SuppressReturnValue = 1
93    };
94
95    /// Constructor.
96    SyscallDesc(const char *_name, FuncPtr _funcPtr, int _flags = 0)
97        : name(_name), funcPtr(_funcPtr), flags(_flags)
98    {
99    }
100
101    /// Emulate the syscall.  Public interface for calling through funcPtr.
102    void doSyscall(int callnum, LiveProcess *proc, ThreadContext *tc);
103};
104
105
106class BaseBufferArg {
107
108  public:
109
110    BaseBufferArg(Addr _addr, int _size) : addr(_addr), size(_size)
111    {
112        bufPtr = new uint8_t[size];
113        // clear out buffer: in case we only partially populate this,
114        // and then do a copyOut(), we want to make sure we don't
115        // introduce any random junk into the simulated address space
116        memset(bufPtr, 0, size);
117    }
118
119    virtual ~BaseBufferArg() { delete [] bufPtr; }
120
121    //
122    // copy data into simulator space (read from target memory)
123    //
124    virtual bool copyIn(SETranslatingPortProxy &memproxy)
125    {
126        memproxy.readBlob(addr, bufPtr, size);
127        return true;    // no EFAULT detection for now
128    }
129
130    //
131    // copy data out of simulator space (write to target memory)
132    //
133    virtual bool copyOut(SETranslatingPortProxy &memproxy)
134    {
135        memproxy.writeBlob(addr, bufPtr, size);
136        return true;    // no EFAULT detection for now
137    }
138
139  protected:
140    Addr addr;
141    int size;
142    uint8_t *bufPtr;
143};
144
145
146class BufferArg : public BaseBufferArg
147{
148  public:
149    BufferArg(Addr _addr, int _size) : BaseBufferArg(_addr, _size) { }
150    void *bufferPtr()   { return bufPtr; }
151};
152
153template <class T>
154class TypedBufferArg : public BaseBufferArg
155{
156  public:
157    // user can optionally specify a specific number of bytes to
158    // allocate to deal with those structs that have variable-size
159    // arrays at the end
160    TypedBufferArg(Addr _addr, int _size = sizeof(T))
161        : BaseBufferArg(_addr, _size)
162    { }
163
164    // type case
165    operator T*() { return (T *)bufPtr; }
166
167    // dereference operators
168    T &operator*()       { return *((T *)bufPtr); }
169    T* operator->()      { return (T *)bufPtr; }
170    T &operator[](int i) { return ((T *)bufPtr)[i]; }
171};
172
173//////////////////////////////////////////////////////////////////////
174//
175// The following emulation functions are generic enough that they
176// don't need to be recompiled for different emulated OS's.  They are
177// defined in sim/syscall_emul.cc.
178//
179//////////////////////////////////////////////////////////////////////
180
181
182/// Handler for unimplemented syscalls that we haven't thought about.
183SyscallReturn unimplementedFunc(SyscallDesc *desc, int num,
184                                LiveProcess *p, ThreadContext *tc);
185
186/// Handler for unimplemented syscalls that we never intend to
187/// implement (signal handling, etc.) and should not affect the correct
188/// behavior of the program.  Print a warning only if the appropriate
189/// trace flag is enabled.  Return success to the target program.
190SyscallReturn ignoreFunc(SyscallDesc *desc, int num,
191                         LiveProcess *p, ThreadContext *tc);
192SyscallReturn ignoreWarnOnceFunc(SyscallDesc *desc, int num,
193                         LiveProcess *p, ThreadContext *tc);
194
195/// Target exit() handler: terminate current context.
196SyscallReturn exitFunc(SyscallDesc *desc, int num,
197                       LiveProcess *p, ThreadContext *tc);
198
199/// Target exit_group() handler: terminate simulation. (exit all threads)
200SyscallReturn exitGroupFunc(SyscallDesc *desc, int num,
201                       LiveProcess *p, ThreadContext *tc);
202
203/// Target getpagesize() handler.
204SyscallReturn getpagesizeFunc(SyscallDesc *desc, int num,
205                              LiveProcess *p, ThreadContext *tc);
206
207/// Target brk() handler: set brk address.
208SyscallReturn brkFunc(SyscallDesc *desc, int num,
209                      LiveProcess *p, ThreadContext *tc);
210
211/// Target close() handler.
212SyscallReturn closeFunc(SyscallDesc *desc, int num,
213                        LiveProcess *p, ThreadContext *tc);
214
215/// Target read() handler.
216SyscallReturn readFunc(SyscallDesc *desc, int num,
217                       LiveProcess *p, ThreadContext *tc);
218
219/// Target write() handler.
220SyscallReturn writeFunc(SyscallDesc *desc, int num,
221                        LiveProcess *p, ThreadContext *tc);
222
223/// Target lseek() handler.
224SyscallReturn lseekFunc(SyscallDesc *desc, int num,
225                        LiveProcess *p, ThreadContext *tc);
226
227/// Target _llseek() handler.
228SyscallReturn _llseekFunc(SyscallDesc *desc, int num,
229                        LiveProcess *p, ThreadContext *tc);
230
231/// Target munmap() handler.
232SyscallReturn munmapFunc(SyscallDesc *desc, int num,
233                         LiveProcess *p, ThreadContext *tc);
234
235/// Target gethostname() handler.
236SyscallReturn gethostnameFunc(SyscallDesc *desc, int num,
237                              LiveProcess *p, ThreadContext *tc);
238
239/// Target getcwd() handler.
240SyscallReturn getcwdFunc(SyscallDesc *desc, int num,
241                         LiveProcess *p, ThreadContext *tc);
242
243/// Target unlink() handler.
244SyscallReturn readlinkFunc(SyscallDesc *desc, int num,
245                           LiveProcess *p, ThreadContext *tc);
246
247/// Target unlink() handler.
248SyscallReturn unlinkFunc(SyscallDesc *desc, int num,
249                         LiveProcess *p, ThreadContext *tc);
250
251/// Target mkdir() handler.
252SyscallReturn mkdirFunc(SyscallDesc *desc, int num,
253                        LiveProcess *p, ThreadContext *tc);
254
255/// Target rename() handler.
256SyscallReturn renameFunc(SyscallDesc *desc, int num,
257                         LiveProcess *p, ThreadContext *tc);
258
259
260/// Target truncate() handler.
261SyscallReturn truncateFunc(SyscallDesc *desc, int num,
262                           LiveProcess *p, ThreadContext *tc);
263
264
265/// Target ftruncate() handler.
266SyscallReturn ftruncateFunc(SyscallDesc *desc, int num,
267                            LiveProcess *p, ThreadContext *tc);
268
269
270/// Target truncate64() handler.
271SyscallReturn truncate64Func(SyscallDesc *desc, int num,
272                             LiveProcess *p, ThreadContext *tc);
273
274/// Target ftruncate64() handler.
275SyscallReturn ftruncate64Func(SyscallDesc *desc, int num,
276                              LiveProcess *p, ThreadContext *tc);
277
278
279/// Target umask() handler.
280SyscallReturn umaskFunc(SyscallDesc *desc, int num,
281                        LiveProcess *p, ThreadContext *tc);
282
283
284/// Target chown() handler.
285SyscallReturn chownFunc(SyscallDesc *desc, int num,
286                        LiveProcess *p, ThreadContext *tc);
287
288
289/// Target fchown() handler.
290SyscallReturn fchownFunc(SyscallDesc *desc, int num,
291                         LiveProcess *p, ThreadContext *tc);
292
293/// Target dup() handler.
294SyscallReturn dupFunc(SyscallDesc *desc, int num,
295                      LiveProcess *process, ThreadContext *tc);
296
297/// Target fnctl() handler.
298SyscallReturn fcntlFunc(SyscallDesc *desc, int num,
299                        LiveProcess *process, ThreadContext *tc);
300
301/// Target fcntl64() handler.
302SyscallReturn fcntl64Func(SyscallDesc *desc, int num,
303                        LiveProcess *process, ThreadContext *tc);
304
305/// Target setuid() handler.
306SyscallReturn setuidFunc(SyscallDesc *desc, int num,
307                               LiveProcess *p, ThreadContext *tc);
308
309/// Target getpid() handler.
310SyscallReturn getpidFunc(SyscallDesc *desc, int num,
311                               LiveProcess *p, ThreadContext *tc);
312
313/// Target getuid() handler.
314SyscallReturn getuidFunc(SyscallDesc *desc, int num,
315                               LiveProcess *p, ThreadContext *tc);
316
317/// Target getgid() handler.
318SyscallReturn getgidFunc(SyscallDesc *desc, int num,
319                               LiveProcess *p, ThreadContext *tc);
320
321/// Target getppid() handler.
322SyscallReturn getppidFunc(SyscallDesc *desc, int num,
323                               LiveProcess *p, ThreadContext *tc);
324
325/// Target geteuid() handler.
326SyscallReturn geteuidFunc(SyscallDesc *desc, int num,
327                               LiveProcess *p, ThreadContext *tc);
328
329/// Target getegid() handler.
330SyscallReturn getegidFunc(SyscallDesc *desc, int num,
331                               LiveProcess *p, ThreadContext *tc);
332
333/// Target clone() handler.
334SyscallReturn cloneFunc(SyscallDesc *desc, int num,
335                               LiveProcess *p, ThreadContext *tc);
336
337
338/// Pseudo Funcs  - These functions use a different return convension,
339/// returning a second value in a register other than the normal return register
340SyscallReturn pipePseudoFunc(SyscallDesc *desc, int num,
341                             LiveProcess *process, ThreadContext *tc);
342
343/// Target getpidPseudo() handler.
344SyscallReturn getpidPseudoFunc(SyscallDesc *desc, int num,
345                               LiveProcess *p, ThreadContext *tc);
346
347/// Target getuidPseudo() handler.
348SyscallReturn getuidPseudoFunc(SyscallDesc *desc, int num,
349                               LiveProcess *p, ThreadContext *tc);
350
351/// Target getgidPseudo() handler.
352SyscallReturn getgidPseudoFunc(SyscallDesc *desc, int num,
353                               LiveProcess *p, ThreadContext *tc);
354
355
356/// A readable name for 1,000,000, for converting microseconds to seconds.
357const int one_million = 1000000;
358
359/// Approximate seconds since the epoch (1/1/1970).  About a billion,
360/// by my reckoning.  We want to keep this a constant (not use the
361/// real-world time) to keep simulations repeatable.
362const unsigned seconds_since_epoch = 1000000000;
363
364/// Helper function to convert current elapsed time to seconds and
365/// microseconds.
366template <class T1, class T2>
367void
368getElapsedTime(T1 &sec, T2 &usec)
369{
370    int elapsed_usecs = curTick() / SimClock::Int::us;
371    sec = elapsed_usecs / one_million;
372    usec = elapsed_usecs % one_million;
373}
374
375//////////////////////////////////////////////////////////////////////
376//
377// The following emulation functions are generic, but need to be
378// templated to account for differences in types, constants, etc.
379//
380//////////////////////////////////////////////////////////////////////
381
382#if NO_STAT64
383    typedef struct stat hst_stat;
384    typedef struct stat hst_stat64;
385#else
386    typedef struct stat hst_stat;
387    typedef struct stat64 hst_stat64;
388#endif
389
390//// Helper function to convert a host stat buffer to a target stat
391//// buffer.  Also copies the target buffer out to the simulated
392//// memory space.  Used by stat(), fstat(), and lstat().
393
394template <typename target_stat, typename host_stat>
395static void
396convertStatBuf(target_stat &tgt, host_stat *host, bool fakeTTY = false)
397{
398    using namespace TheISA;
399
400    if (fakeTTY)
401        tgt->st_dev = 0xA;
402    else
403        tgt->st_dev = host->st_dev;
404    tgt->st_dev = TheISA::htog(tgt->st_dev);
405    tgt->st_ino = host->st_ino;
406    tgt->st_ino = TheISA::htog(tgt->st_ino);
407    tgt->st_mode = host->st_mode;
408    if (fakeTTY) {
409        // Claim to be a character device
410        tgt->st_mode &= ~S_IFMT;    // Clear S_IFMT
411        tgt->st_mode |= S_IFCHR;    // Set S_IFCHR
412    }
413    tgt->st_mode = TheISA::htog(tgt->st_mode);
414    tgt->st_nlink = host->st_nlink;
415    tgt->st_nlink = TheISA::htog(tgt->st_nlink);
416    tgt->st_uid = host->st_uid;
417    tgt->st_uid = TheISA::htog(tgt->st_uid);
418    tgt->st_gid = host->st_gid;
419    tgt->st_gid = TheISA::htog(tgt->st_gid);
420    if (fakeTTY)
421        tgt->st_rdev = 0x880d;
422    else
423        tgt->st_rdev = host->st_rdev;
424    tgt->st_rdev = TheISA::htog(tgt->st_rdev);
425    tgt->st_size = host->st_size;
426    tgt->st_size = TheISA::htog(tgt->st_size);
427    tgt->st_atimeX = host->st_atime;
428    tgt->st_atimeX = TheISA::htog(tgt->st_atimeX);
429    tgt->st_mtimeX = host->st_mtime;
430    tgt->st_mtimeX = TheISA::htog(tgt->st_mtimeX);
431    tgt->st_ctimeX = host->st_ctime;
432    tgt->st_ctimeX = TheISA::htog(tgt->st_ctimeX);
433    // Force the block size to be 8k. This helps to ensure buffered io works
434    // consistently across different hosts.
435    tgt->st_blksize = 0x2000;
436    tgt->st_blksize = TheISA::htog(tgt->st_blksize);
437    tgt->st_blocks = host->st_blocks;
438    tgt->st_blocks = TheISA::htog(tgt->st_blocks);
439}
440
441// Same for stat64
442
443template <typename target_stat, typename host_stat64>
444static void
445convertStat64Buf(target_stat &tgt, host_stat64 *host, bool fakeTTY = false)
446{
447    using namespace TheISA;
448
449    convertStatBuf<target_stat, host_stat64>(tgt, host, fakeTTY);
450#if defined(STAT_HAVE_NSEC)
451    tgt->st_atime_nsec = host->st_atime_nsec;
452    tgt->st_atime_nsec = TheISA::htog(tgt->st_atime_nsec);
453    tgt->st_mtime_nsec = host->st_mtime_nsec;
454    tgt->st_mtime_nsec = TheISA::htog(tgt->st_mtime_nsec);
455    tgt->st_ctime_nsec = host->st_ctime_nsec;
456    tgt->st_ctime_nsec = TheISA::htog(tgt->st_ctime_nsec);
457#else
458    tgt->st_atime_nsec = 0;
459    tgt->st_mtime_nsec = 0;
460    tgt->st_ctime_nsec = 0;
461#endif
462}
463
464//Here are a couple convenience functions
465template<class OS>
466static void
467copyOutStatBuf(SETranslatingPortProxy &mem, Addr addr,
468        hst_stat *host, bool fakeTTY = false)
469{
470    typedef TypedBufferArg<typename OS::tgt_stat> tgt_stat_buf;
471    tgt_stat_buf tgt(addr);
472    convertStatBuf<tgt_stat_buf, hst_stat>(tgt, host, fakeTTY);
473    tgt.copyOut(mem);
474}
475
476template<class OS>
477static void
478copyOutStat64Buf(SETranslatingPortProxy &mem, Addr addr,
479        hst_stat64 *host, bool fakeTTY = false)
480{
481    typedef TypedBufferArg<typename OS::tgt_stat64> tgt_stat_buf;
482    tgt_stat_buf tgt(addr);
483    convertStat64Buf<tgt_stat_buf, hst_stat64>(tgt, host, fakeTTY);
484    tgt.copyOut(mem);
485}
486
487/// Target ioctl() handler.  For the most part, programs call ioctl()
488/// only to find out if their stdout is a tty, to determine whether to
489/// do line or block buffering.
490template <class OS>
491SyscallReturn
492ioctlFunc(SyscallDesc *desc, int callnum, LiveProcess *process,
493          ThreadContext *tc)
494{
495    int index = 0;
496    int fd = process->getSyscallArg(tc, index);
497    unsigned req = process->getSyscallArg(tc, index);
498
499    DPRINTF(SyscallVerbose, "ioctl(%d, 0x%x, ...)\n", fd, req);
500
501    if (fd < 0 || process->sim_fd(fd) < 0) {
502        // doesn't map to any simulator fd: not a valid target fd
503        return -EBADF;
504    }
505
506    switch (req) {
507      case OS::TIOCISATTY_:
508      case OS::TIOCGETP_:
509      case OS::TIOCSETP_:
510      case OS::TIOCSETN_:
511      case OS::TIOCSETC_:
512      case OS::TIOCGETC_:
513      case OS::TIOCGETS_:
514      case OS::TIOCGETA_:
515      case OS::TCSETAW_:
516        return -ENOTTY;
517
518      default:
519        fatal("Unsupported ioctl call: ioctl(%d, 0x%x, ...) @ \n",
520              fd, req, tc->pcState());
521    }
522}
523
524/// Target open() handler.
525template <class OS>
526SyscallReturn
527openFunc(SyscallDesc *desc, int callnum, LiveProcess *process,
528         ThreadContext *tc)
529{
530    std::string path;
531
532    int index = 0;
533    if (!tc->getMemProxy().tryReadString(path,
534                process->getSyscallArg(tc, index)))
535        return -EFAULT;
536
537    if (path == "/dev/sysdev0") {
538        // This is a memory-mapped high-resolution timer device on Alpha.
539        // We don't support it, so just punt.
540        warn("Ignoring open(%s, ...)\n", path);
541        return -ENOENT;
542    }
543
544    int tgtFlags = process->getSyscallArg(tc, index);
545    int mode = process->getSyscallArg(tc, index);
546    int hostFlags = 0;
547
548    // translate open flags
549    for (int i = 0; i < OS::NUM_OPEN_FLAGS; i++) {
550        if (tgtFlags & OS::openFlagTable[i].tgtFlag) {
551            tgtFlags &= ~OS::openFlagTable[i].tgtFlag;
552            hostFlags |= OS::openFlagTable[i].hostFlag;
553        }
554    }
555
556    // any target flags left?
557    if (tgtFlags != 0)
558        warn("Syscall: open: cannot decode flags 0x%x", tgtFlags);
559
560#ifdef __CYGWIN32__
561    hostFlags |= O_BINARY;
562#endif
563
564    // Adjust path for current working directory
565    path = process->fullPath(path);
566
567    DPRINTF(SyscallVerbose, "opening file %s\n", path.c_str());
568
569    int fd;
570    if (!path.compare(0, 6, "/proc/") || !path.compare(0, 8, "/system/") ||
571        !path.compare(0, 10, "/platform/") || !path.compare(0, 5, "/sys/")) {
572        // It's a proc/sys entery and requires special handling
573        fd = OS::openSpecialFile(path, process, tc);
574        return (fd == -1) ? -1 : process->alloc_fd(fd,path.c_str(),hostFlags,mode, false);
575     } else {
576        // open the file
577        fd = open(path.c_str(), hostFlags, mode);
578        return (fd == -1) ? -errno : process->alloc_fd(fd,path.c_str(),hostFlags,mode, false);
579     }
580
581}
582
583/// Target sysinfo() handler.
584template <class OS>
585SyscallReturn
586sysinfoFunc(SyscallDesc *desc, int callnum, LiveProcess *process,
587         ThreadContext *tc)
588{
589
590    int index = 0;
591    TypedBufferArg<typename OS::tgt_sysinfo>
592        sysinfo(process->getSyscallArg(tc, index));
593
594    sysinfo->uptime=seconds_since_epoch;
595    sysinfo->totalram=process->system->memSize();
596
597    sysinfo.copyOut(tc->getMemProxy());
598
599    return 0;
600}
601
602/// Target chmod() handler.
603template <class OS>
604SyscallReturn
605chmodFunc(SyscallDesc *desc, int callnum, LiveProcess *process,
606          ThreadContext *tc)
607{
608    std::string path;
609
610    int index = 0;
611    if (!tc->getMemProxy().tryReadString(path,
612                process->getSyscallArg(tc, index))) {
613        return -EFAULT;
614    }
615
616    uint32_t mode = process->getSyscallArg(tc, index);
617    mode_t hostMode = 0;
618
619    // XXX translate mode flags via OS::something???
620    hostMode = mode;
621
622    // Adjust path for current working directory
623    path = process->fullPath(path);
624
625    // do the chmod
626    int result = chmod(path.c_str(), hostMode);
627    if (result < 0)
628        return -errno;
629
630    return 0;
631}
632
633
634/// Target fchmod() handler.
635template <class OS>
636SyscallReturn
637fchmodFunc(SyscallDesc *desc, int callnum, LiveProcess *process,
638           ThreadContext *tc)
639{
640    int index = 0;
641    int fd = process->getSyscallArg(tc, index);
642    if (fd < 0 || process->sim_fd(fd) < 0) {
643        // doesn't map to any simulator fd: not a valid target fd
644        return -EBADF;
645    }
646
647    uint32_t mode = process->getSyscallArg(tc, index);
648    mode_t hostMode = 0;
649
650    // XXX translate mode flags via OS::someting???
651    hostMode = mode;
652
653    // do the fchmod
654    int result = fchmod(process->sim_fd(fd), hostMode);
655    if (result < 0)
656        return -errno;
657
658    return 0;
659}
660
661/// Target mremap() handler.
662template <class OS>
663SyscallReturn
664mremapFunc(SyscallDesc *desc, int callnum, LiveProcess *process, ThreadContext *tc)
665{
666    int index = 0;
667    Addr start = process->getSyscallArg(tc, index);
668    uint64_t old_length = process->getSyscallArg(tc, index);
669    uint64_t new_length = process->getSyscallArg(tc, index);
670    uint64_t flags = process->getSyscallArg(tc, index);
671
672    if ((start % TheISA::VMPageSize != 0) ||
673            (new_length % TheISA::VMPageSize != 0)) {
674        warn("mremap failing: arguments not page aligned");
675        return -EINVAL;
676    }
677
678    if (new_length > old_length) {
679        if ((start + old_length) == process->mmap_end) {
680            uint64_t diff = new_length - old_length;
681            process->allocateMem(process->mmap_end, diff);
682            process->mmap_end += diff;
683            return start;
684        } else {
685            // sys/mman.h defined MREMAP_MAYMOVE
686            if (!(flags & 1)) {
687                warn("can't remap here and MREMAP_MAYMOVE flag not set\n");
688                return -ENOMEM;
689            } else {
690                process->pTable->remap(start, old_length, process->mmap_end);
691                warn("mremapping to totally new vaddr %08p-%08p, adding %d\n",
692                        process->mmap_end, process->mmap_end + new_length, new_length);
693                start = process->mmap_end;
694                // add on the remaining unallocated pages
695                process->allocateMem(start + old_length,
696                                     new_length - old_length);
697                process->mmap_end += new_length;
698                warn("returning %08p as start\n", start);
699                return start;
700            }
701        }
702    } else {
703        process->pTable->unmap(start + new_length, old_length - new_length);
704        return start;
705    }
706}
707
708/// Target stat() handler.
709template <class OS>
710SyscallReturn
711statFunc(SyscallDesc *desc, int callnum, LiveProcess *process,
712         ThreadContext *tc)
713{
714    std::string path;
715
716    int index = 0;
717    if (!tc->getMemProxy().tryReadString(path,
718                process->getSyscallArg(tc, index))) {
719        return -EFAULT;
720    }
721    Addr bufPtr = process->getSyscallArg(tc, index);
722
723    // Adjust path for current working directory
724    path = process->fullPath(path);
725
726    struct stat hostBuf;
727    int result = stat(path.c_str(), &hostBuf);
728
729    if (result < 0)
730        return -errno;
731
732    copyOutStatBuf<OS>(tc->getMemProxy(), bufPtr, &hostBuf);
733
734    return 0;
735}
736
737
738/// Target stat64() handler.
739template <class OS>
740SyscallReturn
741stat64Func(SyscallDesc *desc, int callnum, LiveProcess *process,
742           ThreadContext *tc)
743{
744    std::string path;
745
746    int index = 0;
747    if (!tc->getMemProxy().tryReadString(path,
748                process->getSyscallArg(tc, index)))
749        return -EFAULT;
750    Addr bufPtr = process->getSyscallArg(tc, index);
751
752    // Adjust path for current working directory
753    path = process->fullPath(path);
754
755#if NO_STAT64
756    struct stat  hostBuf;
757    int result = stat(path.c_str(), &hostBuf);
758#else
759    struct stat64 hostBuf;
760    int result = stat64(path.c_str(), &hostBuf);
761#endif
762
763    if (result < 0)
764        return -errno;
765
766    copyOutStat64Buf<OS>(tc->getMemProxy(), bufPtr, &hostBuf);
767
768    return 0;
769}
770
771
772/// Target fstat64() handler.
773template <class OS>
774SyscallReturn
775fstat64Func(SyscallDesc *desc, int callnum, LiveProcess *process,
776            ThreadContext *tc)
777{
778    int index = 0;
779    int fd = process->getSyscallArg(tc, index);
780    Addr bufPtr = process->getSyscallArg(tc, index);
781    if (fd < 0 || process->sim_fd(fd) < 0) {
782        // doesn't map to any simulator fd: not a valid target fd
783        return -EBADF;
784    }
785
786#if NO_STAT64
787    struct stat  hostBuf;
788    int result = fstat(process->sim_fd(fd), &hostBuf);
789#else
790    struct stat64  hostBuf;
791    int result = fstat64(process->sim_fd(fd), &hostBuf);
792#endif
793
794    if (result < 0)
795        return -errno;
796
797    copyOutStat64Buf<OS>(tc->getMemProxy(), bufPtr, &hostBuf, (fd == 1));
798
799    return 0;
800}
801
802
803/// Target lstat() handler.
804template <class OS>
805SyscallReturn
806lstatFunc(SyscallDesc *desc, int callnum, LiveProcess *process,
807          ThreadContext *tc)
808{
809    std::string path;
810
811    int index = 0;
812    if (!tc->getMemProxy().tryReadString(path,
813                process->getSyscallArg(tc, index))) {
814        return -EFAULT;
815    }
816    Addr bufPtr = process->getSyscallArg(tc, index);
817
818    // Adjust path for current working directory
819    path = process->fullPath(path);
820
821    struct stat hostBuf;
822    int result = lstat(path.c_str(), &hostBuf);
823
824    if (result < 0)
825        return -errno;
826
827    copyOutStatBuf<OS>(tc->getMemProxy(), bufPtr, &hostBuf);
828
829    return 0;
830}
831
832/// Target lstat64() handler.
833template <class OS>
834SyscallReturn
835lstat64Func(SyscallDesc *desc, int callnum, LiveProcess *process,
836            ThreadContext *tc)
837{
838    std::string path;
839
840    int index = 0;
841    if (!tc->getMemProxy().tryReadString(path,
842                process->getSyscallArg(tc, index))) {
843        return -EFAULT;
844    }
845    Addr bufPtr = process->getSyscallArg(tc, index);
846
847    // Adjust path for current working directory
848    path = process->fullPath(path);
849
850#if NO_STAT64
851    struct stat hostBuf;
852    int result = lstat(path.c_str(), &hostBuf);
853#else
854    struct stat64 hostBuf;
855    int result = lstat64(path.c_str(), &hostBuf);
856#endif
857
858    if (result < 0)
859        return -errno;
860
861    copyOutStat64Buf<OS>(tc->getMemProxy(), bufPtr, &hostBuf);
862
863    return 0;
864}
865
866/// Target fstat() handler.
867template <class OS>
868SyscallReturn
869fstatFunc(SyscallDesc *desc, int callnum, LiveProcess *process,
870          ThreadContext *tc)
871{
872    int index = 0;
873    int fd = process->sim_fd(process->getSyscallArg(tc, index));
874    Addr bufPtr = process->getSyscallArg(tc, index);
875
876    DPRINTF(SyscallVerbose, "fstat(%d, ...)\n", fd);
877
878    if (fd < 0)
879        return -EBADF;
880
881    struct stat hostBuf;
882    int result = fstat(fd, &hostBuf);
883
884    if (result < 0)
885        return -errno;
886
887    copyOutStatBuf<OS>(tc->getMemProxy(), bufPtr, &hostBuf, (fd == 1));
888
889    return 0;
890}
891
892
893/// Target statfs() handler.
894template <class OS>
895SyscallReturn
896statfsFunc(SyscallDesc *desc, int callnum, LiveProcess *process,
897           ThreadContext *tc)
898{
899    std::string path;
900
901    int index = 0;
902    if (!tc->getMemProxy().tryReadString(path,
903                process->getSyscallArg(tc, index))) {
904        return -EFAULT;
905    }
906    Addr bufPtr = process->getSyscallArg(tc, index);
907
908    // Adjust path for current working directory
909    path = process->fullPath(path);
910
911    struct statfs hostBuf;
912    int result = statfs(path.c_str(), &hostBuf);
913
914    if (result < 0)
915        return -errno;
916
917    OS::copyOutStatfsBuf(tc->getMemProxy(), bufPtr, &hostBuf);
918
919    return 0;
920}
921
922
923/// Target fstatfs() handler.
924template <class OS>
925SyscallReturn
926fstatfsFunc(SyscallDesc *desc, int callnum, LiveProcess *process,
927            ThreadContext *tc)
928{
929    int index = 0;
930    int fd = process->sim_fd(process->getSyscallArg(tc, index));
931    Addr bufPtr = process->getSyscallArg(tc, index);
932
933    if (fd < 0)
934        return -EBADF;
935
936    struct statfs hostBuf;
937    int result = fstatfs(fd, &hostBuf);
938
939    if (result < 0)
940        return -errno;
941
942    OS::copyOutStatfsBuf(tc->getMemProxy(), bufPtr, &hostBuf);
943
944    return 0;
945}
946
947
948/// Target writev() handler.
949template <class OS>
950SyscallReturn
951writevFunc(SyscallDesc *desc, int callnum, LiveProcess *process,
952           ThreadContext *tc)
953{
954    int index = 0;
955    int fd = process->getSyscallArg(tc, index);
956    if (fd < 0 || process->sim_fd(fd) < 0) {
957        // doesn't map to any simulator fd: not a valid target fd
958        return -EBADF;
959    }
960
961    SETranslatingPortProxy &p = tc->getMemProxy();
962    uint64_t tiov_base = process->getSyscallArg(tc, index);
963    size_t count = process->getSyscallArg(tc, index);
964    struct iovec hiov[count];
965    for (size_t i = 0; i < count; ++i) {
966        typename OS::tgt_iovec tiov;
967
968        p.readBlob(tiov_base + i*sizeof(typename OS::tgt_iovec),
969                   (uint8_t*)&tiov, sizeof(typename OS::tgt_iovec));
970        hiov[i].iov_len = TheISA::gtoh(tiov.iov_len);
971        hiov[i].iov_base = new char [hiov[i].iov_len];
972        p.readBlob(TheISA::gtoh(tiov.iov_base), (uint8_t *)hiov[i].iov_base,
973                   hiov[i].iov_len);
974    }
975
976    int result = writev(process->sim_fd(fd), hiov, count);
977
978    for (size_t i = 0; i < count; ++i)
979        delete [] (char *)hiov[i].iov_base;
980
981    if (result < 0)
982        return -errno;
983
984    return 0;
985}
986
987
988/// Target mmap() handler.
989///
990/// We don't really handle mmap().  If the target is mmaping an
991/// anonymous region or /dev/zero, we can get away with doing basically
992/// nothing (since memory is initialized to zero and the simulator
993/// doesn't really check addresses anyway).
994///
995template <class OS>
996SyscallReturn
997mmapFunc(SyscallDesc *desc, int num, LiveProcess *p, ThreadContext *tc)
998{
999    int index = 0;
1000    Addr start = p->getSyscallArg(tc, index);
1001    uint64_t length = p->getSyscallArg(tc, index);
1002    index++; // int prot = p->getSyscallArg(tc, index);
1003    int flags = p->getSyscallArg(tc, index);
1004    int tgt_fd = p->getSyscallArg(tc, index);
1005    // int offset = p->getSyscallArg(tc, index);
1006
1007    if (!(flags & OS::TGT_MAP_ANONYMOUS)) {
1008        Process::FdMap *fd_map = p->sim_fd_obj(tgt_fd);
1009        if (!fd_map || fd_map->fd < 0) {
1010            warn("mmap failing: target fd %d is not valid\n", tgt_fd);
1011            return -EBADF;
1012        }
1013
1014        if (fd_map->filename != "/dev/zero") {
1015            // This is very likely broken, but leave a warning here
1016            // (rather than panic) in case /dev/zero is known by
1017            // another name on some platform
1018            warn("allowing mmap of file %s; mmap not supported on files"
1019                 " other than /dev/zero\n", fd_map->filename);
1020        }
1021    }
1022
1023    if ((start  % TheISA::VMPageSize) != 0 ||
1024        (length % TheISA::VMPageSize) != 0) {
1025        warn("mmap failing: arguments not page-aligned: "
1026             "start 0x%x length 0x%x",
1027             start, length);
1028        return -EINVAL;
1029    }
1030
1031    // are we ok with clobbering existing mappings?  only set this to
1032    // true if the user has been warned.
1033    bool clobber = false;
1034
1035    // try to use the caller-provided address if there is one
1036    bool use_provided_address = (start != 0);
1037
1038    if (use_provided_address) {
1039        // check to see if the desired address is already in use
1040        if (!p->pTable->isUnmapped(start, length)) {
1041            // there are existing mappings in the desired range
1042            // whether we clobber them or not depends on whether the caller
1043            // specified MAP_FIXED
1044            if (flags & OS::TGT_MAP_FIXED) {
1045                // MAP_FIXED specified: clobber existing mappings
1046                warn("mmap: MAP_FIXED at 0x%x overwrites existing mappings\n",
1047                     start);
1048                clobber = true;
1049            } else {
1050                // MAP_FIXED not specified: ignore suggested start address
1051                warn("mmap: ignoring suggested map address 0x%x\n", start);
1052                use_provided_address = false;
1053            }
1054        }
1055    }
1056
1057    if (!use_provided_address) {
1058        // no address provided, or provided address unusable:
1059        // pick next address from our "mmap region"
1060        if (OS::mmapGrowsDown()) {
1061            start = p->mmap_end - length;
1062            p->mmap_end = start;
1063        } else {
1064            start = p->mmap_end;
1065            p->mmap_end += length;
1066        }
1067    }
1068
1069    p->allocateMem(start, length, clobber);
1070
1071    return start;
1072}
1073
1074/// Target getrlimit() handler.
1075template <class OS>
1076SyscallReturn
1077getrlimitFunc(SyscallDesc *desc, int callnum, LiveProcess *process,
1078        ThreadContext *tc)
1079{
1080    int index = 0;
1081    unsigned resource = process->getSyscallArg(tc, index);
1082    TypedBufferArg<typename OS::rlimit> rlp(process->getSyscallArg(tc, index));
1083
1084    switch (resource) {
1085        case OS::TGT_RLIMIT_STACK:
1086            // max stack size in bytes: make up a number (8MB for now)
1087            rlp->rlim_cur = rlp->rlim_max = 8 * 1024 * 1024;
1088            rlp->rlim_cur = TheISA::htog(rlp->rlim_cur);
1089            rlp->rlim_max = TheISA::htog(rlp->rlim_max);
1090            break;
1091
1092        case OS::TGT_RLIMIT_DATA:
1093            // max data segment size in bytes: make up a number
1094            rlp->rlim_cur = rlp->rlim_max = 256 * 1024 * 1024;
1095            rlp->rlim_cur = TheISA::htog(rlp->rlim_cur);
1096            rlp->rlim_max = TheISA::htog(rlp->rlim_max);
1097            break;
1098
1099        default:
1100            std::cerr << "getrlimitFunc: unimplemented resource " << resource
1101                << std::endl;
1102            abort();
1103            break;
1104    }
1105
1106    rlp.copyOut(tc->getMemProxy());
1107    return 0;
1108}
1109
1110/// Target gettimeofday() handler.
1111template <class OS>
1112SyscallReturn
1113gettimeofdayFunc(SyscallDesc *desc, int callnum, LiveProcess *process,
1114        ThreadContext *tc)
1115{
1116    int index = 0;
1117    TypedBufferArg<typename OS::timeval> tp(process->getSyscallArg(tc, index));
1118
1119    getElapsedTime(tp->tv_sec, tp->tv_usec);
1120    tp->tv_sec += seconds_since_epoch;
1121    tp->tv_sec = TheISA::htog(tp->tv_sec);
1122    tp->tv_usec = TheISA::htog(tp->tv_usec);
1123
1124    tp.copyOut(tc->getMemProxy());
1125
1126    return 0;
1127}
1128
1129
1130/// Target utimes() handler.
1131template <class OS>
1132SyscallReturn
1133utimesFunc(SyscallDesc *desc, int callnum, LiveProcess *process,
1134           ThreadContext *tc)
1135{
1136    std::string path;
1137
1138    int index = 0;
1139    if (!tc->getMemProxy().tryReadString(path,
1140                process->getSyscallArg(tc, index))) {
1141        return -EFAULT;
1142    }
1143
1144    TypedBufferArg<typename OS::timeval [2]>
1145        tp(process->getSyscallArg(tc, index));
1146    tp.copyIn(tc->getMemProxy());
1147
1148    struct timeval hostTimeval[2];
1149    for (int i = 0; i < 2; ++i)
1150    {
1151        hostTimeval[i].tv_sec = TheISA::gtoh((*tp)[i].tv_sec);
1152        hostTimeval[i].tv_usec = TheISA::gtoh((*tp)[i].tv_usec);
1153    }
1154
1155    // Adjust path for current working directory
1156    path = process->fullPath(path);
1157
1158    int result = utimes(path.c_str(), hostTimeval);
1159
1160    if (result < 0)
1161        return -errno;
1162
1163    return 0;
1164}
1165/// Target getrusage() function.
1166template <class OS>
1167SyscallReturn
1168getrusageFunc(SyscallDesc *desc, int callnum, LiveProcess *process,
1169              ThreadContext *tc)
1170{
1171    int index = 0;
1172    int who = process->getSyscallArg(tc, index); // THREAD, SELF, or CHILDREN
1173    TypedBufferArg<typename OS::rusage> rup(process->getSyscallArg(tc, index));
1174
1175    rup->ru_utime.tv_sec = 0;
1176    rup->ru_utime.tv_usec = 0;
1177    rup->ru_stime.tv_sec = 0;
1178    rup->ru_stime.tv_usec = 0;
1179    rup->ru_maxrss = 0;
1180    rup->ru_ixrss = 0;
1181    rup->ru_idrss = 0;
1182    rup->ru_isrss = 0;
1183    rup->ru_minflt = 0;
1184    rup->ru_majflt = 0;
1185    rup->ru_nswap = 0;
1186    rup->ru_inblock = 0;
1187    rup->ru_oublock = 0;
1188    rup->ru_msgsnd = 0;
1189    rup->ru_msgrcv = 0;
1190    rup->ru_nsignals = 0;
1191    rup->ru_nvcsw = 0;
1192    rup->ru_nivcsw = 0;
1193
1194    switch (who) {
1195      case OS::TGT_RUSAGE_SELF:
1196        getElapsedTime(rup->ru_utime.tv_sec, rup->ru_utime.tv_usec);
1197        rup->ru_utime.tv_sec = TheISA::htog(rup->ru_utime.tv_sec);
1198        rup->ru_utime.tv_usec = TheISA::htog(rup->ru_utime.tv_usec);
1199        break;
1200
1201      case OS::TGT_RUSAGE_CHILDREN:
1202        // do nothing.  We have no child processes, so they take no time.
1203        break;
1204
1205      default:
1206        // don't really handle THREAD or CHILDREN, but just warn and
1207        // plow ahead
1208        warn("getrusage() only supports RUSAGE_SELF.  Parameter %d ignored.",
1209             who);
1210    }
1211
1212    rup.copyOut(tc->getMemProxy());
1213
1214    return 0;
1215}
1216
1217/// Target times() function.
1218template <class OS>
1219SyscallReturn
1220timesFunc(SyscallDesc *desc, int callnum, LiveProcess *process,
1221           ThreadContext *tc)
1222{
1223    int index = 0;
1224    TypedBufferArg<typename OS::tms> bufp(process->getSyscallArg(tc, index));
1225
1226    // Fill in the time structure (in clocks)
1227    int64_t clocks = curTick() * OS::M5_SC_CLK_TCK / SimClock::Int::s;
1228    bufp->tms_utime = clocks;
1229    bufp->tms_stime = 0;
1230    bufp->tms_cutime = 0;
1231    bufp->tms_cstime = 0;
1232
1233    // Convert to host endianness
1234    bufp->tms_utime = TheISA::htog(bufp->tms_utime);
1235
1236    // Write back
1237    bufp.copyOut(tc->getMemProxy());
1238
1239    // Return clock ticks since system boot
1240    return clocks;
1241}
1242
1243/// Target time() function.
1244template <class OS>
1245SyscallReturn
1246timeFunc(SyscallDesc *desc, int callnum, LiveProcess *process,
1247           ThreadContext *tc)
1248{
1249    typename OS::time_t sec, usec;
1250    getElapsedTime(sec, usec);
1251    sec += seconds_since_epoch;
1252
1253    int index = 0;
1254    Addr taddr = (Addr)process->getSyscallArg(tc, index);
1255    if(taddr != 0) {
1256        typename OS::time_t t = sec;
1257        t = TheISA::htog(t);
1258        SETranslatingPortProxy &p = tc->getMemProxy();
1259        p.writeBlob(taddr, (uint8_t*)&t, (int)sizeof(typename OS::time_t));
1260    }
1261    return sec;
1262}
1263
1264
1265#endif // __SIM_SYSCALL_EMUL_HH__
1266