dbus-monitor.c 16.8 KB
Newer Older
1
/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
/* dbus-monitor.c  Utility program to monitor messages on the bus
 *
 * Copyright (C) 2003 Philip Blundell <philb@gnu.org>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
18
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
19 20 21
 *
 */

Ralf Habacker's avatar
Ralf Habacker committed
22
#include <config.h>
23 24 25

#include "dbus/dbus-internals.h"        /* just for the macros */

26 27 28 29
#include <stdio.h>
#include <stdlib.h>
#include <string.h>

30 31 32 33
#ifdef DBUS_WIN
#include <winsock2.h>
#undef interface
#else
34
#include <sys/time.h>
35 36
#endif

37 38
#include <time.h>

39
#include "dbus-print-message.h"
40
#include "tool-common.h"
41

42 43
#define EAVESDROPPING_RULE "eavesdrop=true"

44 45 46 47 48 49 50
#ifndef STDOUT_FILENO
#define STDOUT_FILENO 1
#endif

/* http://www.tcpdump.org/linktypes.html */
#define LINKTYPE_DBUS 231

51
static DBusHandlerResult
52
monitor_filter_func (DBusConnection     *connection,
53 54
                     DBusMessage        *message,
                     void               *user_data)
55
{
56 57 58 59 60
  long sec = 0, usec = 0;

  _dbus_get_real_time (&sec, &usec);

  print_message (message, FALSE, sec, usec);
61
  
62
  if (dbus_message_is_signal (message,
63
                              DBUS_INTERFACE_LOCAL,
64
                              "Disconnected"))
65
    exit (0);
66 67 68

  /* Monitors must not allow libdbus to reply to messages, so we eat
   * the message. See bug 1719.
69
   */
70
  return DBUS_HANDLER_RESULT_HANDLED;
71 72
}

73 74 75 76 77 78 79 80 81 82 83
#define TRAP_NULL_STRING(str) ((str) ? (str) : "<none>")

typedef enum
{
  PROFILE_ATTRIBUTE_FLAG_SERIAL = 1,
  PROFILE_ATTRIBUTE_FLAG_REPLY_SERIAL = 2,
  PROFILE_ATTRIBUTE_FLAG_SENDER = 4,
  PROFILE_ATTRIBUTE_FLAG_DESTINATION = 8,
  PROFILE_ATTRIBUTE_FLAG_PATH = 16,
  PROFILE_ATTRIBUTE_FLAG_INTERFACE = 32,
  PROFILE_ATTRIBUTE_FLAG_MEMBER = 64,
84
  PROFILE_ATTRIBUTE_FLAG_ERROR_NAME = 128
85 86
} ProfileAttributeFlags;

87 88 89
static void
profile_print_headers (void)
{
90
  printf ("#type\ttimestamp\tserial\tsender\tdestination\tpath\tinterface\tmember\n");
91
  printf ("#\t\t\t\t\tin_reply_to\n");
92 93
}

94 95
static void
profile_print_with_attrs (const char *type, DBusMessage *message,
96
  long sec, long usec, ProfileAttributeFlags attrs)
97
{
98
  printf ("%s\t%ld.%06ld", type, sec, usec);
99 100 101 102 103 104 105 106 107 108

  if (attrs & PROFILE_ATTRIBUTE_FLAG_SERIAL)
    printf ("\t%u", dbus_message_get_serial (message));

  if (attrs & PROFILE_ATTRIBUTE_FLAG_SENDER)
    printf ("\t%s", TRAP_NULL_STRING (dbus_message_get_sender (message)));

  if (attrs & PROFILE_ATTRIBUTE_FLAG_DESTINATION)
    printf ("\t%s", TRAP_NULL_STRING (dbus_message_get_destination (message)));

109 110 111
  if (attrs & PROFILE_ATTRIBUTE_FLAG_REPLY_SERIAL)
    printf ("\t%u", dbus_message_get_reply_serial (message));

112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129
  if (attrs & PROFILE_ATTRIBUTE_FLAG_PATH)
    printf ("\t%s", TRAP_NULL_STRING (dbus_message_get_path (message)));

  if (attrs & PROFILE_ATTRIBUTE_FLAG_INTERFACE)
    printf ("\t%s", TRAP_NULL_STRING (dbus_message_get_interface (message)));

  if (attrs & PROFILE_ATTRIBUTE_FLAG_MEMBER)
    printf ("\t%s", TRAP_NULL_STRING (dbus_message_get_member (message)));

  if (attrs & PROFILE_ATTRIBUTE_FLAG_ERROR_NAME)
    printf ("\t%s", TRAP_NULL_STRING (dbus_message_get_error_name (message)));

  printf ("\n");
}

