release/src/router/udpxy/util.h

   1 /* @(#) interface to utility functions for udpxy
   2  *
   3  * Copyright 2008-2011 Pavel V. Cherenkov (pcherenkov@gmail.com)
   4  *
   5  *  This file is part of udpxy.
   6  *
   7  *  udpxy is free software: you can redistribute it and/or modify
   8  *  it under the terms of the GNU General Public License as published by
   9  *  the Free Software Foundation, either version 3 of the License, or
  10  *  (at your option) any later version.
  11  *
  12  *  udpxy is distributed in the hope that it will be useful,
  13  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  *  GNU General Public License for more details.
  16  *
  17  *  You should have received a copy of the GNU General Public License
  18  *  along with udpxy.  If not, see <http://www.gnu.org/licenses/>.
  19  */
  20
  21 #ifndef UTILH_UDPXY_200712181853
  22 #define UTILH_UDPXY_200712181853
  23
  24 #include <sys/types.h>
  25 #include <stdio.h>
  26
  27 struct timeval;
  28
  29 #ifdef __cplusplus
  30 extern "C" {
  31 #endif
  32
  33 /* write buffer to a file
  34  */
  35 ssize_t
  36 save_buffer( const void* buf, size_t len, const char* filename );
  37
  38 /* read text file into a buffer
  39  *
  40  */
  41 ssize_t
  42 txtf_read (const char* fpath, char* dst, size_t maxlen, FILE* log);
  43
  44 /* start process as a daemon
  45  *
  46  */
  47 #define DZ_STDIO_OPEN  1   /* do not close STDIN, STDOUT, STDERR */
  48 int
  49 daemonize(int options, FILE* log);
  50
  51
  52 /* multiplex error output to custom log
  53  * and syslog
  54  */
  55 void
  56 mperror( FILE* fp, int err, const char* format, ... );
  57
  58
  59 /* create and lock file with process's ID
  60  */
  61 int
  62 make_pidfile( const char* fpath, pid_t pid, FILE* log );
  63
  64
  65 /* write path to application's pidfile into the the buffer
  66  * (fail of destination directory is not writable)
  67  */
  68 int
  69 set_pidfile( const char* appname, int port, char* buf, size_t len );
  70
  71 /* write buffer to designated socket/file
  72  * return number of bytes read/written or one of the error
  73  * codes below
  74  */
  75 #define IO_ERR      -1      /* generic error */
  76 #define IO_BLK      -2      /* operation timed out or would block */
  77 ssize_t
  78 write_buf( int fd, const char* data, const ssize_t len, FILE* log );
  79
  80 /* read data chunk of designated size into buffer
  81  */
  82 ssize_t
  83 read_buf( int fd, char* buf, const ssize_t len, FILE* log );
  84
  85 /* output hex dump of a memory fragment
  86  */
  87 void
  88 hex_dump( const char* msg, const char* data, size_t len, FILE* log );
  89
  90 /* check for expected size, complain if not matched
  91  */
  92 int
  93 sizecheck( const char* msg, ssize_t expct, ssize_t len,
  94               FILE* log, const char* func );
  95
  96 /* check for a potential buffer overrun by
  97  * evaluating target buffer and the portion
  98  * of that buffer to be accessed
  99  */
 100 int
 101 buf_overrun( const char* buf, size_t buflen,
 102              size_t offset, size_t dlen,
 103              FILE* log );
 104
 105
 106 /* write timestamp-prepended formatted message to file
 107  */
 108 int
 109 tmfprintf( FILE* stream, const char* format, ... );
 110
 111
 112 /* write timestamp-prepended message to file
 113  */
 114 int
 115 tmfputs( const char* s, FILE* stream );
 116
 117
 118 /* print out command-line
 119  */
 120 void
 121 printcmdln( FILE* stream, const char* msg,
 122         int argc, char* const argv[] );
 123
 124
 125 /* convert timespec to time_t
 126  * where
 127  *      timespec format: [+|-]dd:hh24:mi:ss
 128  *
 129  * @return 0 if success, n>0 if parse error at position n,
 130  *         -1 otherwise
 131  */
 132 int
 133 a2time( const char* str, time_t* t, time_t from );
 134
 135
 136 /* convert ASCII size spec (positive) into numeric value
 137  * size spec format:
 138  *      num[modifier], where num is an ASCII representation of
 139  *      any positive integer and
 140  *      modifier ::= [Kb|K|Mb|M|Gb|G]
 141  */
 142 int
 143 a2size( const char* str, ssize_t* pval );
 144
 145 int
 146 a2int64( const char* str, int64_t* pval );
 147
 148 /* returns asctime w/o CR character at the end
 149  */
 150 struct tm;
 151
 152 const char*
 153 Zasctime( const struct tm* tm );
 154
 155
 156 /* adjust nice value if needed
 157  */
 158 int
 159 set_nice( int val, FILE* log );
 160
 161
 162 /* check and report a deviation in values: n_was and n_is are not supposed
 163  * to differ more than by delta
 164  */
 165 void
 166 check_fragments( const char* action, ssize_t total, ssize_t n_was, ssize_t n_is,
 167                  ssize_t delta, FILE* log );
 168
 169 /* create timestamp string in YYYY-mm-dd HH24:MI:SS.MSEC from struct timeval
 170  */
 171 static const int32_t TVSTAMP_GMT = 1;
 172
 173 int
 174 mk_tvstamp( const struct timeval* tv, char* buf, size_t* len,
 175              int32_t flags );
 176
 177
 178 /* retrieve UNIX time value from given environment
 179  * variable, otherwise return default */
 180 time_t
 181 get_timeval( const char* envar, const time_t deflt  );
 182
 183
 184 /* retrieve flag value as 1 = true, 0 = false
 185  * from an environment variable set in the form
 186  * of 0|1|'true'|'false'|'yes'|'no'
 187  */
 188 int
 189 get_flagval( const char* envar, const int deflt );
 190
 191 /* retrieve LONG value from given environment
 192  * variable, otherwise return default */
 193 ssize_t
 194 get_sizeval( const char* envar, const ssize_t deflt );
 195
 196
 197 /* retrieve/reset string representation of pid,
 198  */
 199 const char*
 200 get_pidstr( int reset, const char* pfx );
 201
 202 /* retrieve system info string
 203  */
 204 const char*
 205 get_sysinfo (int* perr);
 206
 207 #ifdef __cplusplus
 208 }
 209 #endif
 210
 211 #endif /* UTILH_UDPXY_200712181853 */
 212
 213 /* __EOF__ */
 214