1/*
2 * Copyright (c) 2007 The Hewlett-Packard Development Company
3 * All rights reserved.
4 *
5 * The license below extends only to copyright in the software and shall
6 * not be construed as granting a license to any other intellectual
7 * property including but not limited to intellectual property relating
8 * to a hardware implementation of the functionality of the software
9 * licensed hereunder.  You may use the software subject to the license
10 * terms below provided that you ensure that this notice is replicated
11 * unmodified and in its entirety in all distributions of the software,
12 * modified or unmodified, in source code or in binary form.
13 *
14 * Redistribution and use in source and binary forms, with or without
15 * modification, are permitted provided that the following conditions are
16 * met: redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer;
18 * redistributions in binary form must reproduce the above copyright
19 * notice, this list of conditions and the following disclaimer in the
20 * documentation and/or other materials provided with the distribution;
21 * neither the name of the copyright holders nor the names of its
22 * contributors may be used to endorse or promote products derived from
23 * this software without specific prior written permission.
24 *
25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
28 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
29 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
30 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
31 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
35 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 *
37 * Authors: Gabe Black
38 */
39
40#ifndef __ARCH_X86_PROCESS_HH__
41#define __ARCH_X86_PROCESS_HH__
42
43#include <string>
44#include <vector>
45
46#include "arch/x86/pagetable.hh"
47#include "mem/multi_level_page_table.hh"
48#include "sim/aux_vector.hh"
49#include "sim/process.hh"
50
51class SyscallDesc;
52
53namespace X86ISA
54{
55    enum X86AuxiliaryVectorTypes {
56        M5_AT_SYSINFO = 32,
57        M5_AT_SYSINFO_EHDR = 33
58    };
59
60    class X86Process : public Process
61    {
62      protected:
63        Addr _gdtStart;
64        Addr _gdtSize;
65
66        SyscallDesc *syscallDescs;
67        const int numSyscallDescs;
68
69        X86Process(ProcessParams * params, ObjectFile *objFile,
70                   SyscallDesc *_syscallDescs, int _numSyscallDescs);
71
72        template<class IntType>
73        void argsInit(int pageSize,
74                      std::vector<AuxVector<IntType> > extraAuxvs);
75
76      public:
77        Addr gdtStart()
78        { return _gdtStart; }
79
80        Addr gdtSize()
81        { return _gdtSize; }
82
83        SyscallDesc* getDesc(int callnum) override;
84
85        void setSyscallReturn(ThreadContext *tc,
86                              SyscallReturn return_value) override;
87        void clone(ThreadContext *old_tc, ThreadContext *new_tc,
88                   Process *process, RegVal flags) override;
89
90        X86Process &
91        operator=(const X86Process &in)
92        {
93            if (this == &in)
94                return *this;
95
96            _gdtStart = in._gdtStart;
97            _gdtSize = in._gdtSize;
98            syscallDescs = in.syscallDescs;
99
100            return *this;
101        }
102    };
103
104    class X86_64Process : public X86Process
105    {
106      protected:
107        X86_64Process(ProcessParams *params, ObjectFile *objFile,
108                      SyscallDesc *_syscallDescs, int _numSyscallDescs);
109
110        class VSyscallPage
111        {
112          public:
113            Addr base;
114            Addr size;
115            Addr vtimeOffset;
116            Addr vgettimeofdayOffset;
117
118            VSyscallPage &
119            operator=(const VSyscallPage &in)
120            {
121                if (this == &in)
122                    return *this;
123
124                base = in.base;
125                size = in.size;
126                vtimeOffset = in.vtimeOffset;
127                vgettimeofdayOffset = in.vgettimeofdayOffset;
128
129                return *this;
130            }
131        };
132        VSyscallPage vsyscallPage;
133
134      public:
135        void argsInit(int pageSize);
136        void initState() override;
137
138        RegVal getSyscallArg(ThreadContext *tc, int &i) override;
139        /// Explicitly import the otherwise hidden getSyscallArg
140        using Process::getSyscallArg;
141        void setSyscallArg(ThreadContext *tc, int i, RegVal val) override;
142        void clone(ThreadContext *old_tc, ThreadContext *new_tc,
143                   Process *process, RegVal flags) override;
144    };
145
146    class I386Process : public X86Process
147    {
148      protected:
149        I386Process(ProcessParams *params, ObjectFile *objFile,
150                    SyscallDesc *_syscallDescs, int _numSyscallDescs);
151
152        class VSyscallPage
153        {
154          public:
155            Addr base;
156            Addr size;
157            Addr vsyscallOffset;
158            Addr vsysexitOffset;
159
160            VSyscallPage &
161            operator=(const VSyscallPage &in)
162            {
163                if (this == &in)
164                    return *this;
165
166                base = in.base;
167                size = in.size;
168                vsyscallOffset = in.vsyscallOffset;
169                vsysexitOffset = in.vsysexitOffset;
170
171                return *this;
172            }
173        };
174        VSyscallPage vsyscallPage;
175
176      public:
177        void argsInit(int pageSize);
178        void initState() override;
179
180        void syscall(int64_t callnum, ThreadContext *tc,
181                     Fault *fault) override;
182        RegVal getSyscallArg(ThreadContext *tc, int &i) override;
183        RegVal getSyscallArg(ThreadContext *tc, int &i, int width) override;
184        void setSyscallArg(ThreadContext *tc, int i, RegVal val) override;
185        void clone(ThreadContext *old_tc, ThreadContext *new_tc,
186                   Process *process, RegVal flags) override;
187    };
188
189}
190
191#endif // __ARCH_X86_PROCESS_HH__
192