linux.hh (11907:48a3d32da9d8) linux.hh (12591:48dfacae20ba)
1/*
2 * Copyright (c) 2004-2009 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: Ali Saidi
29 */
30
31#ifndef __LINUX_HH__
32#define __LINUX_HH__
33
34#include "base/types.hh"
35
36#include <string>
37
38#include "kern/operatingsystem.hh"
39#include "sim/process.hh"
40
41class ThreadContext;
42
43///
44/// This class encapsulates the types, structures, constants,
45/// functions, and syscall-number mappings specific to the Alpha Linux
46/// syscall interface.
47///
48class Linux : public OperatingSystem
49{
50
51 public:
52
53 //@{
54 /// Basic Linux types.
55 typedef uint64_t size_t;
56 typedef uint64_t off_t;
57 typedef int64_t time_t;
58 typedef int64_t clock_t;
59 typedef uint32_t uid_t;
60 typedef uint32_t gid_t;
61 //@}
62
63 /// Stat buffer. Note that we can't call it 'stat' since that
64 /// gets #defined to something else on some systems. This type
65 /// can be specialized by architecture specific "Linux" classes
66 typedef struct {
67 uint32_t st_dev; //!< device
68 uint32_t st_ino; //!< inode
69 uint32_t st_mode; //!< mode
70 uint32_t st_nlink; //!< link count
71 uint32_t st_uid; //!< owner's user ID
72 uint32_t st_gid; //!< owner's group ID
73 uint32_t st_rdev; //!< device number
74 int32_t _pad1; //!< for alignment
75 int64_t st_size; //!< file size in bytes
76 uint64_t st_atimeX; //!< time of last access
77 uint64_t st_mtimeX; //!< time of last modification
78 uint64_t st_ctimeX; //!< time of last status change
79 uint32_t st_blksize; //!< optimal I/O block size
80 int32_t st_blocks; //!< number of blocks allocated
81 uint32_t st_flags; //!< flags
82 uint32_t st_gen; //!< unknown
83 } tgt_stat;
84
85 // same for stat64
86 typedef struct {
87 uint64_t st_dev;
88 uint64_t st_ino;
89 uint64_t st_rdev;
90 int64_t st_size;
91 uint64_t st_blocks;
92
93 uint32_t st_mode;
94 uint32_t st_uid;
95 uint32_t st_gid;
96 uint32_t st_blksize;
97 uint32_t st_nlink;
98 uint32_t __pad0;
99
100 uint64_t st_atimeX;
101 uint64_t st_atime_nsec;
102 uint64_t st_mtimeX;
103 uint64_t st_mtime_nsec;
104 uint64_t st_ctimeX;
105 uint64_t st_ctime_nsec;
106 int64_t ___unused[3];
107 } tgt_stat64;
108
109 /// Length of strings in struct utsname (plus 1 for null char).
110 static const int _SYS_NMLN = 65;
111
112 /// Interface struct for uname().
113 struct utsname {
114 char sysname[_SYS_NMLN]; //!< System name.
115 char nodename[_SYS_NMLN]; //!< Node name.
116 char release[_SYS_NMLN]; //!< OS release.
117 char version[_SYS_NMLN]; //!< OS version.
118 char machine[_SYS_NMLN]; //!< Machine type.
119 };
120
121 /// Limit struct for getrlimit/setrlimit.
122 struct rlimit {
123 uint64_t rlim_cur; //!< soft limit
124 uint64_t rlim_max; //!< hard limit
125 };
126
127 /// For gettimeofday().
128 struct timeval {
129 int64_t tv_sec; //!< seconds
130 int64_t tv_usec; //!< microseconds
131 };
132
133 /// For clock_gettime().
134 struct timespec {
135 time_t tv_sec; //!< seconds
136 int64_t tv_nsec; //!< nanoseconds
137 };
138
139 /// Clock ticks per second, for times().
140 static const int M5_SC_CLK_TCK = 100;
141
142 /// For times().
143 struct tms {
144 int64_t tms_utime; //!< user time
145 int64_t tms_stime; //!< system time
146 int64_t tms_cutime; //!< user time of children
147 int64_t tms_cstime; //!< system time of children
148 };
149
150 // For writev/readv
151 struct tgt_iovec {
152 uint64_t iov_base; // void *
153 uint64_t iov_len;
154 };
155
156 //@{
157 /// ioctl() command codes.
158 static const unsigned TGT_TCGETS = 0x5401;
159 static const unsigned TGT_TCGETA = 0x5405;
160 static const unsigned TGT_TCSETAW = 0x5407;
161 static const unsigned TGT_FIONREAD = 0x541B;
162 //@}
163
164 /// Return true for the ioctl codes for which we return ENOTTY
165 /// *without* printing a warning, since we know that ENOTTY is the
166 /// correct thing to return (and not just a sign that we don't
167 /// recognize the ioctl code.
168 static bool
169 isTtyReq(unsigned req)
170 {
171 switch (req) {
172 case TGT_FIONREAD:
173 case TGT_TCSETAW:
174 case TGT_TCGETS:
175 case TGT_TCGETA:
176 return true;
177 default:
178 return false;
179 }
180 }
181
182
183 /// Resource constants for getrlimit().
184 static const unsigned TGT_RLIMIT_CPU = 0;
185 static const unsigned TGT_RLIMIT_FSIZE = 1;
186 static const unsigned TGT_RLIMIT_DATA = 2;
187 static const unsigned TGT_RLIMIT_STACK = 3;
188 static const unsigned TGT_RLIMIT_CORE = 4;
189 static const unsigned TGT_RLIMIT_RSS = 5;
190 static const unsigned TGT_RLIMIT_NPROC = 6;
191 static const unsigned TGT_RLIMIT_NOFILE = 7;
192 static const unsigned TGT_RLIMIT_MEMLOCK = 8;
193 static const unsigned TGT_RLIMIT_AS = 9;
194 static const unsigned TGT_RLIMIT_LOCKS = 10;
195 static const unsigned TGT_RLIMIT_SIGPENDING = 11;
196 static const unsigned TGT_RLIMIT_MSGQUEUE = 12;
197 static const unsigned TGT_RLIMIT_NICE = 13;
198 static const unsigned TGT_RLIMIT_RTPRIO = 14;
199 static const unsigned TGT_RLIMIT_RTTIME = 15;
200 static const unsigned TGT_RLIM_NLIMITS = 16;
201
202 /// For getrusage().
203 static const int TGT_RUSAGE_SELF = 0;
204 static const int TGT_RUSAGE_CHILDREN = -1;
205 static const int TGT_RUSAGE_BOTH = -2;
206
207 struct rusage {
208 struct timeval ru_utime; //!< user time used
209 struct timeval ru_stime; //!< system time used
210 int64_t ru_maxrss; //!< max rss
211 int64_t ru_ixrss; //!< integral shared memory size
212 int64_t ru_idrss; //!< integral unshared data "
213 int64_t ru_isrss; //!< integral unshared stack "
214 int64_t ru_minflt; //!< page reclaims - total vmfaults
215 int64_t ru_majflt; //!< page faults
216 int64_t ru_nswap; //!< swaps
217 int64_t ru_inblock; //!< block input operations
218 int64_t ru_oublock; //!< block output operations
219 int64_t ru_msgsnd; //!< messages sent
220 int64_t ru_msgrcv; //!< messages received
221 int64_t ru_nsignals; //!< signals received
222 int64_t ru_nvcsw; //!< voluntary context switches
223 int64_t ru_nivcsw; //!< involuntary "
224 };
225
226 static int openSpecialFile(std::string path, Process *process,
227 ThreadContext *tc);
228 static std::string procMeminfo(Process *process, ThreadContext *tc);
229 static std::string etcPasswd(Process *process, ThreadContext *tc);
1/*
2 * Copyright (c) 2004-2009 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: Ali Saidi
29 */
30
31#ifndef __LINUX_HH__
32#define __LINUX_HH__
33
34#include "base/types.hh"
35
36#include <string>
37
38#include "kern/operatingsystem.hh"
39#include "sim/process.hh"
40
41class ThreadContext;
42
43///
44/// This class encapsulates the types, structures, constants,
45/// functions, and syscall-number mappings specific to the Alpha Linux
46/// syscall interface.
47///
48class Linux : public OperatingSystem
49{
50
51 public:
52
53 //@{
54 /// Basic Linux types.
55 typedef uint64_t size_t;
56 typedef uint64_t off_t;
57 typedef int64_t time_t;
58 typedef int64_t clock_t;
59 typedef uint32_t uid_t;
60 typedef uint32_t gid_t;
61 //@}
62
63 /// Stat buffer. Note that we can't call it 'stat' since that
64 /// gets #defined to something else on some systems. This type
65 /// can be specialized by architecture specific "Linux" classes
66 typedef struct {
67 uint32_t st_dev; //!< device
68 uint32_t st_ino; //!< inode
69 uint32_t st_mode; //!< mode
70 uint32_t st_nlink; //!< link count
71 uint32_t st_uid; //!< owner's user ID
72 uint32_t st_gid; //!< owner's group ID
73 uint32_t st_rdev; //!< device number
74 int32_t _pad1; //!< for alignment
75 int64_t st_size; //!< file size in bytes
76 uint64_t st_atimeX; //!< time of last access
77 uint64_t st_mtimeX; //!< time of last modification
78 uint64_t st_ctimeX; //!< time of last status change
79 uint32_t st_blksize; //!< optimal I/O block size
80 int32_t st_blocks; //!< number of blocks allocated
81 uint32_t st_flags; //!< flags
82 uint32_t st_gen; //!< unknown
83 } tgt_stat;
84
85 // same for stat64
86 typedef struct {
87 uint64_t st_dev;
88 uint64_t st_ino;
89 uint64_t st_rdev;
90 int64_t st_size;
91 uint64_t st_blocks;
92
93 uint32_t st_mode;
94 uint32_t st_uid;
95 uint32_t st_gid;
96 uint32_t st_blksize;
97 uint32_t st_nlink;
98 uint32_t __pad0;
99
100 uint64_t st_atimeX;
101 uint64_t st_atime_nsec;
102 uint64_t st_mtimeX;
103 uint64_t st_mtime_nsec;
104 uint64_t st_ctimeX;
105 uint64_t st_ctime_nsec;
106 int64_t ___unused[3];
107 } tgt_stat64;
108
109 /// Length of strings in struct utsname (plus 1 for null char).
110 static const int _SYS_NMLN = 65;
111
112 /// Interface struct for uname().
113 struct utsname {
114 char sysname[_SYS_NMLN]; //!< System name.
115 char nodename[_SYS_NMLN]; //!< Node name.
116 char release[_SYS_NMLN]; //!< OS release.
117 char version[_SYS_NMLN]; //!< OS version.
118 char machine[_SYS_NMLN]; //!< Machine type.
119 };
120
121 /// Limit struct for getrlimit/setrlimit.
122 struct rlimit {
123 uint64_t rlim_cur; //!< soft limit
124 uint64_t rlim_max; //!< hard limit
125 };
126
127 /// For gettimeofday().
128 struct timeval {
129 int64_t tv_sec; //!< seconds
130 int64_t tv_usec; //!< microseconds
131 };
132
133 /// For clock_gettime().
134 struct timespec {
135 time_t tv_sec; //!< seconds
136 int64_t tv_nsec; //!< nanoseconds
137 };
138
139 /// Clock ticks per second, for times().
140 static const int M5_SC_CLK_TCK = 100;
141
142 /// For times().
143 struct tms {
144 int64_t tms_utime; //!< user time
145 int64_t tms_stime; //!< system time
146 int64_t tms_cutime; //!< user time of children
147 int64_t tms_cstime; //!< system time of children
148 };
149
150 // For writev/readv
151 struct tgt_iovec {
152 uint64_t iov_base; // void *
153 uint64_t iov_len;
154 };
155
156 //@{
157 /// ioctl() command codes.
158 static const unsigned TGT_TCGETS = 0x5401;
159 static const unsigned TGT_TCGETA = 0x5405;
160 static const unsigned TGT_TCSETAW = 0x5407;
161 static const unsigned TGT_FIONREAD = 0x541B;
162 //@}
163
164 /// Return true for the ioctl codes for which we return ENOTTY
165 /// *without* printing a warning, since we know that ENOTTY is the
166 /// correct thing to return (and not just a sign that we don't
167 /// recognize the ioctl code.
168 static bool
169 isTtyReq(unsigned req)
170 {
171 switch (req) {
172 case TGT_FIONREAD:
173 case TGT_TCSETAW:
174 case TGT_TCGETS:
175 case TGT_TCGETA:
176 return true;
177 default:
178 return false;
179 }
180 }
181
182
183 /// Resource constants for getrlimit().
184 static const unsigned TGT_RLIMIT_CPU = 0;
185 static const unsigned TGT_RLIMIT_FSIZE = 1;
186 static const unsigned TGT_RLIMIT_DATA = 2;
187 static const unsigned TGT_RLIMIT_STACK = 3;
188 static const unsigned TGT_RLIMIT_CORE = 4;
189 static const unsigned TGT_RLIMIT_RSS = 5;
190 static const unsigned TGT_RLIMIT_NPROC = 6;
191 static const unsigned TGT_RLIMIT_NOFILE = 7;
192 static const unsigned TGT_RLIMIT_MEMLOCK = 8;
193 static const unsigned TGT_RLIMIT_AS = 9;
194 static const unsigned TGT_RLIMIT_LOCKS = 10;
195 static const unsigned TGT_RLIMIT_SIGPENDING = 11;
196 static const unsigned TGT_RLIMIT_MSGQUEUE = 12;
197 static const unsigned TGT_RLIMIT_NICE = 13;
198 static const unsigned TGT_RLIMIT_RTPRIO = 14;
199 static const unsigned TGT_RLIMIT_RTTIME = 15;
200 static const unsigned TGT_RLIM_NLIMITS = 16;
201
202 /// For getrusage().
203 static const int TGT_RUSAGE_SELF = 0;
204 static const int TGT_RUSAGE_CHILDREN = -1;
205 static const int TGT_RUSAGE_BOTH = -2;
206
207 struct rusage {
208 struct timeval ru_utime; //!< user time used
209 struct timeval ru_stime; //!< system time used
210 int64_t ru_maxrss; //!< max rss
211 int64_t ru_ixrss; //!< integral shared memory size
212 int64_t ru_idrss; //!< integral unshared data "
213 int64_t ru_isrss; //!< integral unshared stack "
214 int64_t ru_minflt; //!< page reclaims - total vmfaults
215 int64_t ru_majflt; //!< page faults
216 int64_t ru_nswap; //!< swaps
217 int64_t ru_inblock; //!< block input operations
218 int64_t ru_oublock; //!< block output operations
219 int64_t ru_msgsnd; //!< messages sent
220 int64_t ru_msgrcv; //!< messages received
221 int64_t ru_nsignals; //!< signals received
222 int64_t ru_nvcsw; //!< voluntary context switches
223 int64_t ru_nivcsw; //!< involuntary "
224 };
225
226 static int openSpecialFile(std::string path, Process *process,
227 ThreadContext *tc);
228 static std::string procMeminfo(Process *process, ThreadContext *tc);
229 static std::string etcPasswd(Process *process, ThreadContext *tc);
230 static std::string cpuOnline(Process *process, ThreadContext *tc);
230
231 // For futex system call
232 static const unsigned TGT_FUTEX_WAIT = 0;
233 static const unsigned TGT_FUTEX_WAKE = 1;
234 static const unsigned TGT_EAGAIN = 11;
235 static const unsigned TGT_EWOULDBLOCK = TGT_EAGAIN;
236 static const unsigned TGT_FUTEX_PRIVATE_FLAG = 128;
237
238 // for *at syscalls
239 static const int TGT_AT_FDCWD = -100;
240
241 // for MREMAP
242 static const unsigned TGT_MREMAP_MAYMOVE = 0x1;
243 static const unsigned TGT_MREMAP_FIXED = 0x2;
244
245 static const unsigned TGT_CLONE_VM = 0x00000100;
246 static const unsigned TGT_CLONE_FS = 0x00000200;
247 static const unsigned TGT_CLONE_FILES = 0x00000400;
248 static const unsigned TGT_CLONE_SIGHAND = 0x00000800;
249 static const unsigned TGT_CLONE_PTRACE = 0x00002000;
250 static const unsigned TGT_CLONE_VFORK = 0x00004000;
251 static const unsigned TGT_CLONE_PARENT = 0x00008000;
252 static const unsigned TGT_CLONE_THREAD = 0x00010000;
253 static const unsigned TGT_CLONE_NEWNS = 0x00020000;
254 static const unsigned TGT_CLONE_SYSVSEM = 0x00040000;
255 static const unsigned TGT_CLONE_SETTLS = 0x00080000;
256 static const unsigned TGT_CLONE_PARENT_SETTID = 0x00100000;
257 static const unsigned TGT_CLONE_CHILD_CLEARTID = 0x00200000;
258 static const unsigned TGT_CLONE_DETACHED = 0x00400000;
259 static const unsigned TGT_CLONE_UNTRACED = 0x00800000;
260 static const unsigned TGT_CLONE_CHILD_SETTID = 0x01000000;
261 static const unsigned TGT_CLONE_NEWUTS = 0x04000000;
262 static const unsigned TGT_CLONE_NEWIPC = 0x08000000;
263 static const unsigned TGT_CLONE_NEWUSER = 0x10000000;
264 static const unsigned TGT_CLONE_NEWPID = 0x20000000;
265 static const unsigned TGT_CLONE_NEWNET = 0x40000000;
266 static const unsigned TGT_CLONE_IO = 0x80000000;
267}; // class Linux
268
269#endif // __LINUX_HH__
231
232 // For futex system call
233 static const unsigned TGT_FUTEX_WAIT = 0;
234 static const unsigned TGT_FUTEX_WAKE = 1;
235 static const unsigned TGT_EAGAIN = 11;
236 static const unsigned TGT_EWOULDBLOCK = TGT_EAGAIN;
237 static const unsigned TGT_FUTEX_PRIVATE_FLAG = 128;
238
239 // for *at syscalls
240 static const int TGT_AT_FDCWD = -100;
241
242 // for MREMAP
243 static const unsigned TGT_MREMAP_MAYMOVE = 0x1;
244 static const unsigned TGT_MREMAP_FIXED = 0x2;
245
246 static const unsigned TGT_CLONE_VM = 0x00000100;
247 static const unsigned TGT_CLONE_FS = 0x00000200;
248 static const unsigned TGT_CLONE_FILES = 0x00000400;
249 static const unsigned TGT_CLONE_SIGHAND = 0x00000800;
250 static const unsigned TGT_CLONE_PTRACE = 0x00002000;
251 static const unsigned TGT_CLONE_VFORK = 0x00004000;
252 static const unsigned TGT_CLONE_PARENT = 0x00008000;
253 static const unsigned TGT_CLONE_THREAD = 0x00010000;
254 static const unsigned TGT_CLONE_NEWNS = 0x00020000;
255 static const unsigned TGT_CLONE_SYSVSEM = 0x00040000;
256 static const unsigned TGT_CLONE_SETTLS = 0x00080000;
257 static const unsigned TGT_CLONE_PARENT_SETTID = 0x00100000;
258 static const unsigned TGT_CLONE_CHILD_CLEARTID = 0x00200000;
259 static const unsigned TGT_CLONE_DETACHED = 0x00400000;
260 static const unsigned TGT_CLONE_UNTRACED = 0x00800000;
261 static const unsigned TGT_CLONE_CHILD_SETTID = 0x01000000;
262 static const unsigned TGT_CLONE_NEWUTS = 0x04000000;
263 static const unsigned TGT_CLONE_NEWIPC = 0x08000000;
264 static const unsigned TGT_CLONE_NEWUSER = 0x10000000;
265 static const unsigned TGT_CLONE_NEWPID = 0x20000000;
266 static const unsigned TGT_CLONE_NEWNET = 0x40000000;
267 static const unsigned TGT_CLONE_IO = 0x80000000;
268}; // class Linux
269
270#endif // __LINUX_HH__