path: root/src/log.c

/*

    File: log.c

    Copyright (C) 1998-2007 Christophe GRENIER <grenier@cgsecurity.org>
  
    This software is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.
  
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
  
    You should have received a copy of the GNU General Public License along
    with this program; if not, write the Free Software Foundation, Inc., 51
    Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

 */
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#ifdef HAVE_STDLIB_H
#include <stdlib.h>
#endif
#include <stdio.h>
#ifdef HAVE_STRING_H
#include <string.h>
#endif
#include <stdarg.h>
#ifdef HAVE_TIME_H
#include <time.h>
#endif
#ifdef HAVE_SYS_TIME_H
#include <sys/time.h>
#endif
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif
#ifdef HAVE_SYS_CYGWIN_H
#include <sys/cygwin.h>
#endif
#include <errno.h>
#include "types.h"
#include "common.h"
#include "log.h"

#ifdef DISABLED_FOR_FRAMAC
#undef HAVE_DUP2
#endif

static FILE *log_handle=NULL;
static int f_status=0;

/* static unsigned int log_levels=LOG_LEVEL_DEBUG|LOG_LEVEL_TRACE|LOG_LEVEL_QUIET|LOG_LEVEL_INFO|LOG_LEVEL_VERBOSE|LOG_LEVEL_PROGRESS|LOG_LEVEL_WARNING|LOG_LEVEL_ERROR|LOG_LEVEL_PERROR|LOG_LEVEL_CRITICAL; */
static unsigned int log_levels=LOG_LEVEL_TRACE|LOG_LEVEL_QUIET|LOG_LEVEL_INFO|LOG_LEVEL_VERBOSE|LOG_LEVEL_PROGRESS|LOG_LEVEL_WARNING|LOG_LEVEL_ERROR|LOG_LEVEL_PERROR|LOG_LEVEL_CRITICAL;

/*@ assigns log_levels; */
unsigned int log_set_levels(const unsigned int levels)
{
  const unsigned int old_levels=log_levels;
  log_levels=levels;
  return old_levels;
}

/*@
  @ requires separation: \separated(default_filename, errsv, log_handle, &errno);
  @ assigns log_handle;
  @ assigns \result,errno,*errsv;
  @*/
int log_open(const char*default_filename, const int mode, int *errsv)
{
  log_handle=fopen(default_filename,(mode==TD_LOG_CREATE?"w":"a"));
  *errsv=errno;
#if defined(__CYGWIN__) || defined(__MINGW32__)
  if(log_handle!=NULL && mode!=TD_LOG_CREATE)
  {
    /* append doesn't work when running the executable via wine */
    if(fprintf(log_handle, "\n")<=0 || fflush(log_handle)!=0)
    {
      fclose(log_handle);
      log_handle=fopen(default_filename,"w");
      *errsv=errno;
    }
  }
#endif
  if(log_handle==NULL)
    return 0;
#if defined(HAVE_DUP2)
  dup2(fileno(log_handle),2);
#endif
  return 1;
}

/*@
  @ requires separation: \separated(default_filename, errsv, log_handle, &errno);
  @ assigns log_handle;
  @ assigns \result,errno,*errsv,__fc_heap_status;
  @*/
#if defined(__CYGWIN__) || defined(__MINGW32__)
int log_open_default(const char*default_filename, const int mode, int *errsv)
{
  char*filename;
  char *path;
  int result;
  if(log_handle != NULL)
    return 1;
  path = getenv("USERPROFILE");
  if (path == NULL)
    path = getenv("HOMEPATH");
  if(path == NULL)
    return log_open(default_filename, mode, errsv);
  /* Check to avoid buffer overflow may not be 100% bullet proof */
  if(strlen(path)+strlen(default_filename)+2 > 4096)
    return log_open(default_filename, mode, errsv);
  filename=(char*)MALLOC(4096);
#ifdef __CYGWIN__
  cygwin_conv_path(CCP_WIN_A_TO_POSIX, path, filename, 4096);
#else
  strcpy(filename, path);
#endif
  strcat(filename, "/");
  strcat(filename, default_filename);
  result=log_open(filename, mode, errsv);
  free(filename);
  return result;
}
#else
int log_open_default(const char*default_filename, const int mode, int *errsv)
{
  char*filename;
  char *path;
  int result;
  path = getenv("HOME");
  if(path == NULL)
    return log_open(default_filename, mode, errsv);
  /*@ assert strlen(path)+strlen(default_filename)+2 < UINT_MAX; */
  filename=(char*)MALLOC(strlen(path)+strlen(default_filename)+2);
#if defined(__FRAMAC__)
  result=0;
#else
  strcpy(filename, path);
  strcat(filename, "/");
  strcat(filename, default_filename);
  result=log_open(filename, mode, errsv);
#endif
  free(filename);
  return result;
}
#endif

/*@
  @ requires log_handle==\null || \valid(log_handle);
  @*/
int log_flush(void)
{
  return fflush(log_handle);
}

/*@
  @ requires \valid(log_handle);
  @ requires valid_read_string(_format);
  @ assigns f_status, *log_handle;
  @*/
// assigns *log_handle \from _format[..], ap;
static int log_handler(const char *_format, va_list ap) __attribute__((format(printf, 1, 0)));

