1/*
2 * Copyright (c) 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) 2004-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: Nathan Binkert
41 *          Ali Saidi
42 */
43
44#ifndef __KERN_LINUX_EVENTS_HH__
45#define __KERN_LINUX_EVENTS_HH__
46
47#include "kern/system_events.hh"
48
49namespace Linux {
50
51class DebugPrintkEvent : public SkipFuncEvent
52{
53  public:
54    DebugPrintkEvent(PCEventQueue *q, const std::string &desc, Addr addr)
55        : SkipFuncEvent(q, desc, addr) {}
56    virtual void process(ThreadContext *xc);
57};
58
59/**
60 * Dump the guest kernel's dmesg buffer to a file in gem5's output
61 * directory and print a warning.
62 *
63 * @warn This event uses Linux::dumpDmesg() and comes with the same
64 * limitations. Most importantly, the kernel's address mappings must
65 * be available to the translating proxy.
66 */
67class DmesgDumpEvent : public PCEvent
68{
69  protected:
70    std::string fname;
71
72  public:
73    DmesgDumpEvent(PCEventQueue *q, const std::string &desc, Addr addr,
74                   const std::string &_fname)
75        : PCEvent(q, desc, addr), fname(_fname) {}
76    virtual void process(ThreadContext *xc);
77};
78
79/**
80 * Dump the guest kernel's dmesg buffer to a file in gem5's output
81 * directory and panic.
82 *
83 * @warn This event uses Linux::dumpDmesg() and comes with the same
84 * limitations. Most importantly, the kernel's address mappings must
85 * be available to the translating proxy.
86 */
87class KernelPanicEvent : public PCEvent
88{
89  protected:
90    std::string fname;
91
92  public:
93    KernelPanicEvent(PCEventQueue *q, const std::string &desc, Addr addr,
94               const std::string &_fname)
95        : PCEvent(q, desc, addr), fname(_fname) {}
96    virtual void process(ThreadContext *xc);
97};
98
99/** A class to skip udelay() and related calls in the kernel.
100 * This class has two additional parameters that take the argument to udelay and
101 * manipulated it to come up with ns and eventually ticks to quiesce for.
102 * See descriptions of argDivToNs and argMultToNs below.
103 */
104class UDelayEvent : public SkipFuncEvent
105{
106  private:
107    /** value to divide arg by to create ns. This is present beacues the linux
108     * kernel code sometime precomputes the first multiply that is done in
109     * udelay() if the parameter is a constant. We need to undo it so here is
110     * how. */
111    uint64_t argDivToNs;
112
113    /** value to multiple arg by to create ns. Nominally, this is 1000 to
114     * convert us to ns, but since linux can do some preprocessing of constant
115     * values something else might be required. */
116    uint64_t argMultToNs;
117
118  public:
119    UDelayEvent(PCEventQueue *q, const std::string &desc, Addr addr,
120            uint64_t mult, uint64_t div)
121        : SkipFuncEvent(q, desc, addr), argDivToNs(div), argMultToNs(mult) {}
122    virtual void process(ThreadContext *xc);
123};
124
125
126}
127
128#endif
129