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-2005 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#ifndef __ARCH_ARM_LINUX_SYSTEM_HH__
44#define __ARCH_ARM_LINUX_SYSTEM_HH__
45
46#include <cstdio>
47#include <map>
48#include <string>
49#include <vector>
50
51#include "arch/arm/system.hh"
52#include "base/output.hh"
53#include "kern/linux/events.hh"
54#include "params/LinuxArmSystem.hh"
55#include "sim/core.hh"
56
57class DumpStatsPCEvent;
58
59class LinuxArmSystem : public GenericArmSystem
60{
61  protected:
62    DumpStatsPCEvent *dumpStatsPCEvent;
63
64  public:
65    /** Boilerplate params code */
66    typedef LinuxArmSystemParams Params;
67    const Params *
68    params() const
69    {
70        return dynamic_cast<const Params *>(_params);
71    }
72
73    /** When enabled, dump stats/task info on context switches for
74     *  Streamline and per-thread cache occupancy studies, etc. */
75    bool enableContextSwitchStatsDump;
76
77    /** This map stores a mapping of OS process IDs to internal Task IDs. The
78     * mapping is done because the stats system doesn't tend to like vectors
79     * that are much greater than 1000 items and the entire process space is
80     * 65K. */
81    std::map<uint32_t, uint32_t> taskMap;
82
83    /** This is a file that is placed in the run directory that prints out
84     * mappings between taskIds and OS process IDs */
85    OutputStream* taskFile;
86
87    LinuxArmSystem(Params *p);
88    ~LinuxArmSystem();
89
90    void initState();
91
92    void startup();
93
94    /** This function creates a new task Id for the given pid.
95     * @param tc thread context that is currentyl executing  */
96    void mapPid(ThreadContext* tc, uint32_t pid);
97
98  public: // Exported Python methods
99    /**
100     * Dump the kernel's dmesg buffer to stdout
101     */
102    void dumpDmesg();
103
104  private:
105    /** Event to halt the simulator if the kernel calls panic()  */
106    PCEvent *kernelPanicEvent;
107
108    /** Event to halt the simulator if the kernel calls oopses  */
109    PCEvent *kernelOopsEvent;
110
111    /**
112     * PC based event to skip udelay(<time>) calls and quiesce the
113     * processor for the appropriate amount of time. This is not functionally
114     * required but does speed up simulation.
115     */
116    Linux::UDelayEvent *uDelaySkipEvent;
117
118    /** Another PC based skip event for const_udelay(). Similar to the udelay
119     * skip, but this function precomputes the first multiply that is done
120     * in the generic case since the parameter is known at compile time.
121     * Thus we need to do some division to get back to us.
122     */
123    Linux::UDelayEvent *constUDelaySkipEvent;
124
125};
126
127class DumpStatsPCEvent : public PCEvent
128{
129  public:
130    DumpStatsPCEvent(PCEventQueue *q, const std::string &desc, Addr addr)
131        : PCEvent(q, desc, addr)
132    {}
133
134    virtual void process(ThreadContext* tc);
135  protected:
136    virtual void getTaskDetails(ThreadContext *tc, uint32_t &pid,
137            uint32_t &tgid, std::string &next_task_str, int32_t &mm);
138
139};
140
141class DumpStatsPCEvent64 : public DumpStatsPCEvent {
142  public:
143    DumpStatsPCEvent64(PCEventQueue *q, const std::string &desc, Addr addr)
144        : DumpStatsPCEvent(q, desc, addr)
145    {}
146  private:
147    void getTaskDetails(ThreadContext *tc, uint32_t &pid, uint32_t &tgid,
148                        std::string &next_task_str, int32_t &mm) override;
149};
150
151
152#endif // __ARCH_ARM_LINUX_SYSTEM_HH__
153
154