mirror of
https://gitlab.isc.org/isc-projects/bind9
synced 2025-09-05 09:05:40 +00:00
e7b36924e2
This commit simplifies a bit the lock management within dns_resolver_prime()
and prime_done() functions by means of turning resolver's attribute
"priming" into an atomic_bool and by creating only one dependent object on the
lock "primelock", namely the "primefetch" attribute.
By having the attribute "priming" as an atomic type, it save us from having to
use a lock just to test if priming is on or off for the given resolver context
object, within "dns_resolver_prime" function.
The "primelock" lock is still necessary, since dns_resolver_prime() function
internally calls dns_resolver_createfetch(), and whenever this function
succeeds it registers an event in the task manager which could be called by
another thread, namely the "prime_done" function, and this function is
responsible for disposing the "primefetch" attribute in the resolver object,
also for resetting "priming" attribute to false.
It is important that the invariant "priming == false AND primefetch == NULL"
remains constant, so that any thread calling "dns_resolver_prime" knows for sure
that if the "priming" attribute is false, "primefetch" attribute should also be
NULL, so a new fetch context could be created to fulfill this purpose, and
assigned to "primefetch" attribute under the lock protection.
To honor the explanation above, dns_resolver_prime is implemented as follow:
1. Atomically checks the attribute "priming" for the given resolver context.
2. If "priming" is false, assumes that "primefetch" is NULL (this is
ensured by the "prime_done" implementation), acquire "primelock"
lock and create a new fetch context, update "primefetch" pointer to
point to the newly allocated fetch context.
3. If "priming" is true, assumes that the job is already in progress,
no locks are acquired, nothing else to do.
To keep the previous invariant consistent, "prime_done" is implemented as follow:
1. Acquire "primefetch" lock.
2. Keep a reference to the current "primefetch" object;
3. Reset "primefetch" attribute to NULL.
4. Release "primefetch" lock.
5. Atomically update "priming" attribute to false.
6. Destroy the "primefetch" object by using the temporary reference.
This ensures that if "priming" is false, "primefetch" was already reset to NULL.
It doesn't make any difference in having the "priming" attribute not protected
by a lock, since the visible state of this variable would depend on the calling
order of the functions "dns_resolver_prime" and "prime_done".
As an example, suppose that instead of using an atomic for the "priming" attribute
we employed a lock to protect it.
Now suppose that "prime_done" function is called by Thread A, it is then preempted
before acquiring the lock, thus not reseting "priming" to false.
In parallel to that suppose that a Thread B is scheduled and that it calls
"dns_resolver_prime()", it then acquires the lock and check that "priming" is true,
thus it will consider that this resolver object is already priming and it won't do
any more job.
Conversely if the lock order was acquired in the other direction, Thread B would check
that "priming" is false (since prime_done acquired the lock first and set "priming" to false)
and it would initiate a priming fetch for this resolver.
An atomic variable wouldn't change this behavior, since it would behave exactly the
same, depending on the function call order, with the exception that it would avoid
having to use a lock.
There should be no side effects resulting from this change, since the previous
implementation employed use of the more general resolver's "lock" mutex, which
is used in far more contexts, but in the specifics of the "dns_resolver_prime"
and "prime_done" it was only used to protect "primefetch" and "priming" attributes,
which are not used in any of the other critical sections protected by the same lock,
thus having zero dependency on those variables.
71 lines
2.7 KiB
C
71 lines
2.7 KiB
C
/*
|
|
* Copyright (C) Internet Systems Consortium, Inc. ("ISC")
|
|
*
|
|
* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
*
|
|
* See the COPYRIGHT file distributed with this work for additional
|
|
* information regarding copyright ownership.
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#ifdef ISC_MUTEX_ATOMICS
|
|
#include <isc/mutexatomic.h>
|
|
#else /* ifdef ISC_MUTEX_ATOMICS */
|
|
#if HAVE_STDATOMIC_H
|
|
#include <stdatomic.h>
|
|
#else /* if HAVE_STDATOMIC_H */
|
|
#include <isc/stdatomic.h>
|
|
#endif /* if HAVE_STDATOMIC_H */
|
|
#endif /* ifdef ISC_MUTEX_ATOMICS */
|
|
|
|
/*
|
|
* We define a few additional macros to make things easier
|
|
*/
|
|
|
|
/* Relaxed Memory Ordering */
|
|
|
|
#define atomic_store_relaxed(o, v) \
|
|
atomic_store_explicit((o), (v), memory_order_relaxed)
|
|
#define atomic_load_relaxed(o) atomic_load_explicit((o), memory_order_relaxed)
|
|
#define atomic_fetch_add_relaxed(o, v) \
|
|
atomic_fetch_add_explicit((o), (v), memory_order_relaxed)
|
|
#define atomic_fetch_sub_relaxed(o, v) \
|
|
atomic_fetch_sub_explicit((o), (v), memory_order_relaxed)
|
|
#define atomic_fetch_or_relaxed(o, v) \
|
|
atomic_fetch_or_explicit((o), (v), memory_order_relaxed)
|
|
#define atomic_fetch_and_relaxed(o, v) \
|
|
atomic_fetch_and_explicit((o), (v), memory_order_relaxed)
|
|
#define atomic_exchange_relaxed(o, v) \
|
|
atomic_exchange_explicit((o), (v), memory_order_relaxed)
|
|
#define atomic_compare_exchange_weak_relaxed(o, e, d) \
|
|
atomic_compare_exchange_weak_explicit( \
|
|
(o), (e), (d), memory_order_relaxed, memory_order_relaxed)
|
|
#define atomic_compare_exchange_strong_relaxed(o, e, d) \
|
|
atomic_compare_exchange_strong_explicit( \
|
|
(o), (e), (d), memory_order_relaxed, memory_order_relaxed)
|
|
#define atomic_compare_exchange_strong_acq_rel(o, e, d) \
|
|
atomic_compare_exchange_strong_explicit( \
|
|
(o), (e), (d), memory_order_acq_rel, memory_order_acquire)
|
|
|
|
/* Acquire-Release Memory Ordering */
|
|
|
|
#define atomic_store_release(o, v) \
|
|
atomic_store_explicit((o), (v), memory_order_release)
|
|
#define atomic_load_acquire(o) atomic_load_explicit((o), memory_order_acquire)
|
|
#define atomic_fetch_add_release(o, v) \
|
|
atomic_fetch_add_explicit((o), (v), memory_order_release)
|
|
#define atomic_fetch_sub_release(o, v) \
|
|
atomic_fetch_sub_explicit((o), (v), memory_order_release)
|
|
#define atomic_fetch_and_release(o, v) \
|
|
atomic_fetch_and_explicit((o), (v), memory_order_release)
|
|
#define atomic_fetch_or_release(o, v) \
|
|
atomic_fetch_or_explicit((o), (v), memory_order_release)
|
|
#define atomic_exchange_acq_rel(o, v) \
|
|
atomic_exchange_explicit((o), (v), memory_order_acq_rel)
|
|
#define atomic_compare_exchange_weak_acq_rel(o, e, d) \
|
|
atomic_compare_exchange_weak_explicit( \
|
|
(o), (e), (d), memory_order_acq_rel, memory_order_acquire)
|