sphinx.addnodesdocument)}( rawsourcechildren]( translations LanguagesNode)}(hhh](h pending_xref)}(hhh]docutils.nodesTextChinese (Simplified)}parenthsba attributes}(ids]classes]names]dupnames]backrefs] refdomainstdreftypedoc reftarget6/translations/zh_CN/arch/arm/cluster-pm-race-avoidancemodnameN classnameN refexplicitutagnamehhh ubh)}(hhh]hChinese (Traditional)}hh2sbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget6/translations/zh_TW/arch/arm/cluster-pm-race-avoidancemodnameN classnameN refexplicituh1hhh ubh)}(hhh]hItalian}hhFsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget6/translations/it_IT/arch/arm/cluster-pm-race-avoidancemodnameN classnameN refexplicituh1hhh ubh)}(hhh]hJapanese}hhZsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget6/translations/ja_JP/arch/arm/cluster-pm-race-avoidancemodnameN classnameN refexplicituh1hhh ubh)}(hhh]hKorean}hhnsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget6/translations/ko_KR/arch/arm/cluster-pm-race-avoidancemodnameN classnameN refexplicituh1hhh ubh)}(hhh]hSpanish}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget6/translations/sp_SP/arch/arm/cluster-pm-race-avoidancemodnameN classnameN refexplicituh1hhh ubeh}(h]h ]h"]h$]h&]current_languageEnglishuh1h hh _documenthsourceNlineNubhsection)}(hhh](htitle)}(h9Cluster-wide Power-up/power-down race avoidance algorithmh]h9Cluster-wide Power-up/power-down race avoidance algorithm}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhhhP/var/lib/git/docbuild/linux/Documentation/arch/arm/cluster-pm-race-avoidance.rsthKubh paragraph)}(hThis file documents the algorithm which is used to coordinate CPU and cluster setup and teardown operations and to manage hardware coherency controls safely.h]hThis file documents the algorithm which is used to coordinate CPU and cluster setup and teardown operations and to manage hardware coherency controls safely.}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhhhhubh)}(hThe section "Rationale" explains what the algorithm is for and why it is needed. "Basic model" explains general concepts using a simplified view of the system. The other sections explain the actual details of the algorithm in use.h]hThe section “Rationale” explains what the algorithm is for and why it is needed. “Basic model” explains general concepts using a simplified view of the system. The other sections explain the actual details of the algorithm in use.}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK hhhhubh)}(hhh](h)}(h Rationaleh]h Rationale}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhhhhhKubh)}(hIn a system containing multiple CPUs, it is desirable to have the ability to turn off individual CPUs when the system is idle, reducing power consumption and thermal dissipation.h]hIn a system containing multiple CPUs, it is desirable to have the ability to turn off individual CPUs when the system is idle, reducing power consumption and thermal dissipation.}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhhhhubh)}(hwIn a system containing multiple clusters of CPUs, it is also desirable to have the ability to turn off entire clusters.h]hwIn a system containing multiple clusters of CPUs, it is also desirable to have the ability to turn off entire clusters.}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhhhhubh)}(hXaTurning entire clusters off and on is a risky business, because it involves performing potentially destructive operations affecting a group of independently running CPUs, while the OS continues to run. This means that we need some coordination in order to ensure that critical cluster-level operations are only performed when it is truly safe to do so.h]hXaTurning entire clusters off and on is a risky business, because it involves performing potentially destructive operations affecting a group of independently running CPUs, while the OS continues to run. This means that we need some coordination in order to ensure that critical cluster-level operations are only performed when it is truly safe to do so.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhhhhubh)}(hXSimple locking may not be sufficient to solve this problem, because mechanisms like Linux spinlocks may rely on coherency mechanisms which are not immediately enabled when a cluster powers up. Since enabling or disabling those mechanisms may itself be a non-atomic operation (such as writing some hardware registers and invalidating large caches), other methods of coordination are required in order to guarantee safe power-down and power-up at the cluster level.h]hXSimple locking may not be sufficient to solve this problem, because mechanisms like Linux spinlocks may rely on coherency mechanisms which are not immediately enabled when a cluster powers up. Since enabling or disabling those mechanisms may itself be a non-atomic operation (such as writing some hardware registers and invalidating large caches), other methods of coordination are required in order to guarantee safe power-down and power-up at the cluster level.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK hhhhubh)}(hThe mechanism presented in this document describes a coherent memory based protocol for performing the needed coordination. It aims to be as lightweight as possible, while providing the required safety properties.h]hThe mechanism presented in this document describes a coherent memory based protocol for performing the needed coordination. It aims to be as lightweight as possible, while providing the required safety properties.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK(hhhhubeh}(h] rationaleah ]h"] rationaleah$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(h Basic modelh]h Basic model}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj4hhhhhK.ubh)}(h5Each cluster and CPU is assigned a state, as follows:h]h5Each cluster and CPU is assigned a state, as follows:}(hjEhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK0hj4hhubh block_quote)}(h%- DOWN - COMING_UP - UP - GOING_DOWN h]h bullet_list)}(hhh](h list_item)}(hDOWNh]h)}(hjbh]hDOWN}(hjdhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK2hj`ubah}(h]h ]h"]h$]h&]uh1j^hj[ubj_)}(h COMING_UPh]h)}(hjyh]h COMING_UP}(hj{hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK3hjwubah}(h]h ]h"]h$]h&]uh1j^hj[ubj_)}(hUPh]h)}(hjh]hUP}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK4hjubah}(h]h ]h"]h$]h&]uh1j^hj[ubj_)}(h GOING_DOWN h]h)}(h GOING_DOWNh]h GOING_DOWN}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK5hjubah}(h]h ]h"]h$]h&]uh1j^hj[ubeh}(h]h ]h"]h$]h&]bullet-uh1jYhhhK2hjUubah}(h]h ]h"]h$]h&]uh1jShhhK2hj4hhubh literal_block)}(h +---------> UP ----------+ | v COMING_UP GOING_DOWN ^ | +--------- DOWN <--------+h]h +---------> UP ----------+ | v COMING_UP GOING_DOWN ^ | +--------- DOWN <--------+}hjsbah}(h]h ]h"]h$]h&] xml:spacepreserveuh1jhhhK9hj4hhubhdefinition_list)}(hhh](hdefinition_list_item)}(h~DOWN: The CPU or cluster is not coherent, and is either powered off or suspended, or is ready to be powered off or suspended. h](hterm)}(hDOWN:h]hDOWN:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKDhjubh definition)}(hhh]h)}(hwThe CPU or cluster is not coherent, and is either powered off or suspended, or is ready to be powered off or suspended.h]hwThe CPU or cluster is not coherent, and is either powered off or suspended, or is ready to be powered off or suspended.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKChjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhhhKDhjubj)}(hCOMING_UP: The CPU or cluster has committed to moving to the UP state. It may be part way through the process of initialisation and enabling coherency. h](j)}(h COMING_UP:h]h COMING_UP:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKIhjubj)}(hhh]h)}(hThe CPU or cluster has committed to moving to the UP state. It may be part way through the process of initialisation and enabling coherency.h]hThe CPU or cluster has committed to moving to the UP state. It may be part way through the process of initialisation and enabling coherency.}(hj,hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKGhj)ubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhhhKIhjhhubj)}(hUP: The CPU or cluster is active and coherent at the hardware level. A CPU in this state is not necessarily being used actively by the kernel. h](j)}(hUP:h]hUP:}(hjJhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKNhjFubj)}(hhh]h)}(hThe CPU or cluster is active and coherent at the hardware level. A CPU in this state is not necessarily being used actively by the kernel.h]hThe CPU or cluster is active and coherent at the hardware level. A CPU in this state is not necessarily being used actively by the kernel.}(hj[hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKLhjXubah}(h]h ]h"]h$]h&]uh1jhjFubeh}(h]h ]h"]h$]h&]uh1jhhhKNhjhhubj)}(hGOING_DOWN: The CPU or cluster has committed to moving to the DOWN state. It may be part way through the process of teardown and coherency exit. h](j)}(h GOING_DOWN:h]h GOING_DOWN:}(hjyhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKThjuubj)}(hhh]h)}(hThe CPU or cluster has committed to moving to the DOWN state. It may be part way through the process of teardown and coherency exit.h]hThe CPU or cluster has committed to moving to the DOWN state. It may be part way through the process of teardown and coherency exit.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKQhjubah}(h]h ]h"]h$]h&]uh1jhjuubeh}(h]h ]h"]h$]h&]uh1jhhhKThjhhubeh}(h]h ]h"]h$]h&]uh1jhj4hhhhhNubh)}(hEach CPU has one of these states assigned to it at any point in time. The CPU states are described in the "CPU state" section, below.h]hEach CPU has one of these states assigned to it at any point in time. The CPU states are described in the “CPU state” section, below.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKVhj4hhubh)}(hXZEach cluster is also assigned a state, but it is necessary to split the state value into two parts (the "cluster" state and "inbound" state) and to introduce additional states in order to avoid races between different CPUs in the cluster simultaneously modifying the state. The cluster- level states are described in the "Cluster state" section.h]hXfEach cluster is also assigned a state, but it is necessary to split the state value into two parts (the “cluster” state and “inbound” state) and to introduce additional states in order to avoid races between different CPUs in the cluster simultaneously modifying the state. The cluster- level states are described in the “Cluster state” section.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKYhj4hhubh)}(hTo help distinguish the CPU states from cluster states in this discussion, the state names are given a `CPU_` prefix for the CPU states, and a `CLUSTER_` or `INBOUND_` prefix for the cluster states.h](hgTo help distinguish the CPU states from cluster states in this discussion, the state names are given a }(hjhhhNhNubhtitle_reference)}(h`CPU_`h]hCPU_}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh" prefix for the CPU states, and a }(hjhhhNhNubj)}(h `CLUSTER_`h]hCLUSTER_}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh or }(hjhhhNhNubj)}(h `INBOUND_`h]hINBOUND_}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh prefix for the cluster states.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhK_hj4hhubeh}(h] basic-modelah ]h"] basic modelah$]h&]uh1hhhhhhhhK.ubh)}(hhh](h)}(h CPU stateh]h CPU state}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhKeubh)}(hIn this algorithm, each individual core in a multi-core processor is referred to as a "CPU". CPUs are assumed to be single-threaded: therefore, a CPU can only be doing one thing at a single point in time.h]hIn this algorithm, each individual core in a multi-core processor is referred to as a “CPU”. CPUs are assumed to be single-threaded: therefore, a CPU can only be doing one thing at a single point in time.}(hj%hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKghjhhubh)}(h1This means that CPUs fit the basic model closely.h]h1This means that CPUs fit the basic model closely.}(hj3hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKkhjhhubh)}(hFThe algorithm defines the following states for each CPU in the system:h]hFThe algorithm defines the following states for each CPU in the system:}(hjAhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKmhjhhubjT)}(h5- CPU_DOWN - CPU_COMING_UP - CPU_UP - CPU_GOING_DOWN h]jZ)}(hhh](j_)}(hCPU_DOWNh]h)}(hjXh]hCPU_DOWN}(hjZhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKohjVubah}(h]h ]h"]h$]h&]uh1j^hjSubj_)}(h CPU_COMING_UPh]h)}(hjoh]h CPU_COMING_UP}(hjqhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKphjmubah}(h]h ]h"]h$]h&]uh1j^hjSubj_)}(hCPU_UPh]h)}(hjh]hCPU_UP}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKqhjubah}(h]h ]h"]h$]h&]uh1j^hjSubj_)}(hCPU_GOING_DOWN h]h)}(hCPU_GOING_DOWNh]hCPU_GOING_DOWN}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKrhjubah}(h]h ]h"]h$]h&]uh1j^hjSubeh}(h]h ]h"]h$]h&]jjuh1jYhhhKohjOubah}(h]h ]h"]h$]h&]uh1jShhhKohjhhubj)}(hXV cluster setup and CPU setup complete policy decision +-----------> CPU_UP ------------+ | v CPU_COMING_UP CPU_GOING_DOWN ^ | +----------- CPU_DOWN <----------+ policy decision CPU teardown complete or hardware eventh]hXV cluster setup and CPU setup complete policy decision +-----------> CPU_UP ------------+ | v CPU_COMING_UP CPU_GOING_DOWN ^ | +----------- CPU_DOWN <----------+ policy decision CPU teardown complete or hardware event}hjsbah}(h]h ]h"]h$]h&]jjuh1jhhhKvhjhhubh)}(hWThe definitions of the four states correspond closely to the states of the basic model.h]hWThe definitions of the four states correspond closely to the states of the basic model.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubh)}(h,Transitions between states occur as follows.h]h,Transitions between states occur as follows.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubh)}(hA trigger event (spontaneous) means that the CPU can transition to the next state as a result of making local progress only, with no requirement for any external event to happen.h]hA trigger event (spontaneous) means that the CPU can transition to the next state as a result of making local progress only, with no requirement for any external event to happen.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubj)}(hhh](j)}(hXCPU_DOWN: A CPU reaches the CPU_DOWN state when it is ready for power-down. On reaching this state, the CPU will typically power itself down or suspend itself, via a WFI instruction or a firmware call. Next state: CPU_COMING_UP Conditions: none Trigger events: a) an explicit hardware power-up operation, resulting from a policy decision on another CPU; b) a hardware event, such as an interrupt. h](j)}(h CPU_DOWN:h]h CPU_DOWN:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKhjubj)}(hhh](h)}(hA CPU reaches the CPU_DOWN state when it is ready for power-down. On reaching this state, the CPU will typically power itself down or suspend itself, via a WFI instruction or a firmware call.h]hA CPU reaches the CPU_DOWN state when it is ready for power-down. On reaching this state, the CPU will typically power itself down or suspend itself, via a WFI instruction or a firmware call.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubj)}(hhh](j)}(hNext state: CPU_COMING_UPh](j)}(h Next state:h]h Next state:}(hj$hhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKhj ubj)}(hhh]h)}(h CPU_COMING_UPh]h CPU_COMING_UP}(hj5hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj2ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhhhKhjubj)}(hConditions: none h](j)}(h Conditions:h]h Conditions:}(hjShhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKhjOubj)}(hhh]h)}(hnoneh]hnone}(hjdhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjaubah}(h]h ]h"]h$]h&]uh1jhjOubeh}(h]h ]h"]h$]h&]uh1jhhhKhjubj)}(hTrigger events: a) an explicit hardware power-up operation, resulting from a policy decision on another CPU; b) a hardware event, such as an interrupt. h](j)}(hTrigger events:h]hTrigger events:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKhj~ubj)}(hhh]henumerated_list)}(hhh](j_)}(hZan explicit hardware power-up operation, resulting from a policy decision on another CPU; h]h)}(hYan explicit hardware power-up operation, resulting from a policy decision on another CPU;h]hYan explicit hardware power-up operation, resulting from a policy decision on another CPU;}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1j^hjubj_)}(h)a hardware event, such as an interrupt. h]h)}(h'a hardware event, such as an interrupt.h]h'a hardware event, such as an interrupt.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1j^hjubeh}(h]h ]h"]h$]h&]enumtype loweralphaprefixhsuffix)uh1jhjubah}(h]h ]h"]h$]h&]uh1jhj~ubeh}(h]h ]h"]h$]h&]uh1jhhhKhjubeh}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhhhKhjubj)}(hXCPU_COMING_UP: A CPU cannot start participating in hardware coherency until the cluster is set up and coherent. If the cluster is not ready, then the CPU will wait in the CPU_COMING_UP state until the cluster has been set up. Next state: CPU_UP Conditions: The CPU's parent cluster must be in CLUSTER_UP. Trigger events: Transition of the parent cluster to CLUSTER_UP. Refer to the "Cluster state" section for a description of the CLUSTER_UP state. h](j)}(hCPU_COMING_UP:h]hCPU_COMING_UP:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKhjubj)}(hhh](h)}(hA CPU cannot start participating in hardware coherency until the cluster is set up and coherent. If the cluster is not ready, then the CPU will wait in the CPU_COMING_UP state until the cluster has been set up.h]hA CPU cannot start participating in hardware coherency until the cluster is set up and coherent. If the cluster is not ready, then the CPU will wait in the CPU_COMING_UP state until the cluster has been set up.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubj)}(hhh](j)}(hNext state: CPU_UPh](j)}(h Next state:h]h Next state:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKhjubj)}(hhh]h)}(hCPU_UPh]hCPU_UP}(hj,hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj)ubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhhhKhjubj)}(h;Conditions: The CPU's parent cluster must be in CLUSTER_UP.h](j)}(h Conditions:h]h Conditions:}(hjJhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKhjFubj)}(hhh]h)}(h/The CPU's parent cluster must be in CLUSTER_UP.h]h1The CPU’s parent cluster must be in CLUSTER_UP.}(hj[hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjXubah}(h]h ]h"]h$]h&]uh1jhjFubeh}(h]h ]h"]h$]h&]uh1jhhhKhjubj)}(h@Trigger events: Transition of the parent cluster to CLUSTER_UP. h](j)}(hTrigger events:h]hTrigger events:}(hjyhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKhjuubj)}(hhh]h)}(h/Transition of the parent cluster to CLUSTER_UP.h]h/Transition of the parent cluster to CLUSTER_UP.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhjuubeh}(h]h ]h"]h$]h&]uh1jhhhKhjubeh}(h]h ]h"]h$]h&]uh1jhjubh)}(hORefer to the "Cluster state" section for a description of the CLUSTER_UP state.h]hSRefer to the “Cluster state” section for a description of the CLUSTER_UP state.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubeh}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhhhKhjhhubj)}(hXCPU_UP: When a CPU reaches the CPU_UP state, it is safe for the CPU to start participating in local coherency. This is done by jumping to the kernel's CPU resume code. Note that the definition of this state is slightly different from the basic model definition: CPU_UP does not mean that the CPU is coherent yet, but it does mean that it is safe to resume the kernel. The kernel handles the rest of the resume procedure, so the remaining steps are not visible as part of the race avoidance algorithm. The CPU remains in this state until an explicit policy decision is made to shut down or suspend the CPU. Next state: CPU_GOING_DOWN Conditions: none Trigger events: explicit policy decision h](j)}(hCPU_UP:h]hCPU_UP:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKhjubj)}(hhh](h)}(hfWhen a CPU reaches the CPU_UP state, it is safe for the CPU to start participating in local coherency.h]hfWhen a CPU reaches the CPU_UP state, it is safe for the CPU to start participating in local coherency.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubh)}(h8This is done by jumping to the kernel's CPU resume code.h]h:This is done by jumping to the kernel’s CPU resume code.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubh)}(hXMNote that the definition of this state is slightly different from the basic model definition: CPU_UP does not mean that the CPU is coherent yet, but it does mean that it is safe to resume the kernel. The kernel handles the rest of the resume procedure, so the remaining steps are not visible as part of the race avoidance algorithm.h]hXMNote that the definition of this state is slightly different from the basic model definition: CPU_UP does not mean that the CPU is coherent yet, but it does mean that it is safe to resume the kernel. The kernel handles the rest of the resume procedure, so the remaining steps are not visible as part of the race avoidance algorithm.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubh)}(hhThe CPU remains in this state until an explicit policy decision is made to shut down or suspend the CPU.h]hhThe CPU remains in this state until an explicit policy decision is made to shut down or suspend the CPU.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubj)}(hhh](j)}(hNext state: CPU_GOING_DOWNh](j)}(h Next state:h]h Next state:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKhjubj)}(hhh]h)}(hCPU_GOING_DOWNh]hCPU_GOING_DOWN}(hj)hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj&ubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhhhKhjubj)}(hConditions: noneh](j)}(h Conditions:h]h Conditions:}(hjGhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKhjCubj)}(hhh]h)}(hnoneh]hnone}(hjXhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjUubah}(h]h ]h"]h$]h&]uh1jhjCubeh}(h]h ]h"]h$]h&]uh1jhhhKhjubj)}(h*Trigger events: explicit policy decision h](j)}(hTrigger events:h]hTrigger events:}(hjvhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKhjrubj)}(hhh]h)}(hexplicit policy decisionh]hexplicit policy decision}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhjrubeh}(h]h ]h"]h$]h&]uh1jhhhKhjubeh}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhhhKhjhhubj)}(hXCPU_GOING_DOWN: While in this state, the CPU exits coherency, including any operations required to achieve this (such as cleaning data caches). Next state: CPU_DOWN Conditions: local CPU teardown complete Trigger events: (spontaneous) h](j)}(hCPU_GOING_DOWN:h]hCPU_GOING_DOWN:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKhjubj)}(hhh](h)}(hWhile in this state, the CPU exits coherency, including any operations required to achieve this (such as cleaning data caches).h]hWhile in this state, the CPU exits coherency, including any operations required to achieve this (such as cleaning data caches).}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubj)}(hhh](j)}(hNext state: CPU_DOWNh](j)}(h Next state:h]h Next state:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKhjubj)}(hhh]h)}(hCPU_DOWNh]hCPU_DOWN}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhhhKhjubj)}(h'Conditions: local CPU teardown completeh](j)}(h Conditions:h]h Conditions:}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKhjubj)}(hhh]h)}(hlocal CPU teardown completeh]hlocal CPU teardown complete}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhhhKhjubj)}(hTrigger events: (spontaneous) h](j)}(hTrigger events:h]hTrigger events:}(hj;hhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKhj7ubj)}(hhh]h)}(h (spontaneous)h]h (spontaneous)}(hjLhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjIubah}(h]h ]h"]h$]h&]uh1jhj7ubeh}(h]h ]h"]h$]h&]uh1jhhhKhjubeh}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhhhKhjhhubeh}(h]h ]h"]h$]h&]uh1jhjhhhNhNubeh}(h] cpu-stateah ]h"] cpu stateah$]h&]uh1hhhhhhhhKeubh)}(hhh](h)}(h Cluster stateh]h Cluster state}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhKubh)}(hX A cluster is a group of connected CPUs with some common resources. Because a cluster contains multiple CPUs, it can be doing multiple things at the same time. This has some implications. In particular, a CPU can start up while another CPU is tearing the cluster down.h]hX A cluster is a group of connected CPUs with some common resources. Because a cluster contains multiple CPUs, it can be doing multiple things at the same time. This has some implications. In particular, a CPU can start up while another CPU is tearing the cluster down.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubh)}(hIn this discussion, the "outbound side" is the view of the cluster state as seen by a CPU tearing the cluster down. The "inbound side" is the view of the cluster state as seen by a CPU setting the CPU up.h]hIn this discussion, the “outbound side” is the view of the cluster state as seen by a CPU tearing the cluster down. The “inbound side” is the view of the cluster state as seen by a CPU setting the CPU up.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubh)}(hXIn order to enable safe coordination in such situations, it is important that a CPU which is setting up the cluster can advertise its state independently of the CPU which is tearing down the cluster. For this reason, the cluster state is split into two parts:h]hXIn order to enable safe coordination in such situations, it is important that a CPU which is setting up the cluster can advertise its state independently of the CPU which is tearing down the cluster. For this reason, the cluster state is split into two parts:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubjT)}(hX "cluster" state: The global state of the cluster; or the state on the outbound side: - CLUSTER_DOWN - CLUSTER_UP - CLUSTER_GOING_DOWN "inbound" state: The state of the cluster on the inbound side. - INBOUND_NOT_COMING_UP - INBOUND_COMING_UP The different pairings of these states results in six possible states for the cluster as a whole:: CLUSTER_UP +==========> INBOUND_NOT_COMING_UP -------------+ # | | CLUSTER_UP <----+ | INBOUND_COMING_UP | v ^ CLUSTER_GOING_DOWN CLUSTER_GOING_DOWN # INBOUND_COMING_UP <=== INBOUND_NOT_COMING_UP CLUSTER_DOWN | | INBOUND_COMING_UP <----+ | | ^ | +=========== CLUSTER_DOWN <------------+ INBOUND_NOT_COMING_UP Transitions -----> can only be made by the outbound CPU, and only involve changes to the "cluster" state. Transitions ===##> can only be made by the inbound CPU, and only involve changes to the "inbound" state, except where there is no further transition possible on the outbound side (i.e., the outbound CPU has put the cluster into the CLUSTER_DOWN state). The race avoidance algorithm does not provide a way to determine which exact CPUs within the cluster play these roles. This must be decided in advance by some other means. Refer to the section "Last man and first man selection" for more explanation. CLUSTER_DOWN/INBOUND_NOT_COMING_UP is the only state where the cluster can actually be powered down. The parallelism of the inbound and outbound CPUs is observed by the existence of two different paths from CLUSTER_GOING_DOWN/ INBOUND_NOT_COMING_UP (corresponding to GOING_DOWN in the basic model) to CLUSTER_DOWN/INBOUND_COMING_UP (corresponding to COMING_UP in the basic model). The second path avoids cluster teardown completely. CLUSTER_UP/INBOUND_COMING_UP is equivalent to UP in the basic model. The final transition to CLUSTER_UP/INBOUND_NOT_COMING_UP is trivial and merely resets the state machine ready for the next cycle. Details of the allowable transitions follow. The next state in each case is notated / () where the is the side on which the transition can occur; either the inbound or the outbound side. h](h)}(hT"cluster" state: The global state of the cluster; or the state on the outbound side:h]hX“cluster” state: The global state of the cluster; or the state on the outbound side:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubjT)}(h1- CLUSTER_DOWN - CLUSTER_UP - CLUSTER_GOING_DOWN h]jZ)}(hhh](j_)}(h CLUSTER_DOWNh]h)}(hjh]h CLUSTER_DOWN}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1j^hjubj_)}(h CLUSTER_UPh]h)}(hjh]h CLUSTER_UP}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1j^hjubj_)}(hCLUSTER_GOING_DOWN h]h)}(hCLUSTER_GOING_DOWNh]hCLUSTER_GOING_DOWN}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1j^hjubeh}(h]h ]h"]h$]h&]jjuh1jYhhhKhjubah}(h]h ]h"]h$]h&]uh1jShhhKhjubh)}(h>"inbound" state: The state of the cluster on the inbound side.h]hB“inbound” state: The state of the cluster on the inbound side.}(hj,hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubjT)}(h-- INBOUND_NOT_COMING_UP - INBOUND_COMING_UP h]jZ)}(hhh](j_)}(hINBOUND_NOT_COMING_UPh]h)}(hjCh]hINBOUND_NOT_COMING_UP}(hjEhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjAubah}(h]h ]h"]h$]h&]uh1j^hj>ubj_)}(hINBOUND_COMING_UP h]h)}(hINBOUND_COMING_UPh]hINBOUND_COMING_UP}(hj\hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjXubah}(h]h ]h"]h$]h&]uh1j^hj>ubeh}(h]h ]h"]h$]h&]jjuh1jYhhhKhj:ubah}(h]h ]h"]h$]h&]uh1jShhhKhjubh)}(hbThe different pairings of these states results in six possible states for the cluster as a whole::h]haThe different pairings of these states results in six possible states for the cluster as a whole:}(hj|hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubj)}(hX CLUSTER_UP +==========> INBOUND_NOT_COMING_UP -------------+ # | | CLUSTER_UP <----+ | INBOUND_COMING_UP | v ^ CLUSTER_GOING_DOWN CLUSTER_GOING_DOWN # INBOUND_COMING_UP <=== INBOUND_NOT_COMING_UP CLUSTER_DOWN | | INBOUND_COMING_UP <----+ | | ^ | +=========== CLUSTER_DOWN <------------+ INBOUND_NOT_COMING_UPh]hX CLUSTER_UP +==========> INBOUND_NOT_COMING_UP -------------+ # | | CLUSTER_UP <----+ | INBOUND_COMING_UP | v ^ CLUSTER_GOING_DOWN CLUSTER_GOING_DOWN # INBOUND_COMING_UP <=== INBOUND_NOT_COMING_UP CLUSTER_DOWN | | INBOUND_COMING_UP <----+ | | ^ | +=========== CLUSTER_DOWN <------------+ INBOUND_NOT_COMING_UP}hjsbah}(h]h ]h"]h$]h&]jjuh1jhhhKhjubh)}(hiTransitions -----> can only be made by the outbound CPU, and only involve changes to the "cluster" state.h]hmTransitions -----> can only be made by the outbound CPU, and only involve changes to the “cluster” state.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubh)}(hTransitions ===##> can only be made by the inbound CPU, and only involve changes to the "inbound" state, except where there is no further transition possible on the outbound side (i.e., the outbound CPU has put the cluster into the CLUSTER_DOWN state).h]hXTransitions ===##> can only be made by the inbound CPU, and only involve changes to the “inbound” state, except where there is no further transition possible on the outbound side (i.e., the outbound CPU has put the cluster into the CLUSTER_DOWN state).}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM hjubh)}(hThe race avoidance algorithm does not provide a way to determine which exact CPUs within the cluster play these roles. This must be decided in advance by some other means. Refer to the section "Last man and first man selection" for more explanation.h]hThe race avoidance algorithm does not provide a way to determine which exact CPUs within the cluster play these roles. This must be decided in advance by some other means. Refer to the section “Last man and first man selection” for more explanation.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubh)}(hdCLUSTER_DOWN/INBOUND_NOT_COMING_UP is the only state where the cluster can actually be powered down.h]hdCLUSTER_DOWN/INBOUND_NOT_COMING_UP is the only state where the cluster can actually be powered down.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubh)}(hXLThe parallelism of the inbound and outbound CPUs is observed by the existence of two different paths from CLUSTER_GOING_DOWN/ INBOUND_NOT_COMING_UP (corresponding to GOING_DOWN in the basic model) to CLUSTER_DOWN/INBOUND_COMING_UP (corresponding to COMING_UP in the basic model). The second path avoids cluster teardown completely.h]hXLThe parallelism of the inbound and outbound CPUs is observed by the existence of two different paths from CLUSTER_GOING_DOWN/ INBOUND_NOT_COMING_UP (corresponding to GOING_DOWN in the basic model) to CLUSTER_DOWN/INBOUND_COMING_UP (corresponding to COMING_UP in the basic model). The second path avoids cluster teardown completely.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubh)}(hCLUSTER_UP/INBOUND_COMING_UP is equivalent to UP in the basic model. The final transition to CLUSTER_UP/INBOUND_NOT_COMING_UP is trivial and merely resets the state machine ready for the next cycle.h]hCLUSTER_UP/INBOUND_COMING_UP is equivalent to UP in the basic model. The final transition to CLUSTER_UP/INBOUND_NOT_COMING_UP is trivial and merely resets the state machine ready for the next cycle.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubh)}(h,Details of the allowable transitions follow.h]h,Details of the allowable transitions follow.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM$hjubh)}(h&The next state in each case is notatedh]h&The next state in each case is notated}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM&hjubjT)}(h1/ () h]h)}(h0/ ()h]h0/ ()}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM(hj ubah}(h]h ]h"]h$]h&]uh1jShhhM(hjubh)}(hpwhere the is the side on which the transition can occur; either the inbound or the outbound side.h]hpwhere the is the side on which the transition can occur; either the inbound or the outbound side.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM*hjubeh}(h]h ]h"]h$]h&]uh1jShhhKhjhhubj)}(hhh]j)}(hX0CLUSTER_DOWN/INBOUND_NOT_COMING_UP: Next state: CLUSTER_DOWN/INBOUND_COMING_UP (inbound) Conditions: none Trigger events: a) an explicit hardware power-up operation, resulting from a policy decision on another CPU; b) a hardware event, such as an interrupt. h](j)}(h#CLUSTER_DOWN/INBOUND_NOT_COMING_UP:h]h#CLUSTER_DOWN/INBOUND_NOT_COMING_UP:}(hj; hhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhM9hj7 ubj)}(hhh]j)}(hhh](j)}(h4Next state: CLUSTER_DOWN/INBOUND_COMING_UP (inbound)h](j)}(h Next state:h]h Next state:}(hjS hhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhM/hjO ubj)}(hhh]h)}(h(CLUSTER_DOWN/INBOUND_COMING_UP (inbound)h]h(CLUSTER_DOWN/INBOUND_COMING_UP (inbound)}(hjd hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM0hja ubah}(h]h ]h"]h$]h&]uh1jhjO ubeh}(h]h ]h"]h$]h&]uh1jhhhM/hjL ubj)}(hConditions: none h](j)}(h Conditions:h]h Conditions:}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhM2hj~ ubj)}(hhh]h)}(hnoneh]hnone}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM2hj ubah}(h]h ]h"]h$]h&]uh1jhj~ ubeh}(h]h ]h"]h$]h&]uh1jhhhM2hjL ubj)}(hTrigger events: a) an explicit hardware power-up operation, resulting from a policy decision on another CPU; b) a hardware event, such as an interrupt. h](j)}(hTrigger events:h]hTrigger events:}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhM9hj ubj)}(hhh]j)}(hhh](j_)}(hZan explicit hardware power-up operation, resulting from a policy decision on another CPU; h]h)}(hYan explicit hardware power-up operation, resulting from a policy decision on another CPU;h]hYan explicit hardware power-up operation, resulting from a policy decision on another CPU;}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM5hj ubah}(h]h ]h"]h$]h&]uh1j^hj ubj_)}(h)a hardware event, such as an interrupt. h]h)}(h'a hardware event, such as an interrupt.h]h'a hardware event, such as an interrupt.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM8hj ubah}(h]h ]h"]h$]h&]uh1j^hj ubeh}(h]h ]h"]h$]h&]jjjhjjuh1jhj ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhhhM9hjL ubeh}(h]h ]h"]h$]h&]uh1jhjI ubah}(h]h ]h"]h$]h&]uh1jhj7 ubeh}(h]h ]h"]h$]h&]uh1jhhhM9hj4 ubah}(h]h ]h"]h$]h&]uh1jhjhhhNhNubh)}(hCLUSTER_DOWN/INBOUND_COMING_UP:h]hCLUSTER_DOWN/INBOUND_COMING_UP:}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM;hjhhubjT)}(hXIn this state, an inbound CPU sets up the cluster, including enabling of hardware coherency at the cluster level and any other operations (such as cache invalidation) which are required in order to achieve this. The purpose of this state is to do sufficient cluster-level setup to enable other CPUs in the cluster to enter coherency safely. Next state: CLUSTER_UP/INBOUND_COMING_UP (inbound) Conditions: cluster-level setup and hardware coherency complete Trigger events: (spontaneous) h](h)}(hIn this state, an inbound CPU sets up the cluster, including enabling of hardware coherency at the cluster level and any other operations (such as cache invalidation) which are required in order to achieve this.h]hIn this state, an inbound CPU sets up the cluster, including enabling of hardware coherency at the cluster level and any other operations (such as cache invalidation) which are required in order to achieve this.}(hj1 hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM=hj- ubh)}(hThe purpose of this state is to do sufficient cluster-level setup to enable other CPUs in the cluster to enter coherency safely.h]hThe purpose of this state is to do sufficient cluster-level setup to enable other CPUs in the cluster to enter coherency safely.}(hj? hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMBhj- ubj)}(hhh](j)}(h2Next state: CLUSTER_UP/INBOUND_COMING_UP (inbound)h](j)}(h Next state:h]h Next state:}(hjT hhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhMFhjP ubj)}(hhh]h)}(h&CLUSTER_UP/INBOUND_COMING_UP (inbound)h]h&CLUSTER_UP/INBOUND_COMING_UP (inbound)}(hje hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMGhjb ubah}(h]h ]h"]h$]h&]uh1jhjP ubeh}(h]h ]h"]h$]h&]uh1jhhhMFhjM ubj)}(h?Conditions: cluster-level setup and hardware coherency completeh](j)}(h Conditions:h]h Conditions:}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhMHhj ubj)}(hhh]h)}(h3cluster-level setup and hardware coherency completeh]h3cluster-level setup and hardware coherency complete}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMIhj ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhhhMHhjM ubj)}(hTrigger events: (spontaneous) h](j)}(hTrigger events:h]hTrigger events:}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhMLhj ubj)}(hhh]h)}(h (spontaneous)h]h (spontaneous)}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMKhj ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhhhMLhjM ubeh}(h]h ]h"]h$]h&]uh1jhj- ubeh}(h]h ]h"]h$]h&]uh1jShhhM=hjhhubh)}(hCLUSTER_UP/INBOUND_COMING_UP:h]hCLUSTER_UP/INBOUND_COMING_UP:}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMNhjhhubjT)}(hXCluster-level setup is complete and hardware coherency is enabled for the cluster. Other CPUs in the cluster can safely enter coherency. This is a transient state, leading immediately to CLUSTER_UP/INBOUND_NOT_COMING_UP. All other CPUs on the cluster should consider treat these two states as equivalent. Next state: CLUSTER_UP/INBOUND_NOT_COMING_UP (inbound) Conditions: none Trigger events: (spontaneous) h](h)}(hCluster-level setup is complete and hardware coherency is enabled for the cluster. Other CPUs in the cluster can safely enter coherency.h]hCluster-level setup is complete and hardware coherency is enabled for the cluster. Other CPUs in the cluster can safely enter coherency.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMPhj ubh)}(hThis is a transient state, leading immediately to CLUSTER_UP/INBOUND_NOT_COMING_UP. All other CPUs on the cluster should consider treat these two states as equivalent.h]hThis is a transient state, leading immediately to CLUSTER_UP/INBOUND_NOT_COMING_UP. All other CPUs on the cluster should consider treat these two states as equivalent.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMThj ubj)}(hhh](j)}(h6Next state: CLUSTER_UP/INBOUND_NOT_COMING_UP (inbound)h](j)}(h Next state:h]h Next state:}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhMXhj ubj)}(hhh]h)}(h*CLUSTER_UP/INBOUND_NOT_COMING_UP (inbound)h]h*CLUSTER_UP/INBOUND_NOT_COMING_UP (inbound)}(hj/ hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMYhj, ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhhhMXhj ubj)}(hConditions: noneh](j)}(h Conditions:h]h Conditions:}(hjM hhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhMZhjI ubj)}(hhh]h)}(hnoneh]hnone}(hj^ hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM[hj[ ubah}(h]h ]h"]h$]h&]uh1jhjI ubeh}(h]h ]h"]h$]h&]uh1jhhhMZhj ubj)}(hTrigger events: (spontaneous) h](j)}(hTrigger events:h]hTrigger events:}(hj| hhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhM^hjx ubj)}(hhh]h)}(h (spontaneous)h]h (spontaneous)}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM]hj ubah}(h]h ]h"]h$]h&]uh1jhjx ubeh}(h]h ]h"]h$]h&]uh1jhhhM^hj ubeh}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jShhhMPhjhhubh)}(h!CLUSTER_UP/INBOUND_NOT_COMING_UP:h]h!CLUSTER_UP/INBOUND_NOT_COMING_UP:}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM`hjhhubjT)}(hXCluster-level setup is complete and hardware coherency is enabled for the cluster. Other CPUs in the cluster can safely enter coherency. The cluster will remain in this state until a policy decision is made to power the cluster down. Next state: CLUSTER_GOING_DOWN/INBOUND_NOT_COMING_UP (outbound) Conditions: none Trigger events: policy decision to power down the cluster h](h)}(hCluster-level setup is complete and hardware coherency is enabled for the cluster. Other CPUs in the cluster can safely enter coherency.h]hCluster-level setup is complete and hardware coherency is enabled for the cluster. Other CPUs in the cluster can safely enter coherency.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMbhj ubh)}(h`The cluster will remain in this state until a policy decision is made to power the cluster down.h]h`The cluster will remain in this state until a policy decision is made to power the cluster down.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMfhj ubj)}(hhh](j)}(h?Next state: CLUSTER_GOING_DOWN/INBOUND_NOT_COMING_UP (outbound)h](j)}(h Next state:h]h Next state:}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhMihj ubj)}(hhh]h)}(h3CLUSTER_GOING_DOWN/INBOUND_NOT_COMING_UP (outbound)h]h3CLUSTER_GOING_DOWN/INBOUND_NOT_COMING_UP (outbound)}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMjhj ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhhhMihj ubj)}(hConditions: noneh](j)}(h Conditions:h]h Conditions:}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhMkhj ubj)}(hhh]h)}(hnoneh]hnone}(hj( hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMlhj% ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhhhMkhj ubj)}(h;Trigger events: policy decision to power down the cluster h](j)}(hTrigger events:h]hTrigger events:}(hjF hhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhMohjB ubj)}(hhh]h)}(h)policy decision to power down the clusterh]h)policy decision to power down the cluster}(hjW hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMnhjT ubah}(h]h ]h"]h$]h&]uh1jhjB ubeh}(h]h ]h"]h$]h&]uh1jhhhMohj ubeh}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jShhhMbhjhhubh)}(h)CLUSTER_GOING_DOWN/INBOUND_NOT_COMING_UP:h]h)CLUSTER_GOING_DOWN/INBOUND_NOT_COMING_UP:}(hj} hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMqhjhhubjT)}(hXAn outbound CPU is tearing the cluster down. The selected CPU must wait in this state until all CPUs in the cluster are in the CPU_DOWN state. When all CPUs are in the CPU_DOWN state, the cluster can be torn down, for example by cleaning data caches and exiting cluster-level coherency. To avoid wasteful unnecessary teardown operations, the outbound should check the inbound cluster state for asynchronous transitions to INBOUND_COMING_UP. Alternatively, individual CPUs can be checked for entry into CPU_COMING_UP or CPU_UP. Next states: CLUSTER_DOWN/INBOUND_NOT_COMING_UP (outbound) Conditions: cluster torn down and ready to power off Trigger events: (spontaneous) CLUSTER_GOING_DOWN/INBOUND_COMING_UP (inbound) Conditions: none Trigger events: a) an explicit hardware power-up operation, resulting from a policy decision on another CPU; b) a hardware event, such as an interrupt. h](h)}(hAn outbound CPU is tearing the cluster down. The selected CPU must wait in this state until all CPUs in the cluster are in the CPU_DOWN state.h]hAn outbound CPU is tearing the cluster down. The selected CPU must wait in this state until all CPUs in the cluster are in the CPU_DOWN state.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMshj ubh)}(hWhen all CPUs are in the CPU_DOWN state, the cluster can be torn down, for example by cleaning data caches and exiting cluster-level coherency.h]hWhen all CPUs are in the CPU_DOWN state, the cluster can be torn down, for example by cleaning data caches and exiting cluster-level coherency.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMwhj ubh)}(hTo avoid wasteful unnecessary teardown operations, the outbound should check the inbound cluster state for asynchronous transitions to INBOUND_COMING_UP. Alternatively, individual CPUs can be checked for entry into CPU_COMING_UP or CPU_UP.h]hTo avoid wasteful unnecessary teardown operations, the outbound should check the inbound cluster state for asynchronous transitions to INBOUND_COMING_UP. Alternatively, individual CPUs can be checked for entry into CPU_COMING_UP or CPU_UP.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM{hj ubh)}(h Next states:h]h Next states:}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj ubj)}(hhh](j)}(hCLUSTER_DOWN/INBOUND_NOT_COMING_UP (outbound) Conditions: cluster torn down and ready to power off Trigger events: (spontaneous) h](j)}(h-CLUSTER_DOWN/INBOUND_NOT_COMING_UP (outbound)h]h-CLUSTER_DOWN/INBOUND_NOT_COMING_UP (outbound)}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhMhj ubj)}(hhh]j)}(hhh](j)}(h4Conditions: cluster torn down and ready to power offh](j)}(h Conditions:h]h Conditions:}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhMhj ubj)}(hhh]h)}(h(cluster torn down and ready to power offh]h(cluster torn down and ready to power off}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhhhMhj ubj)}(hTrigger events: (spontaneous) h](j)}(hTrigger events:h]hTrigger events:}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhMhj ubj)}(hhh]h)}(h (spontaneous)h]h (spontaneous)}(hj& hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj# ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhhhMhj ubeh}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhhhMhj ubj)}(hX CLUSTER_GOING_DOWN/INBOUND_COMING_UP (inbound) Conditions: none Trigger events: a) an explicit hardware power-up operation, resulting from a policy decision on another CPU; b) a hardware event, such as an interrupt. h](j)}(h.CLUSTER_GOING_DOWN/INBOUND_COMING_UP (inbound)h]h.CLUSTER_GOING_DOWN/INBOUND_COMING_UP (inbound)}(hjV hhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhMhjR ubj)}(hhh]j)}(hhh](j)}(hConditions: none h](j)}(h Conditions:h]h Conditions:}(hjn hhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhMhjj ubj)}(hhh]h)}(hnoneh]hnone}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj| ubah}(h]h ]h"]h$]h&]uh1jhjj ubeh}(h]h ]h"]h$]h&]uh1jhhhMhjg ubj)}(hTrigger events: a) an explicit hardware power-up operation, resulting from a policy decision on another CPU; b) a hardware event, such as an interrupt. h](j)}(hTrigger events:h]hTrigger events:}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhMhj ubj)}(hhh]j)}(hhh](j_)}(hZan explicit hardware power-up operation, resulting from a policy decision on another CPU; h]h)}(hYan explicit hardware power-up operation, resulting from a policy decision on another CPU;h]hYan explicit hardware power-up operation, resulting from a policy decision on another CPU;}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj ubah}(h]h ]h"]h$]h&]uh1j^hj ubj_)}(h)a hardware event, such as an interrupt. h]h)}(h'a hardware event, such as an interrupt.h]h'a hardware event, such as an interrupt.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj ubah}(h]h ]h"]h$]h&]uh1j^hj ubeh}(h]h ]h"]h$]h&]jjjhjjuh1jhj ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhhhMhjg ubeh}(h]h ]h"]h$]h&]uh1jhjd ubah}(h]h ]h"]h$]h&]uh1jhjR ubeh}(h]h ]h"]h$]h&]uh1jhhhMhj ubeh}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jShhhMshjhhubh)}(h%CLUSTER_GOING_DOWN/INBOUND_COMING_UP:h]h%CLUSTER_GOING_DOWN/INBOUND_COMING_UP:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubjT)}(hXThe cluster is (or was) being torn down, but another CPU has come online in the meantime and is trying to set up the cluster again. If the outbound CPU observes this state, it has two choices: a) back out of teardown, restoring the cluster to the CLUSTER_UP state; b) finish tearing the cluster down and put the cluster in the CLUSTER_DOWN state; the inbound CPU will set up the cluster again from there. Choice (a) permits the removal of some latency by avoiding unnecessary teardown and setup operations in situations where the cluster is not really going to be powered down. Next states: CLUSTER_UP/INBOUND_COMING_UP (outbound) Conditions: cluster-level setup and hardware coherency complete Trigger events: (spontaneous) CLUSTER_DOWN/INBOUND_COMING_UP (outbound) Conditions: cluster torn down and ready to power off Trigger events: (spontaneous) h](h)}(hThe cluster is (or was) being torn down, but another CPU has come online in the meantime and is trying to set up the cluster again.h]hThe cluster is (or was) being torn down, but another CPU has come online in the meantime and is trying to set up the cluster again.}(hj#hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubh)}(hubj)}(hTrigger events: (spontaneous) h](j)}(hTrigger events:h]hTrigger events:}(hjthhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhMhjpubj)}(hhh]h)}(h (spontaneous)h]h (spontaneous)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jhjpubeh}(h]h ]h"]h$]h&]uh1jhhhMhj>ubeh}(h]h ]h"]h$]h&]uh1jhj;ubah}(h]h ]h"]h$]h&]uh1jhj)ubeh}(h]h ]h"]h$]h&]uh1jhhhMhjubeh}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jShhhMhjhhubeh}(h] cluster-stateah ]h"] cluster stateah$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(h Last man and First man selectionh]h Last man and First man selection}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMubh)}(hsThe CPU which performs cluster tear-down operations on the outbound side is commonly referred to as the "last man".h]hwThe CPU which performs cluster tear-down operations on the outbound side is commonly referred to as the “last man”.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hdThe CPU which performs cluster setup on the inbound side is commonly referred to as the "first man".h]hhThe CPU which performs cluster setup on the inbound side is commonly referred to as the “first man”.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hxThe race avoidance algorithm documented above does not provide a mechanism to choose which CPUs should play these roles.h]hxThe race avoidance algorithm documented above does not provide a mechanism to choose which CPUs should play these roles.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(h Last man:h]h Last man:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hWhen shutting down the cluster, all the CPUs involved are initially executing Linux and hence coherent. Therefore, ordinary spinlocks can be used to select a last man safely, before the CPUs become non-coherent.h]hWhen shutting down the cluster, all the CPUs involved are initially executing Linux and hence coherent. Therefore, ordinary spinlocks can be used to select a last man safely, before the CPUs become non-coherent.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(h First man:h]h First man:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hXBecause CPUs may power up asynchronously in response to external wake-up events, a dynamic mechanism is needed to make sure that only one CPU attempts to play the first man role and do the cluster-level initialisation: any other CPUs must wait for this to complete before proceeding.h]hXBecause CPUs may power up asynchronously in response to external wake-up events, a dynamic mechanism is needed to make sure that only one CPU attempts to play the first man role and do the cluster-level initialisation: any other CPUs must wait for this to complete before proceeding.}(hj*hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hjCluster-level initialisation may involve actions such as configuring coherency controls in the bus fabric.h]hjCluster-level initialisation may involve actions such as configuring coherency controls in the bus fabric.}(hj8hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hThe current implementation in mcpm_head.S uses a separate mutual exclusion mechanism to do this arbitration. This mechanism is documented in detail in vlocks.txt.h]hThe current implementation in mcpm_head.S uses a separate mutual exclusion mechanism to do this arbitration. This mechanism is documented in detail in vlocks.txt.}(hjFhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubeh}(h] last-man-and-first-man-selectionah ]h"] last man and first man selectionah$]h&]uh1hhhhhhhhMubh)}(hhh](h)}(hFeatures and Limitationsh]hFeatures and Limitations}(hj_hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj\hhhhhMubh)}(hImplementation:h]hImplementation:}(hjmhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj\hhubjT)}(hXThe current ARM-based implementation is split between arch/arm/common/mcpm_head.S (low-level inbound CPU operations) and arch/arm/common/mcpm_entry.c (everything else): __mcpm_cpu_going_down() signals the transition of a CPU to the CPU_GOING_DOWN state. __mcpm_cpu_down() signals the transition of a CPU to the CPU_DOWN state. A CPU transitions to CPU_COMING_UP and then to CPU_UP via the low-level power-up code in mcpm_head.S. This could involve CPU-specific setup code, but in the current implementation it does not. __mcpm_outbound_enter_critical() and __mcpm_outbound_leave_critical() handle transitions from CLUSTER_UP to CLUSTER_GOING_DOWN and from there to CLUSTER_DOWN or back to CLUSTER_UP (in the case of an aborted cluster power-down). These functions are more complex than the __mcpm_cpu_*() functions due to the extra inter-CPU coordination which is needed for safe transitions at the cluster level. A cluster transitions from CLUSTER_DOWN back to CLUSTER_UP via the low-level power-up code in mcpm_head.S. This typically involves platform-specific setup code, provided by the platform-specific power_up_setup function registered via mcpm_sync_init. h](h)}(hThe current ARM-based implementation is split between arch/arm/common/mcpm_head.S (low-level inbound CPU operations) and arch/arm/common/mcpm_entry.c (everything else):h]hThe current ARM-based implementation is split between arch/arm/common/mcpm_head.S (low-level inbound CPU operations) and arch/arm/common/mcpm_entry.c (everything else):}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj{ubh)}(hT__mcpm_cpu_going_down() signals the transition of a CPU to the CPU_GOING_DOWN state.h]hT__mcpm_cpu_going_down() signals the transition of a CPU to the CPU_GOING_DOWN state.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj{ubh)}(hH__mcpm_cpu_down() signals the transition of a CPU to the CPU_DOWN state.h]hH__mcpm_cpu_down() signals the transition of a CPU to the CPU_DOWN state.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj{ubh)}(hA CPU transitions to CPU_COMING_UP and then to CPU_UP via the low-level power-up code in mcpm_head.S. This could involve CPU-specific setup code, but in the current implementation it does not.h]hA CPU transitions to CPU_COMING_UP and then to CPU_UP via the low-level power-up code in mcpm_head.S. This could involve CPU-specific setup code, but in the current implementation it does not.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj{ubh)}(h__mcpm_outbound_enter_critical() and __mcpm_outbound_leave_critical() handle transitions from CLUSTER_UP to CLUSTER_GOING_DOWN and from there to CLUSTER_DOWN or back to CLUSTER_UP (in the case of an aborted cluster power-down).h]h__mcpm_outbound_enter_critical() and __mcpm_outbound_leave_critical() handle transitions from CLUSTER_UP to CLUSTER_GOING_DOWN and from there to CLUSTER_DOWN or back to CLUSTER_UP (in the case of an aborted cluster power-down).}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj{ubh)}(hThese functions are more complex than the __mcpm_cpu_*() functions due to the extra inter-CPU coordination which is needed for safe transitions at the cluster level.h]hThese functions are more complex than the __mcpm_cpu_*() functions due to the extra inter-CPU coordination which is needed for safe transitions at the cluster level.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj{ubh)}(hA cluster transitions from CLUSTER_DOWN back to CLUSTER_UP via the low-level power-up code in mcpm_head.S. This typically involves platform-specific setup code, provided by the platform-specific power_up_setup function registered via mcpm_sync_init.h]hA cluster transitions from CLUSTER_DOWN back to CLUSTER_UP via the low-level power-up code in mcpm_head.S. This typically involves platform-specific setup code, provided by the platform-specific power_up_setup function registered via mcpm_sync_init.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj{ubeh}(h]h ]h"]h$]h&]uh1jShhhMhj\hhubh)}(hDeep topologies:h]hDeep topologies:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj\hhubjT)}(hXnAs currently described and implemented, the algorithm does not support CPU topologies involving more than two levels (i.e., clusters of clusters are not supported). The algorithm could be extended by replicating the cluster-level states for the additional topological levels, and modifying the transition rules for the intermediate (non-outermost) cluster levels. h]h)}(hXlAs currently described and implemented, the algorithm does not support CPU topologies involving more than two levels (i.e., clusters of clusters are not supported). The algorithm could be extended by replicating the cluster-level states for the additional topological levels, and modifying the transition rules for the intermediate (non-outermost) cluster levels.h]hXlAs currently described and implemented, the algorithm does not support CPU topologies involving more than two levels (i.e., clusters of clusters are not supported). The algorithm could be extended by replicating the cluster-level states for the additional topological levels, and modifying the transition rules for the intermediate (non-outermost) cluster levels.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jShhhMhj\hhubeh}(h]features-and-limitationsah ]h"]features and limitationsah$]h&]uh1hhhhhhhhMubh)}(hhh](h)}(hColophonh]hColophon}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMubh)}(hyOriginally created and documented by Dave Martin for Linaro Limited, in collaboration with Nicolas Pitre and Achin Gupta.h]hyOriginally created and documented by Dave Martin for Linaro Limited, in collaboration with Nicolas Pitre and Achin Gupta.}(hj&hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hCopyright (C) 2012-2013 Linaro Limited Distributed under the terms of Version 2 of the GNU General Public License, as defined in linux/COPYING.h]hCopyright (C) 2012-2013 Linaro Limited Distributed under the terms of Version 2 of the GNU General Public License, as defined in linux/COPYING.}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubeh}(h]colophonah ]h"]colophonah$]h&]uh1hhhhhhhhMubeh}(h]9cluster-wide-power-up-power-down-race-avoidance-algorithmah ]h"]9cluster-wide power-up/power-down race avoidance algorithmah$]h&]uh1hhhhhhhhKubeh}(h]h ]h"]h$]h&]sourcehuh1hcurrent_sourceN current_lineNsettingsdocutils.frontendValues)}(hN generatorN datestampN source_linkN source_urlN toc_backlinksentryfootnote_backlinksK sectnum_xformKstrip_commentsNstrip_elements_with_classesN strip_classesN report_levelK halt_levelKexit_status_levelKdebugNwarning_streamN tracebackinput_encoding utf-8-siginput_encoding_error_handlerstrictoutput_encodingutf-8output_encoding_error_handlerjuerror_encodingutf-8error_encoding_error_handlerbackslashreplace language_codeenrecord_dependenciesNconfigN id_prefixhauto_id_prefixid dump_settingsNdump_internalsNdump_transformsNdump_pseudo_xmlNexpose_internalsNstrict_visitorN_disable_configN_sourceh _destinationN _config_files]7/var/lib/git/docbuild/linux/Documentation/docutils.confafile_insertion_enabled raw_enabledKline_length_limitM'pep_referencesN pep_base_urlhttps://peps.python.org/pep_file_url_templatepep-%04drfc_referencesN rfc_base_url&https://datatracker.ietf.org/doc/html/ tab_widthKtrim_footnote_reference_spacesyntax_highlightlong smart_quotessmartquotes_locales]character_level_inline_markupdoctitle_xform docinfo_xformKsectsubtitle_xform image_loadinglinkembed_stylesheetcloak_email_addressessection_self_linkenvNubreporterNindirect_targets]substitution_defs}substitution_names}refnames}refids}nameids}(jOjLj1j.jjjjjjjYjVjjjGjDu nametypes}(jOj1jjjjYjjGuh}(jLhj.hjj4jjjjjVjjj\jDju footnote_refs} citation_refs} autofootnotes]autofootnote_refs]symbol_footnotes]symbol_footnote_refs] footnotes] citations]autofootnote_startKsymbol_footnote_startK id_counter collectionsCounter}Rparse_messages]transform_messages] transformerN include_log] decorationNhhub.