[v2,56/60] service: Leverage 'OnlineCheckMode' setting.

Message ID	20231221064007.2347566-57-gerickson@nuovations.com (mailing list archive)
State	Superseded
Headers	show Received: from mohas.pair.com (mohas.pair.com [209.68.5.112]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 6C36CBE4D for <connman@lists.linux.dev>; Thu, 21 Dec 2023 06:40:31 +0000 (UTC) From: Grant Erickson <gerickson@nuovations.com> To: connman@lists.linux.dev Subject: [PATCH v2 56/60] service: Leverage 'OnlineCheckMode' setting. Date: Wed, 20 Dec 2023 22:40:00 -0800 Message-ID: <20231221064007.2347566-57-gerickson@nuovations.com> In-Reply-To: <20231221064007.2347566-1-gerickson@nuovations.com> References: <20231221064007.2347566-1-gerickson@nuovations.com> Precedence: bulk MIME-Version: 1.0 Content-Transfer-Encoding: 8bit
Series	Complete 'continuous' Online Check Mode Implementation. \| expand [00/60] Complete 'continuous' Online Check Mode Implementation. [v2,01/60] service: Change return type of '__connman_service_wispr_start'. [v2,02/60] service: Sanity check the 'type' param in '__connman_service_wispr_start'. [v2,03/60] service: Rename 'online_check_enabled_check'. [v2,04/60] service: Change return type of 'start_online_check'. [v2,05/60] service: Change return type of 'start_wispr_if_connected'. [v2,06/60] service: Introduce and use online check 'active' state. [v2,07/60] service: Document 'online_check_state' 'active' member. [v2,08/60] service: Document 'online_check_is_active'. [v2,09/60] service: Document 'online_check_active_set_value'. [v2,10/60] service: Document 'online_check_active_{clear,set}'. [v2,11/60] service: Rename 'start_wispr_if_connected'. [v2,12/60] service: Refactor 'start_online_check_if_connected'. [v2,13/60] service: Document 'start_online_check_if_connected_with_type'. [v2,14/60] service: Add an explicit conditional for IPv6 in 'reschedule_online_check'. [v2,15/60] session: Add service identifier to 'DBG' in four functions. [v2,16/60] service: Add online check failure service error enumeration and string. [v2,17/60] doc/service: Document online check failure service error. [v2,18/60] service: Introduce and use online check 'failures/successes' state. [v2,19/60] service: Document 'online_check_state' 'failures/successes' members. [v2,20/60] main: Introduce the 'OnlineCheck{Failures,Successes}Threshold' settings. [v2,21/60] doc: Document the 'OnlineCheck{Failures,Successes}Threshold' settings. [v2,22/60] service: Add per-service online check failure threshold state. [v2,23/60] service: Document 'connman_service' 'online_check_failures_met_threshold' member. [v2,24/60] service: Document 'connman_service' 'online_check_state_ipv{4,6}' members. [v2,25/60] service: Move 'set_error' forward declaration earlier in the source. [v2,26/60] service: Capture IP configuration state by value rather than by pointer. [v2,27/60] service: Complete 'continuous' online check mode implementation. [v2,28/60] service: Document 'online_check_failures_threshold_was_met'. [v2,29/60] service: Document 'online_check_failures_threshold_was_met_set_value'. [v2,30/60] service: Document 'online_check_failures_threshold_was_met_{set,clear}'. [v2,31/60] service: Document 'online_check_counter_reset'. [v2,32/60] service: Document 'online_check_{failures,successes}_reset'. [v2,33/60] service: Document 'online_check_state_reset'. [v2,34/60] service: Document 'online_check_counters_log'. [v2,35/60] service: Document 'online_check_counter_threshold_is_met'. [v2,36/60] service: Document 'is_online_check_failure_threshold_met_predicate'. [v2,37/60] service: Document 'online_check_failures_threshold_is_met'. [v2,38/60] service: Document 'is_online_check_success_threshold_met_predicate'. [v2,39/60] service: Document 'online_check_successes_threshold_is_met'. [v2,40/60] service: Document 'online_check_counter_increment_and_log'. [v2,41/60] service: Document 'online_check_log_success'. [v2,42/60] service: Document 'continuous_online_check_log_{counter,failures,successes}_threshold_me… [v2,43/60] service: Document 'handle_{continuous,oneshot}_online_check_success'. [v2,44/60] service: Document 'online_check_log_failure'. [v2,45/60] service: Document 'handle_{continuous,oneshot}_online_check_failure'. [v2,46/60] service: Add @sa documentation references. [v2,47/60] service: Document the internals of 'service_compare'. [v2,48/60] service: Document interval assignment in '__connman_service_wispr_start'. [v2,49/60] service: Document 'downgrade_connected_services'. [v2,50/60] service: Document 'service_schedule_changed'. [v2,51/60] service: Document 'service_route_changed'. [v2,52/60] service: Add function parameter to 'default_changed' and 'service_list_sort'. [v2,53/60] service: Add @sa documentation reference to 'current_default'. [v2,54/60] service: Add 'DBG' to 'downgrade_connected_services'. [v2,55/60] main/service: Introduce 'OnlineCheckMode' setting. [v2,56/60] service: Leverage 'OnlineCheckMode' setting. [v2,57/60] doc: Document the 'OnlineCheckMode' setting. [v2,58/60] main: Add comments tags for online check-related settings. [v2,59/60] main: Consolidate logging of online check-related settings. [v2,60/60] main: Add deprecation warnings for 'EnableOnlineCheck' and 'EnableOnlineToReadyTransitio…

diff --git a/src/connman.h b/src/connman.h index 28280a55b0ec..b33704d31bc4 100644 --- a/src/connman.h +++ b/src/connman.h @@ -807,8 +807,15 @@ enum service_online_check_mode { CONNMAN_SERVICE_ONLINE_CHECK_MODE_CONTINUOUS = 3 }; +const char *__connman_service_online_check_mode2string( + enum service_online_check_mode mode); enum service_online_check_mode __connman_service_online_check_string2mode( const char *mode); +enum service_online_check_mode __connman_service_get_online_check_mode(void); +bool __connman_service_is_online_check_enabled(void); +bool __connman_service_is_online_check_mode( + enum service_online_check_mode mode); + int __connman_service_nameserver_append(struct connman_service *service, const char *nameserver, bool is_auto); int __connman_service_nameserver_remove(struct connman_service *service, diff --git a/src/service.c b/src/service.c index c427fc441193..99b322a91684 100644 --- a/src/service.c +++ b/src/service.c @@ -83,7 +83,6 @@ static unsigned int vpn_autoconnect_id = 0; */ static struct connman_service *current_default = NULL; static bool services_dirty = false; -static bool enable_online_to_ready_transition = false; static unsigned int online_check_connect_timeout_ms = 0; static unsigned int online_check_initial_interval = 0; static unsigned int online_check_max_interval = 0; @@ -1749,6 +1748,25 @@ static bool check_proxy_setup(struct connman_service *service) return false; } +const char *__connman_service_online_check_mode2string( + enum service_online_check_mode mode) +{ + switch (mode) { + case CONNMAN_SERVICE_ONLINE_CHECK_MODE_UNKNOWN: + break; + case CONNMAN_SERVICE_ONLINE_CHECK_MODE_NONE: + return "none"; + case CONNMAN_SERVICE_ONLINE_CHECK_MODE_ONE_SHOT: + return "one-shot"; + case CONNMAN_SERVICE_ONLINE_CHECK_MODE_CONTINUOUS: + return "continuous"; + default: + break; + } + + return NULL; +} + enum service_online_check_mode __connman_service_online_check_string2mode( const char *mode) { @@ -1765,6 +1783,61 @@ enum service_online_check_mode __connman_service_online_check_string2mode( return CONNMAN_SERVICE_ONLINE_CHECK_MODE_UNKNOWN; } +/** + * @brief + * Return the "online" HTTP-based Internet reachability check mode. + * + * @returns + * The "online" HTTP-based Internet reachability check mode. + * + */ +enum service_online_check_mode __connman_service_get_online_check_mode(void) +{ + return connman_setting_get_uint("OnlineCheckMode"); +} + +/** + * @brief + * Return whether the "online" HTTP-based Internet reachability + * checks are enabled. + * + * @returns + * True if "online" HTTP-based Internet reachability checks are + * enabled; otherwise, false. + * + * @sa __connman_service_get_online_check_mode + * + */ +bool __connman_service_is_online_check_enabled(void) +{ + const enum service_online_check_mode mode = + __connman_service_get_online_check_mode(); + + return mode != CONNMAN_SERVICE_ONLINE_CHECK_MODE_UNKNOWN && + mode != CONNMAN_SERVICE_ONLINE_CHECK_MODE_NONE; +} + +/** + * @brief + * Determines whether the "online" HTTP-based Internet reachability + * check mode is the specified mode. + * + * @param[in] mode The "online" HTTP-based Internet reachability + * check mode to confirm. + * + * @returns + * True if the current "online" HTTP-based Internet reachability + * check mode is @a mode; otherwise, false. + * + * @sa __connman_service_get_online_check_mode + * + */ +bool __connman_service_is_online_check_mode( + enum service_online_check_mode mode) +{ + return __connman_service_get_online_check_mode() == mode; +} + /** * @brief * Determine whether an "online" HTTP-based Internet reachability @@ -2122,7 +2195,7 @@ static void cancel_online_check(struct connman_service *service, static bool online_check_is_enabled_check( const struct connman_service *service) { - if (!connman_setting_get_bool("EnableOnlineCheck")) { + if (!__connman_service_is_online_check_enabled()) { connman_info("Online check disabled. " "Default service remains in READY state."); return false; @@ -2142,7 +2215,7 @@ static bool online_check_is_enabled_check( * * @note * Any check is skipped, with an informational log message, if @a - * EnableOnlineCheck is not asserted. + * OnlineCheckMode is "none". * * @param[in,out] service A pointer to the mutable network service * for which to start the "online" @@ -3614,22 +3687,22 @@ done: * configuration type. This effectively "bookends" an earlier * #__connman_service_wispr_start. * - * If "EnableOnlineToReadyTransition" is deasserted and if @a success - * is asserted, then the state for the specified IP configuration - * type is transitioned to "online" and a future online check is + * If "OnlineCheckMode" is "one-shot" and if @a success is asserted, + * then the state for the specified IP configuration type is + * transitioned to "online" and a future online check is scheduled + * based on the current interval and the "OnlineCheckIntervalStyle" + * setting. + * + * Otherwise, if "OnlineCheckMode" is "continuous", then counters are + * managed for the success or failure and state is managed and + * tracked resulting in the potential demotion of the service, + * placing it into a temporary failure state until such time as a + * series of back-to-back online checks successfully complete. If the + * service is a non-default after demotion and it is in failure state + * or if it is the default service, then a future online check is * scheduled based on the current interval and the * "OnlineCheckIntervalStyle" setting. * - * Otherwise, if "EnableOnlineToReadyTransition" is asserted, then - * counters are managed for the success or failure and state is - * managed and tracked resulting in the potential demotion of the - * service, placing it into a temporary failure state until such time - * as a series of back-to-back online checks successfully - * complete. If the service is a non-default after demotion and it is - * in failure state or if it is the default service, then a future - * online check is scheduled based on the current interval and the - * "OnlineCheckIntervalStyle" setting. - * * @param[in,out] service A pointer to the mutable service for which * to complete a previously-requested online * check. @@ -3658,6 +3731,8 @@ static void complete_online_check(struct connman_service *service, bool success, int err) { + const bool oneshot = __connman_service_is_online_check_mode( + CONNMAN_SERVICE_ONLINE_CHECK_MODE_ONE_SHOT); struct online_check_state *online_check_state; enum connman_service_state ipconfig_state; bool reschedule = false; @@ -3682,13 +3757,13 @@ static void complete_online_check(struct connman_service *service, reschedule = handle_online_check_success(service, type, online_check_state, - !enable_online_to_ready_transition); + oneshot); else reschedule = handle_online_check_failure(service, type, ipconfig_state, online_check_state, - !enable_online_to_ready_transition, + oneshot, err); DBG("reschedule online check %u", reschedule); @@ -10689,8 +10764,6 @@ int __connman_service_init(void) remove_unprovisioned_services(); - enable_online_to_ready_transition = - connman_setting_get_bool("EnableOnlineToReadyTransition"); online_check_timeout_interval_style = connman_setting_get_string("OnlineCheckIntervalStyle"); if (g_strcmp0(online_check_timeout_interval_style, "fibonacci") == 0)

[v2,56/60] service: Leverage 'OnlineCheckMode' setting.

Commit Message

Patch