globalObjects.c

/*@HEADER
// ***********************************************************************
//
//       Ifpack: Object-Oriented Algebraic Preconditioner Package
//                 Copyright (2002) Sandia Corporation
//
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
//
// ***********************************************************************
//@HEADER
*/

/* Contains definitions of globally scoped  objects; 
 * Also, functions for error handling and message logging.
 */

#include "euclid_common.h"
#include "Parser_dh.h"
#include "Mem_dh.h"
#include "TimeLog_dh.h"
extern void sigRegister_dh ();  /* use sig_dh.h if not for euclid_signals_len */

/*-------------------------------------------------------------------------
 * Globally scoped variables, flags, and objects
 *-------------------------------------------------------------------------*/
bool errFlag_dh = false;    /* set to "true" by functions encountering errors */
Parser_dh parser_dh = NULL; /* for setting/getting runtime options */
TimeLog_dh tlog_dh = NULL;  /* internal timing  functionality */
Mem_dh mem_dh = NULL;       /* memory management */
FILE *logFile = NULL;
char msgBuf_dh[MSG_BUF_SIZE_DH];    /* for internal use */
int np_dh = 1;          /* number of processors and subdomains */
int myid_dh = 0;        /* rank of this processor (and subdomain) */
MPI_Comm comm_dh = 0;


  /* Each processor (may) open a logfile.
   * The bools are switches for controlling the amount of informational 
   * output, and where it gets written to.  Function logging is only enabled
   * when compiled with the debugging (-g) option.
   */
FILE *logFile;
void openLogfile_dh (int argc, char *argv[]);
void closeLogfile_dh ();
bool logInfoToStderr = false;
bool logInfoToFile = false;
bool logFuncsToStderr = false;
bool logFuncsToFile = false;

bool ignoreMe = true;
int ref_counter = 0;


/*-------------------------------------------------------------------------
 * End of global definitions. 
 * Error and info functions follow.
 *-------------------------------------------------------------------------*/

#define MAX_MSG_SIZE 1024
#define MAX_STACK_SIZE 20

static char errMsg_private[MAX_STACK_SIZE][MAX_MSG_SIZE];
static int errCount_private = 0;

static char calling_stack[MAX_STACK_SIZE][MAX_MSG_SIZE];
/* static  int  priority_private[MAX_STACK_SIZE]; */
static int calling_stack_count = 0;

/* static  char errMsg[MAX_MSG_SIZE];    */

void
openLogfile_dh (int argc, char *argv[])
{
  char buf[1024];

  /* this doesn't really belong here, but it's gotta go someplace! */
/*  strcpy(errMsg, "error msg was never set -- ??"); */

  if (logFile != NULL)
    return;

  /* set default logging filename */
  sprintf (buf, "logFile");

  /* set user supplied logging filename, if one was specified */
  if (argc && argv != NULL)
    {
      int j;
      for (j = 1; j < argc; ++j)
    {
      if (strcmp (argv[j], "-logFile") == 0)
        {
          if (j + 1 < argc)
        {
          sprintf (buf, "%s", argv[j + 1]);
          break;
        }
        }
    }
    }

  /* attempt to open logfile, unless the user entered "-logFile none" */
  if (strcmp (buf, "none"))
    {
      char a[5];
      sprintf (a, ".%i", myid_dh);
      strcat (buf, a);

      if ((logFile = fopen (buf, "w")) == NULL)
    {
      fprintf (stderr, "can't open >%s< for writing; continuing anyway\n",
           buf);
    }
    }
}

void
closeLogfile_dh ()
{
  if (logFile != NULL)
    {
      if (fclose (logFile))
    {
      fprintf (stderr, "Error closing logFile\n");
    }
      logFile = NULL;
    }
}

void
setInfo_dh (char *msg, char *function, char *file, int line)
{
  if (logInfoToFile && logFile != NULL)
    {
      fprintf (logFile, "INFO: %s;\n       function= %s  file=%s  line=%i\n",
           msg, function, file, line);
      fflush (logFile);
    }
  if (logInfoToStderr)
    {
      fprintf (stderr, "INFO: %s;\n       function= %s  file=%s  line=%i\n",
           msg, function, file, line);
    }
}

/*----------------------------------------------------------------------
 *  Error handling stuph follows
 *----------------------------------------------------------------------*/

