Polishing the store feature so that it is easily usable.

Author: ianamason

README.md

@@ -223,13 +223,18 @@ Building a bitcode archive then extracting the bitcode
     ls -la
 
 
-Put the bitcode files in a store
+Preserving bitcode files in a store
 --------------------------------
 
-Sometimes it can be useful to put the bitcode files out of the build folder, to prevent
-deletion or to retrieve it later. If the environment variable `WLLVM_BC_STORE` is set to
-an existing directory, then WLLVM will copy the produced bitcode file into that directory,
-using a hash of the path to the original bitcode file as a name for the stored copy.
+Sometimes it can be useful to preserve the bitcode files produced in a
+build, either to prevent deletion or to retrieve it later. If the
+environment variable `WLLVM_BC_STORE` is set to the absolute path of
+an existing directory,
+then WLLVM will copy the produced bitcode file into that directory.
+The name of the copied bitcode file is the hash of the path to the
+original bitcode file.  For convenience, when using both the manifest
+feature of `extract-bc` and the store, the manifest will contain both
+the original path, and the store path.
 
 
 Debugging

test/test_files/Makefile

@@ -1,5 +1,6 @@
 #iam: please leave this Makefile; it is useful for debugging when things break.
 
+all: one archive
 
 zero:
 	${CXX} hello.cc -o hello

wllvm/checker.py

@@ -91,6 +91,7 @@ def check(self):
         1. Check that the OS is supported.
         2. Checks that the compiler settings make sense.
         3. Checks that the needed LLVM utilities exists.
+        4. Check that the store, if set, exists.
         """
 
         if not self.checkOS():
@@ -101,6 +102,7 @@ def check(self):
 
         if success:
             self.checkAuxiliaries()
+            self.checkStore()
 
         return 0 if success else 1
 
@@ -264,6 +266,17 @@ def checkAuxiliaries(self):
             print('The bitcode archiver {0} is:\n\n{1}\n'.format(ar, extractLine(arVersion, 1)))
 
 
+    def checkStore(self):
+        """Checks that the bitcode store, if set, makes sense."""
+        store_dir = os.getenv('WLLVM_BC_STORE')
+        if store_dir:
+            if os.path.exists(store_dir) and os.path.isdir(store_dir) and os.path.isabs(store_dir):
+                print('Using the bitcode store:\n\n\t{0}\n\n'.format(store_dir))
+            else:
+                print('The bitcode store:\n\n\t{0}\n\nis either not absolute, does not exist, or is not a directory.\n\n'.format(store_dir))
+        else:
+            print('Not using a bitcode store.\n\n')
+
 
 def extractLine(version, n):
     if not version:

wllvm/extraction.py

@@ -149,18 +149,34 @@ def extract_section_linux(inputFile):
         _logger.error('%s contained no %s. section is empty', inputFile, elfSectionName)
     return contents
 
-# loicg: This function checks if the given path points to an existing bitcode file.
-# If it does not, it tries to look for the bitcode file in the store directory given
-# by the environment variable WLLVM_BC_STORE
-def getBitcodePath(bcPath):
-    if not bcPath or os.path.isfile(bcPath):
-        return bcPath
+
+def getStorePath(bcPath):
     storeEnv = os.getenv('WLLVM_BC_STORE')
     if storeEnv:
         hashName = hashlib.sha256(bcPath).hexdigest()
         hashPath = os.path.join(storeEnv, hashName)
         if os.path.isfile(hashPath):
             return hashPath
+    return None
+
+
+# loicg: This function checks if the given path points to an existing bitcode file.
+# If it does not, it tries to look for the bitcode file in the store directory given
+# by the environment variable WLLVM_BC_STORE
+def getBitcodePath(bcPath):
+    if not bcPath or os.path.isfile(bcPath):
+        return bcPath
+
+    storePath = getStorePath(bcPath)
+    if storePath:
+        return storePath
+
+#    storeEnv = os.getenv('WLLVM_BC_STORE')
+#    if storeEnv:
+#        hashName = hashlib.sha256(bcPath).hexdigest()
+#        hashPath = os.path.join(storeEnv, hashName)
+#        if os.path.isfile(hashPath):
+#            return hashPath
     return bcPath
 
 def linkFiles(pArgs, fileNames):
@@ -231,10 +247,7 @@ def handleExecutable(pArgs):
         return 1
 
     if pArgs.manifestFlag:
-        manifestFile = '{0}.llvm.manifest'.format(pArgs.inputFile)
-        with open(manifestFile, 'w') as output:
-            for f in fileNames:
-                output.write('{0}\n'.format(f))
+        writeManifest('{0}.llvm.manifest'.format(pArgs.inputFile), fileNames)
 
     if pArgs.outputFile is None:
         pArgs.outputFile = pArgs.inputFile + '.' + moduleExtension
@@ -304,10 +317,7 @@ def handleArchive(pArgs):
 
     #write the manifest file if asked for
     if pArgs.manifestFlag:
-        manifestFile = '{0}.llvm.manifest'.format(pArgs.inputFile)
-        with open(manifestFile, 'w') as output:
-            for f in bitCodeFiles:
-                output.write('{0}\n'.format(f))
+        writeManifest('{0}.llvm.manifest'.format(pArgs.inputFile), bitCodeFiles)
 
     # Build bitcode archive
     os.chdir(originalDir)
@@ -341,6 +351,16 @@ def buildArchive(pArgs, bitCodeFiles):
         return archiveFiles(pArgs, bitCodeFiles)
 
 
+def writeManifest(manifestFile, bitCodeFiles):
+    with open(manifestFile, 'w') as output:
+            for f in bitCodeFiles:
+                output.write('{0}\n'.format(f))
+                sf = getStorePath(f)
+                if sf:
+                    output.write('{0}\n'.format(sf))
+
+
+
 class ExtractedArgs(object):
 
     def __init__(self):

wllvm/version.py

@@ -46,6 +46,9 @@
 
 1.0.18   - 4/11/2017  tentative solution to the -emit-llvm "out of context" experience.
 
+1.0.19   - 4/19/2017  fixed a '-o' issue in extract-bc and added the bitcode store feature.
+
+
 """
 
-wllvm_version = '1.0.18'
+wllvm_version = '1.0.19'