static void
print_message_profile (DBusMessage *message)
{
130
  static dbus_bool_t first = TRUE;
131
  long sec = 0, usec = 0;
132

133 134
  if (first)
    {
135
      profile_print_headers ();
136 137 138
      first = FALSE;
    }

139 140
  _dbus_get_real_time (&sec, &usec);

141 142 143
  switch (dbus_message_get_type (message))
    {
      case DBUS_MESSAGE_TYPE_METHOD_CALL:
144
        profile_print_with_attrs ("mc", message, sec, usec,
145 146
          PROFILE_ATTRIBUTE_FLAG_SERIAL |
          PROFILE_ATTRIBUTE_FLAG_SENDER |
147
          PROFILE_ATTRIBUTE_FLAG_DESTINATION |
148 149 150 151
          PROFILE_ATTRIBUTE_FLAG_PATH |
          PROFILE_ATTRIBUTE_FLAG_INTERFACE |
          PROFILE_ATTRIBUTE_FLAG_MEMBER);
        break;
152
      case DBUS_MESSAGE_TYPE_METHOD_RETURN:
153
        profile_print_with_attrs ("mr", message, sec, usec,
154
          PROFILE_ATTRIBUTE_FLAG_SERIAL |
155
          PROFILE_ATTRIBUTE_FLAG_SENDER |
156 157 158
          PROFILE_ATTRIBUTE_FLAG_DESTINATION |
          PROFILE_ATTRIBUTE_FLAG_REPLY_SERIAL);
        break;
159
      case DBUS_MESSAGE_TYPE_ERROR:
160
        profile_print_with_attrs ("err", message, sec, usec,
161
          PROFILE_ATTRIBUTE_FLAG_SERIAL |
162
          PROFILE_ATTRIBUTE_FLAG_SENDER |
163 164 165
          PROFILE_ATTRIBUTE_FLAG_DESTINATION |
          PROFILE_ATTRIBUTE_FLAG_REPLY_SERIAL);
        break;
166
      case DBUS_MESSAGE_TYPE_SIGNAL:
167
        profile_print_with_attrs ("sig", message, sec, usec,
168
          PROFILE_ATTRIBUTE_FLAG_SERIAL |
169 170
          PROFILE_ATTRIBUTE_FLAG_SENDER |
          PROFILE_ATTRIBUTE_FLAG_DESTINATION |
171 172 173 174
          PROFILE_ATTRIBUTE_FLAG_PATH |
          PROFILE_ATTRIBUTE_FLAG_INTERFACE |
          PROFILE_ATTRIBUTE_FLAG_MEMBER);
        break;
175
      default:
176
        printf ("%s\t%ld.%06ld", "tun", sec, usec);
177
        break;
178 179 180 181
    }
}

static DBusHandlerResult
182 183 184
profile_filter_func (DBusConnection     *connection,
                     DBusMessage        *message,
                     void               *user_data)
185 186 187 188 189 190 191 192 193 194 195
{
  print_message_profile (message);

  if (dbus_message_is_signal (message,
                              DBUS_INTERFACE_LOCAL,
                              "Disconnected"))
    exit (0);

  return DBUS_HANDLER_RESULT_HANDLED;
}

196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220
typedef enum {
    BINARY_MODE_NOT,
    BINARY_MODE_RAW,
    BINARY_MODE_PCAP
} BinaryMode;

