3 Subroutines that support tracing of OMAPI wire transactions and
4 provide a mechanism for programs using OMAPI to trace their own
8 * Copyright (c) 2004 by Internet Systems Consortium, Inc. ("ISC")
9 * Copyright (c) 2001-2003 by Internet Software Consortium
11 * Permission to use, copy, modify, and distribute this software for any
12 * purpose with or without fee is hereby granted, provided that the above
13 * copyright notice and this permission notice appear in all copies.
15 * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES
16 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
17 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR
18 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
19 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
20 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
21 * OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
23 * Internet Systems Consortium, Inc.
25 * Redwood City, CA 94063
29 * This software has been written for Internet Systems Consortium
30 * by Ted Lemon, as part of a project for Nominum, Inc. To learn more
31 * about Internet Systems Consortium, see http://www.isc.org/. To
32 * learn more about Nominum, Inc., see ``http://www.nominum.com''.
35 #include <omapip/omapip_p.h>
38 void (*trace_set_time_hook) (u_int32_t);
39 static int tracing_stopped;
40 static int traceoutfile;
41 static int traceindex;
42 static trace_type_t **trace_types;
43 static int trace_type_count;
44 static int trace_type_max;
45 static trace_type_t *new_trace_types;
46 static FILE *traceinfile;
47 static tracefile_header_t tracefile_header;
48 static int trace_playback_flag;
49 trace_type_t trace_time_marker;
51 #if defined (DEBUG_MEMORY_LEAKAGE) || defined (DEBUG_MEMORY_LEAKAGE_ON_EXIT)
52 extern omapi_array_t *trace_listeners;
53 extern omapi_array_t *omapi_connections;
55 void trace_free_all ()
61 new_trace_types = tp -> next;
63 dfree (tp -> name, MDL);
64 tp -> name = (char *)0;
69 for (i = 0; i < trace_type_count; i++) {
70 if (trace_types [i]) {
71 if (trace_types [i] -> name)
72 dfree (trace_types [i] -> name, MDL);
73 dfree (trace_types [i], MDL);
76 dfree (trace_types, MDL);
77 trace_types = (trace_type_t **)0;
78 trace_type_count = trace_type_max = 0;
80 omapi_array_free (&trace_listeners, MDL);
81 omapi_array_free (&omapi_connections, MDL);
85 static isc_result_t trace_type_record (trace_type_t *,
86 unsigned, const char *, int);
90 return trace_playback_flag;
95 if (traceoutfile && !tracing_stopped)
100 isc_result_t trace_init (void (*set_time) (u_int32_t),
101 const char *file, int line)
103 trace_type_t *root_type;
104 static int root_setup = 0;
107 return ISC_R_SUCCESS;
109 trace_set_time_hook = set_time;
111 root_type = trace_type_register ("trace-index-mapping",
112 (void *)0, trace_index_map_input,
113 trace_index_stop_tracing, file, line);
115 return ISC_R_UNEXPECTED;
116 if (new_trace_types == root_type)
117 new_trace_types = new_trace_types -> next;
118 root_type -> index = 0;
119 trace_type_stash (root_type);
122 return ISC_R_SUCCESS;
125 isc_result_t trace_begin (const char *filename,
126 const char *file, int line)
128 tracefile_header_t tfh;
130 trace_type_t *tptr, *next;
134 log_error ("%s(%d): trace_begin called twice",
136 return ISC_R_INVALIDARG;
139 traceoutfile = open (filename, O_CREAT | O_WRONLY | O_EXCL, 0644);
140 if (traceoutfile < 0) {
141 log_error ("%s(%d): trace_begin: %s: %m",
142 file, line, filename);
143 return ISC_R_UNEXPECTED;
145 #if defined (HAVE_SETFD)
146 if (fcntl (traceoutfile, F_SETFD, 1) < 0)
147 log_error ("Can't set close-on-exec on %s: %m", filename);
150 tfh.magic = htonl (TRACEFILE_MAGIC);
151 tfh.version = htonl (TRACEFILE_VERSION);
152 tfh.hlen = htonl (sizeof (tracefile_header_t));
153 tfh.phlen = htonl (sizeof (tracepacket_t));
155 status = write (traceoutfile, &tfh, sizeof tfh);
157 log_error ("%s(%d): trace_begin write failed: %m", file, line);
158 return ISC_R_UNEXPECTED;
159 } else if (status != sizeof tfh) {
160 log_error ("%s(%d): trace_begin: short write (%d:%ld)",
161 file, line, status, (long)(sizeof tfh));
163 return ISC_R_UNEXPECTED;
166 /* Stash all the types that have already been set up. */
167 if (new_trace_types) {
168 next = new_trace_types;
169 new_trace_types = (trace_type_t *)0;
170 for (tptr = next; tptr; tptr = next) {
172 if (tptr -> index != 0) {
173 result = (trace_type_record
175 strlen (tptr -> name), file, line));
176 if (result != ISC_R_SUCCESS)
182 return ISC_R_SUCCESS;
185 isc_result_t trace_write_packet (trace_type_t *ttype, unsigned length,
186 const char *buf, const char *file, int line)
192 return trace_write_packet_iov (ttype, 1, &iov, file, line);
195 isc_result_t trace_write_packet_iov (trace_type_t *ttype,
196 int count, trace_iov_t *iov,
197 const char *file, int line)
204 /* Really shouldn't get called here, but it may be hard to turn off
205 tracing midstream if the trace file write fails or something. */
210 log_error ("%s(%d): trace_write_packet with null trace type",
211 file ? file : "<unknown file>", line);
212 return ISC_R_INVALIDARG;
215 log_error ("%s(%d): trace_write_packet with no tracefile.",
216 file ? file : "<unknown file>", line);
217 return ISC_R_INVALIDARG;
220 /* Compute the total length of the iov. */
222 for (i = 0; i < count; i++)
223 length += iov [i].len;
225 /* We have to swap out the data, because it may be read back on a
226 machine of different endianness. */
227 tmp.type_index = htonl (ttype -> index);
228 tmp.when = htonl (time ((time_t *)0)); /* XXX */
229 tmp.length = htonl (length);
231 status = write (traceoutfile, &tmp, sizeof tmp);
233 log_error ("%s(%d): trace_write_packet write failed: %m",
235 return ISC_R_UNEXPECTED;
236 } else if (status != sizeof tmp) {
237 log_error ("%s(%d): trace_write_packet: short write (%d:%ld)",
238 file, line, status, (long)(sizeof tmp));
242 for (i = 0; i < count; i++) {
243 status = write (traceoutfile, iov [i].buf, iov [i].len);
245 log_error ("%s(%d): %s write failed: %m",
246 file, line, "trace_write_packet");
247 return ISC_R_UNEXPECTED;
248 } else if (status != iov [i].len) {
249 log_error ("%s(%d): %s: short write (%d:%d)",
251 "trace_write_packet", status, length);
256 /* Write padding on the end of the packet to align the next
257 packet to an 8-byte boundary. This is in case we decide to
258 use mmap in some clever way later on. */
260 static char zero [] = { 0, 0, 0, 0, 0, 0, 0 };
261 unsigned padl = 8 - (length % 8);
263 status = write (traceoutfile, zero, padl);
265 log_error ("%s(%d): trace_write_packet write failed: %m",
267 return ISC_R_UNEXPECTED;
268 } else if (status != padl) {
269 log_error ("%s(%d): trace_write_packet: short write (%d:%d)",
270 file, line, status, padl);
275 return ISC_R_SUCCESS;
278 void trace_type_stash (trace_type_t *tptr)
282 if (trace_type_max <= tptr -> index) {
283 delta = tptr -> index - trace_type_max + 10;
284 vec = dmalloc (((trace_type_max + delta) *
285 sizeof (trace_type_t *)), MDL);
288 memset (&vec [trace_type_max], 0,
289 (sizeof (trace_type_t *)) * delta);
290 trace_type_max += delta;
292 memcpy (vec, trace_types,
293 trace_type_count * sizeof (trace_type_t *));
294 dfree (trace_types, MDL);
298 trace_types [tptr -> index] = tptr;
299 if (tptr -> index >= trace_type_count)
300 trace_type_count = tptr -> index + 1;
303 trace_type_t *trace_type_register (const char *name,
305 void (*have_packet) (trace_type_t *,
307 void (*stop_tracing) (trace_type_t *),
308 const char *file, int line)
310 trace_type_t *ttmp, *tptr;
311 unsigned slen = strlen (name);
314 ttmp = dmalloc (sizeof *ttmp, file, line);
318 ttmp -> name = dmalloc (slen + 1, file, line);
320 dfree (ttmp, file, line);
321 return (trace_type_t *)0;
323 strcpy (ttmp -> name, name);
324 ttmp -> have_packet = have_packet;
325 ttmp -> stop_tracing = stop_tracing;
328 status = trace_type_record (ttmp, slen, file, line);
329 if (status != ISC_R_SUCCESS) {
330 dfree (ttmp -> name, file, line);
331 dfree (ttmp, file, line);
332 return (trace_type_t *)0;
335 ttmp -> next = new_trace_types;
336 new_trace_types = ttmp;
342 static isc_result_t trace_type_record (trace_type_t *ttmp, unsigned slen,
343 const char *file, int line)
345 trace_index_mapping_t *tim;
348 tim = dmalloc (slen + TRACE_INDEX_MAPPING_SIZE, file, line);
350 return ISC_R_NOMEMORY;
351 ttmp -> index = ++traceindex;
352 trace_type_stash (ttmp);
353 tim -> index = htonl (ttmp -> index);
354 memcpy (tim -> name, ttmp -> name, slen);
355 status = trace_write_packet (trace_types [0],
356 slen + TRACE_INDEX_MAPPING_SIZE,
357 (char *)tim, file, line);
358 dfree (tim, file, line);
362 /* Stop all registered trace types from trying to trace. */
364 void trace_stop (void)
368 for (i = 0; i < trace_type_count; i++)
369 if (trace_types [i] -> stop_tracing)
370 (*(trace_types [i] -> stop_tracing))
375 void trace_index_map_input (trace_type_t *ttype, unsigned length, char *buf)
377 trace_index_mapping_t *tmap;
379 trace_type_t *tptr, **prev;
381 if (length < TRACE_INDEX_MAPPING_SIZE) {
382 log_error ("short trace index mapping");
385 tmap = (trace_index_mapping_t *)buf;
387 prev = &new_trace_types;
388 for (tptr = new_trace_types; tptr; tptr = tptr -> next) {
389 len = strlen (tptr -> name);
390 if (len == length - TRACE_INDEX_MAPPING_SIZE &&
391 !memcmp (tptr -> name, tmap -> name, len)) {
392 tptr -> index = ntohl (tmap -> index);
393 trace_type_stash (tptr);
394 *prev = tptr -> next;
397 prev = &tptr -> next;
400 log_error ("No registered trace type for type name %.*s",
401 (int)length - TRACE_INDEX_MAPPING_SIZE, tmap -> name);
405 void trace_index_stop_tracing (trace_type_t *ttype) { }
407 void trace_replay_init (void)
409 trace_playback_flag = 1;
412 void trace_file_replay (const char *filename)
414 tracepacket_t *tpkt = (tracepacket_t *)0;
416 char *buf = (char *)0;
419 trace_type_t *ttype = (trace_type_t *)0;
423 traceinfile = fopen (filename, "r");
425 log_error ("Can't open tracefile %s: %m", filename);
428 #if defined (HAVE_SETFD)
429 if (fcntl (fileno (traceinfile), F_SETFD, 1) < 0)
430 log_error ("Can't set close-on-exec on %s: %m", filename);
432 status = fread (&tracefile_header, 1,
433 sizeof tracefile_header, traceinfile);
434 if (status < sizeof tracefile_header) {
435 if (ferror (traceinfile))
436 log_error ("Error reading trace file header: %m");
438 log_error ("Short read on trace file header: %d %ld.",
439 status, (long)(sizeof tracefile_header));
442 tracefile_header.magic = ntohl (tracefile_header.magic);
443 tracefile_header.version = ntohl (tracefile_header.version);
444 tracefile_header.hlen = ntohl (tracefile_header.hlen);
445 tracefile_header.phlen = ntohl (tracefile_header.phlen);
447 if (tracefile_header.magic != TRACEFILE_MAGIC) {
448 log_error ("%s: not a dhcp trace file.", filename);
451 if (tracefile_header.version > TRACEFILE_VERSION) {
452 log_error ("tracefile version %ld > current %ld.",
453 (long int)tracefile_header.version,
454 (long int)TRACEFILE_VERSION);
457 if (tracefile_header.phlen < sizeof *tpkt) {
458 log_error ("tracefile packet size too small - %ld < %ld",
459 (long int)tracefile_header.phlen,
460 (long int)sizeof *tpkt);
463 len = (sizeof tracefile_header) - tracefile_header.hlen;
465 log_error ("tracefile header size too small - %ld < %ld",
466 (long int)tracefile_header.hlen,
467 (long int)sizeof tracefile_header);
471 status = fseek (traceinfile, (long)len, SEEK_CUR);
473 log_error ("can't seek past header: %m");
478 tpkt = dmalloc ((unsigned)tracefile_header.phlen, MDL);
480 log_error ("can't allocate trace packet header.");
484 while ((result = trace_get_next_packet (&ttype, tpkt, &buf, &buflen,
485 &bufmax)) == ISC_R_SUCCESS) {
486 (*ttype -> have_packet) (ttype, tpkt -> length, buf);
487 ttype = (trace_type_t *)0;
490 fclose (traceinfile);
497 /* Get the next packet from the file. If ttp points to a nonzero pointer
498 to a trace type structure, check the next packet to see if it's of the
499 expected type, and back off if not. */
501 isc_result_t trace_get_next_packet (trace_type_t **ttp,
503 char **buf, unsigned *buflen,
512 status = fgetpos (traceinfile, &curpos);
514 log_error ("Can't save tracefile position: %m");
516 status = fread (tpkt, 1, (size_t)tracefile_header.phlen, traceinfile);
517 if (status < tracefile_header.phlen) {
518 if (ferror (traceinfile))
519 log_error ("Error reading trace packet header: %m");
520 else if (status == 0)
523 log_error ("Short read on trace packet header: "
526 (long int)tracefile_header.phlen);
527 return ISC_R_PROTOCOLERROR;
530 /* Swap the packet. */
531 tpkt -> type_index = ntohl (tpkt -> type_index);
532 tpkt -> length = ntohl (tpkt -> length);
533 tpkt -> when = ntohl (tpkt -> when);
535 /* See if there's a handler for this packet type. */
536 if (tpkt -> type_index < trace_type_count &&
537 trace_types [tpkt -> type_index])
538 ttype = trace_types [tpkt -> type_index];
540 log_error ("Trace packet with unknown index %ld",
541 (long int)tpkt -> type_index);
542 return ISC_R_PROTOCOLERROR;
545 /* If we were just hunting for the time marker, we've found it,
546 so back up to the beginning of the packet and return its
548 if (ttp && *ttp == &trace_time_marker) {
550 status = fsetpos (traceinfile, &curpos);
552 log_error ("fsetpos in tracefile failed: %m");
553 return ISC_R_PROTOCOLERROR;
558 /* If we were supposed to get a particular kind of packet,
559 check to see that we got the right kind. */
560 if (ttp && *ttp && ttype != *ttp) {
561 log_error ("Read packet type %s when expecting %s",
562 ttype -> name, (*ttp) -> name);
563 status = fsetpos (traceinfile, &curpos);
565 log_error ("fsetpos in tracefile failed: %m");
566 return ISC_R_PROTOCOLERROR;
568 return ISC_R_UNEXPECTEDTOKEN;
571 paylen = tpkt -> length;
573 paylen += 8 - (tpkt -> length % 8);
574 if (paylen > (*bufmax)) {
577 (*bufmax) = ((paylen + 1023) & ~1023U);
578 (*buf) = dmalloc ((*bufmax), MDL);
580 log_error ("Can't allocate input buffer sized %d",
582 return ISC_R_NOMEMORY;
586 status = fread ((*buf), 1, paylen, traceinfile);
587 if (status < paylen) {
588 if (ferror (traceinfile))
589 log_error ("Error reading trace payload: %m");
591 log_error ("Short read on trace payload: %d %d.",
593 return ISC_R_PROTOCOLERROR;
596 /* Store the actual length of the payload. */
597 *buflen = tpkt -> length;
599 if (trace_set_time_hook)
600 (*trace_set_time_hook) (tpkt -> when);
604 return ISC_R_SUCCESS;
607 isc_result_t trace_get_packet (trace_type_t **ttp,
608 unsigned *buflen, char **buf)
615 return ISC_R_INVALIDARG;
617 tpkt = dmalloc ((unsigned)tracefile_header.phlen, MDL);
619 log_error ("can't allocate trace packet header.");
620 return ISC_R_NOMEMORY;
623 status = trace_get_next_packet (ttp, tpkt, buf, buflen, &bufmax);
629 time_t trace_snoop_time (trace_type_t **ptp)
634 char *buf = (char *)0;
642 tpkt = dmalloc ((unsigned)tracefile_header.phlen, MDL);
644 log_error ("can't allocate trace packet header.");
645 return ISC_R_NOMEMORY;
648 *ptp = &trace_time_marker;
649 trace_get_next_packet (ptp, tpkt, &buf, &buflen, &bufmax);
650 result = tpkt -> when;
656 /* Get a packet from the trace input file that contains a file with the
657 specified name. We don't hunt for the packet - it should be the next
658 packet in the tracefile. If it's not, or something else bad happens,
659 return an error code. */
661 isc_result_t trace_get_file (trace_type_t *ttype,
662 const char *filename, unsigned *len, char **buf)
670 /* Disallow some obvious bogosities. */
671 if (!buf || !len || *buf)
672 return ISC_R_INVALIDARG;
674 /* Save file position in case of filename mismatch. */
675 status = fgetpos (traceinfile, &curpos);
677 log_error ("Can't save tracefile position: %m");
679 tpkt = dmalloc ((unsigned)tracefile_header.phlen, MDL);
681 log_error ("can't allocate trace packet header.");
682 return ISC_R_NOMEMORY;
685 result = trace_get_next_packet (&ttype, tpkt, buf, len, &max);
686 if (result != ISC_R_SUCCESS) {
693 /* Make sure the filename is right. */
694 if (strcmp (filename, *buf)) {
695 log_error ("Read file %s when expecting %s", *buf, filename);
696 status = fsetpos (traceinfile, &curpos);
698 log_error ("fsetpos in tracefile failed: %m");
701 return ISC_R_PROTOCOLERROR;
703 return ISC_R_UNEXPECTEDTOKEN;
707 return ISC_R_SUCCESS;