#include <rconfc.h>
Detailed Description
Field Documentation
◆ rc_active
| struct m0_tl rc_active |
◆ rc_ast
| struct m0_sm_ast rc_ast |
◆ rc_cctx_fini_ast
| struct m0_sm_ast rc_cctx_fini_ast |
◆ rc_conductor_clink
| struct m0_clink rc_conductor_clink |
◆ rc_confc
| struct m0_confc rc_confc |
A dedicated confc instance initialised during m0_rconfc_start() in case the read lock is successfully acquired. Initially connected to a confd of the elected version, an element of m0_rconfc::rc_active list. Later, it may be reconnected on the fly to another confd server of the same version in case previous confd communication failed, or version re-election occurred.
Consumer is expected to use m0_rconfc::rc_confc instance for reading configuration data done any standard way in accordance with m0_confc specification. However, any explicit initialisation and finalisation of the instance must be avoided, as m0_rconfc is fully responsible for that part.
◆ rc_datum
| int rc_datum |
◆ rc_expired_cb
| m0_rconfc_cb_t rc_expired_cb |
Rconfc expiration callback. Installed during m0_rconfc_init(), but is allowed to be re-set later if required, on a locked rconfc instance.
The callback is executed being under rconfc lock.
Rconfc expiration callback is called when rconfc election happens. The callee side must close all configuration objects currently held and invalidate locally stored configuration data copies if any.
- Note
- No configuration reading is granted during the call because of rconfc locked state. Therefore, configuration reader should schedule reading for some time in future. The callback will also be called when reaching quorum is not possible. In this case rconfc->rc_ver == M0_CONF_VER_UNKNOWN.
◆ rc_fatal_cb
| m0_rconfc_cb_t rc_fatal_cb |
Rconfc callback called when M0_RCS_FAILURE state reached. Initially unset. Allowed to be installed after start if required, on a locked rconfc instance.
- Note
- Do not set m0_rconfc::rc_fatal_cb directly, use m0_rconfc_fatal_cb_set() instead.
Rconfc is expected to start without the callback set up. This lets us distinguish a failure during motr setup from a failure at runtime, and handle those appropriately.
- Note
- Rconfc fatal callback is called when m0_rconfc::rc_sm is switched to M0_RCS_FAILURE. This makes impossible to read configuration from m0_rconfc::rc_confc::cc_cache during the callback execution. Besides, the cache starts to be drained right before the call, so no part of the cache is guaranteed to remain available after call completion.
◆ rc_gops
| struct m0_confc_gate_ops rc_gops |
Gating operations. Intended to control m0_rconfc::rc_confc ability to perform configuration reading operations.
◆ rc_ha_entrypoint_cl
| struct m0_clink rc_ha_entrypoint_cl |
◆ rc_ha_entrypoint_rep
| struct m0_ha_entrypoint_rep rc_ha_entrypoint_rep |
◆ rc_ha_entrypoint_retries
| uint32_t rc_ha_entrypoint_retries |
◆ rc_ha_update_cl
| struct m0_clink rc_ha_update_cl |
Clink to track the finish of m0_conf_confc_ha_update_async() on phony confc.
◆ rc_herd
| struct m0_tl rc_herd |
◆ rc_herd_chan
| struct m0_chan rc_herd_chan |
◆ rc_herd_cl
| struct m0_clink rc_herd_cl |
◆ rc_herd_lock
| struct m0_mutex rc_herd_lock |
The mutex is to protect m0_rconfc::rc_herd_chan.
As well, rconfc_link::rl_fom_queued value is accessed by rconfc code strictly under the lock.
◆ rc_load_ast
| struct m0_sm_ast rc_load_ast |
◆ rc_load_fini_ast
| struct m0_sm_ast rc_load_fini_ast |
◆ rc_local_conf
| char* rc_local_conf |
Local configuration database string to be passed to rc_confc during its initialisation. Initially NULL-ed it can be set prior to running m0_rconfc_start(). Being set it indicates that rconfc is to be running mode compatible with confd, i.e. having cache pre-loaded.
- See also
- m0_rconfc_is_preloaded()
- Note
- rconfc takes care of freeing this string with m0_free() during finalisation.
◆ rc_nvec
| struct m0_ha_nvec rc_nvec |
nvec for m0_conf_confc_ha_update_async().
◆ rc_phony
| struct m0_confc rc_phony |
Confc instance artificially filled with objects having fids of current confd and top-level RM services got from HA. Artificial nature is because of filling its cache non-standard way at the time when conventional configuration reading is impossible due to required conf version number remaining unknown until election procedure is done.
This instance is added to HA clients list and serves HA notifications about remote confd and RM service deaths. The intention is to automatically keep herd list and top-level RM endpoint address up to date during the entire rconfc instance life cycle.
- Attention
- Never use this confc for real configuration reading. No RPC communication is possible with the instance due to the way of its initialisation.
◆ rc_profile
| struct m0_fid rc_profile |
◆ rc_qctx
◆ rc_quorum
| uint32_t rc_quorum |
◆ rc_quorum_decision_is_made
| bool rc_quorum_decision_is_made |
◆ rc_ready_cb
| m0_rconfc_cb_t rc_ready_cb |
Rconfc idle callback. Initially unset. Allowed to be installed later if required, on a locked rconfc instance.
The callback is executed being under rconfc lock.
Rconfc ready callback is called when m0_rconfc::rc_sm is switched to M0_RCS_IDLE state. Callback indicates that configuration is available for reading using m0_rconfc::rc_confc.
- Note
- No configuration reading is possible during the callback execution due to the locked state, and the reading should be scheduled for some time in future.
◆ rc_rlock_conflict
| bool rc_rlock_conflict |
◆ rc_rlock_ctx
◆ rc_rmach
| struct m0_rpc_machine* rc_rmach |
◆ rc_rx
| struct rconfc_load_ctx rc_rx |
◆ rc_sm
| struct m0_sm rc_sm |
Rconfc state machine.
- Note
- rc_ha_update_cl links to the rc_sm.sm_chan which is used as argument for the m0_conf_confc_ha_update_async() call. It is convenient as we don't need additional channel and mutex structures just to get the notification about confc_ha_update completion. The drawback of this approach is that the threads waiting for the SM state change (like at m0_rconfc_start_wait()) will be awaken needlessly. But this seems to be harmless.
◆ rc_sm_state_on_abort
| uint32_t rc_sm_state_on_abort |
The state, which m0_rconfc::rc_sm was in prior to entering M0_RCS_FAILURE state. Rconfc start may fail due to external causes unrelated to rconfc internal workings, e.g. start timeout expired.
◆ rc_stop_ast
| struct m0_sm_ast rc_stop_ast |
◆ rc_stopping
| bool rc_stopping |
◆ rc_unpinned_cl
| struct m0_clink rc_unpinned_cl |
◆ rc_ver
| uint64_t rc_ver |
The documentation for this struct was generated from the following file:
- conf/rconfc.h