static DBusHandlerResult
binary_filter_func (DBusConnection *connection,
                    DBusMessage    *message,
                    void           *user_data)
{
  BinaryMode mode = _DBUS_POINTER_TO_INT (user_data);
  char *blob;
  int len;

  /* It would be nice if we could do a zero-copy "peek" one day, but libdbus
   * is so copy-happy that this isn't really a big deal.
   */
  if (!dbus_message_marshal (message, &blob, &len))
    tool_oom ("retrieving message");

  switch (mode)
    {
      case BINARY_MODE_PCAP:
          {
221
            long tv_sec, tv_usec;
222 223 224 225 226 227 228 229 230
            /* seconds, microseconds, bytes captured (possibly truncated),
             * original length.
             * http://wiki.wireshark.org/Development/LibpcapFileFormat
             */
            dbus_uint32_t header[4] = { 0, 0, len, len };

            /* If this gets padded then we'd need to write it out in pieces */
            _DBUS_STATIC_ASSERT (sizeof (header) == 16);

231 232 233
            _dbus_get_real_time (&tv_sec, &tv_usec);
            header[0] = tv_sec;
            header[1] = tv_usec;
234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264

            if (!tool_write_all (STDOUT_FILENO, header, sizeof (header)))
              {
                perror ("dbus-monitor: write");
                exit (1);
              }
          }
        break;

      case BINARY_MODE_RAW:
      default:
        /* nothing special, just the raw message stream */
        break;
    }

  if (!tool_write_all (STDOUT_FILENO, blob, len))
    {
      perror ("dbus-monitor: write");
      exit (1);
    }

  dbus_free (blob);

  if (dbus_message_is_signal (message,
                              DBUS_INTERFACE_LOCAL,
                              "Disconnected"))
    exit (0);

  return DBUS_HANDLER_RESULT_HANDLED;
}

265 266 267
static void
usage (char *name, int ecode)
{
268
  fprintf (stderr, "Usage: %s [--system | --session | --address ADDRESS] [--monitor | --profile | --pcap | --binary ] [watch expressions]\n", name);
269 270 271
  exit (ecode);
}

272 273 274 275 276 277 278 279 280 281 282 283 284 285 286
static void
only_one_type (dbus_bool_t *seen_bus_type,
               char        *name)
{
  if (*seen_bus_type)
    {
      fprintf (stderr, "I only support monitoring one bus at a time!\n");
      usage (name, 1);
    }
  else
    {
      *seen_bus_type = TRUE;
    }
}

287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346
static dbus_bool_t
become_monitor (DBusConnection *connection,
    int numFilters,
    const char * const *filters)
{
  DBusError error = DBUS_ERROR_INIT;
  DBusMessage *m;
  DBusMessage *r;
  int i;
  dbus_uint32_t zero = 0;
  DBusMessageIter appender, array_appender;

  m = dbus_message_new_method_call (DBUS_SERVICE_DBUS,
      DBUS_PATH_DBUS, DBUS_INTERFACE_MONITORING, "BecomeMonitor");

  if (m == NULL)
    tool_oom ("becoming a monitor");

  dbus_message_iter_init_append (m, &appender);

  if (!dbus_message_iter_open_container (&appender, DBUS_TYPE_ARRAY, "s",
        &array_appender))
    tool_oom ("opening string array");

  for (i = 0; i < numFilters; i++)
    {
      if (!dbus_message_iter_append_basic (&array_appender, DBUS_TYPE_STRING,
            &filters[i]))
        tool_oom ("adding filter to array");
    }

  if (!dbus_message_iter_close_container (&appender, &array_appender) ||
      !dbus_message_iter_append_basic (&appender, DBUS_TYPE_UINT32, &zero))
    tool_oom ("finishing arguments");

  r = dbus_connection_send_with_reply_and_block (connection, m, -1, &error);

  if (r != NULL)
    {
      dbus_message_unref (r);
    }
  else if (dbus_error_has_name (&error, DBUS_ERROR_UNKNOWN_INTERFACE))
    {
      fprintf (stderr, "dbus-monitor: unable to enable new-style monitoring, "
          "your dbus-daemon is too old. Falling back to eavesdropping.\n");
      dbus_error_free (&error);
    }
  else
    {
      fprintf (stderr, "dbus-monitor: unable to enable new-style monitoring: "
          "%s: \"%s\". Falling back to eavesdropping.\n",
          error.name, error.message);
      dbus_error_free (&error);
    }

  dbus_message_unref (m);

  return (r != NULL);
}

