syscall_emul.hh revision 3113:a6811aaea654
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#include <errno.h>
45#include <string>
46#ifdef __CYGWIN32__
47#include <sys/fcntl.h>	// for O_BINARY
48#endif
49#include <sys/stat.h>
50#include <fcntl.h>
51#include <sys/uio.h>
52
53#include "sim/host.hh"	// for Addr
54#include "base/chunk_generator.hh"
55#include "base/intmath.hh"	// for RoundUp
56#include "base/misc.hh"
57#include "base/trace.hh"
58#include "cpu/base.hh"
59#include "cpu/thread_context.hh"
60#include "mem/translating_port.hh"
61#include "mem/page_table.hh"
62#include "sim/process.hh"
63
64///
65/// System call descriptor.
66///
67class SyscallDesc {
68
69  public:
70
71    /// Typedef for target syscall handler functions.
72    typedef SyscallReturn (*FuncPtr)(SyscallDesc *, int num,
73                           Process *, ThreadContext *);
74
75    const char *name;	//!< Syscall name (e.g., "open").
76    FuncPtr funcPtr;	//!< Pointer to emulation function.
77    int flags;		//!< Flags (see Flags enum).
78
79    /// Flag values for controlling syscall behavior.
80    enum Flags {
81        /// Don't set return regs according to funcPtr return value.
82        /// Used for syscalls with non-standard return conventions
83        /// that explicitly set the ThreadContext regs (e.g.,
84        /// sigreturn).
85        SuppressReturnValue = 1
86    };
87
88    /// Constructor.
89    SyscallDesc(const char *_name, FuncPtr _funcPtr, int _flags = 0)
90        : name(_name), funcPtr(_funcPtr), flags(_flags)
91    {
92    }
93
94    /// Emulate the syscall.  Public interface for calling through funcPtr.
95    void doSyscall(int callnum, Process *proc, ThreadContext *tc);
96};
97
98
99class BaseBufferArg {
100
101  public:
102
103    BaseBufferArg(Addr _addr, int _size) : addr(_addr), size(_size)
104    {
105        bufPtr = new uint8_t[size];
106        // clear out buffer: in case we only partially populate this,
107        // and then do a copyOut(), we want to make sure we don't
108        // introduce any random junk into the simulated address space
109        memset(bufPtr, 0, size);
110    }
111
112    virtual ~BaseBufferArg() { delete [] bufPtr; }
113
114    //
115    // copy data into simulator space (read from target memory)
116    //
117    virtual bool copyIn(TranslatingPort *memport)
118    {
119        memport->readBlob(addr, bufPtr, size);
120        return true;	// no EFAULT detection for now
121    }
122
123    //
124    // copy data out of simulator space (write to target memory)
125    //
126    virtual bool copyOut(TranslatingPort *memport)
127    {
128        memport->writeBlob(addr, bufPtr, size);
129        return true;	// no EFAULT detection for now
130    }
131
132  protected:
133    Addr addr;
134    int size;
135    uint8_t *bufPtr;
136};
137
138
139class BufferArg : public BaseBufferArg
140{
141  public:
142    BufferArg(Addr _addr, int _size) : BaseBufferArg(_addr, _size) { }
143    void *bufferPtr()	{ return bufPtr; }
144};
145
146template <class T>
147class TypedBufferArg : public BaseBufferArg
148{
149  public:
150    // user can optionally specify a specific number of bytes to
151    // allocate to deal with those structs that have variable-size
152    // arrays at the end
153    TypedBufferArg(Addr _addr, int _size = sizeof(T))
154        : BaseBufferArg(_addr, _size)
155    { }
156
157    // type case
158    operator T*() { return (T *)bufPtr; }
159
160    // dereference operators
161    T &operator*()	 { return *((T *)bufPtr); }
162    T* operator->()	 { return (T *)bufPtr; }
163    T &operator[](int i) { return ((T *)bufPtr)[i]; }
164};
165
166//////////////////////////////////////////////////////////////////////
167//
168// The following emulation functions are generic enough that they
169// don't need to be recompiled for different emulated OS's.  They are
170// defined in sim/syscall_emul.cc.
171//
172//////////////////////////////////////////////////////////////////////
173
174
175/// Handler for unimplemented syscalls that we haven't thought about.
176SyscallReturn unimplementedFunc(SyscallDesc *desc, int num,
177                                Process *p, ThreadContext *tc);
178
179/// Handler for unimplemented syscalls that we never intend to
180/// implement (signal handling, etc.) and should not affect the correct
181/// behavior of the program.  Print a warning only if the appropriate
182/// trace flag is enabled.  Return success to the target program.
183SyscallReturn ignoreFunc(SyscallDesc *desc, int num,
184                         Process *p, ThreadContext *tc);
185
186/// Target exit() handler: terminate simulation.
187SyscallReturn exitFunc(SyscallDesc *desc, int num,
188                       Process *p, ThreadContext *tc);
189
190/// Target getpagesize() handler.
191SyscallReturn getpagesizeFunc(SyscallDesc *desc, int num,
192                              Process *p, ThreadContext *tc);
193
194/// Target obreak() handler: set brk address.
195SyscallReturn obreakFunc(SyscallDesc *desc, int num,
196                         Process *p, ThreadContext *tc);
197
198/// Target close() handler.
199SyscallReturn closeFunc(SyscallDesc *desc, int num,
200                        Process *p, ThreadContext *tc);
201
202/// Target read() handler.
203SyscallReturn readFunc(SyscallDesc *desc, int num,
204                       Process *p, ThreadContext *tc);
205
206/// Target write() handler.
207SyscallReturn writeFunc(SyscallDesc *desc, int num,
208                        Process *p, ThreadContext *tc);
209
210/// Target lseek() handler.
211SyscallReturn lseekFunc(SyscallDesc *desc, int num,
212                        Process *p, ThreadContext *tc);
213
214/// Target munmap() handler.
215SyscallReturn munmapFunc(SyscallDesc *desc, int num,
216                         Process *p, ThreadContext *tc);
217
218/// Target gethostname() handler.
219SyscallReturn gethostnameFunc(SyscallDesc *desc, int num,
220                              Process *p, ThreadContext *tc);
221
222/// Target unlink() handler.
223SyscallReturn unlinkFunc(SyscallDesc *desc, int num,
224                         Process *p, ThreadContext *tc);
225
226/// Target rename() handler.
227SyscallReturn renameFunc(SyscallDesc *desc, int num,
228                         Process *p, ThreadContext *tc);
229
230
231/// Target truncate() handler.
232SyscallReturn truncateFunc(SyscallDesc *desc, int num,
233                           Process *p, ThreadContext *tc);
234
235
236/// Target ftruncate() handler.
237SyscallReturn ftruncateFunc(SyscallDesc *desc, int num,
238                            Process *p, ThreadContext *tc);
239
240
241/// Target chown() handler.
242SyscallReturn chownFunc(SyscallDesc *desc, int num,
243                        Process *p, ThreadContext *tc);
244
245
246/// Target fchown() handler.
247SyscallReturn fchownFunc(SyscallDesc *desc, int num,
248                         Process *p, ThreadContext *tc);
249
250/// Target dup() handler.
251SyscallReturn dupFunc(SyscallDesc *desc, int num,
252                      Process *process, ThreadContext *tc);
253
254/// Target fnctl() handler.
255SyscallReturn fcntlFunc(SyscallDesc *desc, int num,
256                        Process *process, ThreadContext *tc);
257
258/// Target fcntl64() handler.
259SyscallReturn fcntl64Func(SyscallDesc *desc, int num,
260                        Process *process, ThreadContext *tc);
261
262/// Target setuid() handler.
263SyscallReturn setuidFunc(SyscallDesc *desc, int num,
264                               Process *p, ThreadContext *tc);
265
266/// Target getpid() handler.
267SyscallReturn getpidFunc(SyscallDesc *desc, int num,
268                               Process *p, ThreadContext *tc);
269
270/// Target getuid() handler.
271SyscallReturn getuidFunc(SyscallDesc *desc, int num,
272                               Process *p, ThreadContext *tc);
273
274/// Target getgid() handler.
275SyscallReturn getgidFunc(SyscallDesc *desc, int num,
276                               Process *p, ThreadContext *tc);
277
278/// Target getppid() handler.
279SyscallReturn getppidFunc(SyscallDesc *desc, int num,
280                               Process *p, ThreadContext *tc);
281
282/// Target geteuid() handler.
283SyscallReturn geteuidFunc(SyscallDesc *desc, int num,
284                               Process *p, ThreadContext *tc);
285
286/// Target getegid() handler.
287SyscallReturn getegidFunc(SyscallDesc *desc, int num,
288                               Process *p, ThreadContext *tc);
289
290
291
292/// Pseudo Funcs  - These functions use a different return convension,
293/// returning a second value in a register other than the normal return register
294SyscallReturn pipePseudoFunc(SyscallDesc *desc, int num,
295                             Process *process, ThreadContext *tc);
296
297/// Target getpidPseudo() handler.
298SyscallReturn getpidPseudoFunc(SyscallDesc *desc, int num,
299                               Process *p, ThreadContext *tc);
300
301/// Target getuidPseudo() handler.
302SyscallReturn getuidPseudoFunc(SyscallDesc *desc, int num,
303                               Process *p, ThreadContext *tc);
304
305/// Target getgidPseudo() handler.
306SyscallReturn getgidPseudoFunc(SyscallDesc *desc, int num,
307                               Process *p, ThreadContext *tc);
308
309
310/// A readable name for 1,000,000, for converting microseconds to seconds.
311const int one_million = 1000000;
312
313/// Approximate seconds since the epoch (1/1/1970).  About a billion,
314/// by my reckoning.  We want to keep this a constant (not use the
315/// real-world time) to keep simulations repeatable.
316const unsigned seconds_since_epoch = 1000000000;
317
318/// Helper function to convert current elapsed time to seconds and
319/// microseconds.
320template <class T1, class T2>
321void
322getElapsedTime(T1 &sec, T2 &usec)
323{
324    int elapsed_usecs = curTick / Clock::Int::us;
325    sec = elapsed_usecs / one_million;
326    usec = elapsed_usecs % one_million;
327}
328
329//////////////////////////////////////////////////////////////////////
330//
331// The following emulation functions are generic, but need to be
332// templated to account for differences in types, constants, etc.
333//
334//////////////////////////////////////////////////////////////////////
335
336#if NO_STAT64
337    typedef struct stat hst_stat;
338    typedef struct stat hst_stat64;
339#else
340    typedef struct stat hst_stat;
341    typedef struct stat64 hst_stat64;
342#endif
343
344//// Helper function to convert a host stat buffer to a target stat
345//// buffer.  Also copies the target buffer out to the simulated
346//// memory space.  Used by stat(), fstat(), and lstat().
347
348template <typename target_stat, typename host_stat>
349static void
350convertStatBuf(target_stat &tgt, host_stat *host, bool fakeTTY = false)
351{
352    if (fakeTTY)
353        tgt->st_dev = 0xA;
354    else
355        tgt->st_dev = host->st_dev;
356    tgt->st_dev = htog(tgt->st_dev);
357    tgt->st_ino = host->st_ino;
358    tgt->st_ino = htog(tgt->st_ino);
359    if (fakeTTY)
360        tgt->st_rdev = 0x880d;
361    else
362        tgt->st_rdev = host->st_rdev;
363    tgt->st_rdev = htog(tgt->st_rdev);
364    tgt->st_size = host->st_size;
365    tgt->st_size = htog(tgt->st_size);
366    tgt->st_atimeX = host->st_atimeX;
367    tgt->st_atimeX = htog(tgt->st_atimeX);
368    tgt->st_mtimeX = host->st_mtimeX;
369    tgt->st_mtimeX = htog(tgt->st_mtimeX);
370    tgt->st_ctimeX = host->st_ctimeX;
371    tgt->st_ctimeX = htog(tgt->st_ctimeX);
372    tgt->st_blksize = host->st_blksize;
373    tgt->st_blksize = htog(tgt->st_blksize);
374    tgt->st_blocks = host->st_blocks;
375    tgt->st_blocks = htog(tgt->st_blocks);
376}
377
378// Same for stat64
379
380template <typename target_stat, typename host_stat64>
381static void
382convertStat64Buf(target_stat &tgt, host_stat64 *host, bool fakeTTY = false)
383{
384    convertStatBuf<target_stat, host_stat64>(tgt, host, fakeTTY);
385#if defined(STAT_HAVE_NSEC)
386    tgt->st_atime_nsec = host->st_atime_nsec;
387    tgt->st_atime_nsec = htog(tgt->st_atime_nsec);
388    tgt->st_mtime_nsec = host->st_mtime_nsec;
389    tgt->st_mtime_nsec = htog(tgt->st_mtime_nsec);
390    tgt->st_ctime_nsec = host->st_ctime_nsec;
391    tgt->st_ctime_nsec = htog(tgt->st_ctime_nsec);
392#else
393    tgt->st_atime_nsec = 0;
394    tgt->st_mtime_nsec = 0;
395    tgt->st_ctime_nsec = 0;
396#endif
397}
398
399//Here are a couple convenience functions
400template<class OS>
401static void
402copyOutStatBuf(TranslatingPort * mem, Addr addr,
403        hst_stat *host, bool fakeTTY = false)
404{
405    typedef TypedBufferArg<typename OS::tgt_stat> tgt_stat_buf;
406    tgt_stat_buf tgt(addr);
407    convertStatBuf<tgt_stat_buf, hst_stat>(tgt, host, fakeTTY);
408    tgt.copyOut(mem);
409}
410
411template<class OS>
412static void
413copyOutStat64Buf(TranslatingPort * mem, Addr addr,
414        hst_stat64 *host, bool fakeTTY = false)
415{
416    typedef TypedBufferArg<typename OS::tgt_stat64> tgt_stat_buf;
417    tgt_stat_buf tgt(addr);
418    convertStatBuf<tgt_stat_buf, hst_stat64>(tgt, host, fakeTTY);
419    tgt.copyOut(mem);
420}
421
422/// Target ioctl() handler.  For the most part, programs call ioctl()
423/// only to find out if their stdout is a tty, to determine whether to
424/// do line or block buffering.
425template <class OS>
426SyscallReturn
427ioctlFunc(SyscallDesc *desc, int callnum, Process *process,
428          ThreadContext *tc)
429{
430    int fd = tc->getSyscallArg(0);
431    unsigned req = tc->getSyscallArg(1);
432
433    DPRINTF(SyscallVerbose, "ioctl(%d, 0x%x, ...)\n", fd, req);
434
435    if (fd < 0 || process->sim_fd(fd) < 0) {
436        // doesn't map to any simulator fd: not a valid target fd
437        return -EBADF;
438    }
439
440    switch (req) {
441      case OS::TIOCISATTY:
442      case OS::TIOCGETP:
443      case OS::TIOCSETP:
444      case OS::TIOCSETN:
445      case OS::TIOCSETC:
446      case OS::TIOCGETC:
447      case OS::TIOCGETS:
448      case OS::TIOCGETA:
449        return -ENOTTY;
450
451      default:
452        fatal("Unsupported ioctl call: ioctl(%d, 0x%x, ...) @ 0x%llx\n",
453              fd, req, tc->readPC());
454    }
455}
456
457/// Target open() handler.
458template <class OS>
459SyscallReturn
460openFunc(SyscallDesc *desc, int callnum, Process *process,
461         ThreadContext *tc)
462{
463    std::string path;
464
465    if (!tc->getMemPort()->tryReadString(path, tc->getSyscallArg(0)))
466        return -EFAULT;
467
468    if (path == "/dev/sysdev0") {
469        // This is a memory-mapped high-resolution timer device on Alpha.
470        // We don't support it, so just punt.
471        warn("Ignoring open(%s, ...)\n", path);
472        return -ENOENT;
473    }
474
475    int tgtFlags = tc->getSyscallArg(1);
476    int mode = tc->getSyscallArg(2);
477    int hostFlags = 0;
478
479    // translate open flags
480    for (int i = 0; i < OS::NUM_OPEN_FLAGS; i++) {
481        if (tgtFlags & OS::openFlagTable[i].tgtFlag) {
482            tgtFlags &= ~OS::openFlagTable[i].tgtFlag;
483            hostFlags |= OS::openFlagTable[i].hostFlag;
484        }
485    }
486
487    // any target flags left?
488    if (tgtFlags != 0)
489        warn("Syscall: open: cannot decode flags 0x%x", tgtFlags);
490
491#ifdef __CYGWIN32__
492    hostFlags |= O_BINARY;
493#endif
494
495    DPRINTF(SyscallVerbose, "opening file %s\n", path.c_str());
496
497    // open the file
498    int fd = open(path.c_str(), hostFlags, mode);
499
500    return (fd == -1) ? -errno : process->alloc_fd(fd);
501}
502
503
504/// Target chmod() handler.
505template <class OS>
506SyscallReturn
507chmodFunc(SyscallDesc *desc, int callnum, Process *process,
508          ThreadContext *tc)
509{
510    std::string path;
511
512    if (!tc->getMemPort()->tryReadString(path, tc->getSyscallArg(0)))
513        return -EFAULT;
514
515    uint32_t mode = tc->getSyscallArg(1);
516    mode_t hostMode = 0;
517
518    // XXX translate mode flags via OS::something???
519    hostMode = mode;
520
521    // do the chmod
522    int result = chmod(path.c_str(), hostMode);
523    if (result < 0)
524        return -errno;
525
526    return 0;
527}
528
529
530/// Target fchmod() handler.
531template <class OS>
532SyscallReturn
533fchmodFunc(SyscallDesc *desc, int callnum, Process *process,
534           ThreadContext *tc)
535{
536    int fd = tc->getSyscallArg(0);
537    if (fd < 0 || process->sim_fd(fd) < 0) {
538        // doesn't map to any simulator fd: not a valid target fd
539        return -EBADF;
540    }
541
542    uint32_t mode = tc->getSyscallArg(1);
543    mode_t hostMode = 0;
544
545    // XXX translate mode flags via OS::someting???
546    hostMode = mode;
547
548    // do the fchmod
549    int result = fchmod(process->sim_fd(fd), hostMode);
550    if (result < 0)
551        return -errno;
552
553    return 0;
554}
555
556
557/// Target stat() handler.
558template <class OS>
559SyscallReturn
560statFunc(SyscallDesc *desc, int callnum, Process *process,
561         ThreadContext *tc)
562{
563    std::string path;
564
565    if (!tc->getMemPort()->tryReadString(path, tc->getSyscallArg(0)))
566    return -EFAULT;
567
568    struct stat hostBuf;
569    int result = stat(path.c_str(), &hostBuf);
570
571    if (result < 0)
572        return -errno;
573
574    copyOutStatBuf<OS>(tc->getMemPort(), tc->getSyscallArg(1), &hostBuf);
575
576    return 0;
577}
578
579
580/// Target fstat64() handler.
581template <class OS>
582SyscallReturn
583fstat64Func(SyscallDesc *desc, int callnum, Process *process,
584            ThreadContext *tc)
585{
586    int fd = tc->getSyscallArg(0);
587    if (fd < 0 || process->sim_fd(fd) < 0) {
588        // doesn't map to any simulator fd: not a valid target fd
589        return -EBADF;
590    }
591
592#if NO_STAT64
593    struct stat  hostBuf;
594    int result = fstat(process->sim_fd(fd), &hostBuf);
595#else
596    struct stat64  hostBuf;
597    int result = fstat64(process->sim_fd(fd), &hostBuf);
598#endif
599
600    if (result < 0)
601        return -errno;
602
603    copyOutStat64Buf<OS>(tc->getMemPort(), fd, tc->getSyscallArg(1), &hostBuf);
604
605    return 0;
606}
607
608
609/// Target lstat() handler.
610template <class OS>
611SyscallReturn
612lstatFunc(SyscallDesc *desc, int callnum, Process *process,
613          ThreadContext *tc)
614{
615    std::string path;
616
617    if (!tc->getMemPort()->tryReadString(path, tc->getSyscallArg(0)))
618      return -EFAULT;
619
620    struct stat hostBuf;
621    int result = lstat(path.c_str(), &hostBuf);
622
623    if (result < 0)
624        return -errno;
625
626    copyOutStatBuf<OS>(tc->getMemPort(), tc->getSyscallArg(1), &hostBuf);
627
628    return 0;
629}
630
631/// Target lstat64() handler.
632template <class OS>
633SyscallReturn
634lstat64Func(SyscallDesc *desc, int callnum, Process *process,
635            ThreadContext *tc)
636{
637    std::string path;
638
639    if (!tc->getMemPort()->tryReadString(path, tc->getSyscallArg(0)))
640      return -EFAULT;
641
642#if NO_STAT64
643    struct stat hostBuf;
644    int result = lstat(path.c_str(), &hostBuf);
645#else
646    struct stat64 hostBuf;
647    int result = lstat64(path.c_str(), &hostBuf);
648#endif
649
650    if (result < 0)
651        return -errno;
652
653    copyOutStat64Buf<OS>(tc->getMemPort(), -1, tc->getSyscallArg(1), &hostBuf);
654
655    return 0;
656}
657
658/// Target fstat() handler.
659template <class OS>
660SyscallReturn
661fstatFunc(SyscallDesc *desc, int callnum, Process *process,
662          ThreadContext *tc)
663{
664    int fd = process->sim_fd(tc->getSyscallArg(0));
665
666    DPRINTF(SyscallVerbose, "fstat(%d, ...)\n", fd);
667
668    if (fd < 0)
669        return -EBADF;
670
671    struct stat hostBuf;
672    int result = fstat(fd, &hostBuf);
673
674    if (result < 0)
675        return -errno;
676
677    copyOutStatBuf<OS>(tc->getMemPort(), tc->getSyscallArg(1), &hostBuf);
678
679    return 0;
680}
681
682
683/// Target statfs() handler.
684template <class OS>
685SyscallReturn
686statfsFunc(SyscallDesc *desc, int callnum, Process *process,
687           ThreadContext *tc)
688{
689    std::string path;
690
691    if (!tc->getMemPort()->tryReadString(path, tc->getSyscallArg(0)))
692      return -EFAULT;
693
694    struct statfs hostBuf;
695    int result = statfs(path.c_str(), &hostBuf);
696
697    if (result < 0)
698        return -errno;
699
700    copyOutStatfsBuf<OS>(tc->getMemPort(), tc->getSyscallArg(1), &hostBuf);
701
702    return 0;
703}
704
705
706/// Target fstatfs() handler.
707template <class OS>
708SyscallReturn
709fstatfsFunc(SyscallDesc *desc, int callnum, Process *process,
710            ThreadContext *tc)
711{
712    int fd = process->sim_fd(tc->getSyscallArg(0));
713
714    if (fd < 0)
715        return -EBADF;
716
717    struct statfs hostBuf;
718    int result = fstatfs(fd, &hostBuf);
719
720    if (result < 0)
721        return -errno;
722
723    copyOutStatfsBuf<OS>(tc->getMemPort(), tc->getSyscallArg(1), &hostBuf);
724
725    return 0;
726}
727
728
729/// Target writev() handler.
730template <class OS>
731SyscallReturn
732writevFunc(SyscallDesc *desc, int callnum, Process *process,
733           ThreadContext *tc)
734{
735    int fd = tc->getSyscallArg(0);
736    if (fd < 0 || process->sim_fd(fd) < 0) {
737        // doesn't map to any simulator fd: not a valid target fd
738        return -EBADF;
739    }
740
741    TranslatingPort *p = tc->getMemPort();
742    uint64_t tiov_base = tc->getSyscallArg(1);
743    size_t count = tc->getSyscallArg(2);
744    struct iovec hiov[count];
745    for (int i = 0; i < count; ++i)
746    {
747        typename OS::tgt_iovec tiov;
748
749        p->readBlob(tiov_base + i*sizeof(typename OS::tgt_iovec),
750                    (uint8_t*)&tiov, sizeof(typename OS::tgt_iovec));
751        hiov[i].iov_len = gtoh(tiov.iov_len);
752        hiov[i].iov_base = new char [hiov[i].iov_len];
753        p->readBlob(gtoh(tiov.iov_base), (uint8_t *)hiov[i].iov_base,
754                    hiov[i].iov_len);
755    }
756
757    int result = writev(process->sim_fd(fd), hiov, count);
758
759    for (int i = 0; i < count; ++i)
760    {
761        delete [] (char *)hiov[i].iov_base;
762    }
763
764    if (result < 0)
765        return -errno;
766
767    return 0;
768}
769
770
771/// Target mmap() handler.
772///
773/// We don't really handle mmap().  If the target is mmaping an
774/// anonymous region or /dev/zero, we can get away with doing basically
775/// nothing (since memory is initialized to zero and the simulator
776/// doesn't really check addresses anyway).  Always print a warning,
777/// since this could be seriously broken if we're not mapping
778/// /dev/zero.
779//
780/// Someday we should explicitly check for /dev/zero in open, flag the
781/// file descriptor, and fail (or implement!) a non-anonymous mmap to
782/// anything else.
783template <class OS>
784SyscallReturn
785mmapFunc(SyscallDesc *desc, int num, Process *p, ThreadContext *tc)
786{
787    Addr start = tc->getSyscallArg(0);
788    uint64_t length = tc->getSyscallArg(1);
789    // int prot = tc->getSyscallArg(2);
790    int flags = tc->getSyscallArg(3);
791    // int fd = p->sim_fd(tc->getSyscallArg(4));
792    // int offset = tc->getSyscallArg(5);
793
794    if ((start  % TheISA::VMPageSize) != 0 ||
795        (length % TheISA::VMPageSize) != 0) {
796        warn("mmap failing: arguments not page-aligned: "
797             "start 0x%x length 0x%x",
798             start, length);
799        return -EINVAL;
800    }
801
802    if (start != 0) {
803        warn("mmap: ignoring suggested map address 0x%x, using 0x%x",
804             start, p->mmap_end);
805    }
806
807    // pick next address from our "mmap region"
808    start = p->mmap_end;
809    p->pTable->allocate(start, length);
810    p->mmap_end += length;
811
812    if (!(flags & OS::TGT_MAP_ANONYMOUS)) {
813        warn("allowing mmap of file @ fd %d. "
814             "This will break if not /dev/zero.", tc->getSyscallArg(4));
815    }
816
817    return start;
818}
819
820/// Target getrlimit() handler.
821template <class OS>
822SyscallReturn
823getrlimitFunc(SyscallDesc *desc, int callnum, Process *process,
824        ThreadContext *tc)
825{
826    unsigned resource = tc->getSyscallArg(0);
827    TypedBufferArg<typename OS::rlimit> rlp(tc->getSyscallArg(1));
828
829    switch (resource) {
830        case OS::TGT_RLIMIT_STACK:
831            // max stack size in bytes: make up a number (2MB for now)
832            rlp->rlim_cur = rlp->rlim_max = 8 * 1024 * 1024;
833            rlp->rlim_cur = htog(rlp->rlim_cur);
834            rlp->rlim_max = htog(rlp->rlim_max);
835            break;
836
837        default:
838            std::cerr << "getrlimitFunc: unimplemented resource " << resource
839                << std::endl;
840            abort();
841            break;
842    }
843
844    rlp.copyOut(tc->getMemPort());
845    return 0;
846}
847
848/// Target gettimeofday() handler.
849template <class OS>
850SyscallReturn
851gettimeofdayFunc(SyscallDesc *desc, int callnum, Process *process,
852        ThreadContext *tc)
853{
854    TypedBufferArg<typename OS::timeval> tp(tc->getSyscallArg(0));
855
856    getElapsedTime(tp->tv_sec, tp->tv_usec);
857    tp->tv_sec += seconds_since_epoch;
858    tp->tv_sec = htog(tp->tv_sec);
859    tp->tv_usec = htog(tp->tv_usec);
860
861    tp.copyOut(tc->getMemPort());
862
863    return 0;
864}
865
866
867/// Target utimes() handler.
868template <class OS>
869SyscallReturn
870utimesFunc(SyscallDesc *desc, int callnum, Process *process,
871           ThreadContext *tc)
872{
873    std::string path;
874
875    if (!tc->getMemPort()->tryReadString(path, tc->getSyscallArg(0)))
876      return -EFAULT;
877
878    TypedBufferArg<typename OS::timeval [2]> tp(tc->getSyscallArg(1));
879    tp.copyIn(tc->getMemPort());
880
881    struct timeval hostTimeval[2];
882    for (int i = 0; i < 2; ++i)
883    {
884        hostTimeval[i].tv_sec = gtoh((*tp)[i].tv_sec);
885        hostTimeval[i].tv_usec = gtoh((*tp)[i].tv_usec);
886    }
887    int result = utimes(path.c_str(), hostTimeval);
888
889    if (result < 0)
890        return -errno;
891
892    return 0;
893}
894/// Target getrusage() function.
895template <class OS>
896SyscallReturn
897getrusageFunc(SyscallDesc *desc, int callnum, Process *process,
898              ThreadContext *tc)
899{
900    int who = tc->getSyscallArg(0);	// THREAD, SELF, or CHILDREN
901    TypedBufferArg<typename OS::rusage> rup(tc->getSyscallArg(1));
902
903    if (who != OS::TGT_RUSAGE_SELF) {
904        // don't really handle THREAD or CHILDREN, but just warn and
905        // plow ahead
906        warn("getrusage() only supports RUSAGE_SELF.  Parameter %d ignored.",
907             who);
908    }
909
910    getElapsedTime(rup->ru_utime.tv_sec, rup->ru_utime.tv_usec);
911    rup->ru_utime.tv_sec = htog(rup->ru_utime.tv_sec);
912    rup->ru_utime.tv_usec = htog(rup->ru_utime.tv_usec);
913
914    rup->ru_stime.tv_sec = 0;
915    rup->ru_stime.tv_usec = 0;
916    rup->ru_maxrss = 0;
917    rup->ru_ixrss = 0;
918    rup->ru_idrss = 0;
919    rup->ru_isrss = 0;
920    rup->ru_minflt = 0;
921    rup->ru_majflt = 0;
922    rup->ru_nswap = 0;
923    rup->ru_inblock = 0;
924    rup->ru_oublock = 0;
925    rup->ru_msgsnd = 0;
926    rup->ru_msgrcv = 0;
927    rup->ru_nsignals = 0;
928    rup->ru_nvcsw = 0;
929    rup->ru_nivcsw = 0;
930
931    rup.copyOut(tc->getMemPort());
932
933    return 0;
934}
935
936
937
938
939#endif // __SIM_SYSCALL_EMUL_HH__
940