src/libsystemd/sd-bus/bus-match.h

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2 #pragma once
   3
   4 /***
   5   Copyright 2013 Lennart Poettering
   6 ***/
   7
   8 #include "sd-bus.h"
   9
  10 #include "hashmap.h"
  11
  12 enum bus_match_node_type {
  13         BUS_MATCH_ROOT,
  14         BUS_MATCH_VALUE,
  15         BUS_MATCH_LEAF,
  16
  17         /* The following are all different kinds of compare nodes */
  18         BUS_MATCH_SENDER,
  19         BUS_MATCH_MESSAGE_TYPE,
  20         BUS_MATCH_DESTINATION,
  21         BUS_MATCH_INTERFACE,
  22         BUS_MATCH_MEMBER,
  23         BUS_MATCH_PATH,
  24         BUS_MATCH_PATH_NAMESPACE,
  25         BUS_MATCH_ARG,
  26         BUS_MATCH_ARG_LAST = BUS_MATCH_ARG + 63,
  27         BUS_MATCH_ARG_PATH,
  28         BUS_MATCH_ARG_PATH_LAST = BUS_MATCH_ARG_PATH + 63,
  29         BUS_MATCH_ARG_NAMESPACE,
  30         BUS_MATCH_ARG_NAMESPACE_LAST = BUS_MATCH_ARG_NAMESPACE + 63,
  31         BUS_MATCH_ARG_HAS,
  32         BUS_MATCH_ARG_HAS_LAST = BUS_MATCH_ARG_HAS + 63,
  33         _BUS_MATCH_NODE_TYPE_MAX,
  34         _BUS_MATCH_NODE_TYPE_INVALID = -1
  35 };
  36
  37 struct bus_match_node {
  38         enum bus_match_node_type type;
  39         struct bus_match_node *parent, *next, *prev, *child;
  40
  41         union {
  42                 struct {
  43                         char *str;
  44                         uint8_t u8;
  45                 } value;
  46                 struct {
  47                         struct match_callback *callback;
  48                 } leaf;
  49                 struct {
  50                         /* If this is set, then the child is NULL */
  51                         Hashmap *children;
  52                 } compare;
  53         };
  54 };
  55
  56 struct bus_match_component {
  57         enum bus_match_node_type type;
  58         uint8_t value_u8;
  59         char *value_str;
  60 };
  61
  62 enum bus_match_scope {
  63         BUS_MATCH_GENERIC,
  64         BUS_MATCH_LOCAL,
  65         BUS_MATCH_DRIVER,
  66 };
  67
  68 int bus_match_run(sd_bus *bus, struct bus_match_node *root, sd_bus_message *m);
  69
  70 int bus_match_add(struct bus_match_node *root, struct bus_match_component *components, unsigned n_components, struct match_callback *callback);
  71 int bus_match_remove(struct bus_match_node *root, struct match_callback *callback);
  72
  73 int bus_match_find(struct bus_match_node *root, struct bus_match_component *components, unsigned n_components, sd_bus_message_handler_t callback, void *userdata, struct match_callback **ret);
  74
  75 void bus_match_free(struct bus_match_node *node);
  76
  77 void bus_match_dump(struct bus_match_node *node, unsigned level);
  78
  79 const char* bus_match_node_type_to_string(enum bus_match_node_type t, char buf[], size_t l);
  80 enum bus_match_node_type bus_match_node_type_from_string(const char *k, size_t n);
  81
  82 int bus_match_parse(const char *match, struct bus_match_component **_components, unsigned *_n_components);
  83 void bus_match_parse_free(struct bus_match_component *components, unsigned n_components);
  84 char *bus_match_to_string(struct bus_match_component *components, unsigned n_components);
  85
  86 enum bus_match_scope bus_match_get_scope(const struct bus_match_component *components, unsigned n_components);