core/sql/langman/LmDebug.cpp

/* -*-C++-*-
 *****************************************************************************
 *
 * File:         LmDebug.cpp
 * Description:  debug functions of the language manager
 *               
 *               
 * Created:      6/20/02
 * Language:     C++
 *
 *
// @@@ START COPYRIGHT @@@
//
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License.  You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.  See the License for the
// specific language governing permissions and limitations
// under the License.
//
// @@@ END COPYRIGHT @@@
**********************************************************************/
#include "Platform.h"
#include "LmExtFunc.h"
#include "LmDebug.h"

#ifdef LM_DEBUG
#include <stdio.h>
#include <stdlib.h>
#include <stdarg.h>
#include "NABoolean.h"
FILE *lmDebugFile = stdout;

NABoolean doLmDebug()
{
  static NABoolean doLmDebugFlag = FALSE;
  static NABoolean firstTime = TRUE;
  if (firstTime)
  {
    firstTime = FALSE;

    // Note: the "LM_DEBUG" string is split into two adjacent strings so
    // the preprocessor does not perform macro substitution on LM_DEBUG.
    if (getenv("LM_""DEBUG"))
      doLmDebugFlag = TRUE;  // LCOV_EXCL_LINE --exclude coverage, used for debugging

    char *debug_log = getenv("LM_DEBUG_LOG");
    if (debug_log != NULL)
    {
// Exclude coverage, used for debugging
// LCOV_EXCL_START 
      lmDebugFile = fopen(debug_log, "a");
      if (!lmDebugFile)
       lmDebugFile = stdout;
// LCOV_EXCL_STOP
    }
  }

  return doLmDebugFlag;
}

void lmDebug(const char *formatString, ...)
{
  if (doLmDebug())
  {
// Exclude coverage, used for debugging
// LCOV_EXCL_START
    va_list args;
    va_start(args, formatString);
    fprintf(lmDebugFile, "[LM DEBUG] ");
    vfprintf(lmDebugFile, formatString, args);
    fprintf(lmDebugFile, "\n");
    fflush(lmDebugFile);
// LCOV_EXCL_STOP
  }
}

NABoolean doLmDebugSignalHandlers(){
  static NABoolean doLmDebugSignalHandlersFlag = FALSE;
  static NABoolean firstTime = TRUE;
  if (firstTime)
  {
    firstTime = FALSE;
    //
    // Note: the "LM_DEBUG" string is split into two adjacent strings so
    // the preprocessor does not perform macro substitution on LM_DEBUG.
    //
    if (getenv("LM_DEBUG_SIGNAL_HANDLERS"))
    {
      doLmDebugSignalHandlersFlag = TRUE;  // LCOV_EXCL_LINE --exclude coverage, used for debugging
    }
  }
  return doLmDebugSignalHandlersFlag;
}

void debugLmSignalHandlers()
{
  if(doLmDebugSignalHandlers())
    lmPrintSignalHandlers();  // LCOV_EXCL_LINE --exclude coverage, used for debugging
}

// Exclude the following function for coverage as this is used only for debugging signal handler
// LCOV_EXCL_START
NABoolean doNotRestoreSignalHandlersAfterUDF(){
  static NABoolean doNotRestoreSignalHandlersAfterUDFFlag = FALSE;
  static NABoolean firstTime = TRUE;
  if (firstTime)
  {
    firstTime = FALSE;
    if (getenv("LM_DO_NOT_ATTEMPT_RESTORE_SIGNAL_HANDLERS_AFTER_UDF"))
    {
      doNotRestoreSignalHandlersAfterUDFFlag = TRUE;
    }
  }
  return doNotRestoreSignalHandlersAfterUDFFlag;
}
// LCOV_EXCL_STOP

#endif // LM_DEBUG