void
dh_StartFunc (char *function, char *file, int line, int priority)
{
  if (priority == 1)
    {
      sprintf (calling_stack[calling_stack_count],
           "[%i]   %s  file= %s  line= %i", myid_dh, function, file,
           line);
      /* priority_private[calling_stack_count] = priority; */
      ++calling_stack_count;

      if (calling_stack_count == MAX_STACK_SIZE)
    {
      fprintf (stderr,
           "_____________ dh_StartFunc: OVERFLOW _____________________\n");
      if (logFile != NULL)
        {
          fprintf (logFile,
               "_____________ dh_StartFunc: OVERFLOW _____________________\n");
        }
      --calling_stack_count;
    }
    }
}

void
dh_EndFunc (char *function, int priority)
{
  if (priority == 1)
    {
      --calling_stack_count;

      if (calling_stack_count < 0)
    {
      calling_stack_count = 0;
      fprintf (stderr,
           "_____________ dh_EndFunc: UNDERFLOW _____________________\n");
      if (logFile != NULL)
        {
          fprintf (logFile,
               "_____________ dh_EndFunc: UNDERFLOW _____________________\n");
        }
    }
    }
}


void
setError_dh (char *msg, char *function, char *file, int line)
{
  errFlag_dh = true;
  if (!strcmp (msg, ""))
    {
      sprintf (errMsg_private[errCount_private],
           "[%i] called from: %s  file= %s  line= %i",
           myid_dh, function, file, line);
    }
  else
    {
      sprintf (errMsg_private[errCount_private],
           "[%i] ERROR: %s\n       %s  file= %s  line= %i\n",
           myid_dh, msg, function, file, line);
    }
  ++errCount_private;

  /* shouldn't do things like this; but we're not building
     for the ages: all the world's a stage, this is merely a
     prop to be bonfired at play's end.
   */
  if (errCount_private == MAX_STACK_SIZE)
    --errCount_private;
}

void
printErrorMsg (FILE * fp)
{
  if (!errFlag_dh)
    {
      fprintf (fp, "errFlag_dh is not set; nothing to print!\n");
      fflush (fp);
    }
  else
    {
      int i;
      fprintf (fp,
           "\n============= error stack trace ====================\n");
      for (i = 0; i < errCount_private; ++i)
    {
      fprintf (fp, "%s\n", errMsg_private[i]);
    }
      fprintf (fp, "\n");
      fflush (fp);
    }
}

void
printFunctionStack (FILE * fp)
{
  int i;
  for (i = 0; i < calling_stack_count; ++i)
    {
      fprintf (fp, "%s\n", calling_stack[i]);
    }
  fprintf (fp, "\n");
  fflush (fp);
}


/*----------------------------------------------------------------------
 *  function call tracing support follows
 *----------------------------------------------------------------------*/

#define MAX_ERROR_SPACES   200
static char spaces[MAX_ERROR_SPACES];
static int nesting = 0;
static bool initSpaces = true;
#define INDENT_DH 3

void
Error_dhStartFunc (char *function, char *file, int line)
{
  if (initSpaces)
    {
      memset (spaces, ' ', MAX_ERROR_SPACES * sizeof (char));
      initSpaces = false;
    }

  /* get rid of string null-terminator from last
   * call (if any) to Error_dhStartFunc()
   */
  spaces[INDENT_DH * nesting] = ' ';

  /* add null-terminator, so the correct number of spaces will be printed */
  ++nesting;
  if (nesting > MAX_ERROR_SPACES - 1)
    nesting = MAX_ERROR_SPACES - 1;
  spaces[INDENT_DH * nesting] = '\0';

  if (logFuncsToStderr)
    {
      fprintf (stderr, "%s(%i) %s  [file= %s  line= %i]\n",
           spaces, nesting, function, file, line);
    }
  if (logFuncsToFile && logFile != NULL)
    {
      fprintf (logFile, "%s(%i) %s  [file= %s  line= %i]\n",
           spaces, nesting, function, file, line);
      fflush (logFile);
    }
}

void
Error_dhEndFunc (char *function)
{
  nesting -= 1;
  if (nesting < 0)
    nesting = 0;
  spaces[INDENT_DH * nesting] = '\0';
}

/*----------------------------------------------------------------------
 *  Euclid initialization and shutdown
 *----------------------------------------------------------------------*/

static bool EuclidIsActive = false;

