src/arch/arm/linux/system.cc

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