system.cc revision 11538:55014a40512c 
1/*
2 * Copyright (c) 2010-2013, 2016 ARM Limited
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 * Copyright (c) 2002-2006 The Regents of The University of Michigan
15 * All rights reserved.
16 *
17 * Redistribution and use in source and binary forms, with or without
18 * modification, are permitted provided that the following conditions are
19 * met: redistributions of source code must retain the above copyright
20 * notice, this list of conditions and the following disclaimer;
21 * redistributions in binary form must reproduce the above copyright
22 * notice, this list of conditions and the following disclaimer in the
23 * documentation and/or other materials provided with the distribution;
24 * neither the name of the copyright holders nor the names of its
25 * contributors may be used to endorse or promote products derived from
26 * this software without specific prior written permission.
27 *
28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
29 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
30 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
31 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
32 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
33 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
34 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
36 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
38 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39 *
40 * Authors: Ali Saidi
41 */
42
43#include "arch/arm/linux/atag.hh"
44#include "arch/arm/linux/system.hh"
45#include "arch/arm/isa_traits.hh"
46#include "arch/arm/utility.hh"
47#include "arch/generic/linux/threadinfo.hh"
48#include "base/loader/dtb_object.hh"
49#include "base/loader/object_file.hh"
50#include "base/loader/symtab.hh"
51#include "cpu/base.hh"
52#include "cpu/pc_event.hh"
53#include "cpu/thread_context.hh"
54#include "debug/Loader.hh"
55#include "kern/linux/events.hh"
56#include "kern/linux/helpers.hh"
57#include "mem/fs_translating_port_proxy.hh"
58#include "mem/physical.hh"
59#include "sim/stat_control.hh"
60
61using namespace ArmISA;
62using namespace Linux;
63
64LinuxArmSystem::LinuxArmSystem(Params *p)
65    : GenericArmSystem(p), dumpStatsPCEvent(nullptr),
66      enableContextSwitchStatsDump(p->enable_context_switch_stats_dump),
67      taskFile(nullptr), kernelPanicEvent(nullptr), kernelOopsEvent(nullptr)
68{
69    const std::string dmesg_output = name() + ".dmesg";
70    if (p->panic_on_panic) {
71        kernelPanicEvent = addKernelFuncEventOrPanic<Linux::KernelPanicEvent>(
72            "panic", "Kernel panic in simulated kernel", dmesg_output);
73    } else {
74        kernelPanicEvent = addKernelFuncEventOrPanic<Linux::DmesgDumpEvent>(
75            "panic", "Kernel panic in simulated kernel", dmesg_output);
76    }
77
78    if (p->panic_on_oops) {
79        kernelOopsEvent = addKernelFuncEventOrPanic<Linux::KernelPanicEvent>(
80            "oops_exit", "Kernel oops in guest", dmesg_output);
81    } else {
82        kernelOopsEvent = addKernelFuncEventOrPanic<Linux::DmesgDumpEvent>(
83            "oops_exit", "Kernel oops in guest", dmesg_output);
84    }
85
86    // With ARM udelay() is #defined to __udelay
87    // newer kernels use __loop_udelay and __loop_const_udelay symbols
88    uDelaySkipEvent = addKernelFuncEvent<UDelayEvent>(
89        "__loop_udelay", "__udelay", 1000, 0);
90    if (!uDelaySkipEvent)
91        uDelaySkipEvent = addKernelFuncEventOrPanic<UDelayEvent>(
92         "__udelay", "__udelay", 1000, 0);
93
94    // constant arguments to udelay() have some precomputation done ahead of
95    // time. Constant comes from code.
96    constUDelaySkipEvent = addKernelFuncEvent<UDelayEvent>(
97        "__loop_const_udelay", "__const_udelay", 1000, 107374);
98    if (!constUDelaySkipEvent)
99        constUDelaySkipEvent = addKernelFuncEventOrPanic<UDelayEvent>(
100         "__const_udelay", "__const_udelay", 1000, 107374);
101
102}
103
104void
105LinuxArmSystem::initState()
106{
107    // Moved from the constructor to here since it relies on the
108    // address map being resolved in the interconnect
109
110    // Call the initialisation of the super class
111    GenericArmSystem::initState();
112
113    // Load symbols at physical address, we might not want
114    // to do this permanently, for but early bootup work
115    // it is helpful.
116    if (params()->early_kernel_symbols) {
117        kernel->loadGlobalSymbols(kernelSymtab, 0, 0, loadAddrMask);
118        kernel->loadGlobalSymbols(debugSymbolTable, 0, 0, loadAddrMask);
119    }
120
121    // Setup boot data structure
122    Addr addr = 0;
123    // Check if the kernel image has a symbol that tells us it supports
124    // device trees.
125    bool kernel_has_fdt_support =
126        kernelSymtab->findAddress("unflatten_device_tree", addr);
127    bool dtb_file_specified = params()->dtb_filename != "";
128
129    if (kernel_has_fdt_support && dtb_file_specified) {
130        // Kernel supports flattened device tree and dtb file specified.
131        // Using Device Tree Blob to describe system configuration.
132        inform("Loading DTB file: %s at address %#x\n", params()->dtb_filename,
133                params()->atags_addr + loadAddrOffset);
134
135        ObjectFile *dtb_file = createObjectFile(params()->dtb_filename, true);
136        if (!dtb_file) {
137            fatal("couldn't load DTB file: %s\n", params()->dtb_filename);
138        }
139
140        DtbObject *_dtb_file = dynamic_cast<DtbObject*>(dtb_file);
141
142        if (_dtb_file) {
143            if (!_dtb_file->addBootCmdLine(params()->boot_osflags.c_str(),
144                                           params()->boot_osflags.size())) {
145                warn("couldn't append bootargs to DTB file: %s\n",
146                     params()->dtb_filename);
147            }
148        } else {
149            warn("dtb_file cast failed; couldn't append bootargs "
150                 "to DTB file: %s\n", params()->dtb_filename);
151        }
152
153        dtb_file->setTextBase(params()->atags_addr + loadAddrOffset);
154        dtb_file->loadSections(physProxy);
155        delete dtb_file;
156    } else {
157        // Using ATAGS
158        // Warn if the kernel supports FDT and we haven't specified one
159        if (kernel_has_fdt_support) {
160            assert(!dtb_file_specified);
161            warn("Kernel supports device tree, but no DTB file specified\n");
162        }
163        // Warn if the kernel doesn't support FDT and we have specified one
164        if (dtb_file_specified) {
165            assert(!kernel_has_fdt_support);
166            warn("DTB file specified, but no device tree support in kernel\n");
167        }
168
169        AtagCore ac;
170        ac.flags(1); // read-only
171        ac.pagesize(8192);
172        ac.rootdev(0);
173
174        AddrRangeList atagRanges = physmem.getConfAddrRanges();
175        if (atagRanges.size() != 1) {
176            fatal("Expected a single ATAG memory entry but got %d\n",
177                  atagRanges.size());
178        }
179        AtagMem am;
180        am.memSize(atagRanges.begin()->size());
181        am.memStart(atagRanges.begin()->start());
182
183        AtagCmdline ad;
184        ad.cmdline(params()->boot_osflags);
185
186        DPRINTF(Loader, "boot command line %d bytes: %s\n",
187                ad.size() <<2, params()->boot_osflags.c_str());
188
189        AtagNone an;
190
191        uint32_t size = ac.size() + am.size() + ad.size() + an.size();
192        uint32_t offset = 0;
193        uint8_t *boot_data = new uint8_t[size << 2];
194
195        offset += ac.copyOut(boot_data + offset);
196        offset += am.copyOut(boot_data + offset);
197        offset += ad.copyOut(boot_data + offset);
198        offset += an.copyOut(boot_data + offset);
199
200        DPRINTF(Loader, "Boot atags was %d bytes in total\n", size << 2);
201        DDUMP(Loader, boot_data, size << 2);
202
203        physProxy.writeBlob(params()->atags_addr + loadAddrOffset, boot_data,
204                size << 2);
205
206        delete[] boot_data;
207    }
208
209    // Kernel boot requirements to set up r0, r1 and r2 in ARMv7
210    for (int i = 0; i < threadContexts.size(); i++) {
211        threadContexts[i]->setIntReg(0, 0);
212        threadContexts[i]->setIntReg(1, params()->machine_type);
213        threadContexts[i]->setIntReg(2, params()->atags_addr + loadAddrOffset);
214    }
215}
216
217LinuxArmSystem::~LinuxArmSystem()
218{
219    if (uDelaySkipEvent)
220        delete uDelaySkipEvent;
221    if (constUDelaySkipEvent)
222        delete constUDelaySkipEvent;
223
224    if (dumpStatsPCEvent)
225        delete dumpStatsPCEvent;
226}
227
228LinuxArmSystem *
229LinuxArmSystemParams::create()
230{
231    return new LinuxArmSystem(this);
232}
233
234void
235LinuxArmSystem::startup()
236{
237    if (enableContextSwitchStatsDump) {
238        dumpStatsPCEvent = addKernelFuncEvent<DumpStatsPCEvent>("__switch_to");
239        if (!dumpStatsPCEvent)
240           panic("dumpStatsPCEvent not created!");
241
242        std::string task_filename = "tasks.txt";
243        taskFile = simout.create(name() + "." + task_filename);
244
245        for (int i = 0; i < _numContexts; i++) {
246            ThreadContext *tc = threadContexts[i];
247            uint32_t pid = tc->getCpuPtr()->getPid();
248            if (pid != BaseCPU::invldPid) {
249                mapPid(tc, pid);
250                tc->getCpuPtr()->taskId(taskMap[pid]);
251            }
252        }
253    }
254}
255
256void
257LinuxArmSystem::mapPid(ThreadContext *tc, uint32_t pid)
258{
259    // Create a new unique identifier for this pid
260    std::map<uint32_t, uint32_t>::iterator itr = taskMap.find(pid);
261    if (itr == taskMap.end()) {
262        uint32_t map_size = taskMap.size();
263        if (map_size > ContextSwitchTaskId::MaxNormalTaskId + 1) {
264            warn_once("Error out of identifiers for cache occupancy stats");
265            taskMap[pid] = ContextSwitchTaskId::Unknown;
266        } else {
267            taskMap[pid] = map_size;
268        }
269    }
270}
271
272void
273LinuxArmSystem::dumpDmesg()
274{
275    Linux::dumpDmesg(getThreadContext(0), std::cout);
276}
277
278/** This function is called whenever the the kernel function
279 *  "__switch_to" is called to change running tasks.
280 *
281 *  r0 = task_struct of the previously running process
282 *  r1 = task_info of the previously running process
283 *  r2 = task_info of the next process to run
284 */
285void
286DumpStatsPCEvent::process(ThreadContext *tc)
287{
288    Linux::ThreadInfo ti(tc);
289    Addr task_descriptor = tc->readIntReg(2);
290    uint32_t pid = ti.curTaskPID(task_descriptor);
291    uint32_t tgid = ti.curTaskTGID(task_descriptor);
292    std::string next_task_str = ti.curTaskName(task_descriptor);
293
294    // Streamline treats pid == -1 as the kernel process.
295    // Also pid == 0 implies idle process (except during Linux boot)
296    int32_t mm = ti.curTaskMm(task_descriptor);
297    bool is_kernel = (mm == 0);
298    if (is_kernel && (pid != 0)) {
299        pid = -1;
300        tgid = -1;
301        next_task_str = "kernel";
302    }
303
304    LinuxArmSystem* sys = dynamic_cast<LinuxArmSystem *>(tc->getSystemPtr());
305    if (!sys) {
306        panic("System is not LinuxArmSystem while getting Linux process info!");
307    }
308    std::map<uint32_t, uint32_t>& taskMap = sys->taskMap;
309
310    // Create a new unique identifier for this pid
311    sys->mapPid(tc, pid);
312
313    // Set cpu task id, output process info, and dump stats
314    tc->getCpuPtr()->taskId(taskMap[pid]);
315    tc->getCpuPtr()->setPid(pid);
316
317    OutputStream* taskFile = sys->taskFile;
318
319    // Task file is read by cache occupancy plotting script or
320    // Streamline conversion script.
321    ccprintf(*(taskFile->stream()),
322             "tick=%lld %d cpu_id=%d next_pid=%d next_tgid=%d next_task=%s\n",
323             curTick(), taskMap[pid], tc->cpuId(), (int) pid, (int) tgid,
324             next_task_str);
325    taskFile->stream()->flush();
326
327    // Dump and reset statistics
328    Stats::schedStatEvent(true, true, curTick(), 0);
329}
330
331