123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239 |
- // Copyright (c) 2017 The Chromium Authors. All rights reserved.
- // Use of this source code is governed by a BSD-style license that can be
- // found in the LICENSE file.
- #ifndef NET_HTTP_BROKEN_ALTERNATIVE_SERVICES_H_
- #define NET_HTTP_BROKEN_ALTERNATIVE_SERVICES_H_
- #include <list>
- #include <set>
- #include "base/containers/lru_cache.h"
- #include "base/memory/raw_ptr.h"
- #include "base/memory/weak_ptr.h"
- #include "base/time/time.h"
- #include "base/timer/timer.h"
- #include "net/base/network_isolation_key.h"
- #include "net/http/alternative_service.h"
- namespace base {
- class TickClock;
- }
- namespace net {
- // Contains information about a broken alternative service, and the context in
- // which it's known to be broken.
- struct NET_EXPORT_PRIVATE BrokenAlternativeService {
- // If |use_network_isolation_key| is false, |network_isolation_key| is
- // ignored, and an empty NetworkIsolationKey is used instead.
- BrokenAlternativeService(const AlternativeService& alternative_service,
- const NetworkIsolationKey& network_isolation_key,
- bool use_network_isolation_key);
- ~BrokenAlternativeService();
- bool operator<(const BrokenAlternativeService& other) const;
- AlternativeService alternative_service;
- // The context in which the alternative service is known to be broken in. Used
- // to avoid cross-NetworkIsolationKey communication.
- NetworkIsolationKey network_isolation_key;
- };
- // Stores broken alternative services and when their brokenness expires.
- typedef std::list<std::pair<BrokenAlternativeService, base::TimeTicks>>
- BrokenAlternativeServiceList;
- // Stores how many times an alternative service has been marked broken.
- class RecentlyBrokenAlternativeServices
- : public base::LRUCache<BrokenAlternativeService, int> {
- public:
- explicit RecentlyBrokenAlternativeServices(
- int max_recently_broken_alternative_service_entries)
- : base::LRUCache<BrokenAlternativeService, int>(
- max_recently_broken_alternative_service_entries) {}
- };
- // This class tracks HTTP alternative services that have been marked as broken.
- // The brokenness of an alt-svc will expire after some time according to an
- // exponential back-off formula: each time an alt-svc is marked broken, the
- // expiration delay will be some constant multiple of its previous expiration
- // delay. This prevents broken alt-svcs from being retried too often by the
- // network stack.
- //
- // Intended solely for use by HttpServerProperties.
- class NET_EXPORT_PRIVATE BrokenAlternativeServices {
- public:
- // Delegate to be used by owner so it can be notified when the brokenness of
- // an AlternativeService expires.
- class NET_EXPORT Delegate {
- public:
- // Called when a broken alternative service's expiration time is reached.
- virtual void OnExpireBrokenAlternativeService(
- const AlternativeService& expired_alternative_service,
- const NetworkIsolationKey& network_isolation_key) = 0;
- virtual ~Delegate() = default;
- };
- // |delegate| will be notified when a broken alternative service expires. It
- // must not be null.
- // |clock| is used for setting expiration times and scheduling the
- // expiration of broken alternative services. It must not be null.
- // |delegate| and |clock| are both unowned and must outlive this.
- BrokenAlternativeServices(int max_recently_broken_alternative_service_entries,
- Delegate* delegate,
- const base::TickClock* clock);
- BrokenAlternativeServices(const BrokenAlternativeServices&) = delete;
- void operator=(const BrokenAlternativeServices&) = delete;
- ~BrokenAlternativeServices();
- // Clears all broken and recently-broken alternative services (i.e. mark all
- // as not broken nor recently-broken).
- void Clear();
- // Marks |broken_alternative_service| as broken until an expiration delay
- // (determined by how many consecutive times it's been marked broken before).
- // After the delay, it will be in the recently broken state. However, when the
- // default network changes, the service will immediately be in the working
- // state.
- void MarkBrokenUntilDefaultNetworkChanges(
- const BrokenAlternativeService& broken_alternative_service);
- // Marks |broken_alternative_service| as broken until an expiration delay
- // (determined by how many consecutive times it's been marked broken before).
- // After the delay, it will be in the recently broken state. When the default
- // network changes, the brokenness state of this service remains unchanged.
- void MarkBroken(const BrokenAlternativeService& broken_alternative_service);
- // Marks |broken_alternative_service| as recently broken. Being recently
- // broken will cause WasAlternativeServiceRecentlyBroken(alternative_service,
- // network_isolation_key) to return true until Confirm(alternative_service,
- // network_isolation_key) is called.
- void MarkRecentlyBroken(
- const BrokenAlternativeService& broken_alternative_service);
- // Returns true if the alternative service is considered broken.
- bool IsBroken(
- const BrokenAlternativeService& broken_alternative_service) const;
- // If the alternative service is considered broken, returns true and sets
- // |brokenness_expiration| to the expiration time for that service.
- // Returns false otherwise.
- bool IsBroken(const BrokenAlternativeService& broken_alternative_service,
- base::TimeTicks* brokenness_expiration) const;
- // Returns true if MarkRecentlyBroken(alternative_service)
- // or MarkBroken(alternative_service) has been called and
- // Confirm(alternative_service) has not been called
- // afterwards (even if brokenness of |alternative_service| has expired).
- bool WasRecentlyBroken(
- const BrokenAlternativeService& broken_alternative_service);
- // Changes the alternative service to be considered as working.
- void Confirm(const BrokenAlternativeService& broken_alternative_service);
- // Clears all alternative services which were marked as broken until the
- // default network changed, those services will now be considered working.
- // Returns true if there was any broken alternative service affected by this
- // network change.
- bool OnDefaultNetworkChanged();
- // Sets broken and recently broken alternative services.
- // |broken_alternative_service_list|, |recently_broken_alternative_services|
- // must not be nullptr.
- //
- // If a broken/recently-broken alt svc that's being added is already stored,
- // the stored expiration/broken-count for that alt svc will be overwritten
- // with the new value.
- void SetBrokenAndRecentlyBrokenAlternativeServices(
- std::unique_ptr<BrokenAlternativeServiceList>
- broken_alternative_service_list,
- std::unique_ptr<RecentlyBrokenAlternativeServices>
- recently_broken_alternative_services);
- // If values are present, sets initial_delay_ and
- // exponential_backoff_on_initial_delay_ which are used to calculate delay of
- // broken alternative services.
- void SetDelayParams(
- absl::optional<base::TimeDelta> initial_delay,
- absl::optional<bool> exponential_backoff_on_initial_delay);
- const BrokenAlternativeServiceList& broken_alternative_service_list() const;
- const RecentlyBrokenAlternativeServices&
- recently_broken_alternative_services() const;
- private:
- // TODO (wangyix): modify HttpServerProperties unit tests so this friendness
- // is no longer required.
- friend class HttpServerPropertiesPeer;
- struct AlternativeServiceHash {
- size_t operator()(const net::AlternativeService& entry) const {
- return entry.protocol ^ std::hash<std::string>()(entry.host) ^ entry.port;
- }
- };
- typedef std::map<BrokenAlternativeService,
- BrokenAlternativeServiceList::iterator>
- BrokenMap;
- // Helper method that marks |broken_alternative_service| as broken until
- // an expiration delay (determined by how many consecutive times it's been
- // marked broken before). After the delay, it will be in the recently broken
- // state.
- void MarkBrokenImpl(
- const BrokenAlternativeService& broken_alternative_service);
- // Inserts |broken_alternative_service| and its |expiration| time into
- // |broken_alternative_service_list_| and |broken_alternative_service_map_|.
- // |it| is the position in |broken_alternative_service_list_| where it was
- // inserted.
- bool AddToBrokenListAndMap(
- const BrokenAlternativeService& broken_alternative_service,
- base::TimeTicks expiration,
- BrokenAlternativeServiceList::iterator* it);
- void ExpireBrokenAlternateProtocolMappings();
- void ScheduleBrokenAlternateProtocolMappingsExpiration();
- raw_ptr<Delegate> delegate_; // Unowned
- raw_ptr<const base::TickClock> clock_; // Unowned
- // List of <broken alt svc, expiration time> pairs sorted by expiration time.
- BrokenAlternativeServiceList broken_alternative_service_list_;
- // A map from broken alt-svcs to their iterator pointing to that alt-svc's
- // position in |broken_alternative_service_list_|.
- BrokenMap broken_alternative_service_map_;
- // A set of broken alternative services on the current default
- // network. This will be cleared every time the default network changes.
- std::set<BrokenAlternativeService>
- broken_alternative_services_on_default_network_;
- // Maps broken alternative services to how many times they've been marked
- // broken.
- RecentlyBrokenAlternativeServices recently_broken_alternative_services_;
- // Used for scheduling the task that expires the brokenness of alternative
- // services.
- base::OneShotTimer expiration_timer_;
- // Delay for the 1st time alternative service is marked broken.
- base::TimeDelta initial_delay_;
- // If true, the delay for broken alternative service =
- // initial_delay_for_broken_alternative_service * (1 << broken_count).
- // Otherwise, the delay would be initial_delay_for_broken_alternative_service,
- // 5min, 10min.. and so on.
- bool exponential_backoff_on_initial_delay_ = true;
- base::WeakPtrFactory<BrokenAlternativeServices> weak_ptr_factory_{this};
- };
- } // namespace net
- #endif // NET_HTTP_BROKEN_ALTERNATIVE_SERVICES_H_
|