Merge branch 'master' of https://github.com/travitch/whole-program-llvm

Author: travitch

NOTES.txt

@@ -0,0 +1,58 @@
+WARNING:Did not recognize the compiler flag "-m32"
+WARNING:Did not recognize the compiler flag "-march=i686"
+WARNING:Did not recognize the compiler flag "-B/home/iam/world/usr/src/lib32/usr/lib32"
+WARNING:Did not recognize the compiler flag "-mpreferred-stack-boundary=2"
+WARNING:Did not recognize the compiler flag "-mno-align-long-strings"
+WARNING:Did not recognize the compiler flag "-mrtd"
+WARNING:Did not recognize the compiler flag "-mregparm=3"
+WARNING:Did not recognize the compiler flag "-mstack-alignment=8"
+WARNING:Did not recognize the compiler flag "-mllvm"
+WARNING:Did not recognize the compiler flag "-inline-threshold=3"
+WARNING:Did not recognize the compiler flag "-enable-load-pre=false"
+WARNING:Did not recognize the compiler flag "-mllvm"
+WARNING:Did not recognize the compiler flag "-simplifycfg-dup-ret"
+WARNING:Did not recognize the compiler flag "-march=i386"
+WARNING:Did not recognize the compiler flag "cat.lo" ....
+WARNING:Did not recognize the compiler flag "-Ttext"
+WARNING:Did not recognize the compiler flag "0x600"
+WARNING:Did not recognize the compiler flag "-m"
+WARNING:Did not recognize the compiler flag "elf_i386_fbsd"
+
+
+Darwin linker flags:
+
+WARNING:Did not recognize the compiler flag "-dynamiclib"
+WARNING:Did not recognize the compiler flag "-current_version"
+WARNING:Did not recognize the compiler flag "2.2.2"
+WARNING:Did not recognize the compiler flag "-compatibility_version"
+WARNING:Did not recognize the compiler flag "2.2.0"
+
+Attempt to attach bitcode stuff on MacOS using ld:
+
+ ld -r <file.o> -sectcreate __LLVM __llvm_bc <tmpfile> -o <file.o>
+
+This works (it adds a new section called __llvm_bc in a new __LLVM
+segment), but the 'ld -r' part may have bad side effects. For example
+if the <file.o> is produced with -fvisibility=hidden then calling
+ld -r <file.o> converts the extern symbols into local symbols.
+
+Workaround for now: give a warning if we see -fvisibility=hidden on
+the Mac.
+
+
+
+TODO: extract-bc for MacOS
+
+To extract bitcode from binaries, objects, or library files on Darwin:
+
+  otool -X -s __LLVM __llvm_bc yices_sat | xxd -r 
+
+Explanations:
+
+  otool -s __LLVM __llvm_bc file  extracts and display the section we care about
+
+  flag -X removes some useless headers we don't want
+
+  xxd -r converts the hexdump to ASCII list of file names
+
+

README.md

@@ -82,6 +82,12 @@ Example building bitcode archive
     # Produces src/LinearMath/libLinearMath.bca
     extract-bc src/LinearMath/libLinearMath.a
 
+Example building an Operating System
+================================
+
+To see how to build freeBSD 10.0 from scratch check out the guide 
+[here.](../master/README-freeBSD.md)
+
 Debugging
 =========
 

driver/utils.py

@@ -34,6 +34,11 @@
 # This is the ELF section name inserted into binaries
 elfSectionName='.llvm_bc'
 
+# These are the MACH_O segment and section name
+darwinSegmentName='__LLVM'
+darwinSectionName='__llvm_bc'
+
+
 # Internal logger
 _logger = logging.getLogger(__name__)
 
@@ -182,6 +187,24 @@ def __init__(self, inputList, exactMatches={}, patternMatches={}):
             '-static' : (0, ArgumentListFilter.linkUnaryCallback),
             '-nostdlib' : (0, ArgumentListFilter.linkUnaryCallback),
             '-nodefaultlibs' : (0, ArgumentListFilter.linkUnaryCallback),
