cpt_upgrader.py revision 9048:950298f29140 
1#!/usr/bin/env python
2
3# Copyright (c) 2012 ARM Limited
4# All rights reserved
5#
6# The license below extends only to copyright in the software and shall
7# not be construed as granting a license to any other intellectual
8# property including but not limited to intellectual property relating
9# to a hardware implementation of the functionality of the software
10# licensed hereunder.  You may use the software subject to the license
11# terms below provided that you ensure that this notice is replicated
12# unmodified and in its entirety in all distributions of the software,
13# modified or unmodified, in source code or in binary form.
14#
15# Redistribution and use in source and binary forms, with or without
16# modification, are permitted provided that the following conditions are
17# met: redistributions of source code must retain the above copyright
18# notice, this list of conditions and the following disclaimer;
19# redistributions in binary form must reproduce the above copyright
20# notice, this list of conditions and the following disclaimer in the
21# documentation and/or other materials provided with the distribution;
22# neither the name of the copyright holders nor the names of its
23# contributors may be used to endorse or promote products derived from
24# this software without specific prior written permission.
25#
26# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
27# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
28# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
29# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
30# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
31# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
32# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
33# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
34# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
35# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
36# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37#
38# Authors: Ali Saidi
39#
40
41import ConfigParser
42import sys, os
43import os.path as osp
44
45def from_0(cpt):
46    pass
47
48# An example of a translator
49def from_1(cpt):
50    if cpt.get('root','isa') == 'arm':
51        for sec in cpt.sections():
52            import re
53            # Search for all the execution contexts
54            if re.search('.*sys.*\.cpu.*\.x.\..*', sec):
55                # Update each one
56                mr = cpt.get(sec, 'miscRegs').split()
57                #mr.insert(21,0)
58                #mr.insert(26,0)
59                cpt.set(sec, 'miscRegs', ' '.join(str(x) for x in mr))
60
61migrations = []
62migrations.append(from_0)
63migrations.append(from_1)
64
65verbose_print = False
66
67def verboseprint(*args):
68    if not verbose_print:
69        return
70    for arg in args:
71        print arg,
72    print
73
74def process_file(path, **kwargs):
75    if not osp.isfile(path):
76        import errno
77        raise IOError(ennro.ENOENT, "No such file", path)
78
79    verboseprint("Processing file %s...." % path)
80
81    if kwargs.get('backup', True):
82        import shutil
83        shutil.copyfile(path, path + '.bak')
84
85    cpt = ConfigParser.SafeConfigParser()
86
87    # gem5 is case sensitive with paramaters
88    cpt.optionxform = str
89
90    # Read the current data
91    cpt_file = file(path, 'r')
92    cpt.readfp(cpt_file)
93    cpt_file.close()
94
95    # Make sure we know what we're starting from
96    if not cpt.has_option('root','cpt_ver'):
97        raise LookupError("cannot determine version of checkpoint")
98
99    cpt_ver = cpt.getint('root','cpt_ver')
100
101    # If the current checkpoint is longer than the migrations list, we have a problem
102    # and someone didn't update this file
103    if cpt_ver > len(migrations):
104        raise ValueError("upgrade script is too old and needs updating")
105
106    verboseprint("\t...file is at version %#x" % cpt_ver)
107
108    if cpt_ver == len(migrations):
109        verboseprint("\t...nothing to do")
110        return
111
112    # Walk through every function from now until the end fixing the checkpoint
113    for v in xrange(cpt_ver,len(migrations)):
114        verboseprint("\t...migrating to version %#x" %  (v + 1))
115        migrations[v](cpt)
116        cpt.set('root','cpt_ver', str(v + 1))
117
118    # Write the old data back
119    verboseprint("\t...completed")
120    cpt.write(file(path, 'w'))
121
122
123if __name__ == '__main__':
124    from optparse import OptionParser
125    parser = OptionParser("usage: %prog [options] <filename or directory>")
126    parser.add_option("-r", "--recurse", action="store_true",
127                      help="Recurse through all subdirectories modifying "\
128                           "each checkpoint that is found")
129    parser.add_option("-N", "--no-backup", action="store_false",
130                      dest="backup", default=True,
131                      help="Do no backup each checkpoint before modifying it")
132    parser.add_option("-v", "--verbose", action="store_true",
133                      help="Print out debugging information as")
134
135    (options, args) = parser.parse_args()
136    if len(args) != 1:
137        parser.error("You must specify a checkpoint file to modify or a "\
138                     "directory of checkpoints to recursively update")
139
140    verbose_print = options.verbose
141
142    # Deal with shell variables and ~
143    path = osp.expandvars(osp.expanduser(args[0]))
144
145    # Process a single file if we have it
146    if osp.isfile(path):
147        process_file(path, **vars(options))
148    # Process an entire directory
149    elif osp.isdir(path):
150        cpt_file = osp.join(path, 'm5.cpt')
151        if options.recurse:
152            # Visit very file and see if it matches
153            for root,dirs,files in os.walk(path):
154                for name in files:
155                    if name == 'm5.cpt':
156                        process_file(osp.join(root,name), **vars(options))
157                for dir in dirs:
158                    pass
159        # Maybe someone passed a cpt.XXXXXXX directory and not m5.cpt
160        elif osp.isfile(cpt_file):
161            process_file(cpt_file, **vars(options))
162        else:
163            print "Error: checkpoint file not found at in %s " % path,
164            print "and recurse not specified"
165            sys.exit(1)
166    sys.exit(0)
167
168