- Add recommendation to use GNU make to INSTALL document

[openssh.git] / log.c

/*

Shared versions of debug(), log(), etc.

*/

#include "includes.h"
RCSID("$OpenBSD: log.c,v 1.2 1999/11/19 16:04:17 markus Exp $");

#include "ssh.h"
#include "xmalloc.h"

/* Fatal messages.  This function never returns. */

void
fatal(const char *fmt, ...)
{
  va_list args;
  va_start(args, fmt);
  do_log(SYSLOG_LEVEL_FATAL, fmt, args);
  va_end(args);
  fatal_cleanup();
}

/* Error messages that should be logged. */

void
error(const char *fmt, ...)
{
  va_list args;
  va_start(args, fmt);
  do_log(SYSLOG_LEVEL_ERROR, fmt, args);
  va_end(args);
}

/* Log this message (information that usually should go to the log). */

void
log(const char *fmt, ...)
{
  va_list args;
  va_start(args, fmt);
  do_log(SYSLOG_LEVEL_INFO, fmt, args);
  va_end(args);
}

/* More detailed messages (information that does not need to go to the log). */

void
chat(const char *fmt, ...)
{
  va_list args;
  va_start(args, fmt);
  do_log(SYSLOG_LEVEL_CHAT, fmt, args);
  va_end(args);
}

/* Debugging messages that should not be logged during normal operation. */

void
debug(const char *fmt, ...)
{
  va_list args;
  va_start(args, fmt);
  do_log(SYSLOG_LEVEL_DEBUG, fmt, args);
  va_end(args);
}

/* Fatal cleanup */

struct fatal_cleanup
{
  struct fatal_cleanup *next;
  void (*proc)(void *);
  void *context;
};

static struct fatal_cleanup *fatal_cleanups = NULL;

/* Registers a cleanup function to be called by fatal() before exiting. */

void
fatal_add_cleanup(void (*proc)(void *), void *context)
{
  struct fatal_cleanup *cu;

  cu = xmalloc(sizeof(*cu));
  cu->proc = proc;
  cu->context = context;
  cu->next = fatal_cleanups;
  fatal_cleanups = cu;
}

/* Removes a cleanup frunction to be called at fatal(). */

void
fatal_remove_cleanup(void (*proc)(void *context), void *context)
{
  struct fatal_cleanup **cup, *cu;
  
  for (cup = &fatal_cleanups; *cup; cup = &cu->next)
    {
      cu = *cup;
      if (cu->proc == proc && cu->context == context)
	{
	  *cup = cu->next;
	  xfree(cu);
	  return;
	}
    }
  fatal("fatal_remove_cleanup: no such cleanup function: 0x%lx 0x%lx\n",
	(unsigned long)proc, (unsigned long)context);
}

/* Cleanup and exit */
void
fatal_cleanup(void)
{
  struct fatal_cleanup *cu, *next_cu;
  static int called = 0;
  if (called)
    exit(255);
  called = 1;

  /* Call cleanup functions. */
  for (cu = fatal_cleanups; cu; cu = next_cu)
    {
      next_cu = cu->next;
      debug("Calling cleanup 0x%lx(0x%lx)",
	    (unsigned long)cu->proc, (unsigned long)cu->context);
      (*cu->proc)(cu->context);
    }

  exit(255);
}

/* textual representation of log-facilities/levels */


static struct 
{
  const char *name;
  SyslogFacility val;
} log_facilities[] =
{
  { "DAEMON", SYSLOG_FACILITY_DAEMON },
  { "USER", SYSLOG_FACILITY_USER },
  { "AUTH", SYSLOG_FACILITY_AUTH },
  { "LOCAL0", SYSLOG_FACILITY_LOCAL0 },
  { "LOCAL1", SYSLOG_FACILITY_LOCAL1 },
  { "LOCAL2", SYSLOG_FACILITY_LOCAL2 },
  { "LOCAL3", SYSLOG_FACILITY_LOCAL3 },
  { "LOCAL4", SYSLOG_FACILITY_LOCAL4 },
  { "LOCAL5", SYSLOG_FACILITY_LOCAL5 },
  { "LOCAL6", SYSLOG_FACILITY_LOCAL6 },
  { "LOCAL7", SYSLOG_FACILITY_LOCAL7 },
  { NULL, 0 }
};

static struct 
{
  const char *name;
  LogLevel val;
} log_levels[] =
{
  { "QUIET",   SYSLOG_LEVEL_QUIET },
  { "FATAL",   SYSLOG_LEVEL_FATAL },
  { "ERROR",   SYSLOG_LEVEL_ERROR },
  { "INFO",    SYSLOG_LEVEL_INFO },
  { "CHAT",	SYSLOG_LEVEL_CHAT },
  { "DEBUG",   SYSLOG_LEVEL_DEBUG },
  { NULL, 0 }
};

SyslogFacility
log_facility_number(char *name)
{
  int i;
  if (name != NULL)
    for (i = 0; log_facilities[i].name; i++)
      if (strcasecmp(log_facilities[i].name, name) == 0)
        return log_facilities[i].val;
  return (SyslogFacility)-1;
}

LogLevel
log_level_number(char *name)
{
  int i;
  if (name != NULL)
    for (i = 0; log_levels[i].name; i++)
      if (strcasecmp(log_levels[i].name, name) == 0)
        return log_levels[i].val;
  return (LogLevel)-1;
}