Refactor folder structure (#425)

* Created mir_to_goto folder, moved monomorphize into it

* moved metadata files into metadata folder

* moved codegen files to codegen folder

* moved stubs and hooks to mir_to_goto

* moved the final files into mir_to_goto

* Comments

* suppress warnings

* added missing file

* rename metadata as per PR comments

* Remove pub modifier on modules that don't need it

* Moved tuple_fld so that typ can be private mod

* removed pub mod from stubs

* moved overrides into their own folder

* moved assumptions into codegen

* utils folder

* init debug properly

* renamed backend to compiler_interface

* gotoCtx should just take a MIR context at construction time

* move more stuff out of utils to where it goes

* names get their own util

* better import in hooks

Author: danielsn

compiler/rustc_codegen_llvm/src/gotoc/assumptions.rs renamed to compiler/rustc_codegen_llvm/src/gotoc/mir_to_goto/codegen/assumptions.rs

@@ -2,9 +2,8 @@
 // SPDX-License-Identifier: Apache-2.0 OR MIT
 //! this module defines functions which impose data invariant on generated data types.
 
-use super::cbmc::goto_program::{Expr, Location, Stmt, Symbol, Type};
-use super::metadata::GotocCtx;
-use crate::gotoc::typ::tuple_fld;
+use crate::gotoc::cbmc::goto_program::{Expr, Location, Stmt, Symbol, Type};
+use crate::gotoc::mir_to_goto::GotocCtx;
 use rustc_middle::mir::interpret::{ConstValue, Scalar};
 use rustc_middle::ty;
 use rustc_middle::ty::ScalarInt;
@@ -559,7 +558,7 @@ impl<'tcx> GotocCtx<'tcx> {
                     let field = ptr
                         .clone()
                         .dereference()
-                        .member(&tuple_fld(i), &tcx.symbol_table) // x->i
+                        .member(&Self::tuple_fld_name(i), &tcx.symbol_table) // x->i
                         .address_of(); // &(x->i)
                     invariants.push(f.call(vec![field]));
                 }

compiler/rustc_codegen_llvm/src/gotoc/block.rs renamed to compiler/rustc_codegen_llvm/src/gotoc/mir_to_goto/codegen/block.rs

@@ -3,7 +3,7 @@
 
 //! This file contains functions related to codegenning MIR blocks into gotoc
 
-use super::metadata::*;
+use crate::gotoc::mir_to_goto::GotocCtx;
 use rustc_middle::mir::{BasicBlock, BasicBlockData};
 
 impl<'tcx> GotocCtx<'tcx> {

compiler/rustc_codegen_llvm/src/gotoc/function.rs renamed to compiler/rustc_codegen_llvm/src/gotoc/mir_to_goto/codegen/function.rs

@@ -3,8 +3,8 @@
 
 //! This file contains functions related to codegenning MIR functions into gotoc
 
-use super::cbmc::goto_program::{Expr, Stmt, Symbol};
-use super::metadata::*;
+use crate::gotoc::cbmc::goto_program::{Expr, Stmt, Symbol};
+use crate::gotoc::mir_to_goto::GotocCtx;
 use rustc_middle::mir::{HasLocalDecls, Local};
 use rustc_middle::ty::{self, Instance, TyS};
 use tracing::{debug, warn};

compiler/rustc_codegen_llvm/src/gotoc/intrinsic.rs renamed to compiler/rustc_codegen_llvm/src/gotoc/mir_to_goto/codegen/intrinsic.rs

@@ -3,8 +3,8 @@
 //! this module handles intrinsics
 use tracing::{debug, warn};
 
-use super::cbmc::goto_program::{BuiltinFn, Expr, Location, Stmt, Type};
-use super::metadata::GotocCtx;
+use crate::gotoc::cbmc::goto_program::{BuiltinFn, Expr, Location, Stmt, Type};
+use crate::gotoc::mir_to_goto::GotocCtx;
 use rustc_middle::mir::Place;
 use rustc_middle::ty::Instance;
 use rustc_middle::ty::{self, Ty, TyS};

compiler/rustc_codegen_llvm/src/gotoc/mir_to_goto/codegen/mod.rs

@@ -0,0 +1,17 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0 OR MIT
+
+//! This module does that actual translation of MIR constructs to goto constructs.
+//! Each subfile is named for the MIR construct it translates.
+
+mod assumptions;
+mod block;
+mod function;
+mod intrinsic;
+mod operand;
+mod place;
+mod rvalue;
+mod span;
+mod statement;
+mod static_var;
+mod typ;

compiler/rustc_codegen_llvm/src/gotoc/operand.rs renamed to compiler/rustc_codegen_llvm/src/gotoc/mir_to_goto/codegen/operand.rs

@@ -1,8 +1,8 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0 OR MIT
-use super::cbmc::goto_program::{Expr, Location, Stmt, Symbol, Type};
-use super::metadata::*;
-use super::utils::slice_fat_ptr;
+use crate::gotoc::cbmc::goto_program::{Expr, Location, Stmt, Symbol, Type};
+use crate::gotoc::mir_to_goto::utils::slice_fat_ptr;
+use crate::gotoc::mir_to_goto::GotocCtx;
 use rustc_ast::ast::Mutability;
 use rustc_hir::def_id::LOCAL_CRATE;
 use rustc_middle::mir::interpret::{

compiler/rustc_codegen_llvm/src/gotoc/place.rs renamed to compiler/rustc_codegen_llvm/src/gotoc/mir_to_goto/codegen/place.rs

@@ -5,9 +5,8 @@
 //! a place is an expression of specifying a location in memory, like a left value. check the cases
 //! in [codegen_place] below.
 
-use super::cbmc::goto_program::{Expr, Type};
-use super::metadata::*;
-use super::typ::tuple_fld;
+use crate::gotoc::cbmc::goto_program::{Expr, Type};
+use crate::gotoc::mir_to_goto::GotocCtx;
 use rustc_middle::{
     mir::{Field, Local, Place, ProjectionElem},
     ty::{self, Ty, TyS, VariantDef},
@@ -41,10 +40,12 @@ pub struct ProjectedPlace<'tcx> {
 }
 
 /// Getters
+#[allow(dead_code)]
 impl<'tcx> ProjectedPlace<'tcx> {
     pub fn goto_expr(&self) -> &Expr {
         &self.goto_expr
     }
+
     pub fn mir_typ_or_variant(&self) -> &TypeOrVariant<'tcx> {
         &self.mir_typ_or_variant
     }
@@ -56,6 +57,7 @@ impl<'tcx> ProjectedPlace<'tcx> {
     pub fn fat_ptr_goto_expr(&self) -> &Option<Expr> {
         &self.fat_ptr_goto_expr
     }
+
     pub fn fat_ptr_mir_typ(&self) -> &Option<Ty<'tcx>> {
         &self.fat_ptr_mir_typ
     }
@@ -137,6 +139,7 @@ impl<'tcx> TypeOrVariant<'tcx> {
         }
     }
 
+    #[allow(dead_code)]
     pub fn expect_variant(&self) -> &'tcx VariantDef {
         match self {
             TypeOrVariant::Type(t) => panic!("expect a variant but type is found: {:?}", t),
@@ -168,7 +171,9 @@ impl<'tcx> GotocCtx<'tcx> {
                     | ty::Param(_)
                     | ty::Infer(_)
                     | ty::Error(_) => unreachable!("type {:?} does not have a field", t),
-                    ty::Tuple(_) => res.member(&tuple_fld(f.index()), &self.symbol_table),
+                    ty::Tuple(_) => {
+                        res.member(&Self::tuple_fld_name(f.index()), &self.symbol_table)
+                    }
                     ty::Adt(def, _) if def.repr.simd() => {
                         // this is a SIMD vector - the index represents one
                         // of the elements, so we want to index as an array

compiler/rustc_codegen_llvm/src/gotoc/rvalue.rs renamed to compiler/rustc_codegen_llvm/src/gotoc/mir_to_goto/codegen/rvalue.rs

@@ -1,12 +1,12 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0 OR MIT
-use super::cbmc::goto_program::{BuiltinFn, Expr, Location, Stmt, Symbol, Type};
-use super::cbmc::utils::{aggr_name, BUG_REPORT_URL};
-use super::cbmc::MachineModel;
-use super::metadata::*;
 use super::typ::{is_pointer, pointee_type};
-use super::utils::{dynamic_fat_ptr, slice_fat_ptr};
 use crate::btree_string_map;
+use crate::gotoc::cbmc::goto_program::{BuiltinFn, Expr, Location, Stmt, Symbol, Type};
+use crate::gotoc::cbmc::utils::{aggr_name, BUG_REPORT_URL};
+use crate::gotoc::cbmc::MachineModel;
+use crate::gotoc::mir_to_goto::utils::{dynamic_fat_ptr, slice_fat_ptr};
+use crate::gotoc::mir_to_goto::GotocCtx;
 use num::bigint::BigInt;
 use rustc_middle::mir::{AggregateKind, BinOp, CastKind, NullOp, Operand, Place, Rvalue, UnOp};
 use rustc_middle::ty::adjustment::PointerCast;

compiler/rustc_codegen_llvm/src/gotoc/mir_to_goto/codegen/span.rs

@@ -0,0 +1,37 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0 OR MIT
+
+//! MIR Span related functions
+
+use crate::gotoc::cbmc::goto_program::Location;
+use crate::gotoc::mir_to_goto::GotocCtx;
+use rustc_middle::mir::{Local, VarDebugInfo, VarDebugInfoContents};
+use rustc_span::Span;
+
+impl<'tcx> GotocCtx<'tcx> {
+    pub fn find_debug_info(&self, l: &Local) -> Option<&VarDebugInfo<'tcx>> {
+        self.current_fn().mir().var_debug_info.iter().find(|info| match info.value {
+            VarDebugInfoContents::Place(p) => p.local == *l && p.projection.len() == 0,
+            VarDebugInfoContents::Const(_) => false,
+        })
+    }
+
+    //TODO fix this name
+    pub fn codegen_span_option2(&self, sp: Option<Span>) -> Location {
+        sp.map_or(Location::none(), |x| self.codegen_span2(&x))
+    }
+
+    //TODO fix this name
+    pub fn codegen_span2(&self, sp: &Span) -> Location {
+        let smap = self.tcx.sess.source_map();
+        let lo = smap.lookup_char_pos(sp.lo());
+        let line = lo.line;
+        let col = 1 + lo.col_display;
+        let filename0 = lo.file.name.prefer_remapped().to_string_lossy().to_string();
+        let filename1 = match std::fs::canonicalize(filename0.clone()) {
+            Ok(pathbuf) => pathbuf.to_str().unwrap().to_string(),
+            Err(_) => filename0,
+        };
+        Location::new(filename1, self.current_fn.as_ref().map(|x| x.name()), line, Some(col))
+    }
+}

compiler/rustc_codegen_llvm/src/gotoc/statement.rs renamed to compiler/rustc_codegen_llvm/src/gotoc/mir_to_goto/codegen/statement.rs

@@ -1,8 +1,8 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0 OR MIT
-use super::cbmc::goto_program::{BuiltinFn, Expr, Location, Stmt, Type};
-use super::metadata::*;
 use super::typ::FN_RETURN_VOID_VAR_NAME;
+use crate::gotoc::cbmc::goto_program::{BuiltinFn, Expr, Location, Stmt, Type};
+use crate::gotoc::mir_to_goto::GotocCtx;
 use rustc_hir::def_id::DefId;
 use rustc_middle::mir;
 use rustc_middle::mir::{