git.meshlink.io Git - catta/blob - avahi-core/probe-sched.c

   1 /* $Id$ */
   2
   3 /***
   4   This file is part of avahi.
   5
   6   avahi is free software; you can redistribute it and/or modify it
   7   under the terms of the GNU Lesser General Public License as
   8   published by the Free Software Foundation; either version 2.1 of the
   9   License, or (at your option) any later version.
  10
  11   avahi is distributed in the hope that it will be useful, but WITHOUT
  12   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  13   or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
  14   Public License for more details.
  15
  16   You should have received a copy of the GNU Lesser General Public
  17   License along with avahi; if not, write to the Free Software
  18   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  19   USA.
  20 ***/
  21
  22 #ifdef HAVE_CONFIG_H
  23 #include <config.h>
  24 #endif
  25
  26 #include <avahi-common/domain.h>
  27 #include <avahi-common/timeval.h>
  28 #include <avahi-common/malloc.h>
  29
  30 #include "probe-sched.h"
  31 #include "log.h"
  32 #include "rr-util.h"
  33
  34 #define AVAHI_PROBE_HISTORY_MSEC 150
  35 #define AVAHI_PROBE_DEFER_MSEC 50
  36
  37 typedef struct AvahiProbeJob AvahiProbeJob;
  38
  39 struct AvahiProbeJob {
  40     AvahiProbeScheduler *scheduler;
  41     AvahiTimeEvent *time_event;
  42
  43     int chosen; /* Use for packet assembling */
  44     int done;
  45     struct timeval delivery;
  46
  47     AvahiRecord *record;
  48
  49     AVAHI_LLIST_FIELDS(AvahiProbeJob, jobs);
  50 };
  51
  52 struct AvahiProbeScheduler {
  53     AvahiInterface *interface;
  54     AvahiTimeEventQueue *time_event_queue;
  55
  56     AVAHI_LLIST_HEAD(AvahiProbeJob, jobs);
  57     AVAHI_LLIST_HEAD(AvahiProbeJob, history);
  58 };
  59
  60 static AvahiProbeJob* job_new(AvahiProbeScheduler *s, AvahiRecord *record, int done) {
  61     AvahiProbeJob *pj;
  62
  63     assert(s);
  64     assert(record);
  65
  66     if (!(pj = avahi_new(AvahiProbeJob, 1))) {
  67         avahi_log_error(__FILE__": Out of memory");
  68         return NULL; /* OOM */
  69     }
  70
  71     pj->scheduler = s;
  72     pj->record = avahi_record_ref(record);
  73     pj->time_event = NULL;
  74     pj->chosen = 0;
  75
  76     if ((pj->done = done))
  77         AVAHI_LLIST_PREPEND(AvahiProbeJob, jobs, s->history, pj);
  78     else
  79         AVAHI_LLIST_PREPEND(AvahiProbeJob, jobs, s->jobs, pj);
  80
  81     return pj;
  82 }
  83
  84 static void job_free(AvahiProbeScheduler *s, AvahiProbeJob *pj) {
  85     assert(pj);
  86
  87     if (pj->time_event)
  88         avahi_time_event_free(pj->time_event);
  89
  90     if (pj->done)
  91         AVAHI_LLIST_REMOVE(AvahiProbeJob, jobs, s->history, pj);
  92     else
  93         AVAHI_LLIST_REMOVE(AvahiProbeJob, jobs, s->jobs, pj);
  94
  95     avahi_record_unref(pj->record);
  96     avahi_free(pj);
  97 }
  98
  99 static void elapse_callback(AvahiTimeEvent *e, void* data);
 100
 101 static void job_set_elapse_time(AvahiProbeScheduler *s, AvahiProbeJob *pj, unsigned msec, unsigned jitter) {
 102     struct timeval tv;
 103
 104     assert(s);
 105     assert(pj);
 106
 107     avahi_elapse_time(&tv, msec, jitter);
 108
 109     if (pj->time_event)
 110         avahi_time_event_update(pj->time_event, &tv);
 111     else
 112         pj->time_event = avahi_time_event_new(s->time_event_queue, &tv, elapse_callback, pj);
 113 }
 114
 115 static void job_mark_done(AvahiProbeScheduler *s, AvahiProbeJob *pj) {
 116     assert(s);
 117     assert(pj);
 118
 119     assert(!pj->done);
 120
 121     AVAHI_LLIST_REMOVE(AvahiProbeJob, jobs, s->jobs, pj);
 122     AVAHI_LLIST_PREPEND(AvahiProbeJob, jobs, s->history, pj);
 123
 124     pj->done = 1;
 125
 126     job_set_elapse_time(s, pj, AVAHI_PROBE_HISTORY_MSEC, 0);
 127     gettimeofday(&pj->delivery, NULL);
 128 }
 129
 130 AvahiProbeScheduler *avahi_probe_scheduler_new(AvahiInterface *i) {
 131     AvahiProbeScheduler *s;
 132
 133     assert(i);
 134
 135     if (!(s = avahi_new(AvahiProbeScheduler, 1))) {
 136         avahi_log_error(__FILE__": Out of memory");
 137         return NULL;
 138     }
 139
 140     s->interface = i;
 141     s->time_event_queue = i->monitor->server->time_event_queue;
 142
 143     AVAHI_LLIST_HEAD_INIT(AvahiProbeJob, s->jobs);
 144     AVAHI_LLIST_HEAD_INIT(AvahiProbeJob, s->history);
 145
 146     return s;
 147 }
 148
 149 void avahi_probe_scheduler_free(AvahiProbeScheduler *s) {
 150     assert(s);
 151
 152     avahi_probe_scheduler_clear(s);
 153     avahi_free(s);
 154 }
 155
 156 void avahi_probe_scheduler_clear(AvahiProbeScheduler *s) {
 157     assert(s);
 158
 159     while (s->jobs)
 160         job_free(s, s->jobs);
 161     while (s->history)
 162         job_free(s, s->history);
 163 }
 164
 165 static int packet_add_probe_query(AvahiProbeScheduler *s, AvahiDnsPacket *p, AvahiProbeJob *pj) {
 166     size_t size;
 167     AvahiKey *k;
 168     int b;
 169
 170     assert(s);
 171     assert(p);
 172     assert(pj);
 173
 174     assert(!pj->chosen);
 175
 176     /* Estimate the size for this record */
 177     size =
 178         avahi_key_get_estimate_size(pj->record->key) +
 179         avahi_record_get_estimate_size(pj->record);
 180
 181     /* Too large */
 182     if (size > avahi_dns_packet_space(p))
 183         return 0;
 184
 185     /* Create the probe query */
 186     if (!(k = avahi_key_new(pj->record->key->name, pj->record->key->clazz, AVAHI_DNS_TYPE_ANY)))
 187         return 0; /* OOM */
 188
 189     b = !!avahi_dns_packet_append_key(p, k, 0);
 190     assert(b);
 191
 192     /* Mark this job for addition to the packet */
 193     pj->chosen = 1;
 194
 195     /* Scan for more jobs whith matching key pattern */
 196     for (pj = s->jobs; pj; pj = pj->jobs_next) {
 197         if (pj->chosen)
 198             continue;
 199
 200         /* Does the record match the probe? */
 201         if (k->clazz != pj->record->key->clazz || !avahi_domain_equal(k->name, pj->record->key->name))
 202             continue;
 203
 204         /* This job wouldn't fit in */
 205         if (avahi_record_get_estimate_size(pj->record) > avahi_dns_packet_space(p))
 206             break;
 207
 208         /* Mark this job for addition to the packet */
 209         pj->chosen = 1;
 210     }
 211
 212     avahi_key_unref(k);
 213
 214     return 1;
 215 }
 216
 217 static void elapse_callback(AvahiTimeEvent *e, void* data) {
 218     AvahiProbeJob *pj = data, *next;
 219     AvahiProbeScheduler *s;
 220     AvahiDnsPacket *p;
 221     unsigned n;
 222
 223     assert(pj);
 224     s = pj->scheduler;
 225
 226     if (pj->done) {
 227         /* Lets remove it  from the history */
 228         job_free(s, pj);
 229         return;
 230     }
 231
 232     if (!(p = avahi_dns_packet_new_query(s->interface->hardware->mtu)))
 233         return; /* OOM */
 234     n = 1;
 235
 236     /* Add the import probe */
 237     if (!packet_add_probe_query(s, p, pj)) {
 238         size_t size;
 239         AvahiKey *k;
 240         int b;
 241
 242         avahi_dns_packet_free(p);
 243
 244         /* The probe didn't fit in the package, so let's allocate a larger one */
 245
 246         size =
 247             avahi_key_get_estimate_size(pj->record->key) +
 248             avahi_record_get_estimate_size(pj->record) +
 249             AVAHI_DNS_PACKET_HEADER_SIZE;
 250
 251         if (size > AVAHI_DNS_PACKET_SIZE_MAX)
 252             size = AVAHI_DNS_PACKET_SIZE_MAX;
 253
 254         if (!(p = avahi_dns_packet_new_query(size)))
 255             return; /* OOM */
 256
 257         if (!(k = avahi_key_new(pj->record->key->name, pj->record->key->clazz, AVAHI_DNS_TYPE_ANY))) {
 258             avahi_dns_packet_free(p);
 259             return;  /* OOM */
 260         }
 261
 262         b = avahi_dns_packet_append_key(p, k, 0) && avahi_dns_packet_append_record(p, pj->record, 0, 0);
 263         avahi_key_unref(k);
 264
 265         if (b) {
 266             avahi_dns_packet_set_field(p, AVAHI_DNS_FIELD_NSCOUNT, 1);
 267             avahi_dns_packet_set_field(p, AVAHI_DNS_FIELD_QDCOUNT, 1);
 268             avahi_interface_send_packet(s->interface, p);
 269         } else
 270             avahi_log_warn("Probe record too large, cannot send");
 271
 272         avahi_dns_packet_free(p);
 273         job_mark_done(s, pj);
 274
 275         return;
 276     }
 277
 278     /* Try to fill up packet with more probes, if available */
 279     for (pj = s->jobs; pj; pj = pj->jobs_next) {
 280
 281         if (pj->chosen)
 282             continue;
 283
 284         if (!packet_add_probe_query(s, p, pj))
 285             break;
 286
 287         n++;
 288     }
 289
 290     avahi_dns_packet_set_field(p, AVAHI_DNS_FIELD_QDCOUNT, n);
 291
 292     n = 0;
 293
 294     /* Now add the chosen records to the authorative section */
 295     for (pj = s->jobs; pj; pj = next) {
 296
 297         next = pj->jobs_next;
 298
 299         if (!pj->chosen)
 300             continue;
 301
 302         if (!avahi_dns_packet_append_record(p, pj->record, 0, 0)) {
 303             avahi_log_warn("Bad probe size estimate!");
 304
 305             /* Unmark all following jobs */
 306             for (; pj; pj = pj->jobs_next)
 307                 pj->chosen = 0;
 308
 309             break;
 310         }
 311
 312         job_mark_done(s, pj);
 313
 314         n ++;
 315     }
 316
 317     avahi_dns_packet_set_field(p, AVAHI_DNS_FIELD_NSCOUNT, n);
 318
 319     /* Send it now */
 320     avahi_interface_send_packet(s->interface, p);
 321     avahi_dns_packet_free(p);
 322 }
 323
 324 static AvahiProbeJob* find_scheduled_job(AvahiProbeScheduler *s, AvahiRecord *record) {
 325     AvahiProbeJob *pj;
 326
 327     assert(s);
 328     assert(record);
 329
 330     for (pj = s->jobs; pj; pj = pj->jobs_next) {
 331         assert(!pj->done);
 332
 333         if (avahi_record_equal_no_ttl(pj->record, record))
 334             return pj;
 335     }
 336
 337     return NULL;
 338 }
 339
 340 static AvahiProbeJob* find_history_job(AvahiProbeScheduler *s, AvahiRecord *record) {
 341     AvahiProbeJob *pj;
 342
 343     assert(s);
 344     assert(record);
 345
 346     for (pj = s->history; pj; pj = pj->jobs_next) {
 347         assert(pj->done);
 348
 349         if (avahi_record_equal_no_ttl(pj->record, record)) {
 350             /* Check whether this entry is outdated */
 351
 352             if (avahi_age(&pj->delivery) > AVAHI_PROBE_HISTORY_MSEC*1000) {
 353                 /* it is outdated, so let's remove it */
 354                 job_free(s, pj);
 355                 return NULL;
 356             }
 357
 358             return pj;
 359         }
 360     }
 361
 362     return NULL;
 363 }
 364
 365 int avahi_probe_scheduler_post(AvahiProbeScheduler *s, AvahiRecord *record, int immediately) {
 366     AvahiProbeJob *pj;
 367     struct timeval tv;
 368
 369     assert(s);
 370     assert(record);
 371     assert(!avahi_key_is_pattern(record->key));
 372
 373     if ((pj = find_history_job(s, record)))
 374         return 0;
 375
 376     avahi_elapse_time(&tv, immediately ? 0 : AVAHI_PROBE_DEFER_MSEC, 0);
 377
 378     if ((pj = find_scheduled_job(s, record))) {
 379
 380         if (avahi_timeval_compare(&tv, &pj->delivery) < 0) {
 381             /* If the new entry should be scheduled earlier, update the old entry */
 382             pj->delivery = tv;
 383             avahi_time_event_update(pj->time_event, &pj->delivery);
 384         }
 385
 386         return 1;
 387     } else {
 388         /* Create a new job and schedule it */
 389         if (!(pj = job_new(s, record, 0)))
 390             return 0; /* OOM */
 391
 392         pj->delivery = tv;
 393         pj->time_event = avahi_time_event_new(s->time_event_queue, &pj->delivery, elapse_callback, pj);
 394
 395
 396 /*     avahi_log_debug("Accepted new probe job."); */
 397
 398         return 1;
 399     }
 400 }