/*******************************************************************************
 *
 * \file
 * \brief FunctionsTable implementation
 *
 * Author: Maxime Arthaud
 *
 * Contact: ikos@lists.nasa.gov
 *
 * Notices:
 *
 * Copyright (c) 2018-2019 United States Government as represented by the
 * Administrator of the National Aeronautics and Space Administration.
 * All Rights Reserved.
 *
 * Disclaimers:
 *
 * No Warranty: THE SUBJECT SOFTWARE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY OF
 * ANY KIND, EITHER EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED
 * TO, ANY WARRANTY THAT THE SUBJECT SOFTWARE WILL CONFORM TO SPECIFICATIONS,
 * ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE,
 * OR FREEDOM FROM INFRINGEMENT, ANY WARRANTY THAT THE SUBJECT SOFTWARE WILL BE
 * ERROR FREE, OR ANY WARRANTY THAT DOCUMENTATION, IF PROVIDED, WILL CONFORM TO
 * THE SUBJECT SOFTWARE. THIS AGREEMENT DOES NOT, IN ANY MANNER, CONSTITUTE AN
 * ENDORSEMENT BY GOVERNMENT AGENCY OR ANY PRIOR RECIPIENT OF ANY RESULTS,
 * RESULTING DESIGNS, HARDWARE, SOFTWARE PRODUCTS OR ANY OTHER APPLICATIONS
 * RESULTING FROM USE OF THE SUBJECT SOFTWARE.  FURTHER, GOVERNMENT AGENCY
 * DISCLAIMS ALL WARRANTIES AND LIABILITIES REGARDING THIRD-PARTY SOFTWARE,
 * IF PRESENT IN THE ORIGINAL SOFTWARE, AND DISTRIBUTES IT "AS IS."
 *
 * Waiver and Indemnity:  RECIPIENT AGREES TO WAIVE ANY AND ALL CLAIMS AGAINST
 * THE UNITED STATES GOVERNMENT, ITS CONTRACTORS AND SUBCONTRACTORS, AS WELL
 * AS ANY PRIOR RECIPIENT.  IF RECIPIENT'S USE OF THE SUBJECT SOFTWARE RESULTS
 * IN ANY LIABILITIES, DEMANDS, DAMAGES, EXPENSES OR LOSSES ARISING FROM SUCH
 * USE, INCLUDING ANY DAMAGES FROM PRODUCTS BASED ON, OR RESULTING FROM,
 * RECIPIENT'S USE OF THE SUBJECT SOFTWARE, RECIPIENT SHALL INDEMNIFY AND HOLD
 * HARMLESS THE UNITED STATES GOVERNMENT, ITS CONTRACTORS AND SUBCONTRACTORS,
 * AS WELL AS ANY PRIOR RECIPIENT, TO THE EXTENT PERMITTED BY LAW.
 * RECIPIENT'S SOLE REMEDY FOR ANY SUCH MATTER SHALL BE THE IMMEDIATE,
 * UNILATERAL TERMINATION OF THIS AGREEMENT.
 *
 ******************************************************************************/

#include <llvm/IR/DebugInfoMetadata.h>
#include <llvm/IR/Function.h>

#include <ikos/analyzer/database/table/functions.hpp>
#include <ikos/analyzer/util/demangle.hpp>

namespace ikos {
namespace analyzer {

FunctionsTable::FunctionsTable(sqlite::DbConnection& db, FilesTable& files)
    : DatabaseTable(db,
                    "functions",
                    {{"id", sqlite::DbColumnType::Integer},
                     {"name", sqlite::DbColumnType::Text},
                     {"demangled", sqlite::DbColumnType::Text},
                     {"definition", sqlite::DbColumnType::Integer},
                     {"file_id", sqlite::DbColumnType::Integer},
                     {"line", sqlite::DbColumnType::Integer}},
                    {"file_id"}),
      _files(files),
      _row(db, "functions", 6) {}

sqlite::DbInt64 FunctionsTable::insert(ar::Function* fun) {
  ikos_assert(fun != nullptr);

  auto it = this->_map.find(fun);
  if (it != this->_map.end()) {
    return it->second;
  }

  sqlite::DbInt64 id = this->_last_insert_id++;
  StringRef fun_name = name(fun);

  this->_row << id;
  this->_row << fun_name;
  if (is_mangled(fun_name)) {
    this->_row << demangle(fun_name);
  } else {
    this->_row << sqlite::null;
  }
  this->_row << (fun->is_definition() ? sqlite::DbInt64(1)
                                      : sqlite::DbInt64(0));
  if (fun->has_frontend()) {
    auto llvm_fun = fun->frontend< llvm::Function >();
    llvm::DISubprogram* dbg = llvm_fun->getSubprogram();
    if (dbg != nullptr) {
      this->_row << this->_files.insert(dbg->getFile());
      this->_row << static_cast< sqlite::DbInt64 >(dbg->getLine());
    } else {
      this->_row << sqlite::null;
      this->_row << sqlite::null;
    }
  } else {
    ikos_assert(fun->is_intrinsic());
    this->_row << sqlite::null;
    this->_row << sqlite::null;
  }
  this->_row << sqlite::end_row;

  this->_map.try_emplace(fun, id);
  return id;
}

StringRef FunctionsTable::name(ar::Function* fun) {
  if (!fun->has_frontend()) {
    return fun->name();
  }

  return name(fun->frontend< llvm::Function >());
}

StringRef FunctionsTable::name(llvm::Function* fun) {
  ikos_assert(fun->hasName());
  return to_string_ref(fun->getName());
}

} // end namespace analyzer
} // end namespace ikos
