1# Copyright (c) 2008 The Hewlett-Packard Development Company
2# All rights reserved.
3#
4# Redistribution and use in source and binary forms, with or without
5# modification, are permitted provided that the following conditions are
6# met: redistributions of source code must retain the above copyright
7# notice, this list of conditions and the following disclaimer;
8# redistributions in binary form must reproduce the above copyright
9# notice, this list of conditions and the following disclaimer in the
10# documentation and/or other materials provided with the distribution;
11# neither the name of the copyright holders nor the names of its
12# contributors may be used to endorse or promote products derived from
13# this software without specific prior written permission.
14#
15# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
18# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
19# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
20# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
21# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26#
27# Authors: Nathan Binkert
28
29from __future__ import print_function
30
31from collections import Mapping
32
33import _m5.debug
34from _m5.debug import SimpleFlag, CompoundFlag
35from _m5.debug import schedBreak, setRemoteGDBPort
36from m5.util import printList
37
38def help():
39    print("Base Flags:")
40    for name in sorted(flags):
41        if name == 'All':
42            continue
43        flag = flags[name]
44        children = [c for c in flag.kids() ]
45        if not children:
46            print("    %s: %s" % (name, flag.desc()))
47    print()
48    print("Compound Flags:")
49    for name in sorted(flags):
50        if name == 'All':
51            continue
52        flag = flags[name]
53        children = [c for c in flag.kids() ]
54        if children:
55            print("    %s: %s" % (name, flag.desc()))
56            printList([ c.name() for c in children ], indent=8)
57    print()
58
59class AllFlags(Mapping):
60    def __init__(self):
61        self._version = -1
62        self._dict = {}
63
64    def _update(self):
65        current_version = _m5.debug.getAllFlagsVersion()
66        if self._version == current_version:
67            return
68
69        self._dict.clear()
70        for name, flag in _m5.debug.allFlags().items():
71            self._dict[name] = flag
72        self._version = current_version
73
74    def __contains__(self, item):
75        self._update()
76        return item in self._dict
77
78    def __getitem__(self, item):
79        self._update()
80        return self._dict[item]
81
82    def __iter__(self):
83        self._update()
84        return iter(self._dict)
85
86    def __len__(self):
87        self._update()
88        return len(self._dict)
89
90    def keys(self):
91        self._update()
92        return self._dict.keys()
93
94    def values(self):
95        self._update()
96        return self._dict.values()
97
98    def items(self):
99        self._update()
100        return self._dict.items()
101
102flags = AllFlags()
103