debugfaults.hh revision 12334 
14486Sbinkertn@umich.edu/*
24486Sbinkertn@umich.edu * Copyright (c) 2010 Advanced Micro Devices, Inc.
34486Sbinkertn@umich.edu * All rights reserved.
44486Sbinkertn@umich.edu *
54486Sbinkertn@umich.edu * The license below extends only to copyright in the software and shall
64486Sbinkertn@umich.edu * not be construed as granting a license to any other intellectual
74486Sbinkertn@umich.edu * property including but not limited to intellectual property relating
84486Sbinkertn@umich.edu * to a hardware implementation of the functionality of the software
94486Sbinkertn@umich.edu * licensed hereunder.  You may use the software subject to the license
104486Sbinkertn@umich.edu * terms below provided that you ensure that this notice is replicated
114486Sbinkertn@umich.edu * unmodified and in its entirety in all distributions of the software,
124486Sbinkertn@umich.edu * modified or unmodified, in source code or in binary form.
134486Sbinkertn@umich.edu *
144486Sbinkertn@umich.edu * Redistribution and use in source and binary forms, with or without
154486Sbinkertn@umich.edu * modification, are permitted provided that the following conditions are
164486Sbinkertn@umich.edu * met: redistributions of source code must retain the above copyright
174486Sbinkertn@umich.edu * notice, this list of conditions and the following disclaimer;
184486Sbinkertn@umich.edu * redistributions in binary form must reproduce the above copyright
194486Sbinkertn@umich.edu * notice, this list of conditions and the following disclaimer in the
204486Sbinkertn@umich.edu * documentation and/or other materials provided with the distribution;
214486Sbinkertn@umich.edu * neither the name of the copyright holders nor the names of its
224486Sbinkertn@umich.edu * contributors may be used to endorse or promote products derived from
234486Sbinkertn@umich.edu * this software without specific prior written permission.
244486Sbinkertn@umich.edu *
254486Sbinkertn@umich.edu * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
264486Sbinkertn@umich.edu * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
274486Sbinkertn@umich.edu * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
284486Sbinkertn@umich.edu * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
294486Sbinkertn@umich.edu * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
304486Sbinkertn@umich.edu * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
314486Sbinkertn@umich.edu * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
324486Sbinkertn@umich.edu * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
334486Sbinkertn@umich.edu * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
344486Sbinkertn@umich.edu * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
354486Sbinkertn@umich.edu * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
364486Sbinkertn@umich.edu *
374486Sbinkertn@umich.edu * Authors: Gabe Black
384486Sbinkertn@umich.edu */
394486Sbinkertn@umich.edu
404486Sbinkertn@umich.edu#ifndef __ARCH_GENERIC_DEBUGFAULTS_HH__
414486Sbinkertn@umich.edu#define __ARCH_GENERIC_DEBUGFAULTS_HH__
424486Sbinkertn@umich.edu
434486Sbinkertn@umich.edu#include <string>
444486Sbinkertn@umich.edu
454486Sbinkertn@umich.edu#include "base/logging.hh"
464486Sbinkertn@umich.edu#include "sim/faults.hh"
474486Sbinkertn@umich.edu
484486Sbinkertn@umich.edunamespace GenericISA
494486Sbinkertn@umich.edu{
504486Sbinkertn@umich.edu
514486Sbinkertn@umich.educlass M5DebugFault : public FaultBase
524486Sbinkertn@umich.edu{
534486Sbinkertn@umich.edu  public:
544486Sbinkertn@umich.edu    enum DebugFunc
554486Sbinkertn@umich.edu    {
564486Sbinkertn@umich.edu        PanicFunc,
574486Sbinkertn@umich.edu        FatalFunc,
584486Sbinkertn@umich.edu        WarnFunc,
594486Sbinkertn@umich.edu        WarnOnceFunc
604486Sbinkertn@umich.edu    };
614486Sbinkertn@umich.edu
624486Sbinkertn@umich.edu  protected:
634486Sbinkertn@umich.edu    std::string message;
644486Sbinkertn@umich.edu    DebugFunc func;
654486Sbinkertn@umich.edu
664486Sbinkertn@umich.edu  public:
674486Sbinkertn@umich.edu    M5DebugFault(DebugFunc _func, std::string _message) :
684486Sbinkertn@umich.edu        message(_message), func(_func)
694486Sbinkertn@umich.edu    {}
704486Sbinkertn@umich.edu
714486Sbinkertn@umich.edu    FaultName
724486Sbinkertn@umich.edu    name() const
734486Sbinkertn@umich.edu    {
747580SAli.Saidi@arm.com        switch (func) {
75          case PanicFunc:
76            return "panic fault";
77          case FatalFunc:
78            return "fatal fault";
79          case WarnFunc:
80            return "warn fault";
81          case WarnOnceFunc:
82            return "warn_once fault";
83          default:
84            panic("unrecognized debug function number\n");
85        }
86    }
87
88    void
89    invoke(ThreadContext *tc, const StaticInstPtr &inst =
90           StaticInst::nullStaticInstPtr)
91    {
92        switch (func) {
93          case PanicFunc:
94            panic(message);
95            break;
96          case FatalFunc:
97            fatal(message);
98            break;
99          case WarnFunc:
100            warn(message);
101            break;
102          case WarnOnceFunc:
103            warn_once(message);
104            break;
105          default:
106            panic("unrecognized debug function number\n");
107        }
108    }
109};
110
111template <int Func>
112class M5VarArgsFault : public M5DebugFault
113{
114  public:
115    template<typename ...Args>
116    M5VarArgsFault(const std::string &format, const Args &...args) :
117        M5DebugFault((DebugFunc)Func, csprintf(format, args...))
118    {}
119};
120
121typedef M5VarArgsFault<M5DebugFault::PanicFunc> M5PanicFault;
122typedef M5VarArgsFault<M5DebugFault::FatalFunc> M5FatalFault;
123typedef M5VarArgsFault<M5DebugFault::WarnFunc> M5WarnFault;
124typedef M5VarArgsFault<M5DebugFault::WarnOnceFunc> M5WarnOnceFault;
125
126} // namespace GenericISA
127
128#endif // __ARCH_GENERIC_DEBUGFAULTS_HH__
129