#undef __FUNC__
#define __FUNC__ "EuclidIsInitialized"
bool
EuclidIsInitialized ()
{
  return EuclidIsActive;
}

#undef __FUNC__
#define __FUNC__ "EuclidInitialize"
void
EuclidInitialize (int argc, char *argv[], char *help)
{
  if (!EuclidIsActive)
    {
      MPI_Comm_size (comm_dh, &np_dh);
      MPI_Comm_rank (comm_dh, &myid_dh);
      openLogfile_dh (argc, argv);
      if (mem_dh == NULL)
    {
      Mem_dhCreate (&mem_dh);
      CHECK_V_ERROR;
    }
      if (tlog_dh == NULL)
    {
      TimeLog_dhCreate (&tlog_dh);
      CHECK_V_ERROR;
    }
      if (parser_dh == NULL)
    {
      Parser_dhCreate (&parser_dh);
      CHECK_V_ERROR;
    }
      Parser_dhInit (parser_dh, argc, argv);
      CHECK_V_ERROR;
      if (Parser_dhHasSwitch (parser_dh, "-sig_dh"))
    {
      sigRegister_dh ();
      CHECK_V_ERROR;
    }
      if (Parser_dhHasSwitch (parser_dh, "-help"))
    {
      if (myid_dh == 0)
        printf ("%s\n\n", help);
      EUCLID_EXIT;
    }
      if (Parser_dhHasSwitch (parser_dh, "-logFuncsToFile"))
    {
      logFuncsToFile = true;
    }
      if (Parser_dhHasSwitch (parser_dh, "-logFuncsToStderr"))
    {
      logFuncsToStderr = true;
    }

      EuclidIsActive = true;
    }

}


/* to do: should restore the signal handler that we preempted above! */
#undef __FUNC__
#define __FUNC__ "EuclidFinalize"
void
EuclidFinalize ()
{
  if (ref_counter)
    return;

  if (EuclidIsActive)
    {
      if (parser_dh != NULL)
    {
      Parser_dhDestroy (parser_dh);
      CHECK_V_ERROR;
    }
      if (tlog_dh != NULL)
    {
      TimeLog_dhDestroy (tlog_dh);
      CHECK_V_ERROR;
    }
      if (logFile != NULL)
    {
      Mem_dhPrint (mem_dh, logFile, true);
      CHECK_V_ERROR;
    }
/*  Mem_dhPrint(mem_dh, stderr, false); CHECK_V_ERROR; */
      if (mem_dh != NULL)
    {
      Mem_dhDestroy (mem_dh);
      CHECK_V_ERROR;
    }
      if (logFile != NULL)
    {
      closeLogfile_dh ();
      CHECK_V_ERROR;
    }
      EuclidIsActive = false;
    }
}


/*----------------------------------------------------------------------
 *  msc. support functions
 *----------------------------------------------------------------------*/

#undef __FUNC__
#define __FUNC__ "printf_dh"
void
printf_dh (char *fmt, ...)
{
  START_FUNC_DH va_list args;
  char *buf = msgBuf_dh;

  va_start (args, fmt);
  vsprintf (buf, fmt, args);
  if (myid_dh == 0)
    {
      fprintf (stdout, "%s", buf);
    }
  va_end (args);
END_FUNC_DH}

#undef __FUNC__
#define __FUNC__ "fprintf_dh"
void
fprintf_dh (FILE * fp, char *fmt, ...)
{
  START_FUNC_DH va_list args;
  char *buf = msgBuf_dh;

  va_start (args, fmt);
  vsprintf (buf, fmt, args);
  if (myid_dh == 0)
    {
      fprintf (fp, "%s", buf);
    }
  va_end (args);
END_FUNC_DH}


#undef __FUNC__
#define __FUNC__ "echoInvocation_dh"
void
echoInvocation_dh (MPI_Comm comm, char *prefix, int argc, char *argv[])
{
  START_FUNC_DH int i, id;

  MPI_Comm_rank (comm, &id);

  if (prefix != NULL)
    {
      printf_dh ("\n%s ", prefix);
    }
  else
    {
      printf_dh ("\n");
    }

  printf_dh ("program invocation: ");
  for (i = 0; i < argc; ++i)
    {
      printf_dh ("%s ", argv[i]);
    }
  printf_dh ("\n");
END_FUNC_DH}