system.cc revision 11463:d9e32a851e2e 
1/*
2 * Copyright (c) 2010-2013 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 "mem/fs_translating_port_proxy.hh"
57#include "mem/physical.hh"
58#include "sim/stat_control.hh"
59
60using namespace ArmISA;
61using namespace Linux;
62
63LinuxArmSystem::LinuxArmSystem(Params *p)
64    : GenericArmSystem(p), dumpStatsPCEvent(nullptr),
65      enableContextSwitchStatsDump(p->enable_context_switch_stats_dump),
66      taskFile(nullptr), kernelPanicEvent(nullptr), kernelOopsEvent(nullptr)
67{
68    if (p->panic_on_panic) {
69        kernelPanicEvent = addKernelFuncEventOrPanic<PanicPCEvent>(
70            "panic", "Kernel panic in simulated kernel");
71    }
72
73    if (p->panic_on_oops) {
74        kernelOopsEvent = addKernelFuncEventOrPanic<PanicPCEvent>(
75            "oops_exit", "Kernel oops in guest");
76    }
77
78    // With ARM udelay() is #defined to __udelay
79    // newer kernels use __loop_udelay and __loop_const_udelay symbols
80    uDelaySkipEvent = addKernelFuncEvent<UDelayEvent>(
81        "__loop_udelay", "__udelay", 1000, 0);
82    if (!uDelaySkipEvent)
83        uDelaySkipEvent = addKernelFuncEventOrPanic<UDelayEvent>(
84         "__udelay", "__udelay", 1000, 0);
85
86    // constant arguments to udelay() have some precomputation done ahead of
87    // time. Constant comes from code.
88    constUDelaySkipEvent = addKernelFuncEvent<UDelayEvent>(
89        "__loop_const_udelay", "__const_udelay", 1000, 107374);
90    if (!constUDelaySkipEvent)
91        constUDelaySkipEvent = addKernelFuncEventOrPanic<UDelayEvent>(
92         "__const_udelay", "__const_udelay", 1000, 107374);
93
94}
95
96void
97LinuxArmSystem::initState()
98{
99    // Moved from the constructor to here since it relies on the
100    // address map being resolved in the interconnect
101
102    // Call the initialisation of the super class
103    GenericArmSystem::initState();
104
105    // Load symbols at physical address, we might not want
106    // to do this permanently, for but early bootup work
107    // it is helpful.
108    if (params()->early_kernel_symbols) {
109        kernel->loadGlobalSymbols(kernelSymtab, 0, 0, loadAddrMask);
110        kernel->loadGlobalSymbols(debugSymbolTable, 0, 0, loadAddrMask);
111    }
112
113    // Setup boot data structure
114    Addr addr = 0;
115    // Check if the kernel image has a symbol that tells us it supports
116    // device trees.
117    bool kernel_has_fdt_support =
118        kernelSymtab->findAddress("unflatten_device_tree", addr);
119    bool dtb_file_specified = params()->dtb_filename != "";
120
121    if (kernel_has_fdt_support && dtb_file_specified) {
122        // Kernel supports flattened device tree and dtb file specified.
123        // Using Device Tree Blob to describe system configuration.
124        inform("Loading DTB file: %s at address %#x\n", params()->dtb_filename,
125                params()->atags_addr + loadAddrOffset);
126
127        ObjectFile *dtb_file = createObjectFile(params()->dtb_filename, true);
128        if (!dtb_file) {
129            fatal("couldn't load DTB file: %s\n", params()->dtb_filename);
130        }
131
132        DtbObject *_dtb_file = dynamic_cast<DtbObject*>(dtb_file);
133
134        if (_dtb_file) {
135            if (!_dtb_file->addBootCmdLine(params()->boot_osflags.c_str(),
136                                           params()->boot_osflags.size())) {
137                warn("couldn't append bootargs to DTB file: %s\n",
138                     params()->dtb_filename);
139            }
140        } else {
141            warn("dtb_file cast failed; couldn't append bootargs "
142                 "to DTB file: %s\n", params()->dtb_filename);
143        }
144
145        dtb_file->setTextBase(params()->atags_addr + loadAddrOffset);
146        dtb_file->loadSections(physProxy);
147        delete dtb_file;
148    } else {
149        // Using ATAGS
150        // Warn if the kernel supports FDT and we haven't specified one
151        if (kernel_has_fdt_support) {
152            assert(!dtb_file_specified);
153            warn("Kernel supports device tree, but no DTB file specified\n");
154        }
155        // Warn if the kernel doesn't support FDT and we have specified one
156        if (dtb_file_specified) {
157            assert(!kernel_has_fdt_support);
158            warn("DTB file specified, but no device tree support in kernel\n");
159        }
160
161        AtagCore ac;
162        ac.flags(1); // read-only
163        ac.pagesize(8192);
164        ac.rootdev(0);
165
166        AddrRangeList atagRanges = physmem.getConfAddrRanges();
167        if (atagRanges.size() != 1) {
168            fatal("Expected a single ATAG memory entry but got %d\n",
169                  atagRanges.size());
170        }
171        AtagMem am;
172        am.memSize(atagRanges.begin()->size());
173        am.memStart(atagRanges.begin()->start());
174
175        AtagCmdline ad;
176        ad.cmdline(params()->boot_osflags);
177
178        DPRINTF(Loader, "boot command line %d bytes: %s\n",
179                ad.size() <<2, params()->boot_osflags.c_str());
180
181        AtagNone an;
182
183        uint32_t size = ac.size() + am.size() + ad.size() + an.size();
184        uint32_t offset = 0;
185        uint8_t *boot_data = new uint8_t[size << 2];
186
187        offset += ac.copyOut(boot_data + offset);
188        offset += am.copyOut(boot_data + offset);
189        offset += ad.copyOut(boot_data + offset);
190        offset += an.copyOut(boot_data + offset);
191
192        DPRINTF(Loader, "Boot atags was %d bytes in total\n", size << 2);
193        DDUMP(Loader, boot_data, size << 2);
194
195        physProxy.writeBlob(params()->atags_addr + loadAddrOffset, boot_data,
196                size << 2);
197
198        delete[] boot_data;
199    }
200
201    // Kernel boot requirements to set up r0, r1 and r2 in ARMv7
202    for (int i = 0; i < threadContexts.size(); i++) {
203        threadContexts[i]->setIntReg(0, 0);
204        threadContexts[i]->setIntReg(1, params()->machine_type);
205        threadContexts[i]->setIntReg(2, params()->atags_addr + loadAddrOffset);
206    }
207}
208
209LinuxArmSystem::~LinuxArmSystem()
210{
211    if (uDelaySkipEvent)
212        delete uDelaySkipEvent;
213    if (constUDelaySkipEvent)
214        delete constUDelaySkipEvent;
215
216    if (dumpStatsPCEvent)
217        delete dumpStatsPCEvent;
218}
219
220LinuxArmSystem *
221LinuxArmSystemParams::create()
222{
223    return new LinuxArmSystem(this);
224}
225
226void
227LinuxArmSystem::startup()
228{
229    if (enableContextSwitchStatsDump) {
230        dumpStatsPCEvent = addKernelFuncEvent<DumpStatsPCEvent>("__switch_to");
231        if (!dumpStatsPCEvent)
232           panic("dumpStatsPCEvent not created!");
233
234        std::string task_filename = "tasks.txt";
235        taskFile = simout.create(name() + "." + task_filename);
236
237        for (int i = 0; i < _numContexts; i++) {
238            ThreadContext *tc = threadContexts[i];
239            uint32_t pid = tc->getCpuPtr()->getPid();
240            if (pid != BaseCPU::invldPid) {
241                mapPid(tc, pid);
242                tc->getCpuPtr()->taskId(taskMap[pid]);
243            }
244        }
245    }
246}
247
248void
249LinuxArmSystem::mapPid(ThreadContext *tc, uint32_t pid)
250{
251    // Create a new unique identifier for this pid
252    std::map<uint32_t, uint32_t>::iterator itr = taskMap.find(pid);
253    if (itr == taskMap.end()) {
254        uint32_t map_size = taskMap.size();
255        if (map_size > ContextSwitchTaskId::MaxNormalTaskId + 1) {
256            warn_once("Error out of identifiers for cache occupancy stats");
257            taskMap[pid] = ContextSwitchTaskId::Unknown;
258        } else {
259            taskMap[pid] = map_size;
260        }
261    }
262}
263
264/** This function is called whenever the the kernel function
265 *  "__switch_to" is called to change running tasks.
266 *
267 *  r0 = task_struct of the previously running process
268 *  r1 = task_info of the previously running process
269 *  r2 = task_info of the next process to run
270 */
271void
272DumpStatsPCEvent::process(ThreadContext *tc)
273{
274    Linux::ThreadInfo ti(tc);
275    Addr task_descriptor = tc->readIntReg(2);
276    uint32_t pid = ti.curTaskPID(task_descriptor);
277    uint32_t tgid = ti.curTaskTGID(task_descriptor);
278    std::string next_task_str = ti.curTaskName(task_descriptor);
279
280    // Streamline treats pid == -1 as the kernel process.
281    // Also pid == 0 implies idle process (except during Linux boot)
282    int32_t mm = ti.curTaskMm(task_descriptor);
283    bool is_kernel = (mm == 0);
284    if (is_kernel && (pid != 0)) {
285        pid = -1;
286        tgid = -1;
287        next_task_str = "kernel";
288    }
289
290    LinuxArmSystem* sys = dynamic_cast<LinuxArmSystem *>(tc->getSystemPtr());
291    if (!sys) {
292        panic("System is not LinuxArmSystem while getting Linux process info!");
293    }
294    std::map<uint32_t, uint32_t>& taskMap = sys->taskMap;
295
296    // Create a new unique identifier for this pid
297    sys->mapPid(tc, pid);
298
299    // Set cpu task id, output process info, and dump stats
300    tc->getCpuPtr()->taskId(taskMap[pid]);
301    tc->getCpuPtr()->setPid(pid);
302
303    OutputStream* taskFile = sys->taskFile;
304
305    // Task file is read by cache occupancy plotting script or
306    // Streamline conversion script.
307    ccprintf(*(taskFile->stream()),
308             "tick=%lld %d cpu_id=%d next_pid=%d next_tgid=%d next_task=%s\n",
309             curTick(), taskMap[pid], tc->cpuId(), (int) pid, (int) tgid,
310             next_task_str);
311    taskFile->stream()->flush();
312
313    // Dump and reset statistics
314    Stats::schedStatEvent(true, true, curTick(), 0);
315}
316
317