logfile_gener.c File Reference

Detailed Description

This file provides functions for creating time-based filenames, timestamps, and for breaking down and retrieving the current time in various formats.

Copyright

• (c) 2002 The University of Chicago, as Operator of Argonne National Laboratory.
• (c) 2002 The Regents of the University of California, as Operator of Los Alamos National Laboratory.

License

This file is distributed under the terms of the Software License Agreement found in the file LICENSE included with this distribution.

Author

M. Borland, R. Soliday

Definition in file logfile_gener.c.

#include "mdb.h"
#include <unistd.h>
#include <time.h>

Go to the source code of this file.

Functions
char *	makeTimeStamp (double Time)
	Create a human-readable timestamp from the given time in seconds since the Epoch.
void	getTimeBreakdown (double *ptrTime, double *ptrDay, double *ptrHour, double *ptrJulianDay, double *ptrMonth, double *ptrYear, char **ptrTimeStamp)
	Retrieve detailed time breakdown (day, hour, julian day, month, year, and timestamp).
double	getHourOfDay ()
	Get the current hour of the day (0-23, possibly fractional).
void	makeTimeBreakdown (double Time, double *ptrTime, double *ptrDay, double *ptrHour, double *ptrJulianDay, double *ptrMonth, double *ptrYear, char **ptrTimeStamp)
	Break down a given time into multiple components (time, day, hour, Julian day, month, year, and timestamp).
double	computeYearStartTime (double StartTime)
	Compute the start time of the year for the given time.
double	getTimeInSecs ()
	Get the current time in seconds since the Epoch with high resolution.
long double	getLongDoubleTimeInSecs ()
	Get the current time in seconds since the Epoch as a long double for higher precision.
char *	MakeGenerationFilename (char *rootname, long digits, char *delimiter, char *lastFile)
	Generate a new filename with an incremented index based on a root name and delimiter.
char *	MakeSCRDailyTimeGenerationFilename (char *rootname)
	Generate a new daily filename with a timestamp based on the current date and time.
char *	MakeDailyGenerationFilename (char *rootname, long digits, char *delimiter, long timetag)
	Generate a new daily filename. Can include a time tag or a numeric index.
char *	MakeMonthlyGenerationFilename (char *rootname, long digits, char *delimiter, long timetag)
	Generate a new monthly filename. Can include a time tag or a numeric index.
void	usleepSystemIndependent (long usec)
	Sleep for a given number of microseconds, system-independently.
char *	getHourMinuteSecond ()
	Get the current hour, minute, and second as a string.
void	checkGenerationFileLocks (char *match_date)
	Check for matching date-based generation files and ensure none are locked.
void	TouchFile (char *filename)
	Update the modification timestamp of a file if it exists.

Function Documentation

checkGenerationFileLocks()

void checkGenerationFileLocks

(

char *

match_date

)

Check for matching date-based generation files and ensure none are locked.

Parameters

match_date

Date pattern to match.

Definition at line 648 of file logfile_gener.c.

                                                {
#if !defined(vxWorks) && !defined(__rtems__) && !defined(__CYGWIN__)
  char comm[1024], filename[2048], buffer[1024];
  FILE *handle, *fp;
 
  sprintf(comm, "ls %s* 2> /dev/stdout", match_date);
  if (!(handle = popen(comm, "r"))) {
    fprintf(stderr, "Error: no data returned from popen call\n");
    exit(1);
  }
  while (!feof(handle)) {
    if (fgets(filename, sizeof(filename), handle)) {
      if (filename[strlen(filename) - 1] == '\n') {
        filename[strlen(filename) - 1] = 0;
      }
      if (!(fp = fopen(filename, "r")))
        continue;
      if (lockf(fileno(fp), F_TEST, 0) == -1) {
        /* file exists and is locked */
        fclose(fp);
        sprintf(buffer, "aborting--previous generation %s is still active",
                filename);
        fprintf(stderr, "Warning: %s\n", buffer);
        exit(0);
      }
      fclose(fp);
    }
  }
#endif
}

computeYearStartTime()

double computeYearStartTime

(

double

StartTime

)

Compute the start time of the year for the given time.

Parameters

StartTime

Time in seconds since the Epoch.

Returns

Start-of-year time in seconds since the Epoch.

