1/*
2 * Copyright (c) 2012-2013, 2015 ARM Limited
3 * Copyright (c) 2015-2016 Advanced Micro Devices, Inc.
4 * All rights reserved
5 *
6 * The license below extends only to copyright in the software and shall
7 * not be construed as granting a license to any other intellectual
8 * property including but not limited to intellectual property relating
9 * to a hardware implementation of the functionality of the software
10 * licensed hereunder. You may use the software subject to the license
11 * terms below provided that you ensure that this notice is replicated
12 * unmodified and in its entirety in all distributions of the software,
13 * modified or unmodified, in source code or in binary form.
14 *
15 * Copyright (c) 2003-2005 The Regents of The University of Michigan
16 * All rights reserved.
17 *
18 * Redistribution and use in source and binary forms, with or without
19 * modification, are permitted provided that the following conditions are
20 * met: redistributions of source code must retain the above copyright
21 * notice, this list of conditions and the following disclaimer;
22 * redistributions in binary form must reproduce the above copyright
23 * notice, this list of conditions and the following disclaimer in the
24 * documentation and/or other materials provided with the distribution;
25 * neither the name of the copyright holders nor the names of its
26 * contributors may be used to endorse or promote products derived from
27 * this software without specific prior written permission.
28 *
29 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
30 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
31 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
32 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
33 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
34 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
35 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
36 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
37 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
38 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
39 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
40 *
41 * Authors: Steve Reinhardt
42 * Kevin Lim
43 * Brandon Potter
44 */
45
46#ifndef __SIM_SYSCALL_DESC_HH__
47#define __SIM_SYSCALL_DESC_HH__
48
49#include <string>
50
51#include "base/types.hh"
52
53class Process;
54class SyscallDesc;
55class SyscallReturn;
56class ThreadContext;
57
58SyscallReturn unimplementedFunc(SyscallDesc *desc, int num,
| 1/*
2 * Copyright (c) 2012-2013, 2015 ARM Limited
3 * Copyright (c) 2015-2016 Advanced Micro Devices, Inc.
4 * All rights reserved
5 *
6 * The license below extends only to copyright in the software and shall
7 * not be construed as granting a license to any other intellectual
8 * property including but not limited to intellectual property relating
9 * to a hardware implementation of the functionality of the software
10 * licensed hereunder. You may use the software subject to the license
11 * terms below provided that you ensure that this notice is replicated
12 * unmodified and in its entirety in all distributions of the software,
13 * modified or unmodified, in source code or in binary form.
14 *
15 * Copyright (c) 2003-2005 The Regents of The University of Michigan
16 * All rights reserved.
17 *
18 * Redistribution and use in source and binary forms, with or without
19 * modification, are permitted provided that the following conditions are
20 * met: redistributions of source code must retain the above copyright
21 * notice, this list of conditions and the following disclaimer;
22 * redistributions in binary form must reproduce the above copyright
23 * notice, this list of conditions and the following disclaimer in the
24 * documentation and/or other materials provided with the distribution;
25 * neither the name of the copyright holders nor the names of its
26 * contributors may be used to endorse or promote products derived from
27 * this software without specific prior written permission.
28 *
29 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
30 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
31 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
32 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
33 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
34 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
35 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
36 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
37 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
38 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
39 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
40 *
41 * Authors: Steve Reinhardt
42 * Kevin Lim
43 * Brandon Potter
44 */
45
46#ifndef __SIM_SYSCALL_DESC_HH__
47#define __SIM_SYSCALL_DESC_HH__
48
49#include <string>
50
51#include "base/types.hh"
52
53class Process;
54class SyscallDesc;
55class SyscallReturn;
56class ThreadContext;
57
58SyscallReturn unimplementedFunc(SyscallDesc *desc, int num,
|
59 Process *p, ThreadContext *tc);
| 59 ThreadContext *tc);
|
60
61/**
62 * This class provides the wrapper interface for the system call
63 * implementations which are defined in the sim/syscall_emul files and
64 * bound to the ISAs in the architecture specific code
65 * (i.e. arch/X86/linux/process.cc).
66 */
67class SyscallDesc {
68 public:
69 /** Typedef the function pointer here to clean up code below */
70 typedef SyscallReturn (*SyscallExecutor)(SyscallDesc*, int num,
| 60
61/**
62 * This class provides the wrapper interface for the system call
63 * implementations which are defined in the sim/syscall_emul files and
64 * bound to the ISAs in the architecture specific code
65 * (i.e. arch/X86/linux/process.cc).
66 */
67class SyscallDesc {
68 public:
69 /** Typedef the function pointer here to clean up code below */
70 typedef SyscallReturn (*SyscallExecutor)(SyscallDesc*, int num,
|
71 Process*, ThreadContext*);
| 71 ThreadContext*);
|
72
73 SyscallDesc(const char *name,
74 SyscallExecutor sys_exec=unimplementedFunc, int flags=0)
75 : _name(name), executor(sys_exec), _flags(flags), _warned(false)
76 {
77 }
78
79 /** Provide a mechanism to specify behavior for abnormal system calls */
80 enum Flags {
81 /**
82 * Do not set return registers according to executor return value.
83 * Used for system calls with non-standard return conventions that
84 * explicitly set the thread context regs (e.g., sigreturn, clone)
85 */
86 SuppressReturnValue = 1,
87 /** Warn only once for unimplemented system calls */
88 WarnOnce = 2
89 /* X2 = 4, // Remove these comments when the next field is added; */
90 /* X3 = 8, // point is to make it obvious that this defines vector */
91 };
92
93 /**
94 * Interface for invoking the system call funcion pointer. Note that
95 * this acts as a gateway for all system calls and serves a good point
96 * to add filters for behaviors or apply checks for all system calls.
97 * @param callnum Number associated with call (by operating system)
98 * @param proc Handle for the owning Process to pass information
99 * @param tc Handle for owning ThreadContext to pass information
100 */
| 72
73 SyscallDesc(const char *name,
74 SyscallExecutor sys_exec=unimplementedFunc, int flags=0)
75 : _name(name), executor(sys_exec), _flags(flags), _warned(false)
76 {
77 }
78
79 /** Provide a mechanism to specify behavior for abnormal system calls */
80 enum Flags {
81 /**
82 * Do not set return registers according to executor return value.
83 * Used for system calls with non-standard return conventions that
84 * explicitly set the thread context regs (e.g., sigreturn, clone)
85 */
86 SuppressReturnValue = 1,
87 /** Warn only once for unimplemented system calls */
88 WarnOnce = 2
89 /* X2 = 4, // Remove these comments when the next field is added; */
90 /* X3 = 8, // point is to make it obvious that this defines vector */
91 };
92
93 /**
94 * Interface for invoking the system call funcion pointer. Note that
95 * this acts as a gateway for all system calls and serves a good point
96 * to add filters for behaviors or apply checks for all system calls.
97 * @param callnum Number associated with call (by operating system)
98 * @param proc Handle for the owning Process to pass information
99 * @param tc Handle for owning ThreadContext to pass information
100 */
|
101 void doSyscall(int callnum, Process *proc, ThreadContext *tc,
102 Fault *fault);
| 101 void doSyscall(int callnum, ThreadContext *tc, Fault *fault);
|
103
104 /**
105 * Return false if WarnOnce is set and a warning has already been issued.
106 * Otherwise, return true. Updates state as a side effect to help
107 * keep track of issued warnings.
108 */
109 bool needWarning();
110
111 bool warnOnce() const { return (_flags & WarnOnce); }
112
113 std::string name() { return _name; }
114
115 int getFlags() const { return _flags; }
116
117 void setFlags(int flags) { _flags = flags; }
118
119 private:
120 /** System call name (e.g., open, mmap, clone, socket, etc.) */
121 std::string _name;
122
123 /** Mechanism for ISAs to connect to the emul function definitions */
124 SyscallExecutor executor;
125
126 /**
127 * Holds values set with the preceding enum; note that this has been
128 * used primarily for features that are mutually exclusive, but there's
129 * no reason that this needs to be true going forward.
130 */
131 int _flags;
132
133 /** Set if WarnOnce is specified in flags AFTER first call */
134 bool _warned;
135};
136
137#endif // __SIM_SYSCALL_DESC_HH__
| 102
103 /**
104 * Return false if WarnOnce is set and a warning has already been issued.
105 * Otherwise, return true. Updates state as a side effect to help
106 * keep track of issued warnings.
107 */
108 bool needWarning();
109
110 bool warnOnce() const { return (_flags & WarnOnce); }
111
112 std::string name() { return _name; }
113
114 int getFlags() const { return _flags; }
115
116 void setFlags(int flags) { _flags = flags; }
117
118 private:
119 /** System call name (e.g., open, mmap, clone, socket, etc.) */
120 std::string _name;
121
122 /** Mechanism for ISAs to connect to the emul function definitions */
123 SyscallExecutor executor;
124
125 /**
126 * Holds values set with the preceding enum; note that this has been
127 * used primarily for features that are mutually exclusive, but there's
128 * no reason that this needs to be true going forward.
129 */
130 int _flags;
131
132 /** Set if WarnOnce is specified in flags AFTER first call */
133 bool _warned;
134};
135
136#endif // __SIM_SYSCALL_DESC_HH__
|