4 This file is part of avahi.
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.
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.
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
27 #define AVAHI_QUERY_HISTORY_MSEC 100
28 #define AVAHI_QUERY_DEFER_MSEC 100
29 #define AVAHI_RESPONSE_HISTORY_MSEC 700
30 #define AVAHI_RESPONSE_DEFER_MSEC 20
31 #define AVAHI_RESPONSE_JITTER_MSEC 100
32 #define AVAHI_PROBE_DEFER_MSEC 70
34 AvahiPacketScheduler *avahi_packet_scheduler_new(AvahiServer *server, AvahiInterface *i) {
35 AvahiPacketScheduler *s;
40 s = g_new(AvahiPacketScheduler, 1);
44 AVAHI_LLIST_HEAD_INIT(AvahiQueryJob, s->query_jobs);
45 AVAHI_LLIST_HEAD_INIT(AvahiResponseJob, s->response_jobs);
46 AVAHI_LLIST_HEAD_INIT(AvahiKnownAnswer, s->known_answers);
47 AVAHI_LLIST_HEAD_INIT(AvahiProbeJob, s->probe_jobs);
52 static void query_job_free(AvahiPacketScheduler *s, AvahiQueryJob *qj) {
56 avahi_time_event_queue_remove(qj->scheduler->server->time_event_queue, qj->time_event);
58 AVAHI_LLIST_REMOVE(AvahiQueryJob, jobs, s->query_jobs, qj);
60 avahi_key_unref(qj->key);
64 static void response_job_free(AvahiPacketScheduler *s, AvahiResponseJob *rj) {
68 avahi_time_event_queue_remove(rj->scheduler->server->time_event_queue, rj->time_event);
70 AVAHI_LLIST_REMOVE(AvahiResponseJob, jobs, s->response_jobs, rj);
72 avahi_record_unref(rj->record);
76 static void probe_job_free(AvahiPacketScheduler *s, AvahiProbeJob *pj) {
80 avahi_time_event_queue_remove(pj->scheduler->server->time_event_queue, pj->time_event);
82 AVAHI_LLIST_REMOVE(AvahiProbeJob, jobs, s->probe_jobs, pj);
84 avahi_record_unref(pj->record);
88 void avahi_packet_scheduler_free(AvahiPacketScheduler *s) {
95 g_assert(!s->known_answers);
97 while ((qj = s->query_jobs))
98 query_job_free(s, qj);
99 while ((rj = s->response_jobs))
100 response_job_free(s, rj);
101 while ((pj = s->probe_jobs))
102 probe_job_free(s, pj);
107 static gpointer known_answer_walk_callback(AvahiCache *c, AvahiKey *pattern, AvahiCacheEntry *e, gpointer userdata) {
108 AvahiPacketScheduler *s = userdata;
109 AvahiKnownAnswer *ka;
116 if (avahi_cache_entry_half_ttl(c, e))
119 ka = g_new0(AvahiKnownAnswer, 1);
121 ka->record = avahi_record_ref(e->record);
123 AVAHI_LLIST_PREPEND(AvahiKnownAnswer, known_answer, s->known_answers, ka);
127 static guint8* packet_add_query_job(AvahiPacketScheduler *s, AvahiDnsPacket *p, AvahiQueryJob *qj) {
134 if ((d = avahi_dns_packet_append_key(p, qj->key, FALSE))) {
139 /* Drop query after some time from history */
140 avahi_elapse_time(&tv, AVAHI_QUERY_HISTORY_MSEC, 0);
141 avahi_time_event_queue_update(s->server->time_event_queue, qj->time_event, &tv);
143 g_get_current_time(&qj->delivery);
145 /* Add all matching known answers to the list */
146 avahi_cache_walk(s->interface->cache, qj->key, known_answer_walk_callback, s);
152 static void append_known_answers_and_send(AvahiPacketScheduler *s, AvahiDnsPacket *p) {
153 AvahiKnownAnswer *ka;
160 while ((ka = s->known_answers)) {
162 while (!avahi_dns_packet_append_record(p, ka->record, FALSE)) {
164 g_assert(!avahi_dns_packet_is_empty(p));
166 avahi_dns_packet_set_field(p, AVAHI_DNS_FIELD_FLAGS, avahi_dns_packet_get_field(p, AVAHI_DNS_FIELD_FLAGS) | AVAHI_DNS_FLAG_TC);
167 avahi_dns_packet_set_field(p, AVAHI_DNS_FIELD_ANCOUNT, n);
168 avahi_interface_send_packet(s->interface, p);
169 avahi_dns_packet_free(p);
171 p = avahi_dns_packet_new_query(s->interface->hardware->mtu - 48);
175 AVAHI_LLIST_REMOVE(AvahiKnownAnswer, known_answer, s->known_answers, ka);
176 avahi_record_unref(ka->record);
182 avahi_dns_packet_set_field(p, AVAHI_DNS_FIELD_ANCOUNT, n);
183 avahi_interface_send_packet(s->interface, p);
184 avahi_dns_packet_free(p);
187 static void query_elapse(AvahiTimeEvent *e, gpointer data) {
188 AvahiQueryJob *qj = data;
189 AvahiPacketScheduler *s;
198 /* Lets remove it from the history */
199 query_job_free(s, qj);
203 g_assert(!s->known_answers);
205 p = avahi_dns_packet_new_query(s->interface->hardware->mtu - 48);
206 d = packet_add_query_job(s, p, qj);
210 /* Try to fill up packet with more queries, if available */
211 for (qj = s->query_jobs; qj; qj = qj->jobs_next) {
216 if (!packet_add_query_job(s, p, qj))
222 avahi_dns_packet_set_field(p, AVAHI_DNS_FIELD_QDCOUNT, n);
224 /* Now add known answers */
225 append_known_answers_and_send(s, p);
228 AvahiQueryJob* query_job_new(AvahiPacketScheduler *s, AvahiKey *key) {
234 qj = g_new(AvahiQueryJob, 1);
236 qj->key = avahi_key_ref(key);
238 qj->time_event = NULL;
240 AVAHI_LLIST_PREPEND(AvahiQueryJob, jobs, s->query_jobs, qj);
245 void avahi_packet_scheduler_post_query(AvahiPacketScheduler *s, AvahiKey *key, gboolean immediately) {
252 avahi_elapse_time(&tv, immediately ? 0 : AVAHI_QUERY_DEFER_MSEC, 0);
254 for (qj = s->query_jobs; qj; qj = qj->jobs_next) {
256 if (avahi_key_equal(qj->key, key)) {
258 glong d = avahi_timeval_diff(&tv, &qj->delivery);
260 /* Duplicate questions suppression */
261 if (d >= 0 && d <= AVAHI_QUERY_HISTORY_MSEC*1000) {
262 g_message("WARNING! DUPLICATE QUERY SUPPRESSION ACTIVE!");
266 query_job_free(s, qj);
272 qj = query_job_new(s, key);
274 qj->time_event = avahi_time_event_queue_add(s->server->time_event_queue, &qj->delivery, query_elapse, qj);
277 static guint8* packet_add_response_job(AvahiPacketScheduler *s, AvahiDnsPacket *p, AvahiResponseJob *rj) {
284 if ((d = avahi_dns_packet_append_record(p, rj->record, rj->flush_cache))) {
289 /* Drop response after some time from history */
290 avahi_elapse_time(&tv, AVAHI_RESPONSE_HISTORY_MSEC, 0);
291 avahi_time_event_queue_update(s->server->time_event_queue, rj->time_event, &tv);
293 g_get_current_time(&rj->delivery);
299 static void send_response_packet(AvahiPacketScheduler *s, AvahiResponseJob *rj) {
305 p = avahi_dns_packet_new_response(s->interface->hardware->mtu - 200);
308 /* If a job was specified, put it in the packet. */
311 d = packet_add_response_job(s, p, rj);
316 /* Try to fill up packet with more responses, if available */
317 for (rj = s->response_jobs; rj; rj = rj->jobs_next) {
322 if (!packet_add_response_job(s, p, rj))
328 avahi_dns_packet_set_field(p, AVAHI_DNS_FIELD_ANCOUNT, n);
329 avahi_interface_send_packet(s->interface, p);
330 avahi_dns_packet_free(p);
333 static void response_elapse(AvahiTimeEvent *e, gpointer data) {
334 AvahiResponseJob *rj = data;
335 AvahiPacketScheduler *s;
341 /* Lets remove it from the history */
342 response_job_free(s, rj);
346 send_response_packet(s, rj);
349 static AvahiResponseJob* look_for_response(AvahiPacketScheduler *s, AvahiRecord *record) {
350 AvahiResponseJob *rj;
355 for (rj = s->response_jobs; rj; rj = rj->jobs_next)
356 if (avahi_record_equal_no_ttl(rj->record, record))
362 static AvahiResponseJob* response_job_new(AvahiPacketScheduler *s, AvahiRecord *record) {
363 AvahiResponseJob *rj;
368 rj = g_new(AvahiResponseJob, 1);
370 rj->record = avahi_record_ref(record);
372 rj->time_event = NULL;
373 rj->address_valid = FALSE;
374 rj->flush_cache = FALSE;
376 AVAHI_LLIST_PREPEND(AvahiResponseJob, jobs, s->response_jobs, rj);
381 void avahi_packet_scheduler_post_response(AvahiPacketScheduler *s, const AvahiAddress *a, AvahiRecord *record, gboolean flush_cache, gboolean immediately) {
382 AvahiResponseJob *rj;
388 g_assert(!avahi_key_is_pattern(record->key));
390 avahi_elapse_time(&tv, immediately ? 0 : AVAHI_RESPONSE_DEFER_MSEC, immediately ? 0 : AVAHI_RESPONSE_JITTER_MSEC);
392 /* Don't send out duplicates */
394 if ((rj = look_for_response(s, record))) {
397 d = avahi_timeval_diff(&tv, &rj->delivery);
399 /* If there's already a matching packet in our history or in
400 * the schedule, we do nothing. */
401 if (!!record->ttl == !!rj->record->ttl &&
402 d >= 0 && d <= AVAHI_RESPONSE_HISTORY_MSEC*1000) {
403 g_message("WARNING! DUPLICATE RESPONSE SUPPRESSION ACTIVE!");
405 /* This job is no longer specific to a single querier, so
406 * make sure it isn't suppressed by known answer
409 if (rj->address_valid && (!a || avahi_address_cmp(a, &rj->address) != 0))
410 rj->address_valid = FALSE;
412 rj->flush_cache = flush_cache;
417 /* Either one was a goodbye packet, but the other was not, so
418 * let's drop the older one. */
419 response_job_free(s, rj);
422 /* g_message("ACCEPTED NEW RESPONSE [%s]", t = avahi_record_to_string(record)); */
425 /* Create a new job and schedule it */
426 rj = response_job_new(s, record);
427 rj->flush_cache = flush_cache;
429 rj->time_event = avahi_time_event_queue_add(s->server->time_event_queue, &rj->delivery, response_elapse, rj);
431 /* Store the address of the host this messages is intended to, so
432 that we can drop this job in case a truncated message with
433 known answer suppresion entries is recieved */
435 if ((rj->address_valid = !!a))
439 void avahi_packet_scheduler_incoming_query(AvahiPacketScheduler *s, AvahiKey *key) {
446 /* This function is called whenever an incoming query was
447 * receieved. We drop all scheduled queries which match here. The
448 * keyword is "DUPLICATE QUESTION SUPPRESION". */
450 for (qj = s->query_jobs; qj; qj = qj->jobs_next)
451 if (avahi_key_equal(qj->key, key)) {
460 /* No matching job was found. Add the query to the history */
461 qj = query_job_new(s, key);
466 /* Drop the query after some time */
467 avahi_elapse_time(&tv, AVAHI_QUERY_HISTORY_MSEC, 0);
468 qj->time_event = avahi_time_event_queue_add(s->server->time_event_queue, &tv, query_elapse, qj);
470 g_get_current_time(&qj->delivery);
473 void response_job_set_elapse_time(AvahiPacketScheduler *s, AvahiResponseJob *rj, guint msec, guint jitter) {
479 avahi_elapse_time(&tv, msec, jitter);
482 avahi_time_event_queue_update(s->server->time_event_queue, rj->time_event, &tv);
484 rj->time_event = avahi_time_event_queue_add(s->server->time_event_queue, &tv, response_elapse, rj);
488 void avahi_packet_scheduler_incoming_response(AvahiPacketScheduler *s, AvahiRecord *record) {
489 AvahiResponseJob *rj;
494 /* This function is called whenever an incoming response was
495 * receieved. We drop all scheduled responses which match
496 * here. The keyword is "DUPLICATE ANSWER SUPPRESION". */
498 for (rj = s->response_jobs; rj; rj = rj->jobs_next)
499 if (avahi_record_equal_no_ttl(rj->record, record)) {
503 if (!!record->ttl == !!rj->record->ttl) {
504 /* An entry like this is already in our history,
505 * so let's get out of here! */
510 /* Either one was a goodbye packet but other was
511 * none. We remove the history entry, and add a
514 response_job_free(s, rj);
520 if (!!record->ttl == !!rj->record->ttl) {
522 /* The incoming packet matches our scheduled
523 * record, so let's mark that one as done */
529 /* Either one was a goodbye packet but other was
530 * none. We ignore the incoming packet. */
537 /* No matching job was found. Add the query to the history */
538 rj = response_job_new(s, record);
543 /* Drop response after 500ms from history */
544 response_job_set_elapse_time(s, rj, AVAHI_RESPONSE_HISTORY_MSEC, 0);
546 g_get_current_time(&rj->delivery);
549 void avahi_packet_scheduler_incoming_known_answer(AvahiPacketScheduler *s, AvahiRecord *record, const AvahiAddress *a) {
550 AvahiResponseJob *rj;
556 for (rj = s->response_jobs; rj; rj = rj->jobs_next) {
558 g_assert(record->ttl > 0);
559 g_assert(rj->record->ttl/2);
561 if (avahi_record_equal_no_ttl(rj->record, record))
562 if (rj->address_valid)
563 if (avahi_address_cmp(&rj->address, a))
564 if (record->ttl >= rj->record->ttl/2) {
566 /* Let's suppress it */
568 response_job_free(s, rj);
574 void avahi_packet_scheduler_flush_responses(AvahiPacketScheduler *s) {
575 AvahiResponseJob *rj;
579 /* Send all scheduled responses, ignoring the scheduled time */
581 for (rj = s->response_jobs; rj; rj = rj->jobs_next)
583 send_response_packet(s, rj);
586 static AvahiProbeJob* probe_job_new(AvahiPacketScheduler *s, AvahiRecord *record) {
592 pj = g_new(AvahiProbeJob, 1);
594 pj->record = avahi_record_ref(record);
595 pj->time_event = NULL;
598 AVAHI_LLIST_PREPEND(AvahiProbeJob, jobs, s->probe_jobs, pj);
603 static guint8* packet_add_probe_query(AvahiPacketScheduler *s, AvahiDnsPacket *p, AvahiProbeJob *pj) {
612 g_assert(!pj->chosen);
614 /* Estimate the size for this record */
616 avahi_key_get_estimate_size(pj->record->key) +
617 avahi_record_get_estimate_size(pj->record);
620 if (size > avahi_dns_packet_space(p))
623 /* Create the probe query */
624 k = avahi_key_new(pj->record->key->name, pj->record->key->class, AVAHI_DNS_TYPE_ANY);
625 ret = avahi_dns_packet_append_key(p, k, FALSE);
628 /* Mark this job for addition to the packet */
631 /* Scan for more jobs whith matching key pattern */
632 for (pj = s->probe_jobs; pj; pj = pj->jobs_next) {
636 /* Does the record match the probe? */
637 if (k->class != pj->record->key->class || !avahi_domain_equal(k->name, pj->record->key->name))
640 /* This job wouldn't fit in */
641 if (avahi_record_get_estimate_size(pj->record) > avahi_dns_packet_space(p))
644 /* Mark this job for addition to the packet */
653 static void probe_elapse(AvahiTimeEvent *e, gpointer data) {
654 AvahiProbeJob *pj = data, *next;
655 AvahiPacketScheduler *s;
662 p = avahi_dns_packet_new_query(s->interface->hardware->mtu - 48);
664 /* Add the import probe */
665 if (!packet_add_probe_query(s, p, pj)) {
666 g_warning("Record too large! ---");
667 avahi_dns_packet_free(p);
673 /* Try to fill up packet with more probes, if available */
674 for (pj = s->probe_jobs; pj; pj = pj->jobs_next) {
679 if (!packet_add_probe_query(s, p, pj))
685 avahi_dns_packet_set_field(p, AVAHI_DNS_FIELD_QDCOUNT, n);
689 /* Now add the chosen records to the authorative section */
690 for (pj = s->probe_jobs; pj; pj = next) {
692 next = pj->jobs_next;
697 if (!avahi_dns_packet_append_record(p, pj->record, TRUE)) {
698 g_warning("Bad probe size estimate!");
700 /* Unmark all following jobs */
701 for (; pj; pj = pj->jobs_next)
707 probe_job_free(s, pj);
712 avahi_dns_packet_set_field(p, AVAHI_DNS_FIELD_NSCOUNT, n);
715 avahi_interface_send_packet(s->interface, p);
716 avahi_dns_packet_free(p);
719 void avahi_packet_scheduler_post_probe(AvahiPacketScheduler *s, AvahiRecord *record, gboolean immediately) {
725 g_assert(!avahi_key_is_pattern(record->key));
727 avahi_elapse_time(&tv, immediately ? 0 : AVAHI_PROBE_DEFER_MSEC, 0);
729 /* Create a new job and schedule it */
730 pj = probe_job_new(s, record);
732 pj->time_event = avahi_time_event_queue_add(s->server->time_event_queue, &pj->delivery, probe_elapse, pj);