exit.cc

Go to the documentation of this file.

// -*- mode:c++;tab-width:2;indent-tabs-mode:t;show-trailing-whitespace:t;rm-trailing-spaces:t -*-
// vi: set ts=2 noet:
//
// (c) Copyright Rosetta Commons Member Institutions.
// (c) This file is part of the Rosetta software suite and is made available under license.
// (c) The Rosetta software is developed by the contributing members of the Rosetta Commons.
// (c) For more information, see http://www.rosettacommons.org. Questions about this can be
// (c) addressed to University of Washington UW TechTransfer, email: license@u.washington.edu.

/// @file   utility/exit.cc
/// @brief  Program exit functions and macros
/// @author David Kim (dekim@u.washington.edu)
/// @author Stuart G. Mentzer (Stuart_Mentzer@objexx.com)

#ifdef USEMPI
#include <mpi.h>
#endif
// Unit headers
#include <utility/exit.hh>
#include <utility/excn/EXCN_Base.hh>
#include <utility/backtrace.hh>
// C++ headers
#include <cassert>
#include <cstdlib>
#include <iostream>

// Boinc headers
#ifdef BOINC
#include <utility/io/izstream.hh>
#include <boinc_api.h>
#endif

#include <string>

#include <vector>

#ifndef _WIN32
#include <unistd.h>
#endif

#include <cstdio>

#ifdef _WIN32
#include <io.h>
//__declspec(dllexport) int isatty(int fd) { return _isatty(fd); }
#endif

namespace utility {


/// Place holder for 'end-action' of utility::exit(…)
static void (*main_exit_callback)(void) = 0;

void set_main_exit_callback( UtilityExitCallBack my_callback )
{
  main_exit_callback = my_callback;
}

/// Array to hold all additional exit-callbacks
std::vector< UtilityExitCallBack > & get_all_exit_callbacks()
{
  static std::vector< UtilityExitCallBack > * all_CB = new std::vector< UtilityExitCallBack >;
  return *all_CB;
}

void add_exit_callback( UtilityExitCallBack cb)
{
  get_all_exit_callbacks().push_back( cb );
}

void remove_exit_callback( UtilityExitCallBack cb )
{
  for ( std::vector<UtilityExitCallBack>::iterator it=get_all_exit_callbacks().begin(); it < get_all_exit_callbacks().end(); ++it ) {
    if ( (*it) == cb ) {
      get_all_exit_callbacks().erase(it);
      break;
    }
  }
}


class EXCN_utility_exit : public excn::EXCN_Base { //noboday should be allowed to throw this... that's why its privately hidden in this modul...
public:
  EXCN_utility_exit( std::string const& msg, std::string const& file, int const line );
  virtual void show( std::ostream& ) const;
private:
  std::string const msg_;
  std::string const file_;
  int const line_;
};


EXCN_utility_exit::EXCN_utility_exit( std::string const& msg, std::string const& file, int const line ) :
  msg_( msg ),
  file_( file ),
  line_( line )
{}

void EXCN_utility_exit::show( std::ostream& os ) const {
  os << "\n\n[ERROR] EXCN_utility_exit has been thrown from: "
    << file_ << " line: " << line_ << "\n";
  if ( ! msg_.empty() ) os << "ERROR: " << msg_ << "\n\n";
}


/// @brief Exit with file + line + message + optional status
void
exit(
  std::string const & file,
  int const line,
  std::string const & message,
  int const status
)
{
  // Calling all preset exit-callback's
  for ( std::vector<UtilityExitCallBack>::iterator it=get_all_exit_callbacks().begin(); it < get_all_exit_callbacks().end(); ++it ) {
    (*it)();
  }

  if ( isatty(fileno(stdout)) ) std::cerr << "\x1b[0m\x1b[1m\x1b[31m";  // Reseting the terminal state and setting bold-red color
  if ( ! message.empty() ) std::cerr << std::endl << "ERROR: " << message << std::endl;
  std::cerr << "ERROR:: Exit from: " << file << " line: " << line << std::endl;
  if ( isatty(fileno(stdout)) ) std::cerr << "\x1b[0m";
  print_backtrace();
  std::cerr.flush();

#ifndef BOINC
  // why did this get placed here basically skipping the logic below?!
  throw EXCN_utility_exit( message, file, line );
#endif

#ifdef USEMPI
  MPI_Abort( MPI_COMM_WORLD, 911 );
#endif

#ifdef BOINC

  // check if there are results, if so, return success
  bool hasresults = false;
  // Quick hack, since we can't access the options assume
  // the result file will always be named default.out and thaat
  // it should be gzipped for now.
  utility::io::izstream data( "default.out" );
  if ( !data ){
    std::cerr << "BOINC:: Error reading and gzipping output datafile: default.out" << std::endl; std::cerr.flush();
    boinc_finish( status );
  }
  std::string tmpline;
  getline( data, tmpline ); // sequence line
  getline( data, tmpline ); // score line
  while( getline(data,tmpline) ) {
    if ( tmpline.substr(0,7) == "SCORE: " ) {
      hasresults = true;
      break;
    }
  }
  data.close();
  if (hasresults) {
    utility::file::gzip( "default.out", true );
    boinc_finish( 0 );
  } else {
    boinc_finish( status );
  }

#else // Not BOINC
  if ( main_exit_callback ) {
    main_exit_callback();
    std::exit( status );
  } else {
#ifndef _WIN32
    assert( false ); // Force a core dump for post-mortem debugging
#endif // Not _WIN32
    std::exit( status );
  }
#endif // BOINC

  throw EXCN_utility_exit( message, file, line );

}


/// @brief Conditional Exit with file + line + message + optional status
int
cond_exit(
  bool condition,
  std::string const & file,
  int const line,
  std::string const & message,
  int const status
){
  if ( condition ) return 1;
  exit( file, line, message, status );
  return 0; // keep compiler happy.
}


} // namespace utility