1 /* $NetBSD: parse.h,v 1.1.1.1 2009/12/13 16:54:53 kardel Exp $ */ 2 3 /* 4 * /src/NTP/REPOSITORY/ntp4-dev/include/parse.h,v 4.12 2007/01/14 08:36:03 kardel RELEASE_20070114_A 5 * 6 * parse.h,v 4.12 2007/01/14 08:36:03 kardel RELEASE_20070114_A 7 * 8 * Copyright (c) 1995-2005 by Frank Kardel <kardel <AT> ntp.org> 9 * Copyright (c) 1989-1994 by Frank Kardel, Friedrich-Alexander Universit�t Erlangen-N�rnberg, Germany 10 * 11 * Redistribution and use in source and binary forms, with or without 12 * modification, are permitted provided that the following conditions 13 * are met: 14 * 1. Redistributions of source code must retain the above copyright 15 * notice, this list of conditions and the following disclaimer. 16 * 2. Redistributions in binary form must reproduce the above copyright 17 * notice, this list of conditions and the following disclaimer in the 18 * documentation and/or other materials provided with the distribution. 19 * 3. Neither the name of the author nor the names of its contributors 20 * may be used to endorse or promote products derived from this software 21 * without specific prior written permission. 22 * 23 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 26 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 33 * SUCH DAMAGE. 34 * 35 */ 36 37 #ifndef __PARSE_H__ 38 #define __PARSE_H__ 39 #if !(defined(lint) || defined(__GNUC__)) 40 static char parsehrcsid[]="parse.h,v 4.12 2007/01/14 08:36:03 kardel RELEASE_20070114_A"; 41 #endif 42 43 #include "ntp_types.h" 44 45 #include "parse_conf.h" 46 47 /* 48 * we use the following datastructures in two modes 49 * either in the NTP itself where we use NTP time stamps at some places 50 * or in the kernel, where only struct timeval will be used. 51 */ 52 #undef PARSEKERNEL 53 #if defined(KERNEL) || defined(_KERNEL) 54 #ifndef PARSESTREAM 55 #define PARSESTREAM 56 #endif 57 #endif 58 #if defined(PARSESTREAM) && defined(HAVE_SYS_STREAM_H) 59 #define PARSEKERNEL 60 #endif 61 #ifdef PARSEKERNEL 62 #ifndef _KERNEL 63 extern caddr_t kmem_alloc (unsigned int); 64 extern caddr_t kmem_free (caddr_t, unsigned int); 65 extern unsigned int splx (unsigned int); 66 extern unsigned int splhigh (void); 67 extern unsigned int splclock (void); 68 #define MALLOC(_X_) (char *)kmem_alloc(_X_) 69 #define FREE(_X_, _Y_) kmem_free((caddr_t)_X_, _Y_) 70 #else 71 #include <sys/kmem.h> 72 #define MALLOC(_X_) (char *)kmem_alloc(_X_, KM_SLEEP) 73 #define FREE(_X_, _Y_) kmem_free((caddr_t)_X_, _Y_) 74 #endif 75 #else 76 #define MALLOC(_X_) malloc(_X_) 77 #define FREE(_X_, _Y_) free(_X_) 78 #endif 79 80 #if defined(PARSESTREAM) && defined(HAVE_SYS_STREAM_H) 81 #include <sys/stream.h> 82 #include <sys/stropts.h> 83 #else /* STREAM */ 84 #include <stdio.h> 85 #include "ntp_syslog.h" 86 #ifdef DEBUG 87 #define DD_PARSE 5 88 #define DD_RAWDCF 4 89 #define parseprintf(LEVEL, ARGS) if (debug > LEVEL) printf ARGS 90 #else /* DEBUG */ 91 #define parseprintf(LEVEL, ARGS) 92 #endif /* DEBUG */ 93 #endif /* PARSESTREAM */ 94 95 #if defined(timercmp) && defined(__GNUC__) 96 #undef timercmp 97 #endif 98 99 #if !defined(timercmp) 100 #define timercmp(tvp, uvp, cmp) \ 101 ((tvp)->tv_sec cmp (uvp)->tv_sec || \ 102 ((tvp)->tv_sec == (uvp)->tv_sec && (tvp)->tv_usec cmp (uvp)->tv_usec)) 103 #endif 104 105 #ifndef TIMES10 106 #define TIMES10(_X_) (((_X_) << 3) + ((_X_) << 1)) 107 #endif 108 109 /* 110 * state flags 111 */ 112 #define PARSEB_POWERUP 0x00000001 /* no synchronisation */ 113 #define PARSEB_NOSYNC 0x00000002 /* timecode currently not confirmed */ 114 115 /* 116 * time zone information 117 */ 118 #define PARSEB_ANNOUNCE 0x00000010 /* switch time zone warning (DST switch) */ 119 #define PARSEB_DST 0x00000020 /* DST in effect */ 120 #define PARSEB_UTC 0x00000040 /* UTC time */ 121 122 /* 123 * leap information 124 */ 125 #define PARSEB_LEAPDEL 0x00000100 /* LEAP deletion warning */ 126 #define PARSEB_LEAPADD 0x00000200 /* LEAP addition warning */ 127 #define PARSEB_LEAPS 0x00000300 /* LEAP warnings */ 128 #define PARSEB_LEAPSECOND 0x00000400 /* actual leap second */ 129 /* 130 * optional status information 131 */ 132 #define PARSEB_ALTERNATE 0x00001000 /* alternate antenna used */ 133 #define PARSEB_POSITION 0x00002000 /* position available */ 134 #define PARSEB_MESSAGE 0x00004000 /* addtitional message data */ 135 /* 136 * feature information 137 */ 138 #define PARSEB_S_LEAP 0x00010000 /* supports LEAP */ 139 #define PARSEB_S_ANTENNA 0x00020000 /* supports antenna information */ 140 #define PARSEB_S_PPS 0x00040000 /* supports PPS time stamping */ 141 #define PARSEB_S_POSITION 0x00080000 /* supports position information (GPS) */ 142 143 /* 144 * time stamp availability 145 */ 146 #define PARSEB_TIMECODE 0x10000000 /* valid time code sample */ 147 #define PARSEB_PPS 0x20000000 /* valid PPS sample */ 148 149 #define PARSE_TCINFO (PARSEB_ANNOUNCE|PARSEB_POWERUP|PARSEB_NOSYNC|PARSEB_DST|\ 150 PARSEB_UTC|PARSEB_LEAPS|PARSEB_ALTERNATE|PARSEB_S_LEAP|\ 151 PARSEB_S_LOCATION|PARSEB_TIMECODE|PARSEB_MESSAGE) 152 153 #define PARSE_POWERUP(x) ((x) & PARSEB_POWERUP) 154 #define PARSE_NOSYNC(x) (((x) & (PARSEB_POWERUP|PARSEB_NOSYNC)) == PARSEB_NOSYNC) 155 #define PARSE_SYNC(x) (((x) & (PARSEB_POWERUP|PARSEB_NOSYNC)) == 0) 156 #define PARSE_ANNOUNCE(x) ((x) & PARSEB_ANNOUNCE) 157 #define PARSE_DST(x) ((x) & PARSEB_DST) 158 #define PARSE_UTC(x) ((x) & PARSEB_UTC) 159 #define PARSE_LEAPADD(x) (PARSE_SYNC(x) && (((x) & PARSEB_LEAPS) == PARSEB_LEAPADD)) 160 #define PARSE_LEAPDEL(x) (PARSE_SYNC(x) && (((x) & PARSEB_LEAPS) == PARSEB_LEAPDEL)) 161 #define PARSE_ALTERNATE(x) ((x) & PARSEB_ALTERNATE) 162 #define PARSE_LEAPSECOND(x) (PARSE_SYNC(x) && ((x) & PARSEB_LEAP_SECOND)) 163 164 #define PARSE_S_LEAP(x) ((x) & PARSEB_S_LEAP) 165 #define PARSE_S_ANTENNA(x) ((x) & PARSEB_S_ANTENNA) 166 #define PARSE_S_PPS(x) ((x) & PARSEB_S_PPS) 167 #define PARSE_S_POSITION(x) ((x) & PARSEB_S_POSITION) 168 169 #define PARSE_TIMECODE(x) ((x) & PARSEB_TIMECODE) 170 #define PARSE_PPS(x) ((x) & PARSEB_PPS) 171 #define PARSE_POSITION(x) ((x) & PARSEB_POSITION) 172 #define PARSE_MESSAGE(x) ((x) & PARSEB_MESSAGE) 173 174 /* 175 * operation flags - lower nibble contains fudge flags 176 */ 177 #define PARSE_TRUSTTIME CLK_FLAG1 /* use flag1 to indicate the time2 references mean the trust time */ 178 #define PARSE_CLEAR CLK_FLAG2 /* use flag2 to control pps on assert */ 179 #define PARSE_PPSKERNEL CLK_FLAG3 /* use flag3 to bind PPS to kernel */ 180 #define PARSE_LEAP_DELETE CLK_FLAG4 /* use flag4 to force leap deletion - only necessary when earth slows down */ 181 182 #define PARSE_FIXED_FMT 0x10 /* fixed format */ 183 #define PARSE_PPSCLOCK 0x20 /* try to get PPS time stamp via ppsclock ioctl */ 184 185 /* 186 * size of buffers 187 */ 188 #define PARSE_TCMAX 400 /* maximum addition data size */ 189 190 typedef union 191 { 192 struct timeval tv; /* timeval - kernel view */ 193 l_fp fp; /* fixed point - ntp view */ 194 } timestamp_t; 195 196 /* 197 * standard time stamp structure 198 */ 199 struct parsetime 200 { 201 u_long parse_status; /* data status - CVT_OK, CVT_NONE, CVT_FAIL ... */ 202 timestamp_t parse_time; /* PARSE timestamp */ 203 timestamp_t parse_stime; /* telegram sample timestamp */ 204 timestamp_t parse_ptime; /* PPS time stamp */ 205 long parse_usecerror; /* sampled usec error */ 206 u_long parse_state; /* current receiver state */ 207 unsigned short parse_format; /* format code */ 208 unsigned short parse_msglen; /* length of message */ 209 unsigned char parse_msg[PARSE_TCMAX]; /* original messages */ 210 }; 211 212 typedef struct parsetime parsetime_t; 213 214 /*---------- STREAMS interface ----------*/ 215 216 #ifdef HAVE_SYS_STREAM_H 217 /* 218 * ioctls 219 */ 220 #define PARSEIOC_ENABLE (('D'<<8) + 'E') 221 #define PARSEIOC_DISABLE (('D'<<8) + 'D') 222 #define PARSEIOC_SETFMT (('D'<<8) + 'f') 223 #define PARSEIOC_GETFMT (('D'<<8) + 'F') 224 #define PARSEIOC_SETCS (('D'<<8) + 'C') 225 #define PARSEIOC_TIMECODE (('D'<<8) + 'T') 226 227 #endif 228 229 /*------ IO handling flags (sorry) ------*/ 230 231 #define PARSE_IO_CSIZE 0x00000003 232 #define PARSE_IO_CS5 0x00000000 233 #define PARSE_IO_CS6 0x00000001 234 #define PARSE_IO_CS7 0x00000002 235 #define PARSE_IO_CS8 0x00000003 236 237 /* 238 * ioctl structure 239 */ 240 union parsectl 241 { 242 struct parsegettc 243 { 244 u_long parse_state; /* last state */ 245 u_long parse_badformat; /* number of bad packets since last query */ 246 unsigned short parse_format;/* last decoded format */ 247 unsigned short parse_count; /* count of valid time code bytes */ 248 char parse_buffer[PARSE_TCMAX+1]; /* timecode buffer */ 249 } parsegettc; 250 251 struct parseformat 252 { 253 unsigned short parse_format;/* number of examined format */ 254 unsigned short parse_count; /* count of valid string bytes */ 255 char parse_buffer[PARSE_TCMAX+1]; /* format code string */ 256 } parseformat; 257 258 struct parsesetcs 259 { 260 u_long parse_cs; /* character size (needed for stripping) */ 261 } parsesetcs; 262 }; 263 264 typedef union parsectl parsectl_t; 265 266 /*------ for conversion routines --------*/ 267 268 struct parse /* parse module local data */ 269 { 270 int parse_flags; /* operation and current status flags */ 271 272 int parse_ioflags; /* io handling flags (5-8 Bit control currently) */ 273 274 /* 275 * private data - fixed format only 276 */ 277 unsigned short parse_plen; /* length of private data */ 278 void *parse_pdata; /* private data pointer */ 279 280 /* 281 * time code input buffer (from RS232 or PPS) 282 */ 283 unsigned short parse_index; /* current buffer index */ 284 char *parse_data; /* data buffer */ 285 unsigned short parse_dsize; /* size of data buffer */ 286 unsigned short parse_lformat; /* last format used */ 287 u_long parse_lstate; /* last state code */ 288 char *parse_ldata; /* last data buffer */ 289 unsigned short parse_ldsize; /* last data buffer length */ 290 u_long parse_badformat; /* number of unparsable pakets */ 291 292 timestamp_t parse_lastchar; /* last time a character was received */ 293 parsetime_t parse_dtime; /* external data prototype */ 294 }; 295 296 typedef struct parse parse_t; 297 298 struct clocktime /* clock time broken up from time code */ 299 { 300 long day; 301 long month; 302 long year; 303 long hour; 304 long minute; 305 long second; 306 long usecond; 307 long utcoffset; /* in seconds */ 308 time_t utctime; /* the actual time - alternative to date/time */ 309 u_long flags; /* current clock status */ 310 }; 311 312 typedef struct clocktime clocktime_t; 313 314 /* 315 * parser related return/error codes 316 */ 317 #define CVT_MASK (unsigned)0x0000000F /* conversion exit code */ 318 #define CVT_NONE (unsigned)0x00000001 /* format not applicable */ 319 #define CVT_FAIL (unsigned)0x00000002 /* conversion failed - error code returned */ 320 #define CVT_OK (unsigned)0x00000004 /* conversion succeeded */ 321 #define CVT_SKIP (unsigned)0x00000008 /* conversion succeeded */ 322 #define CVT_ADDITIONAL (unsigned)0x00000010 /* additional data is available */ 323 #define CVT_BADFMT (unsigned)0x00000100 /* general format error - (unparsable) */ 324 #define CVT_BADDATE (unsigned)0x00000200 /* date field incorrect */ 325 #define CVT_BADTIME (unsigned)0x00000400 /* time field incorrect */ 326 327 /* 328 * return codes used by special input parsers 329 */ 330 #define PARSE_INP_SKIP 0x00 /* discard data - may have been consumed */ 331 #define PARSE_INP_TIME 0x01 /* time code assembled */ 332 #define PARSE_INP_PARSE 0x02 /* parse data using normal algorithm */ 333 #define PARSE_INP_DATA 0x04 /* additional data to pass up */ 334 #define PARSE_INP_SYNTH 0x08 /* just pass up synthesized time */ 335 336 /* 337 * PPS edge info 338 */ 339 #define SYNC_ZERO 0x00 340 #define SYNC_ONE 0x01 341 342 struct clockformat 343 { 344 /* special input protocol - implies fixed format */ 345 u_long (*input) (parse_t *, unsigned int, timestamp_t *); 346 /* conversion routine */ 347 u_long (*convert) (unsigned char *, int, struct format *, clocktime_t *, void *); 348 /* routine for handling RS232 sync events (time stamps) */ 349 /* PPS input routine */ 350 u_long (*syncpps) (parse_t *, int, timestamp_t *); 351 /* time code synthesizer */ 352 353 void *data; /* local parameters */ 354 const char *name; /* clock format name */ 355 unsigned short length; /* maximum length of data packet */ 356 unsigned short plen; /* length of private data - implies fixed format */ 357 }; 358 359 typedef struct clockformat clockformat_t; 360 361 /* 362 * parse interface 363 */ 364 extern int parse_ioinit (parse_t *); 365 extern void parse_ioend (parse_t *); 366 extern int parse_ioread (parse_t *, unsigned int, timestamp_t *); 367 extern int parse_iopps (parse_t *, int, timestamp_t *); 368 extern void parse_iodone (parse_t *); 369 extern int parse_timecode (parsectl_t *, parse_t *); 370 extern int parse_getfmt (parsectl_t *, parse_t *); 371 extern int parse_setfmt (parsectl_t *, parse_t *); 372 extern int parse_setcs (parsectl_t *, parse_t *); 373 374 extern unsigned int parse_restart (parse_t *, unsigned int); 375 extern unsigned int parse_addchar (parse_t *, unsigned int); 376 extern unsigned int parse_end (parse_t *); 377 378 extern int Strok (const unsigned char *, const unsigned char *); 379 extern int Stoi (const unsigned char *, long *, int); 380 381 extern time_t parse_to_unixtime (clocktime_t *, u_long *); 382 extern u_long updatetimeinfo (parse_t *, u_long); 383 extern void syn_simple (parse_t *, timestamp_t *, struct format *, u_long); 384 extern u_long pps_simple (parse_t *, int, timestamp_t *); 385 extern u_long pps_one (parse_t *, int, timestamp_t *); 386 extern u_long pps_zero (parse_t *, int, timestamp_t *); 387 extern int parse_timedout (parse_t *, timestamp_t *, struct timeval *); 388 389 #endif 390 391 /* 392 * History: 393 * 394 * parse.h,v 395 * Revision 4.12 2007/01/14 08:36:03 kardel 396 * make timestamp union anonymous to avoid conflicts with 397 * some OSes that choose to create a nameing conflic here. 398 * 399 * Revision 4.11 2005/06/25 10:58:45 kardel 400 * add missing log keywords 401 * 402 * Revision 4.5 1998/08/09 22:23:32 kardel 403 * 4.0.73e2 adjustments 404 * 405 * Revision 4.4 1998/06/14 21:09:27 kardel 406 * Sun acc cleanup 407 * 408 * Revision 4.3 1998/06/13 11:49:25 kardel 409 * STREAM macro gone in favor of HAVE_SYS_STREAM_H 410 * 411 * Revision 4.2 1998/06/12 15:14:25 kardel 412 * fixed prototypes 413 * 414 * Revision 4.1 1998/05/24 10:07:59 kardel 415 * removed old data structure cruft (new input model) 416 * new PARSE_INP* macros for input handling 417 * removed old SYNC_* macros from old input model 418 * (struct clockformat): removed old parse functions in favor of the 419 * new input model 420 * updated prototypes 421 * 422 * form V3 3.31 - log info deleted 1998/04/11 kardel 423 */ 424