Use *WithWarnings functions from llvm-pretty-bc-parser

This bumps the `llvm-pretty-bc-parser` submodule to bring in the changes from
GaloisInc/llvm-pretty-bc-parser#282 (as well as the
knock-on changes on the `crucible` side in
GaloisInc/crucible#1313). It also updates the code to
use the `*WithWarnings` variants of bitcode parsing functions.

For now, we simply print parse warnings using the established mechanisms in
`saw-script` and `saw-remote-api`, although there is a broader question of
whether we should be using something more systematized to print these warnings
(#2129).

Author: RyanGlScott

CHANGES.md

@@ -26,6 +26,11 @@ This release supports [version
   helps ensure that unsupported `mir-json` files do not cause unintended
   results.
 
+* Emit a warning when parsing an LLVM bitcode metadata record that SAW
+  does not support. (Previously, SAW would throw a fatal error if this
+  occurred, so this change makes SAW more permissive with respect to
+  unsupported LLVM versions.)
+
 ## Bug fixes
 
 * The saw executable's usage message now fits into a terminal. (#405)

deps/crucible

@@ -21,6 +21,7 @@ module SAWServer.LLVMCrucibleSetup
 
 import Control.Exception (throw)
 import Control.Lens ( view )
+import Control.Monad (unless)
 import Control.Monad.IO.Class
 import Data.Aeson (FromJSON(..), withObject, (.:))
 import Data.ByteString (ByteString)
@@ -260,7 +261,11 @@ llvmLoadModule (LLVMLoadModuleParams serverName fileName) =
             loaded <- liftIO (CMS.loadLLVMModule fileName halloc)
             case loaded of
               Left err -> Argo.raise (cantLoadLLVMModule (LLVM.formatError err))
-              Right llvmMod ->
-                do setServerVal serverName llvmMod
+              Right (llvmMod, warnings) ->
+                do -- TODO: Printing warnings directly to stdout here is
+                   -- questionable (#2129)
+                   unless (null warnings) $
+                     liftIO $ print $ LLVM.ppParseWarnings warnings
+                   setServerVal serverName llvmMod
                    trackFile fileName
                    ok

deps/llvm-pretty-bc-parser

@@ -84,6 +84,7 @@ import           Control.Lens
 import           Data.Map ( Map )
 import qualified Data.Map as Map
 import           Data.Maybe
+import           Data.Sequence (Seq)
 import qualified Data.Text as Text
 import           Data.Type.Equality (TestEquality(..))
 import           Data.Void (Void)
@@ -215,15 +216,15 @@ loadLLVMModule ::
   (?transOpts :: CL.TranslationOptions) =>
   FilePath ->
   Crucible.HandleAllocator ->
-  IO (Either LLVM.Error (Some LLVMModule))
+  IO (Either LLVM.Error (Some LLVMModule, Seq LLVM.ParseWarning))
 loadLLVMModule file halloc =
-  do parseResult <- LLVM.parseBitCodeFromFile file
+  do parseResult <- LLVM.parseBitCodeFromFileWithWarnings file
      case parseResult of
        Left err -> return (Left err)
-       Right llvm_mod ->
+       Right (llvm_mod, warnings) ->
          do memVar <- CL.mkMemVar (Text.pack "saw:llvm_memory") halloc
             Some mtrans <- CL.translateModule halloc memVar llvm_mod
-            return (Right (Some (LLVMModule file llvm_mod mtrans)))
+            return (Right (Some (LLVMModule file llvm_mod mtrans), warnings))
 
 instance TestEquality LLVMModule where
   -- As 'LLVMModule' is an abstract type, we know that the values must

saw-remote-api/src/SAWServer/LLVMCrucibleSetup.hs

@@ -24,16 +24,17 @@ import Control.Applicative hiding (many)
 #endif
 import Data.String
 import Data.Parameterized.Some
+import Control.Monad (unless)
 import Control.Monad.State (gets)
 
 import qualified Text.LLVM.AST as LLVM
 import qualified Data.LLVM.BitCode as LLVM
 import qualified Text.LLVM.Parser as LLVM (parseType)
 
-import SAWScript.Value as SV
-
 import qualified SAWScript.Crucible.LLVM.CrucibleLLVM as CL
 import qualified SAWScript.Crucible.LLVM.MethodSpecIR as CMS (LLVMModule, loadLLVMModule)
+import SAWScript.Options
+import SAWScript.Value as SV
 
 llvm_load_module :: FilePath -> TopLevel (Some CMS.LLVMModule)
 llvm_load_module file =
@@ -46,7 +47,10 @@ llvm_load_module file =
      halloc <- getHandleAlloc
      io (CMS.loadLLVMModule file halloc) >>= \case
        Left err -> fail (LLVM.formatError err)
-       Right llvm_mod -> return llvm_mod
+       Right (llvm_mod, warnings) -> do
+         unless (null warnings) $
+           printOutLnTop Warn $ show $ LLVM.ppParseWarnings warnings
+         return llvm_mod
 
 llvm_type :: String -> TopLevel LLVM.Type
 llvm_type str =