hphp/util/cronoutils.h

   1 /* ====================================================================
   2  * Copyright (c) 1995-1999 The Apache Group.  All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  *
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  *
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in
  13  *    the documentation and/or other materials provided with the
  14  *    distribution.
  15  *
  16  * 3. All advertising materials mentioning features or use of this
  17  *    software must display the following acknowledgment:
  18  *    "This product includes software developed by the Apache Group
  19  *    for use in the Apache HTTP server project (http://www.apache.org/)."
  20  *
  21  * 4. The names "Apache Server" and "Apache Group" must not be used to
  22  *    endorse or promote products derived from this software without
  23  *    prior written permission. For written permission, please contact
  24  *    apache@apache.org.
  25  *
  26  * 5. Products derived from this software may not be called "Apache"
  27  *    nor may "Apache" appear in their names without prior written
  28  *    permission of the Apache Group.
  29  *
  30  * 6. Redistributions of any form whatsoever must retain the following
  31  *    acknowledgment:
  32  *    "This product includes software developed by the Apache Group
  33  *    for use in the Apache HTTP server project (http://www.apache.org/)."
  34  *
  35  * THIS SOFTWARE IS PROVIDED BY THE APACHE GROUP ``AS IS'' AND ANY
  36  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  37  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  38  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE APACHE GROUP OR
  39  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  40  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  41  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  42  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  43  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  44  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  45  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  46  * OF THE POSSIBILITY OF SUCH DAMAGE.
  47  * ====================================================================
  48  *
  49  * This software consists of voluntary contributions made by many
  50  * individuals on behalf of the Apache Group and was originally based
  51  * on public domain software written at the National Center for
  52  * Supercomputing Applications, University of Illinois, Urbana-Champaign.
  53  * For more information on the Apache Group and the Apache HTTP server
  54  * project, please see <http://www.apache.org/>.
  55  *
  56  */
  57 /*
  58  * cronoutils -- utilities for the cronolog program
  59  *
  60  * Copyright (c) 1996-1999 by Ford & Mason Ltd
  61  *
  62  * This software was submitted by Ford & Mason Ltd to the Apache
  63  * Software Foundation in December 1999.  Future revisions and
  64  * derivatives of this source code must acknowledge Ford & Mason Ltd
  65  * as the original contributor of this module.  All other licensing
  66  * and usage conditions are those of the Apache Software Foundation.
  67  *
  68  * Originally written by Andrew Ford <A.Ford@ford-mason.co.uk>
  69  *
  70  * For platforms that don't declare getopt() in header files the symbol
  71  * NEED_GETOPT_DEFS can be defined and declarations are provided here.
  72  */
  73
  74 #pragma once
  75
  76 /* Header files */
  77
  78 #include <ctype.h>
  79 #include <stdio.h>
  80 #include <stdlib.h>
  81 #include <stdarg.h>
  82 #include <errno.h>
  83 #include <fcntl.h>
  84 #include <limits.h>
  85 #include <string.h>
  86 #include <sys/types.h>
  87 #include <sys/stat.h>
  88 #include <time.h>
  89
  90 #include <folly/portability/SysTime.h>
  91 #include <folly/portability/Unistd.h>
  92
  93 /* Some operating systems don't declare getopt() */
  94
  95 #ifdef NEED_GETOPT_DEFS
  96 int getopt(int argc, char * const argv[], const char *optstring);
  97 extern char *optarg;
  98 extern int optind, opterr, optopt;
  99 #endif
 100
 101
 102 /* If log files are not rotated then this is when the first file
 103  * should be closed. */
 104
 105 #define FAR_DISTANT_FUTURE  LONG_MAX
 106
 107
 108 /* How often the log is rotated */
 109
 110 typedef enum
 111 {
 112   PER_SECOND,
 113   PER_MINUTE,
 114   HOURLY,
 115   DAILY,
 116   WEEKLY,
 117   MONTHLY,
 118   YEARLY,
 119   ONCE_ONLY,
 120   UNKNOWN,
 121   INVALID_PERIOD
 122 }
 123 PERIODICITY;
 124
 125
 126 /* Function prototypes */
 127
 128 void    create_subdirs(char *);
 129 void    create_link(const char *, const char *, mode_t, const char *);
 130 PERIODICITY  determine_periodicity(char *);
 131 PERIODICITY   parse_timespec(char *optarg, int *p_period_multiple);
 132 time_t    start_of_next_period(time_t, PERIODICITY, int);
 133 time_t    start_of_this_period(time_t, PERIODICITY, int);
 134 void    print_debug_msg(const char *msg, ...);
 135 time_t    parse_time(char *time_str, int);
 136 char     *timestamp(time_t thetime);
 137
 138
 139 /* Global variables */
 140
 141 extern FILE  *debug_file;
 142 extern const char  *periods[];
 143 extern int  period_seconds[];
 144
 145
 146 /* Usage message and CRONO_DEBUG macro.
 147  */
 148
 149 #ifdef CRONO_DEBUG
 150 #undef CRONO_DEBUG
 151 #endif
 152
 153 #define CRONO_DEBUG(msg_n_args)  \
 154 do { if (debug_file) print_debug_msg  msg_n_args; } while (0)
 155