Definition at line 202 of file logfile_gener.c.

                                              {
  struct tm *YearStart;
  time_t intTime;
 
  intTime = StartTime;
  YearStart = localtime(&intTime);
  YearStart->tm_sec = 0;
  YearStart->tm_min = 0;
  YearStart->tm_hour = 0;
  YearStart->tm_mday = 1;
  YearStart->tm_mon = 0;
#if defined(SUNOS4)
  return (double)timelocal(YearStart);
#else
  return (double)mktime(YearStart);
#endif
}

getHourMinuteSecond()

char * getHourMinuteSecond

(

)

Get the current hour, minute, and second as a string.

Returns

Pointer to a static string (e.g., "HH:MM:SS").

Definition at line 626 of file logfile_gener.c.

                            {
  time_t now;
  char *Hour, *ptr;
  int i = 0;
 
  now = time(NULL);
  Hour = ctime(&now);
  ptr = strtok(Hour, " ");
  i++;
  while (ptr != NULL) {
    if (i == 4)
      break;
    ptr = strtok(NULL, " ");
    i++;
  }
  return ptr;
}

getHourOfDay()

double getHourOfDay

(

)

Get the current hour of the day (0-23, possibly fractional).

Returns

Hour of the day.

Definition at line 113 of file logfile_gener.c.

                      {
  double theTime, hour;
  theTime = getTimeInSecs(); /* may get more precision than time() offers */
  makeTimeBreakdown(theTime, NULL, NULL, &hour, NULL, NULL, NULL, NULL);
  return hour;
}

getLongDoubleTimeInSecs()

long double getLongDoubleTimeInSecs

(

)

Get the current time in seconds since the Epoch as a long double for higher precision.

Returns

Current time in seconds as a long double.

Definition at line 297 of file logfile_gener.c.

                                      {
#if defined(_WIN32)
  struct timespecoag tp;
  clock_gettime_oag(&tp);
  return ((long double)tp.tv_sec) + ((long double)tp.tv_nsec) * 1e-9L;
#endif
 
#if defined(__APPLE__) /* This is only needed until I compile on MacOS 10.12 */
#  include <sys/time.h>
  struct timeval tv;
  gettimeofday(&tv, NULL);
  return ((long double)tv.tv_sec) + ((long double)tv.tv_usec) * 1e-6L;
#endif
 
#if !defined(_WIN32) && !defined(__APPLE__)
#  include <time.h>
  struct timespec tp;
  clock_gettime(CLOCK_REALTIME, &tp);
  return ((long double)tp.tv_sec) + ((long double)tp.tv_nsec) * 1e-9L;
#endif
}

getTimeBreakdown()

void getTimeBreakdown	(	double *	ptrTime,
		double *	ptrDay,
		double *	ptrHour,
		double *	ptrJulianDay,
		double *	ptrMonth,
		double *	ptrYear,
		char **	ptrTimeStamp )

Retrieve detailed time breakdown (day, hour, julian day, month, year, and timestamp).

Parameters

ptrTime	If not NULL, stores the time in seconds since the Epoch.
ptrDay	If not NULL, stores the day of the month (fractional).
ptrHour	If not NULL, stores the hour of the day (fractional).
ptrJulianDay	If not NULL, stores the Julian day (fractional).
ptrMonth	If not NULL, stores the month of the year (fractional).
ptrYear	If not NULL, stores the year (fractional).
ptrTimeStamp	If not NULL, stores a pointer to a timestamp string.

Definition at line 100 of file logfile_gener.c.

                                                            {
  double theTime;
  theTime = getTimeInSecs(); /* may get more precision than time() offers */
  makeTimeBreakdown(theTime, ptrTime, ptrDay, ptrHour, ptrJulianDay,
                    ptrMonth, ptrYear, ptrTimeStamp);
}

getTimeInSecs()

double getTimeInSecs

(

)

Get the current time in seconds since the Epoch with high resolution.

Returns

Current time in seconds.

Definition at line 271 of file logfile_gener.c.

                       {
#if defined(_WIN32)
  struct timespecoag tp;
  clock_gettime_oag(&tp);
  return ((double)tp.tv_sec) + ((double)tp.tv_nsec) * 1e-9;
#endif
 
#if defined(__APPLE__) /* This is only needed until I compile on MacOS 10.12 */
#  include <sys/time.h>
  struct timeval tv;
  gettimeofday(&tv, NULL);
  return ((double)tv.tv_sec) + ((double)tv.tv_usec) * 1e-6;
#endif
 
#if !defined(_WIN32) && !defined(__APPLE__)
#  include <time.h>
  struct timespec tp;
  clock_gettime(CLOCK_REALTIME, &tp);
  return ((double)tp.tv_sec) + ((double)tp.tv_nsec) * 1e-9;
#endif
}

MakeDailyGenerationFilename()

char * MakeDailyGenerationFilename	(	char *	rootname,
		long	digits,
		char *	delimiter,
		long	timetag )

Generate a new daily filename. Can include a time tag or a numeric index.

Parameters

rootname	Base name for the file.
digits	Number of digits for the index.
delimiter	Delimiter between parts of the filename.
timetag	If non-zero, includes a time tag in the filename.

Returns

Newly allocated string containing the daily generated filename.

Definition at line 429 of file logfile_gener.c.

                                                                                              {
#if !defined(vxWorks)
  char buffer[1100];
#endif
  char format[100], filename[1024], *name, *hourNow, match_date[1024];
  long index = 1;
  FILE *fp;
  double dayDbl, jDayDbl, monthDbl, yearDbl, theTime;
  long day, jDay, month, year;
 
  if (digits < 0)
    digits = DEFAULT_GENERATIONS_DIGITS;
  theTime = getTimeInSecs();
  makeTimeBreakdown(theTime, NULL, &dayDbl, NULL, &jDayDbl, &monthDbl, &yearDbl, NULL);
  day = dayDbl;
  jDay = jDayDbl;
  month = monthDbl;
  year = yearDbl;
 
  if (timetag) {
    hourNow = getHourMinuteSecond();
    if (rootname && strlen(rootname) > 0)
      sprintf(match_date, "%s-%4ld-%03ld-%02ld%02ld", rootname, year, jDay, month, day);
    else
      sprintf(match_date, "%4ld-%03ld-%02ld%02ld", year, jDay, month, day);
    checkGenerationFileLocks(match_date);
    if (rootname && strlen(rootname) > 0)
      sprintf(filename, "%s-%4ld-%03ld-%02ld%02ld.%s", rootname,
              year, jDay, month, day, hourNow);
    else
      sprintf(filename, "%4ld-%03ld-%02ld%02ld.%s", year, jDay, month, day, hourNow);
  } else {
    if (!digits) {
      if (rootname && strlen(rootname) > 0)
        sprintf(filename, "%s-%4ld-%03ld-%02ld%02ld", rootname, year, jDay, month, day);
      else
        sprintf(filename, "%4ld-%03ld-%02ld%02ld", year, jDay, month, day);
      if ((fp = fopen(filename, "r"))) {
#if !defined(vxWorks) && !defined(__rtems__) && !defined(__CYGWIN__)
        if (lockf(fileno(fp), F_TEST, 0) == -1) {
          /* file exists and is locked */
          fclose(fp);
          sprintf(buffer, "aborting--previous generation of %s is still active", filename);
          fprintf(stderr, "Warning: %s\n", buffer);
          exit(0);
        }
#endif
      }
    } else {
      if (!delimiter || strlen(delimiter) == 0)
        return NULL;
      if (rootname && strlen(rootname) > 0)
        sprintf(format, "%s-%%4ld-%%03ld-%%02ld%%02ld%s%%0%ldld", rootname, delimiter, digits);
      else
        sprintf(format, "%%4ld-%%03ld-%%02ld%%02ld%s%%0%ldld", delimiter, digits);
      do {
        sprintf(filename, format, year, jDay, month, day, index);
        index++;
        if (!(fp = fopen(filename, "r")))
          break;
        theTime = getTimeInSecs();
        makeTimeBreakdown(theTime, NULL, &dayDbl, NULL, &jDayDbl, &monthDbl, &yearDbl, NULL);
        day = dayDbl;
        jDay = jDayDbl;
        month = monthDbl;
        year = yearDbl;
#if !defined(vxWorks) && !defined(__rtems__) && !defined(__CYGWIN__)
        if (lockf(fileno(fp), F_TEST, 0) == -1) {
          /* file exists and is locked */
          fclose(fp);
          sprintf(buffer, "aborting--previous generation of %s (%s) is still active", rootname,
                  filename);
          fprintf(stderr, "Warning: %s\n", buffer);
          exit(0);
        }
#endif
        fclose(fp);
      } while (1);
    }
  }
  if (!(name = malloc(sizeof(*name) * (strlen(filename) + 1)))) {
    fprintf(stderr, "Error: memory allocation failure making generation filename\n");
    exit(1);
  }
  return strcpy(name, filename);
}

MakeGenerationFilename()

char * MakeGenerationFilename	(	char *	rootname,
		long	digits,
		char *	delimiter,
		char *	lastFile )

Generate a new filename with an incremented index based on a root name and delimiter.

Parameters

rootname	Base name for the file.
digits	Number of digits to use for the index.
delimiter	Delimiter between root name and index.
lastFile	Last generated filename, used to determine the next index.

Returns

Newly allocated string containing the generated filename.

Definition at line 327 of file logfile_gener.c.

                                                                                           {
  char format[100], filename[1024], buffer[1100], *name, *ptr, *ptr1;
  long index = 1;
  FILE *fp;
 
  if (!rootname || strlen(rootname) == 0)
    return NULL;
  if (digits < 1)
    digits = DEFAULT_GENERATIONS_DIGITS;
 
  if (lastFile && strlen(lastFile)) {
    ptr1 = lastFile;
    ptr = NULL;
    while ((ptr1 = strstr(ptr1, delimiter))) {
      ptr = ptr1;
      ptr1 += 1;
    }
    if (ptr) {
      ptr += strlen(delimiter);
      while (*ptr == '0')
        ptr++;
      if (sscanf(ptr, "%ld", &index) != 1) {
        sprintf(buffer, "Error scanning name of last file: %s", lastFile);
        fprintf(stderr, "Error: %s\n", buffer);
        exit(1);
      }
    } else {
      sprintf(buffer, "Error scanning name of last file: %s", lastFile);
      fprintf(stderr, "Error: %s\n", buffer);
      exit(1);
    }
    if (!fexists(lastFile))
      index += 1; /* avoids reuse of the file even if it has been deleted */
  }
 
  sprintf(format, "%%s%s%%0%ldld", delimiter, digits);
 
  do {
    sprintf(filename, format, rootname, index);
    index++;
    if (!(fp = fopen(filename, "r")))
      break;
#if !defined(vxWorks) && !defined(__rtems__) && !defined(__CYGWIN__)
    if (lockf(fileno(fp), F_TEST, 0) == -1) {
      /* file exists and is locked */
      fclose(fp);
      sprintf(buffer, "aborting--previous generation of %s (%s) is still active", rootname,
              filename);
      fprintf(stderr, "Warning: %s\n", buffer);
      exit(0);
    }
#endif
    fclose(fp);
  } while (1);
  if (!(name = malloc(sizeof(*name) * (strlen(filename) + 1)))) {
    fprintf(stderr, "Error: memory allocation failure making generation filename\n");
    exit(1);
  }
  return strcpy(name, filename);
}

MakeMonthlyGenerationFilename()

char * MakeMonthlyGenerationFilename	(	char *	rootname,
		long	digits,
		char *	delimiter,
		long	timetag )

Generate a new monthly filename. Can include a time tag or a numeric index.

Parameters

rootname	Base name for the file.
digits	Number of digits for the index.
delimiter	Delimiter between parts of the filename.
timetag	If non-zero, includes a time tag in the filename.

Returns

Newly allocated string containing the monthly generated filename.