static int log_handler(const char *_format, va_list ap)
{
  int res;
  res=vfprintf(log_handle,_format,ap);
  if(res<0)
  {
    f_status=1;
  }
  /* flushing the outputs slow down the program, don't flush. Hope it's not a bad idea */
  /*
     fflush(stderr);
     if(fflush(log_handle))
     {
     f_status=1;
     }
   */
  return res;
}

/*@
  @ requires log_handle == \null || \valid(log_handle);
  @ assigns \result,errno,log_handle;
  @ assigns f_status;
  @*/
int log_close(void)
{
  if(log_handle!=NULL)
  {
    if(fclose(log_handle))
      f_status=1;
    log_handle=NULL;
  }
  return f_status;
}

/*@
  @ requires log_handle == \null || \valid(log_handle);
  @ assigns *log_handle;
  @ assigns f_status;
  @*/
int log_redirect(const unsigned int level, const char *format, ...)
{
  if((log_levels & level)==0)
    return 0;
  if(log_handle==NULL)
    return 0;
  {
    int res;
    va_list ap;
    va_start(ap, format);
    res=log_handler(format, ap);
    va_end(ap);
    return res;
  }
}

void dump_log(const void *nom_dump, const unsigned int lng)
{
#ifndef DISABLED_FOR_FRAMAC
  const char *ptr=(const char*)nom_dump;
  const unsigned int nbr_line=(lng+0x10-1)/0x10;
  unsigned int i;
  /*@ assert \valid_read(ptr + (0 .. lng-1)); */
  /* write dump to log file*/
  /*@
    @ loop invariant 0 <= i <= nbr_line;
    @ loop assigns *log_handle, f_status, i;
    @ loop variant nbr_line - i;
    @*/
  for (i=0; i<nbr_line; i++)
  {
    unsigned int j;
    log_info("%04X ",i*0x10);
    /*@
      @ loop invariant 0 <= j <= 0x10;
      @ loop assigns *log_handle, f_status, j;
      @ loop variant 0x10 - j;
      @*/
    for(j=0; j< 0x10;j++)
    {
      const unsigned int o=i*0x10+j;
      if(o<lng)
      {
	/*@ assert o<lng; */
        /*@ assert \valid_read(ptr + (0 .. lng-1)); */
        log_info("%02x", ptr[o]);
      }
      else
        log_info("  ");
      if(j%4==(4-1))
        log_info(" ");
    }
    log_info("  ");
    /*@
      @ loop invariant 0 <= j <= 0x10;
      @ loop assigns *log_handle, f_status, j;
      @ loop variant 0x10 - j;
      @*/
    for(j=0; j< 0x10;j++)
    {
      const unsigned int o=i*0x10+j;
      if(o<lng)
      {
        const char car=ptr[o];
        if (car<32 || car >= 127)
          log_info(".");
        else
          log_info("%c",  car);
      }
      else
        log_info("  ");
    }
    log_info("\n");
  }
#endif
}

void dump2_log(const void *dump_1, const void *dump_2, const unsigned int lng)
{
#ifndef DISABLED_FOR_FRAMAC
  const char *ptr1=(const char*)dump_1;
  const char *ptr2=(const char*)dump_2;
  const unsigned int nbr_line=(lng+0x08-1)/0x08;
  unsigned int i,j;
  /* write dump to log file*/
  /*@
    @ loop invariant 0 <= i <= nbr_line;
    @ loop assigns *log_handle, f_status, i, j;
    @ loop variant nbr_line - i;
    @*/
  for (i=0; i<nbr_line; i++)
  {
    log_info("%04X ",i*0x08);
    /*@
      @ loop invariant 0 <= j <= 8;
      @ loop assigns *log_handle, f_status, j;
      @ loop variant 0x8 - j;
      @*/
    for(j=0; j<0x08;j++)
    {
      const unsigned int o=i*0x08+j;
      if(o<lng)
      {
        log_info("%02x", ptr1[o]);
      }
      else
        log_info("  ");
      if(j%4==(4-1))
        log_info(" ");
    }
    log_info("  ");
    /*@
      @ loop invariant 0 <= j <= 8;
      @ loop assigns *log_handle, f_status, j;
      @ loop variant 0x8 - j;
      @*/
    for(j=0; j<0x08;j++)
    {
      const unsigned int o=i*0x08+j;
      if(o<lng)
      {
        const char car=ptr1[o];
        if (car<32 || car >= 127)
          log_info(".");
        else
          log_info("%c",  car);
      }
      else
        log_info(" ");
    }
    log_info("  ");
    /*@
      @ loop invariant 0 <= j <= 8;
      @ loop assigns *log_handle, f_status, j;
      @ loop variant 0x8 - j;
      @*/
    for(j=0; j<0x08;j++)
    {
      const unsigned int o=i*0x08+j;
      if(o<lng)
      {
        log_info("%02x", ptr2[o]);
      }
      else
        log_info("  ");
      if(j%4==(4-1))
        log_info(" ");
    }
    log_info("  ");
    /*@
      @ loop invariant 0 <= j <= 8;
      @ loop assigns *log_handle, f_status, j;
      @ loop variant 0x8 - j;
      @*/
    for(j=0; j<0x08;j++)
    {
      const unsigned int o=i*0x08+j;
      if(o<lng)
      {
        const char car=ptr2[o];
        if (car<32 || car >= 127)
          log_info(".");
        else
          log_info("%c",  car);
      }
      else
        log_info(" ");
    }
    log_info("\n");
  }
#endif
}