+            # darwin flags
+            '-dynamiclib' : (0, ArgumentListFilter.linkUnaryCallback),
+            '-current_version' : (1, ArgumentListFilter.linkBinaryCallback),
+            '-compatibility_version' : (1, ArgumentListFilter.linkBinaryCallback),
+
+            # bd: need to warn the darwin user that these flags will rain on their parade
+            # (the Darwin ld is a bit single minded)
+            #
+            # 1) compilation with -fvisibility=hidden causes trouble when we try to
+            #    attach bitcode filenames to an object file. The global symbols in object 
+            #    files get turned into local symbols when we invoke 'ld -r'
+            #
+            # 2) all stripping commands (e.g., -dead_strip) remove the __LLVM segment after
+            #    linking
+            #
+            '-fvisibility=hidden' :  (0, ArgumentListFilter.darwinWarningCompileUnaryCallback),
+            '-Wl,-dead_strip' :  (0, ArgumentListFilter.darwinWarningLinkUnaryCallback),
+            
            }
 
         #
@@ -310,6 +333,20 @@ def linkUnaryCallback(self, flag):
     def compileUnaryCallback(self, flag):
         self.compileArgs.append(flag)
 
+    def darwinWarningCompileUnaryCallback(self, flag):
+        if sys.platform.startswith('darwin'):
+            _logger.warning('The flag "{0}" cannot be used with this tool'.format(flag))
+            sys.exit(1)
+        else:
+            self.compileArgs.append(flag)
+
+    def darwinWarningLinkUnaryCallback(self, flag):
+        if sys.platform.startswith('darwin'):
+            _logger.warning('The flag "{0}" cannot be used with this tool'.format(flag))
+            sys.exit(1)
+        else:
+            self.linkArgs.append(flag)
+
     def defaultBinaryCallback(self, flag, arg):
         _logger.warning('Ignoring compiler arg pair: "{0} {1}"'.format(flag, arg))
 
@@ -395,19 +432,32 @@ def getFileType(cls, fileName):
       output = fileP.communicate()[0]
       output = output.decode()
       if 'ELF' in output and 'executable' in output:
-          return cls.EXECUTABLE
+          return cls.ELF_EXECUTABLE
+      if 'Mach-O' in output and 'executable' in output:
+          return cls.MACH_EXECUTABLE
       elif 'ELF' in output and 'shared' in output:
-          return cls.SHARED
+          return cls.ELF_SHARED
+      elif 'Mach-O' in output and 'dynamically linked shared' in output:
+          return cls.MACH_SHARED
       elif 'current ar archive' in output:
           return cls.ARCHIVE
       elif 'ELF' in output and 'relocatable' in output:
-          return cls.OBJECT
+          return cls.ELF_OBJECT
+      elif 'Mach-O' in output and 'object' in output:
+          return cls.MACH_OBJECT
       else:
           return cls.UNKNOWN
 
   @classmethod
   def init(cls):
-      for (index, name) in enumerate(('UNKNOWN', 'EXECUTABLE', 'OBJECT', 'ARCHIVE', 'SHARED')):
+      for (index, name) in enumerate(('UNKNOWN',
+                                      'ELF_EXECUTABLE',
+                                      'ELF_OBJECT',
+                                      'ELF_SHARED',
+                                      'MACH_EXECUTABLE',
+                                      'MACH_OBJECT',
+                                      'MACH_SHARED',
+                                      'ARCHIVE')):
           setattr(cls, name, index)
           cls.revMap[index] = name
 
@@ -437,8 +487,12 @@ def attachBitcodePathToObject(bcPath, outFileName):
     os.fsync(f.fileno())
     f.close()
 
-    # Now write our .llvm_bc section
-    objcopyCmd = ['objcopy', '--add-section', '{0}={1}'.format(elfSectionName, f.name), outFileName]
+    
+    # Now write our bitcode section
+    if (sys.platform.startswith('darwin')):
+        objcopyCmd = ['ld', '-r', outFileName, '-sectcreate', darwinSegmentName, darwinSectionName,  f.name, '-o', outFileName]
+    else:
+        objcopyCmd = ['objcopy', '--add-section', '{0}={1}'.format(elfSectionName, f.name), outFileName]
     orc = 0
 
     try:
@@ -600,7 +654,7 @@ def buildAndAttachBitcode(builder):
         # "... -c -o foo.o" or even "... -c -o foo.So" which is OK, but we could also have
         # "... -c -o crazy-assed.objectfile" which we wouldn't get right (yet)
         # so we need to be careful with the objFile and bcFile
-        # maybe python-magic is in out future ...
+        # maybe python-magic is in our future ...
         srcFile = af.inputFiles[0]
         (objFile, bcFile) = af.getArtifactNames(srcFile, hidden)
         if af.outputFilename is not None: