Draft: Support up to LLVM 20

This bumps the `llvm-pretty`, `llvm-pretty-bc-parser`, and `crucible`
submodules in order to bring in several downstream changes that, in total,
allow SAW to support LLVM versions up to 20. These include:

* `llvm-pretty`:
  GaloisInc/llvm-pretty#168,
  GaloisInc/llvm-pretty#169, and
  GaloisInc/llvm-pretty#170

* `llvm-pretty-bc-parser`:
  GaloisInc/llvm-pretty-bc-parser#316,
  GaloisInc/llvm-pretty-bc-parser#317, and
  GaloisInc/llvm-pretty-bc-parser#318

* `crucible`:
  GaloisInc/crucible#1600,
  GaloisInc/crucible#1602,
  GaloisInc/crucible#1603, and
  GaloisInc/crucible#1606

The only code changes that had to be made in SAW itself involve the LLVM
backend's skeleton-related commands, which look up debug metadata to figure out
which variables are declared. For the time being, I have opted not to make
these commands look into LLVM's new debug records to find equivalent
information, although it probably should. (TODO RGS: Open an issue about this.)

Author: RyanGlScott

CHANGES.md

@@ -150,6 +150,8 @@ This release supports [version
        - importing ambiguous symbols is allowed
        - referring to ambiguous (qualified) symbols is an error.
 
+* Support LLVM versions up to 20.
+
 ## New Features
 
 * SAW has new commands `llvm_unint: [String] -> LLVMSetup ()` and

README.md

@@ -117,7 +117,7 @@ SAW can analyze LLVM programs (usually derived from C, but potentially
 for other languages). The only tool strictly required for this is a
 compiler that can generate LLVM bitcode, such as `clang`. However,
 having the full LLVM tool suite available can be useful. We have tested
-SAW with LLVM and `clang` versions from 3.5 to 16.0, as well as the
+SAW with LLVM and `clang` versions from 3.5 to 20.0, as well as the
 version of `clang` bundled with Apple Xcode. We welcome bug reports on
 any failure to parse bitcode from LLVM versions in that range.
 

deps/crucible

@@ -140,9 +140,9 @@ parseArg LLVM.Typed { LLVM.typedType = t } (nm, loc) = do
 
 stmtCalls :: [LLVM.Stmt] -> Set Text
 stmtCalls [] = Set.empty
-stmtCalls (LLVM.Result _ (LLVM.Call _ _ (LLVM.ValSymbol (LLVM.Symbol s)) _) _:stmts) =
+stmtCalls (LLVM.Result _ (LLVM.Call _ _ (LLVM.ValSymbol (LLVM.Symbol s)) _) _ _:stmts) =
   Set.insert (Text.pack s) $ stmtCalls stmts
-stmtCalls (LLVM.Effect (LLVM.Call _ _ (LLVM.ValSymbol (LLVM.Symbol s)) _) _:stmts) =
+stmtCalls (LLVM.Effect (LLVM.Call _ _ (LLVM.ValSymbol (LLVM.Symbol s)) _) _ _:stmts) =
   Set.insert (Text.pack s) $ stmtCalls stmts
 stmtCalls (_:stmts) = stmtCalls stmts
 
@@ -158,7 +158,7 @@ stmtDebugDeclares
           LLVM.ValMd (LLVM.ValMdDebugInfo (LLVM.DebugInfoLocalVariable LLVM.DILocalVariable { LLVM.dilvArg = a }))
         }
       , _
-      ]) md:stmts)
+      ]) _dr md:stmts) -- TODO RGS: Should we also look into the debug records?
   | s == "llvm.dbg.declare" || s == "llvm.dbg.value"
   , Just (LLVM.ValMdLoc LLVM.DebugLoc { LLVM.dlLine = line, LLVM.dlCol = col }) <- lookup "dbg" md
   = Map.insert (fromIntegral a) (Location (fromIntegral line) . Just $ fromIntegral col) $ stmtDebugDeclares stmts
@@ -172,7 +172,7 @@ stmtDebugDeclares
           LLVM.ValMd (LLVM.ValMdDebugInfo (LLVM.DebugInfoLocalVariable LLVM.DILocalVariable { LLVM.dilvArg = a }))
         }
       , _
-      ]) md:stmts)
+      ]) _dr md:stmts) -- TODO RGS: Should we also look into the debug records?
   | s == "llvm.dbg.declare" || s == "llvm.dbg.value"
   , Just (LLVM.ValMdLoc LLVM.DebugLoc { LLVM.dlLine = line, LLVM.dlCol = col }) <- lookup "dbg" md
   = Map.insert (fromIntegral a) (Location (fromIntegral line) . Just $ fromIntegral col) $ stmtDebugDeclares stmts