Definition at line 524 of file logfile_gener.c.

                                                                                                {
#if !defined(vxWorks)
  char buffer[1100];
#endif
  char format[100], filename[1024], *name, *hourNow, match_date[1024];
  long index = 1;
  FILE *fp;
  double dayDbl, jDayDbl, monthDbl, yearDbl, theTime;
  long month, year;
 
  if (digits < 0)
    digits = DEFAULT_GENERATIONS_DIGITS;
  theTime = getTimeInSecs();
  makeTimeBreakdown(theTime, NULL, &dayDbl, NULL, &jDayDbl, &monthDbl, &yearDbl, NULL);
  month = monthDbl;
  year = yearDbl;
 
  if (timetag) {
    hourNow = getHourMinuteSecond();
    if (rootname && strlen(rootname) > 0)
      sprintf(match_date, "%s-%4ld-%02ld", rootname, year, month);
    else
      sprintf(match_date, "%4ld-%02ld", year, month);
    checkGenerationFileLocks(match_date);
    if (rootname && strlen(rootname) > 0)
      sprintf(filename, "%s-%4ld-%02ld.%s", rootname,
              year, month, hourNow);
    else
      sprintf(filename, "%4ld-%02ld.%s", year, month, hourNow);
  } else {
    if (!digits) {
      if (rootname && strlen(rootname) > 0)
        sprintf(filename, "%s-%4ld-%02ld", rootname, year, month);
      else
        sprintf(filename, "%4ld-%02ld", year, month);
      if ((fp = fopen(filename, "r"))) {
#if !defined(vxWorks) && !defined(__rtems__) && !defined(__CYGWIN__)
        if (lockf(fileno(fp), F_TEST, 0) == -1) {
          /* file exists and is locked */
          fclose(fp);
          sprintf(buffer, "aborting--previous generation of %s is still active", filename);
          fprintf(stderr, "Warning: %s\n", buffer);
          exit(0);
        }
#endif
      }
    } else {
      if (!delimiter || strlen(delimiter) == 0)
        return NULL;
      if (rootname && strlen(rootname) > 0)
        sprintf(format, "%s-%%4ld-%%02ld%s%%0%ldld", rootname, delimiter, digits);
      else
        sprintf(format, "%%4ld-%%02ld%s%%0%ldld", delimiter, digits);
      do {
        sprintf(filename, format, year, month, index);
        index++;
        if (!(fp = fopen(filename, "r")))
          break;
          /* theTime = getTimeInSecs(); */
          /* makeTimeBreakdown(theTime, NULL, &dayDbl, NULL, &jDayDbl, &monthDbl, &yearDbl, NULL); */
          /* month = monthDbl; */
          /* year = yearDbl; */
#if !defined(vxWorks) && !defined(__rtems__) && !defined(__CYGWIN__)
        if (lockf(fileno(fp), F_TEST, 0) == -1) {
          /* file exists and is locked */
          fclose(fp);
          sprintf(buffer, "aborting--previous generation of %s (%s) is still active", rootname,
                  filename);
          fprintf(stderr, "Warning: %s\n", buffer);
          exit(0);
        }
#endif
        fclose(fp);
      } while (1);
    }
  }
  if (!(name = malloc(sizeof(*name) * (strlen(filename) + 1)))) {
    fprintf(stderr, "Error: memory allocation failure making generation filename\n");
    exit(1);
  }
  return strcpy(name, filename);
}

MakeSCRDailyTimeGenerationFilename()

char * MakeSCRDailyTimeGenerationFilename

(

char *

rootname

)

Generate a new daily filename with a timestamp based on the current date and time.

Parameters

rootname

Base name for the file.

Returns

Newly allocated string containing the generated filename.

Definition at line 393 of file logfile_gener.c.

                                                         {
  char buffer[1024];
  char filename[1024];
  char *name;
  time_t now;
  struct tm *now1;
  FILE *fp;
 
  if (!rootname) {
    fprintf(stderr, "The rootname is not provided.\n");
    exit(1);
  }
  /*generate a new file name */
  do {
    now = time(NULL);
    now1 = localtime(&now);
    strftime(buffer, 1024, "%Y-%j-%m%d-%H%M%S", now1);
    sprintf(filename, "%s%s", rootname, buffer);
    fp = fopen(filename, "r");
  } while (fp != NULL);
 
  if (!(name = malloc(sizeof(*name) * (strlen(filename) + 1)))) {
    fprintf(stderr, "Error: memory allocation failure making generation filename\n");
    exit(1);
  }
  return strcpy(name, filename);
}

makeTimeBreakdown()

void makeTimeBreakdown	(	double	Time,
		double *	ptrTime,
		double *	ptrDay,
		double *	ptrHour,
		double *	ptrJulianDay,
		double *	ptrMonth,
		double *	ptrYear,
		char **	ptrTimeStamp )

Break down a given time into multiple components (time, day, hour, Julian day, month, year, and timestamp).

Parameters

