extras/gudev/gudevclient.c

   1 /* -*- Mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*-
   2  *
   3  * Copyright (C) 2008 David Zeuthen <davidz@redhat.com>
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with this library; if not, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  *
  20  */
  21
  22 #ifdef HAVE_CONFIG_H
  23 #  include "config.h"
  24 #endif
  25
  26 #include <stdlib.h>
  27 #include <string.h>
  28
  29 #include "gudevclient.h"
  30 #include "gudevdevice.h"
  31 #include "gudevmarshal.h"
  32 #include "gudevprivate.h"
  33
  34 /**
  35  * SECTION:gudevclient
  36  * @short_description: Query devices and listen to uevents
  37  *
  38  * #GUdevClient is used to query information about devices on a Linux
  39  * system from the Linux kernel and the udev device
  40  * manager.
  41  *
  42  * Device information is retrieved from the kernel (through the
  43  * <literal>sysfs</literal> filesystem) and the udev daemon (through a
  44  * <literal>tmpfs</literal> filesystem) and presented through
  45  * #GUdevDevice objects. This means that no blocking IO ever happens
  46  * (in both cases, we are essentially just reading data from kernel
  47  * memory) and as such there are no asynchronous versions of the
  48  * provided methods.
  49  *
  50  * To get information about a device, use
  51  * g_udev_client_query_by_subsystem(),
  52  * g_udev_client_query_by_device_number(),
  53  * g_udev_client_query_by_device_file(),
  54  * g_udev_client_query_by_sysfs_path() or
  55  * g_udev_client_query_by_subsystem_and_name().
  56  *
  57  * To listen to uevents, connect to the #GUdevClient::uevent signal.
  58  */
  59
  60 struct _GUdevClientPrivate
  61 {
  62   guint watch_id;
  63   struct udev *udev;
  64   struct udev_monitor *monitor;
  65
  66   gchar **subsystems;
  67 };
  68
  69 enum
  70 {
  71   PROP_0,
  72   PROP_SUBSYSTEMS,
  73 };
  74
  75 enum
  76 {
  77   UEVENT_SIGNAL,
  78   LAST_SIGNAL,
  79 };
  80
  81 static guint signals[LAST_SIGNAL] = { 0 };
  82
  83 G_DEFINE_TYPE (GUdevClient, g_udev_client, G_TYPE_OBJECT)
  84
  85 /* ---------------------------------------------------------------------------------------------------- */
  86
  87 static gboolean
  88 monitor_event (GIOChannel *source,
  89                GIOCondition condition,
  90                gpointer data)
  91 {
  92   GUdevClient *client = (GUdevClient *) data;
  93   GUdevDevice *device;
  94   struct udev_device *udevice;
  95
  96   if (client->priv->monitor == NULL)
  97     goto out;
  98   udevice = udev_monitor_receive_device (client->priv->monitor);
  99   if (udevice == NULL)
 100     goto out;
 101
 102   device = _g_udev_device_new (udevice);
 103   udev_device_unref (udevice);
 104   g_signal_emit (client,
 105                  signals[UEVENT_SIGNAL],
 106                  0,
 107                  g_udev_device_get_action (device),
 108                  device);
 109   g_object_unref (device);
 110
 111  out:
 112   return TRUE;
 113 }
 114
 115 static void
 116 g_udev_client_finalize (GObject *object)
 117 {
 118   GUdevClient *client = G_UDEV_CLIENT (object);
 119
 120   if (client->priv->watch_id != 0)
 121     {
 122       g_source_remove (client->priv->watch_id);
 123       client->priv->watch_id = 0;
 124     }
 125
 126   if (client->priv->monitor != NULL)
 127     {
 128       udev_monitor_unref (client->priv->monitor);
 129       client->priv->monitor = NULL;
 130     }
 131
 132   if (client->priv->udev != NULL)
 133     {
 134       udev_unref (client->priv->udev);
 135       client->priv->udev = NULL;
 136     }
 137
 138   g_strfreev (client->priv->subsystems);
 139
 140   if (G_OBJECT_CLASS (g_udev_client_parent_class)->finalize != NULL)
 141     G_OBJECT_CLASS (g_udev_client_parent_class)->finalize (object);
 142 }
 143
 144 static void
 145 g_udev_client_set_property (GObject      *object,
 146                             guint         prop_id,
 147                             const GValue *value,
 148                             GParamSpec   *pspec)
 149 {
 150   GUdevClient *client = G_UDEV_CLIENT (object);
 151
 152   switch (prop_id)
 153     {
 154     case PROP_SUBSYSTEMS:
 155       if (client->priv->subsystems != NULL)
 156         g_strfreev (client->priv->subsystems);
 157       client->priv->subsystems = g_strdupv (g_value_get_boxed (value));
 158       break;
 159
 160     default:
 161       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 162       break;
 163     }
 164 }
 165
 166 static void
 167 g_udev_client_get_property (GObject     *object,
 168                             guint        prop_id,
 169                             GValue      *value,
 170                             GParamSpec  *pspec)
 171 {
 172   GUdevClient *client = G_UDEV_CLIENT (object);
 173
 174   switch (prop_id)
 175     {
 176     case PROP_SUBSYSTEMS:
 177       g_value_set_boxed (value, client->priv->subsystems);
 178       break;
 179
 180     default:
 181       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 182       break;
 183     }
 184 }
 185
 186 static void
 187 g_udev_client_constructed (GObject *object)
 188 {
 189   GUdevClient *client = G_UDEV_CLIENT (object);
 190   GIOChannel *channel;
 191   guint n;
 192
 193   client->priv->udev = udev_new ();
 194
 195   /* connect to event source */
 196   client->priv->monitor = udev_monitor_new_from_netlink (client->priv->udev, "udev");
 197
 198   //g_debug ("ss = %p", client->priv->subsystems);
 199
 200   if (client->priv->subsystems != NULL)
 201     {
 202       /* install subsystem filters to only wake up for certain events */
 203       for (n = 0; client->priv->subsystems[n] != NULL; n++)
 204         {
 205           gchar *subsystem;
 206           gchar *devtype;
 207           gchar *s;
 208
 209           subsystem = g_strdup (client->priv->subsystems[n]);
 210           devtype = NULL;
 211
 212           //g_debug ("s = '%s'", subsystem);
 213
 214           s = strstr (subsystem, "/");
 215           if (s != NULL)
 216             {
 217               devtype = s + 1;
 218               *s = '\0';
 219             }
 220
 221           if (client->priv->monitor != NULL)
 222               udev_monitor_filter_add_match_subsystem_devtype (client->priv->monitor, subsystem, devtype);
 223
 224           g_free (subsystem);
 225         }
 226
 227       /* listen to events, and buffer them */
 228       if (client->priv->monitor != NULL)
 229         {
 230           udev_monitor_enable_receiving (client->priv->monitor);
 231           channel = g_io_channel_unix_new (udev_monitor_get_fd (client->priv->monitor));
 232           client->priv->watch_id = g_io_add_watch (channel, G_IO_IN, monitor_event, client);
 233           g_io_channel_unref (channel);
 234         } else
 235           client->priv->watch_id = NULL;
 236     }
 237
 238   if (G_OBJECT_CLASS (g_udev_client_parent_class)->constructed != NULL)
 239     G_OBJECT_CLASS (g_udev_client_parent_class)->constructed (object);
 240 }
 241
 242
 243 static void
 244 g_udev_client_class_init (GUdevClientClass *klass)
 245 {
 246   GObjectClass *gobject_class = (GObjectClass *) klass;
 247
 248   gobject_class->constructed  = g_udev_client_constructed;
 249   gobject_class->set_property = g_udev_client_set_property;
 250   gobject_class->get_property = g_udev_client_get_property;
 251   gobject_class->finalize     = g_udev_client_finalize;
 252
 253   /**
 254    * GUdevClient:subsystems:
 255    *
 256    * The subsystems to listen for uevents on.
 257    *
 258    * To listen for only a specific DEVTYPE for a given SUBSYSTEM, use
 259    * "subsystem/devtype". For example, to only listen for uevents
 260    * where SUBSYSTEM is usb and DEVTYPE is usb_interface, use
 261    * "usb/usb_interface".
 262    *
 263    * If this property is %NULL, then no events will be reported. If
 264    * it's the empty array, events from all subsystems will be
 265    * reported.
 266    */
 267   g_object_class_install_property (gobject_class,
 268                                    PROP_SUBSYSTEMS,
 269                                    g_param_spec_boxed ("subsystems",
 270                                                        "The subsystems to listen for changes on",
 271                                                        "The subsystems to listen for changes on",
 272                                                        G_TYPE_STRV,
 273                                                        G_PARAM_CONSTRUCT_ONLY |
 274                                                        G_PARAM_READWRITE));
 275
 276   /**
 277    * GUdevClient::uevent:
 278    * @client: The #GUdevClient receiving the event.
 279    * @action: The action for the uevent e.g. "add", "remove", "change", "move", etc.
 280    * @device: Details about the #GUdevDevice the event is for.
 281    *
 282    * Emitted when @client receives an uevent.
 283    */
 284   signals[UEVENT_SIGNAL] = g_signal_new ("uevent",
 285                                          G_TYPE_FROM_CLASS (klass),
 286                                          G_SIGNAL_RUN_LAST,
 287                                          G_STRUCT_OFFSET (GUdevClientClass, uevent),
 288                                          NULL,
 289                                          NULL,
 290                                          g_udev_marshal_VOID__STRING_OBJECT,
 291                                          G_TYPE_NONE,
 292                                          2,
 293                                          G_TYPE_STRING,
 294                                          G_UDEV_TYPE_DEVICE);
 295
 296   g_type_class_add_private (klass, sizeof (GUdevClientPrivate));
 297 }
 298
 299 static void
 300 g_udev_client_init (GUdevClient *client)
 301 {
 302   client->priv = G_TYPE_INSTANCE_GET_PRIVATE (client,
 303                                               G_UDEV_TYPE_CLIENT,
 304                                               GUdevClientPrivate);
 305 }
 306
 307 /**
 308  * g_udev_client_new:
 309  * @subsystems: (allow-none): A %NULL terminated string array of subsystems to listen for uevents on, %NULL to not listen on uevents at all, or an empty array to listen to uevents on all subsystems. See the documentation for the #GUdevClient:subsystems property for details on this parameter.
 310  *
 311  * Constructs a #GUdevClient object that can be used to query
 312  * information about devices. Connect to the #GUdevClient::uevent
 313  * signal to listen for uevents.
 314  *
 315  * Returns: A new #GUdevClient object. Free with g_object_unref().
 316  */
 317 GUdevClient *
 318 g_udev_client_new (const gchar * const *subsystems)
 319 {
 320   return G_UDEV_CLIENT (g_object_new (G_UDEV_TYPE_CLIENT, "subsystems", subsystems, NULL));
 321 }
 322
 323 /**
 324  * g_udev_client_query_by_subsystem:
 325  * @client: A #GUdevClient.
 326  * @subsystem: (allow-none): The subsystem to get devices for or %NULL to get all devices.
 327  *
 328  * Gets all devices belonging to @subsystem.
 329  *
 330  * Returns: (element-type GUdevDevice): A list of #GUdevDevice objects. The caller should free the result by using g_object_unref() on each element in the list and then g_list_free() on the list.
 331  */
 332 GList *
 333 g_udev_client_query_by_subsystem (GUdevClient  *client,
 334                                   const gchar  *subsystem)
 335 {
 336   struct udev_enumerate *enumerate;
 337   struct udev_list_entry *l, *devices;
 338   GList *ret;
 339
 340   g_return_val_if_fail (G_UDEV_IS_CLIENT (client), NULL);
 341
 342   ret = NULL;
 343
 344   /* prepare a device scan */
 345   enumerate = udev_enumerate_new (client->priv->udev);
 346
 347   /* filter for subsystem */
 348   if (subsystem != NULL)
 349     udev_enumerate_add_match_subsystem (enumerate, subsystem);
 350   /* retrieve the list */
 351   udev_enumerate_scan_devices (enumerate);
 352
 353   /* add devices to the list */
 354   devices = udev_enumerate_get_list_entry (enumerate);
 355   for (l = devices; l != NULL; l = udev_list_entry_get_next (l))
 356     {
 357       struct udev_device *udevice;
 358       GUdevDevice *device;
 359
 360       udevice = udev_device_new_from_syspath (udev_enumerate_get_udev (enumerate),
 361                                               udev_list_entry_get_name (l));
 362       if (udevice == NULL)
 363         continue;
 364       device = _g_udev_device_new (udevice);
 365       udev_device_unref (udevice);
 366       ret = g_list_prepend (ret, device);
 367     }
 368   udev_enumerate_unref (enumerate);
 369
 370   ret = g_list_reverse (ret);
 371
 372   return ret;
 373 }
 374
 375 /**
 376  * g_udev_client_query_by_device_number:
 377  * @client: A #GUdevClient.
 378  * @type: A value from the #GUdevDeviceType enumeration.
 379  * @number: A device number.
 380  *
 381  * Looks up a device for a type and device number.
 382  *
 383  * Returns: A #GUdevDevice object or %NULL if the device was not found. Free with g_object_unref().
 384  */
 385 GUdevDevice *
 386 g_udev_client_query_by_device_number (GUdevClient      *client,
 387                                       GUdevDeviceType   type,
 388                                       GUdevDeviceNumber number)
 389 {
 390   struct udev_device *udevice;
 391   GUdevDevice *device;
 392
 393   g_return_val_if_fail (G_UDEV_IS_CLIENT (client), NULL);
 394
 395   device = NULL;
 396   udevice = udev_device_new_from_devnum (client->priv->udev, type, number);
 397
 398   if (udevice == NULL)
 399     goto out;
 400
 401   device = _g_udev_device_new (udevice);
 402   udev_device_unref (udevice);
 403
 404  out:
 405   return device;
 406 }
 407
 408 /**
 409  * g_udev_client_query_by_device_file:
 410  * @client: A #GUdevClient.
 411  * @device_file: A device file.
 412  *
 413  * Looks up a device for a device file.
 414  *
 415  * Returns: A #GUdevDevice object or %NULL if the device was not found. Free with g_object_unref().
 416  */
 417 GUdevDevice *
 418 g_udev_client_query_by_device_file (GUdevClient  *client,
 419                                     const gchar  *device_file)
 420 {
 421   struct stat stat_buf;
 422   GUdevDevice *device;
 423
 424   g_return_val_if_fail (G_UDEV_IS_CLIENT (client), NULL);
 425   g_return_val_if_fail (device_file != NULL, NULL);
 426
 427   device = NULL;
 428
 429   if (stat (device_file, &stat_buf) != 0)
 430     goto out;
 431
 432   if (stat_buf.st_rdev == 0)
 433     goto out;
 434
 435   if (S_ISBLK (stat_buf.st_mode))
 436     device = g_udev_client_query_by_device_number (client, G_UDEV_DEVICE_TYPE_BLOCK, stat_buf.st_rdev);
 437   else if (S_ISCHR (stat_buf.st_mode))
 438     device = g_udev_client_query_by_device_number (client, G_UDEV_DEVICE_TYPE_CHAR, stat_buf.st_rdev);
 439
 440  out:
 441   return device;
 442 }
 443
 444 /**
 445  * g_udev_client_query_by_sysfs_path:
 446  * @client: A #GUdevClient.
 447  * @sysfs_path: A sysfs path.
 448  *
 449  * Looks up a device for a sysfs path.
 450  *
 451  * Returns: A #GUdevDevice object or %NULL if the device was not found. Free with g_object_unref().
 452  */
 453 GUdevDevice *
 454 g_udev_client_query_by_sysfs_path (GUdevClient  *client,
 455                                    const gchar  *sysfs_path)
 456 {
 457   struct udev_device *udevice;
 458   GUdevDevice *device;
 459
 460   g_return_val_if_fail (G_UDEV_IS_CLIENT (client), NULL);
 461   g_return_val_if_fail (sysfs_path != NULL, NULL);
 462
 463   device = NULL;
 464   udevice = udev_device_new_from_syspath (client->priv->udev, sysfs_path);
 465   if (udevice == NULL)
 466     goto out;
 467
 468   device = _g_udev_device_new (udevice);
 469   udev_device_unref (udevice);
 470
 471  out:
 472   return device;
 473 }
 474
 475 /**
 476  * g_udev_client_query_by_subsystem_and_name:
 477  * @client: A #GUdevClient.
 478  * @subsystem: A subsystem name.
 479  * @name: The name of the device.
 480  *
 481  * Looks up a device for a subsystem and name.
 482  *
 483  * Returns: A #GUdevDevice object or %NULL if the device was not found. Free with g_object_unref().
 484  */
 485 GUdevDevice *
 486 g_udev_client_query_by_subsystem_and_name (GUdevClient  *client,
 487                                            const gchar  *subsystem,
 488                                            const gchar  *name)
 489 {
 490   struct udev_device *udevice;
 491   GUdevDevice *device;
 492
 493   g_return_val_if_fail (G_UDEV_IS_CLIENT (client), NULL);
 494   g_return_val_if_fail (subsystem != NULL, NULL);
 495   g_return_val_if_fail (name != NULL, NULL);
 496
 497   device = NULL;
 498   udevice = udev_device_new_from_subsystem_sysname (client->priv->udev, subsystem, name);
 499   if (udevice == NULL)
 500     goto out;
 501
 502   device = _g_udev_device_new (udevice);
 503   udev_device_unref (udevice);
 504
 505  out:
 506   return device;
 507 }
 508