source: mainline/tools/checkers/stanse/stanse.py@ 8786aa5

#!/usr/bin/env python
#
# Copyright (c) 2010 Martin Decky
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
#
# - Redistributions of source code must retain the above copyright
#   notice, this list of conditions and the following disclaimer.
# - Redistributions in binary form must reproduce the above copyright
#   notice, this list of conditions and the following disclaimer in the
#   documentation and/or other materials provided with the distribution.
# - The name of the author may not be used to endorse or promote products
#   derived from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
# IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
# NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
# THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#
"""
Wrapper for Stanse static checker
"""

import sys
import os
import subprocess

jobs = [
        "kernel/kernel.job",
        "uspace/srv/clip/clip.job"
]

def usage(prname):
        "Print usage syntax"
        print prname + " <ROOT>"

def parse_arg(record):
        "Parse jobfile line arguments"
        
        arg = []
        i = 0
        current = ""
        nil = True
        inside = False
        
        while (i < len(record)):
                if (inside):
                        if (record[i] == "}"):
                                inside = False
                        else:
                                current = "%s%s" % (current, record[i])
                else:
                        if (record[i] == "{"):
                                nil = False
                                inside = True
                        elif (record[i] == ","):
                                arg.append(current)
                                current = ""
                                nil = True
                        else:
                                print "Unexpected '%s'" % record[i]
                                return False
                
                i += 1
        
        if (not nil):
                arg.append(current)
        
        return arg

def stanse(root, job):
        "Run Stanse on a jobfile"
        
        # Convert generic jobfile to Stanse-specific jobfile format
        
        inname = os.path.join(root, job)
        outname = os.path.join(root, "_%s" % os.path.basename(job))
        
        if (not os.path.isfile(inname)):
                print "Unable to open %s" % inname
                print "Did you run \"make precheck\" on the source tree?"
                return False
        
        inf = file(inname, "r")
        records = inf.read().splitlines()
        inf.close()
        
        output = []
        for record in records:
                arg = parse_arg(record)
                if (not arg):
                        return False
                
                if (len(arg) < 6):
                        print "Not enought jobfile record arguments"
                        return False
                
                srcfname = arg[0]
                tgtfname = arg[1]
                base = arg[4]
                options = arg[5]
                
                srcfqname = os.path.join(base, srcfname)
                if (not os.path.isfile(srcfqname)):
                        print "Source %s not found" % srcfqname
                        return False
                
                # Only C files are interesting for us
                if (arg[2] != "cc"):
                        continue
                
                output.append([srcfname, tgtfname, base, options])
        
        outf = file(outname, "w")
        for record in output:
                outf.write("{%s},{%s},{%s},{%s}\n" % (record[0], record[1], record[2], record[3]))
        outf.close()
        
        # Run Stanse
        
        retval = subprocess.Popen(['stanse', '--checker', 'ReachabilityChecker', '--jobfile', outname]).wait()
        
        # Cleanup
        
        os.remove(outname)
        for record in output:
                tmpfile = os.path.join(record[2], "%s.preproc" % record[1])
                if (os.path.isfile(tmpfile)):
                        os.remove(tmpfile)
        
        if (retval == 0):
                return True
        
        return False

def main():
        if (len(sys.argv) < 2):
                usage(sys.argv[0])
                return
        
        rootdir = os.path.abspath(sys.argv[1])
        config = os.path.join(rootdir, "HelenOS.config")
        
        if (not os.path.isfile(config)):
                print "%s not found." % config
                print "Please specify the path to HelenOS build tree root as the first argument."
                return
        
        for job in jobs:
                if (not stanse(rootdir, job)):
                        print
                        print "Failed job: %s" % job
                        return
        
        print
        print "All jobs passed"

if __name__ == '__main__':
        main()