Time	Time in seconds since the Epoch.
ptrTime	If not NULL, stores the input time value.
ptrDay	If not NULL, stores the day of the month (fractional).
ptrHour	If not NULL, stores the hour of the day (fractional).
ptrJulianDay	If not NULL, stores the Julian day (fractional).
ptrMonth	If not NULL, stores the month (fractional).
ptrYear	If not NULL, stores the year (fractional).
ptrTimeStamp	If not NULL, stores a timestamp string.

Definition at line 146 of file logfile_gener.c.

                                            {
  double SubSeconds;
  double Day, Hour, JulianDay, Year;
  struct tm *tmBreakdown;
  time_t integerTime;
  long isLeap;
 
  if (ptrTime)
    *ptrTime = Time;
  if (ptrTimeStamp)
    *ptrTimeStamp = makeTimeStamp(Time);
 
  /* get breakdown based on integer part of time */
  integerTime = (time_t)Time;
  SubSeconds = Time - integerTime;
  tmBreakdown = localtime(&integerTime);
 
  /* time since midnight in hours */
  Hour = (tmBreakdown->tm_min + (tmBreakdown->tm_sec + SubSeconds) / 60.0) / 60.0 + tmBreakdown->tm_hour;
  if (ptrHour)
    *ptrHour = Hour;
 
  /* time since beginning of month in days (includes partial days) */
  Day = tmBreakdown->tm_mday + Hour / 24.0;
  if (ptrDay)
    *ptrDay = Day;
 
  /* time since start of year in days (includes partial days) plus 1 day to give Julian convention */
  JulianDay = tmBreakdown->tm_yday + Hour / 24.0 + 1;
  if (ptrJulianDay)
    *ptrJulianDay = JulianDay;
 
  /* years since 0000 AD, including fractional years */
  isLeap = 0;
  tmBreakdown->tm_year += 1900;
  if ((tmBreakdown->tm_year % 4 == 0 && tmBreakdown->tm_year % 100 != 0) || tmBreakdown->tm_year % 400 == 0)
    isLeap = 1;
  Year = tmBreakdown->tm_year + (JulianDay - 1) / (365.0 + isLeap);
  if (ptrYear)
    *ptrYear = Year;
 
  /* time since start of year in 30-day months (includes partial days) */
  if (ptrMonth) {
    *ptrMonth = tmBreakdown->tm_mon + 1 +
                +(1.0 * tmBreakdown->tm_mday - 1) / (daysInMonth[tmBreakdown->tm_mon] +
                                                     (isLeap && tmBreakdown->tm_mon == 1 ? 1 : 0));
  }
}

makeTimeStamp()

char * makeTimeStamp

(

double

Time

)

Create a human-readable timestamp from the given time in seconds since the Epoch.

Parameters

Time	Time in seconds since the Epoch.

Returns

Pointer to a static string containing the formatted timestamp.

Definition at line 81 of file logfile_gener.c.

                                 {
  time_t intTime;
  char *TimeStamp;
  intTime = Time;
  TimeStamp = ctime(&intTime);
  TimeStamp[strlen(TimeStamp) - 1] = 0; /* kill newline */
  return TimeStamp;
}

TouchFile()

void TouchFile

(

char *

filename

)

Update the modification timestamp of a file if it exists.

Parameters

filename

File to "touch."

Definition at line 683 of file logfile_gener.c.

                               {
#if !defined(vxWorks) && !defined(__rtems__)
  FILE *fp;
  static FILE *fsh = NULL;
 
  if (!fsh) {
    if (!(fsh = popen("csh", "w"))) {
      fprintf(stderr, "Error: unable to launch csh for touchFile operations\n");
      exit(1);
    }
  }
  if (filename) {
    if ((fp = fopen(filename, "r"))) {
      fclose(fp);
      fprintf(fsh, "touch %s\n", filename);
      fflush(fsh);
    }
  }
#endif
}

usleepSystemIndependent()

void usleepSystemIndependent

(

long

usec

)

Sleep for a given number of microseconds, system-independently.

Parameters

usec	Number of microseconds to sleep.

Definition at line 611 of file logfile_gener.c.

                                        {
#if defined(vxWorks) && !defined(__rtems__)
  struct timespec rqtp;
  rqtp.tv_sec = (long)(usec / 1000000);
  rqtp.tv_nsec = usec % 1000000 * 1000;
  nanosleep(&rqtp, NULL);
#else
  usleep(usec);
#endif
}