347 348 349 350 351
int
main (int argc, char *argv[])
{
  DBusConnection *connection;
  DBusError error;
352
  DBusBusType type = DBUS_BUS_SESSION;
353
  DBusHandleMessageFunction filter_func = monitor_filter_func;
354
  char *address = NULL;
355
  dbus_bool_t seen_bus_type = FALSE;
356
  BinaryMode binary_mode = BINARY_MODE_NOT;
357 358
  int i = 0, j = 0, numFilters = 0;
  char **filters = NULL;
359 360 361 362 363

  /* Set stdout to be unbuffered; this is basically so that if people
   * do dbus-monitor > file, then send SIGINT via Control-C, they
   * don't lose the last chunk of messages.
   */
364 365 366 367

#ifdef DBUS_WIN
  setvbuf (stdout, NULL, _IONBF, 0);
#else
368
  setvbuf (stdout, NULL, _IOLBF, 0);
369
#endif
370

371 372 373 374
  for (i = 1; i < argc; i++)
    {
      char *arg = argv[i];

375
      if (!strcmp (arg, "--system"))
376 377 378 379
        {
          only_one_type (&seen_bus_type, argv[0]);
          type = DBUS_BUS_SYSTEM;
        }
380
      else if (!strcmp (arg, "--session"))
381 382 383 384
        {
          only_one_type (&seen_bus_type, argv[0]);
          type = DBUS_BUS_SESSION;
        }
385
      else if (!strcmp (arg, "--address"))
386 387 388 389 390 391 392 393 394 395 396
        {
          only_one_type (&seen_bus_type, argv[0]);

          if (i+1 < argc)
            {
              address = argv[i+1];
              i++;
            }
          else
            usage (argv[0], 1);
        }
397
      else if (!strcmp (arg, "--help"))
398
        usage (argv[0], 0);
399
      else if (!strcmp (arg, "--monitor"))
400 401 402 403
        {
          filter_func = monitor_filter_func;
          binary_mode = BINARY_MODE_NOT;
        }
404
      else if (!strcmp (arg, "--profile"))
405 406 407 408 409 410 411 412 413 414 415 416 417 418
        {
          filter_func = profile_filter_func;
          binary_mode = BINARY_MODE_NOT;
        }
      else if (!strcmp (arg, "--binary"))
        {
          filter_func = binary_filter_func;
          binary_mode = BINARY_MODE_RAW;
        }
      else if (!strcmp (arg, "--pcap"))
        {
          filter_func = binary_filter_func;
          binary_mode = BINARY_MODE_PCAP;
        }
419
      else if (!strcmp (arg, "--"))
420
        continue;
421
      else if (arg[0] == '-')
422
        usage (argv[0], 1);
423
      else {
424 425 426 427 428 429 430 431 432
          unsigned int filter_len;
          numFilters++;
          /* Prepend a rule (and a comma) to enable the monitor to eavesdrop.
           * Prepending allows the user to add eavesdrop=false at command line
           * in order to disable eavesdropping when needed */
          filter_len = strlen (EAVESDROPPING_RULE) + 1 + strlen (arg) + 1;

          filters = (char **) realloc (filters, numFilters * sizeof (char *));
          if (filters == NULL)
433
            tool_oom ("adding a new filter slot");
434
          filters[j] = (char *) malloc (filter_len);
435
          if (filters[j] == NULL)
436
            tool_oom ("adding a new filter");
437 438
          snprintf (filters[j], filter_len, "%s,%s", EAVESDROPPING_RULE, arg);
          j++;
439
      }
440 441
    }

442
  dbus_error_init (&error);
443 444 445 446 447 448 449
  
  if (address != NULL)
    {
      connection = dbus_connection_open (address, &error);
      if (connection)
        {
          if (!dbus_bus_register (connection, &error))
450
            {
451
              fprintf (stderr, "Failed to register connection to bus at %s: %s\n",
452
                       address, error.message);
453 454
              dbus_error_free (&error);
              exit (1);
455
            }
456 457 458 459
        }
    }
  else
    connection = dbus_bus_get (type, &error);
460 461
  if (connection == NULL)
    {
462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480
      const char *where;
      if (address != NULL)
        where = address;
      else
        {
          switch (type)
            {
            case DBUS_BUS_SYSTEM:
              where = "system bus";
              break;
            case DBUS_BUS_SESSION:
              where = "session bus";
              break;
            default:
              where = "";
            }
        }
      fprintf (stderr, "Failed to open connection to %s: %s\n",
               where,
481 482 483 484 485
               error.message);
      dbus_error_free (&error);
      exit (1);
    }

486 487 488 489 490
  /* Receive o.fd.Peer messages as normal messages, rather than having
   * libdbus handle them internally, which is the wrong thing for
   * a monitor */
  dbus_connection_set_route_peer_messages (connection, TRUE);

491 492
  if (!dbus_connection_add_filter (connection, filter_func,
                                   _DBUS_INT_TO_POINTER (binary_mode), NULL))
493 494 495 496 497 498 499 500 501 502 503
    {
      fprintf (stderr, "Couldn't add filter!\n");
      exit (1);
    }

  if (become_monitor (connection, numFilters,
                      (const char * const *) filters))
    {
      /* no more preparation needed */
    }
  else if (numFilters)
504
    {
505
      size_t offset = 0;
506 507
      for (i = 0; i < j; i++)
        {
508 509 510 511 512 513 514 515 516 517 518 519
          dbus_bus_add_match (connection, filters[i] + offset, &error);
          if (dbus_error_is_set (&error) && i == 0 && offset == 0)
            {
              /* We might be talking to a pre-1.5.6 dbus-daemon
              * which wouldn't understand eavesdrop=true.
              * If this works, carry on with offset > 0
              * on the remaining iterations. */
              offset = strlen (EAVESDROPPING_RULE) + 1;
              dbus_error_free (&error);
              dbus_bus_add_match (connection, filters[i] + offset, &error);
            }

520
          if (dbus_error_is_set (&error))
521 522 523 524 525 526
            {
              fprintf (stderr, "Failed to setup match \"%s\": %s\n",
                       filters[i], error.message);
              dbus_error_free (&error);
              exit (1);
            }
527
          free(filters[i]);
528 529 530 531 532
        }
    }
  else
    {
      dbus_bus_add_match (connection,
533 534
                          EAVESDROPPING_RULE,
                          &error);
535
      if (dbus_error_is_set (&error))
536 537 538 539 540 541 542 543
        {
          dbus_error_free (&error);
          dbus_bus_add_match (connection,
                              "",
                              &error);
          if (dbus_error_is_set (&error))
            goto lose;
        }
544 545
    }

546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584
  switch (binary_mode)
    {
      case BINARY_MODE_NOT:
      case BINARY_MODE_RAW:
        break;

      case BINARY_MODE_PCAP:
          {
            /* We're not using libpcap because the file format is simple
             * enough not to need it.
             * http://wiki.wireshark.org/Development/LibpcapFileFormat */
            struct {
                dbus_uint32_t magic;
                dbus_uint16_t major_version;
                dbus_uint16_t minor_version;
                dbus_int32_t timezone;
                dbus_uint32_t precision;
                dbus_uint32_t max_length;
                dbus_uint32_t link_type;
            } header = {
                0xA1B2C3D4U,  /* magic number */
                2, 4,         /* v2.4 */
                0,            /* capture in GMT */
                0,            /* no opinion on timestamp precision */
                (1 << 27),    /* D-Bus spec says so */
                LINKTYPE_DBUS
            };

            /* Assert that there is no padding */
            _DBUS_STATIC_ASSERT (sizeof (header) == 24);

            if (!tool_write_all (STDOUT_FILENO, &header, sizeof (header)))
              {
                perror ("dbus-monitor: write");
                exit (1);
              }
          }
        break;
    }
585

586
  while (dbus_connection_read_write_dispatch(connection, -1))
587
    ;
588
  exit (0);
589 590 591
 lose:
  fprintf (stderr, "Error: %s\n", error.message);
  exit (1);
592
}
593