granicus.if.org Git - fcron/blob - global.h

   1 /*
   2  * FCRON - periodic command scheduler
   3  *
   4  *  Copyright 2000-2010 Thibault Godouet <fcron@free.fr>
   5  *
   6  *  This program is free software; you can redistribute it and/or modify
   7  *  it under the terms of the GNU General Public License as published by
   8  *  the Free Software Foundation; either version 2 of the License, or
   9  *  (at your option) any later version.
  10  *
  11  *  This program is distributed in the hope that it will be useful,
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  *  GNU General Public License for more details.
  15  *
  16  *  You should have received a copy of the GNU General Public License
  17  *  along with this program; if not, write to the Free Software
  18  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  *
  20  *  The GNU General Public License can also be found in the file
  21  *  `LICENSE' that comes with the fcron source distribution.
  22  */
  23
  24  /* $Id: global.h,v 1.51 2007-06-24 22:01:49 thib Exp $ */
  25
  26
  27 /*
  28    WARNING : this file should not be modified.
  29    Compilation's options are in config.h
  30 */
  31
  32 #ifndef __GLOBAL_H__
  33 #define __GLOBAL_H__
  34
  35 /* config.h must be included before every other includes
  36  * (contains the compilation options) */
  37 #include "config.h"
  38
  39
  40 #include <ctype.h>
  41
  42 #ifdef HAVE_ERRNO_H
  43 #include <errno.h>
  44 #endif
  45
  46 #ifdef WITH_SELINUX
  47 #include <selinux.h>
  48 #include <get_context_list.h>
  49 #include <selinux/flask.h>
  50 #include <selinux/av_permissions.h>
  51 #endif
  52
  53 #ifdef HAVE_GETOPT_H
  54 #include <getopt.h>
  55 #endif
  56
  57 #ifdef HAVE_GRP_H
  58 #include <grp.h>
  59 #endif
  60
  61 #ifdef HAVE_LIMITS_H
  62 #include <limits.h>
  63 #endif
  64
  65 #include <pwd.h>
  66 #include <signal.h>
  67
  68 #ifdef HAVE_STDARG_H
  69 #include <stdarg.h>
  70 #endif
  71
  72 #include <stdio.h>
  73 #include <stdlib.h>
  74 #include <string.h>
  75
  76 #ifdef HAVE_STRINGS_H
  77 #include <strings.h>
  78 #endif
  79
  80 #ifdef HAVE_SYS_FILE_H
  81 #include <sys/file.h>
  82 #endif
  83
  84 #include <sys/stat.h>
  85 #include <sys/types.h>
  86
  87 #ifdef HAVE_SYS_WAIT_H
  88 #include <sys/wait.h>
  89 #endif
  90
  91 #ifdef HAVE_SYSLOG_H
  92 #include <syslog.h>
  93 #endif
  94
  95 #ifdef TIME_WITH_SYS_TIME
  96 #include <time.h>
  97 #elif HAVE_SYS_TIME_H
  98 #include <sys/time.h>
  99 #endif
 100
 101 #ifdef HAVE_TERMIOS_H
 102 #include <termios.h>
 103 #endif
 104
 105 #ifdef HAVE_UNISTD_H
 106 #include <unistd.h>
 107 #endif
 108
 109 #ifdef HAVE_FCNTL_H
 110 #include <fcntl.h>
 111 #elif HAVE_SYS_FCNTL_H
 112 #include <sys/fcntl.h>
 113 #endif
 114
 115 #ifdef HAVE_LIBPAM
 116 #include "pam.h"
 117 #endif
 118
 119 #include "bitstring.h"     /* bit arrays */
 120 #include "option.h"        /* manage fcrontab's options */
 121
 122 /* you should not change this (nor need to do it) */
 123 #define ERR     -1
 124 #define OK       0
 125
 126 /* options for local functions */
 127 #define STD 0
 128
 129 /* macros */
 130 #ifndef HAVE_SETEUID
 131 #define seteuid(arg) setresuid(-1,(arg),-1)
 132 #endif
 133
 134 #ifndef HAVE_SETEGID
 135 #define setegid(arg) setresgid(-1,(arg),-1)
 136 #endif
 137
 138 #define Alloc(PTR, TYPE) \
 139         if( (PTR = calloc(1, sizeof(TYPE))) == NULL ) \
 140             die_e("Could not calloc.");
 141
 142 #define Set(VAR, VALUE) \
 143         { \
 144           free(VAR); \
 145           VAR = strdup2(VALUE); \
 146         }
 147
 148 #define Flush(VAR) \
 149         { \
 150           free(VAR); \
 151           VAR = NULL; \
 152         }
 153
 154 #define Skip_blanks(PTR) \
 155         while((*(PTR) == ' ') || (*(PTR) == '\t')) \
 156             (PTR)++;
 157
 158 #define Overwrite(x) \
 159         do {                     \
 160           register char *__xx__; \
 161           if ((__xx__=(x)))      \
 162             while (*__xx__)      \
 163               *__xx__++ = '\0';  \
 164         } while (0)
 165
 166 #define debug if(debug_opt) Debug
 167
 168 typedef struct env_t {
 169     char         *e_val;        /* env value                            */
 170     struct env_t *e_next;
 171 } env_t ;
 172
 173 typedef struct cf_t {
 174     struct cf_t  *cf_next;
 175     struct cl_t  *cf_line_base;
 176     char         *cf_user;      /* user-name                                 */
 177     struct env_t *cf_env_base;  /* list of all env variables to set          */
 178     int           cf_running;   /* number of jobs running                    */
 179     signed char   cf_tzdiff;    /* time diff between system and local hour   */
 180 #ifdef WITH_SELINUX
 181     security_context_t cf_user_context;
 182     security_context_t cf_file_context;
 183 #endif
 184 } cf_t;
 185
 186
 187 #define OPTION_SIZE 4
 188 #define LAVG_SIZE 3
 189 /* warning : do not change the order of the members of this structure
 190  *   because some tests made are dependent to that order */
 191 /* warning : if you change a field type, you may have to also make some changes
 192  *   in the save/load binary fcrontab functions */
 193 typedef struct cl_t {
 194     struct cl_t   *cl_next;
 195     struct cf_t   *cl_file;       /* the file in which the line is           */
 196     char          *cl_shell;      /* shell command                           */
 197     char          *cl_runas;      /* determine permissions of the job        */
 198     char          *cl_mailto;     /* mail output to cl_mailto                */
 199     char          *cl_tz;         /* time zone of the line                   */
 200     long int       cl_id;         /* line's unique id number                 */
 201     time_t         cl_until;      /* timeout of the wait for a lavg value    */
 202     time_t         cl_first;      /* initial delay preserved for volatile entries */
 203     time_t         cl_nextexe;    /* time and date of the next execution     */
 204     long int       cl_timefreq;   /* Run every n seconds                     */
 205     unsigned short cl_remain;     /* remaining until next execution          */
 206     unsigned short cl_runfreq;    /* Run once every n matches(=1 for %-lines)*/
 207     unsigned char  cl_option[OPTION_SIZE]; /* line's option (see option.h)   */
 208     unsigned char  cl_lavg[LAVG_SIZE];/*load averages needed (1,5,15 mins)   */
 209     unsigned char  cl_numexe;     /* entries in queues & running processes   */
 210     char           cl_nice;       /* nice value to control priority          */
 211     /* see bitstring(3) man page for more details */
 212     bitstr_t       bit_decl(cl_mins, 60); /* 0-59                            */
 213     bitstr_t       bit_decl(cl_hrs, 24);  /* 0-23                            */
 214     bitstr_t       bit_decl(cl_days, 32); /* 1-31                            */
 215     bitstr_t       bit_decl(cl_mons, 12); /* 0-11                            */
 216     bitstr_t       bit_decl(cl_dow, 8);   /* 0-7, 0 and 7 are both Sunday    */
 217 } cl_t;
 218
 219 typedef struct job_t {
 220     struct cl_t  *j_line;
 221     struct job_t   *j_next;
 222 } job_t;
 223
 224 typedef struct lavg_t {
 225     struct cl_t *l_line;
 226     time_t       l_until;   /* the timeout of the wait for load averages */
 227 } lavg_t;
 228
 229 typedef struct exe_t {
 230     struct cl_t *e_line;
 231     pid_t        e_ctrl_pid; /* pid of the fcron process controling the job */
 232     pid_t        e_job_pid;  /* pid of the job itself */
 233 } exe_t;
 234
 235
 236 #if SIZEOF_TIME_T == SIZEOF_SHORT_INT
 237 #define ATTR_SIZE_TIMET "h"
 238 #define CAST_TIMET_PTR (short int *)
 239 #elif SIZEOF_TIME_T == SIZEOF_INT
 240 #define ATTR_SIZE_TIMET ""
 241 #define CAST_TIMET_PTR (int *)
 242 #elif SIZEOF_TIME_T == SIZEOF_LONG_INT
 243 #define ATTR_SIZE_TIMET "l"
 244 #define CAST_TIMET_PTR (long int *)
 245 #elif SIZEOF_TIME_T == SIZEOF_LONG_LONG_INT
 246 #define ATTR_SIZE_TIMET "ll"
 247 #define CAST_TIMET_PTR (long long int *)
 248 #else
 249 #error "SIZEOF_TIME_T does not correspond with a known format."
 250 #endif
 251
 252 #if SIZEOF_PID_T == SIZEOF_SHORT_INT
 253 #define ATTR_SIZE_PIDT "h"
 254 #define CAST_PIDT_PTR (short int *)
 255 #elif SIZEOF_PID_T == SIZEOF_INT
 256 #define ATTR_SIZE_PIDT ""
 257 #define CAST_PIDT_PTR (int *)
 258 #elif SIZEOF_PID_T == SIZEOF_LONG_INT
 259 #define ATTR_SIZE_PIDT "l"
 260 #define CAST_PIDT_PTR (long int *)
 261 #elif SIZEOF_PID_T == SIZEOF_LONG_LONG_INT
 262 #define ATTR_SIZE_PIDT "ll"
 263 #define CAST_PIDT_PTR (long long int *)
 264 #else
 265 #error "SIZEOF_PID_T does not correspond with a known format."
 266 #endif
 267
 268
 269 /* local header files : we include here the headers which may use some types defined
 270  *                      above. */
 271
 272 /* constants for fcrontabs needed to load and save the fcrontabs to disk */
 273 #include "save.h"
 274 /* log part */
 275 #include "log.h"
 276 /* functions used by fcrontab, fcrondyn, and fcron */
 277 #include "subs.h"
 278
 279
 280 #endif /* __GLOBAL_H__ */
 281