sphinx.addnodesdocument)}( rawsourcechildren]( translations LanguagesNode)}(hhh](h pending_xref)}(hhh]docutils.nodesTextChinese (Simplified)}parenthsba attributes}(ids]classes]names]dupnames]backrefs] refdomainstdreftypedoc reftarget(/translations/zh_CN/core-api/assoc_arraymodnameN classnameN refexplicitutagnamehhh ubh)}(hhh]hChinese (Traditional)}hh2sbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget(/translations/zh_TW/core-api/assoc_arraymodnameN classnameN refexplicituh1hhh ubh)}(hhh]hItalian}hhFsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget(/translations/it_IT/core-api/assoc_arraymodnameN classnameN refexplicituh1hhh ubh)}(hhh]hJapanese}hhZsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget(/translations/ja_JP/core-api/assoc_arraymodnameN classnameN refexplicituh1hhh ubh)}(hhh]hKorean}hhnsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget(/translations/ko_KR/core-api/assoc_arraymodnameN classnameN refexplicituh1hhh ubh)}(hhh]hPortuguese (Brazilian)}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget(/translations/pt_BR/core-api/assoc_arraymodnameN classnameN refexplicituh1hhh ubh)}(hhh]hSpanish}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget(/translations/sp_SP/core-api/assoc_arraymodnameN classnameN refexplicituh1hhh ubeh}(h]h ]h"]h$]h&]current_languageEnglishuh1h hh _documenthsourceNlineNubhsection)}(hhh](htitle)}(h(Generic Associative Array Implementationh]h(Generic Associative Array Implementation}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhhhB/var/lib/git/docbuild/linux/Documentation/core-api/assoc_array.rsthKubh)}(hhh](h)}(hOverviewh]hOverview}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhhhhhKubh paragraph)}(h[This associative array implementation is an object container with the following properties:h]h[This associative array implementation is an object container with the following properties:}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhhhhubhenumerated_list)}(hhh](h list_item)}(hObjects are opaque pointers. The implementation does not care where they point (if anywhere) or what they point to (if anything). .. note:: Pointers to objects _must_ be zero in the least significant bit. h](h)}(hObjects are opaque pointers. The implementation does not care where they point (if anywhere) or what they point to (if anything).h]hObjects are opaque pointers. The implementation does not care where they point (if anywhere) or what they point to (if anything).}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK hhubhnote)}(h@Pointers to objects _must_ be zero in the least significant bit.h]h)}(hj h]h@Pointers to objects _must_ be zero in the least significant bit.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhhubeh}(h]h ]h"]h$]h&]uh1hhhhhhNhNubh)}(hObjects do not need to contain linkage blocks for use by the array. This permits an object to be located in multiple arrays simultaneously. Rather, the array is made up of metadata blocks that point to objects. h]h)}(hObjects do not need to contain linkage blocks for use by the array. This permits an object to be located in multiple arrays simultaneously. Rather, the array is made up of metadata blocks that point to objects.h]hObjects do not need to contain linkage blocks for use by the array. This permits an object to be located in multiple arrays simultaneously. Rather, the array is made up of metadata blocks that point to objects.}(hj(hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj$ubah}(h]h ]h"]h$]h&]uh1hhhhhhhhNubh)}(h``. The associative array is rooted on the following structure::h](hThe public API can be found in }(hjFhhhNhNubhliteral)}(h````h]h}(hjPhhhNhNubah}(h]h ]h"]h$]h&]uh1jNhjFubh>. The associative array is rooted on the following structure:}(hjFhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhK;hj5hhubh literal_block)}(h#struct assoc_array { ... };h]h#struct assoc_array { ... };}hjjsbah}(h]h ]h"]h$]h&] xml:spacepreserveuh1jhhhhK>hj5hhubh)}(hDThe code is selected by enabling ``CONFIG_ASSOCIATIVE_ARRAY`` with::h](h!The code is selected by enabling }(hjzhhhNhNubjO)}(h``CONFIG_ASSOCIATIVE_ARRAY``h]hCONFIG_ASSOCIATIVE_ARRAY}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jNhjzubh with:}(hjzhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKBhj5hhubji)}(h$./script/config -e ASSOCIATIVE_ARRAYh]h$./script/config -e ASSOCIATIVE_ARRAY}hjsbah}(h]h ]h"]h$]h&]jxjyuh1jhhhhKDhj5hhubh)}(hhh](h)}(h Edit Scripth]h Edit Script}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhKHubh)}(hXIThe insertion and deletion functions produce an 'edit script' that can later be applied to effect the changes without risking ``ENOMEM``. This retains the preallocated metadata blocks that will be installed in the internal tree and keeps track of the metadata blocks that will be removed from the tree when the script is applied.h](hThe insertion and deletion functions produce an ‘edit script’ that can later be applied to effect the changes without risking }(hjhhhNhNubjO)}(h ``ENOMEM``h]hENOMEM}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jNhjubh. This retains the preallocated metadata blocks that will be installed in the internal tree and keeps track of the metadata blocks that will be removed from the tree when the script is applied.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKJhjhhubh)}(hXThis is also used to keep track of dead blocks and dead objects after the script has been applied so that they can be freed later. The freeing is done after an RCU grace period has passed - thus allowing access functions to proceed under the RCU read lock.h]hXThis is also used to keep track of dead blocks and dead objects after the script has been applied so that they can be freed later. The freeing is done after an RCU grace period has passed - thus allowing access functions to proceed under the RCU read lock.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKPhjhhubh)}(hCThe script appears as outside of the API as a pointer of the type::h]hBThe script appears as outside of the API as a pointer of the type:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKUhjhhubji)}(hstruct assoc_array_edit;h]hstruct assoc_array_edit;}hjsbah}(h]h ]h"]h$]h&]jxjyuh1jhhhhKWhjhhubh)}(h4There are two functions for dealing with the script:h]h4There are two functions for dealing with the script:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKYhjhhubh)}(hhh](h)}(hX<Apply an edit script:: void assoc_array_apply_edit(struct assoc_array_edit *edit); This will perform the edit functions, interpolating various write barriers to permit accesses under the RCU read lock to continue. The edit script will then be passed to ``call_rcu()`` to free it and any dead stuff it points to. h](h)}(hApply an edit script::h]hApply an edit script:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK[hjubji)}(h;void assoc_array_apply_edit(struct assoc_array_edit *edit);h]h;void assoc_array_apply_edit(struct assoc_array_edit *edit);}hj&sbah}(h]h ]h"]h$]h&]jxjyuh1jhhhhK]hjubh)}(hThis will perform the edit functions, interpolating various write barriers to permit accesses under the RCU read lock to continue. The edit script will then be passed to ``call_rcu()`` to free it and any dead stuff it points to.h](hThis will perform the edit functions, interpolating various write barriers to permit accesses under the RCU read lock to continue. The edit script will then be passed to }(hj4hhhNhNubjO)}(h``call_rcu()``h]h call_rcu()}(hj<hhhNhNubah}(h]h ]h"]h$]h&]uh1jNhj4ubh, to free it and any dead stuff it points to.}(hj4hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhK_hjubeh}(h]h ]h"]h$]h&]uh1hhjhhhhhNubh)}(hXCancel an edit script:: void assoc_array_cancel_edit(struct assoc_array_edit *edit); This frees the edit script and all preallocated memory immediately. If this was for insertion, the new object is *not* released by this function, but must rather be released by the caller. h](h)}(hCancel an edit script::h]hCancel an edit script:}(hj^hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKdhjZubji)}(hhhhNhNubjO)}(h ``-ENOMEM``h]h-ENOMEM}(hjFhhhNhNubah}(h]h ]h"]h$]h&]uh1jNhj>ubh3 is returned in the case of an out-of-memory error.}(hj>hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjubh)}(hHThe caller should lock exclusively against other modifiers of the array.h]hHThe caller should lock exclusively against other modifiers of the array.}(hj^hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubeh}(h]h ]h"]h$]h&]uh1hhjhhhhhNubh)}(hXDelete an object from an associative array:: struct assoc_array_edit * assoc_array_delete(struct assoc_array *array, const struct assoc_array_ops *ops, const void *index_key); This deletes an object that matches the specified data from the array. The ``index_key`` argument should hold index key information and is passed to the methods in the ops table when they are called. This function makes no alteration to the array itself, but rather returns an edit script that must be applied. ``-ENOMEM`` is returned in the case of an out-of-memory error. ``NULL`` will be returned if the specified object is not found within the array. h](h)}(h,Delete an object from an associative array::h]h+Delete an object from an associative array:}(hjvhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjrubji)}(hstruct assoc_array_edit * assoc_array_delete(struct assoc_array *array, const struct assoc_array_ops *ops, const void *index_key);h]hstruct assoc_array_edit * assoc_array_delete(struct assoc_array *array, const struct assoc_array_ops *ops, const void *index_key);}hjsbah}(h]h ]h"]h$]h&]jxjyuh1jhhhhKhjrubh)}(hFThis deletes an object that matches the specified data from the array.h]hFThis deletes an object that matches the specified data from the array.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjrubh)}(hThe ``index_key`` argument should hold index key information and is passed to the methods in the ops table when they are called.h](hThe }(hjhhhNhNubjO)}(h ``index_key``h]h index_key}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jNhjubho argument should hold index key information and is passed to the methods in the ops table when they are called.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjrubh)}(hXThis function makes no alteration to the array itself, but rather returns an edit script that must be applied. ``-ENOMEM`` is returned in the case of an out-of-memory error. ``NULL`` will be returned if the specified object is not found within the array.h](hpThis function makes no alteration to the array itself, but rather returns an edit script that must be applied. }(hjhhhNhNubjO)}(h ``-ENOMEM``h]h-ENOMEM}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jNhjubh5 is returned in the case of an out-of-memory error. }(hjhhhNhNubjO)}(h``NULL``h]hNULL}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jNhjubhH will be returned if the specified object is not found within the array.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjrubeh}(h]h ]h"]h$]h&]uh1hhjhhhhhNubeh}(h]h ]h"]h$]h&]jjjhjjuh1hhjhhhhhKubh)}(hHThe caller should lock exclusively against other modifiers of the array.h]hHThe caller should lock exclusively against other modifiers of the array.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubh)}(hhh](h)}(hXDelete all objects from an associative array:: struct assoc_array_edit * assoc_array_clear(struct assoc_array *array, const struct assoc_array_ops *ops); This deletes all the objects from an associative array and leaves it completely empty. This function makes no alteration to the array itself, but rather returns an edit script that must be applied. ``-ENOMEM`` is returned in the case of an out-of-memory error. The caller should lock exclusively against other modifiers of the array. h](h)}(h.Delete all objects from an associative array::h]h-Delete all objects from an associative array:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubji)}(h|struct assoc_array_edit * assoc_array_clear(struct assoc_array *array, const struct assoc_array_ops *ops);h]h|struct assoc_array_edit * assoc_array_clear(struct assoc_array *array, const struct assoc_array_ops *ops);}hj!sbah}(h]h ]h"]h$]h&]jxjyuh1jhhhhKhjubh)}(hVThis deletes all the objects from an associative array and leaves it completely empty.h]hVThis deletes all the objects from an associative array and leaves it completely empty.}(hj/hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubh)}(hThis function makes no alteration to the array itself, but rather returns an edit script that must be applied. ``-ENOMEM`` is returned in the case of an out-of-memory error.h](hpThis function makes no alteration to the array itself, but rather returns an edit script that must be applied. }(hj=hhhNhNubjO)}(h ``-ENOMEM``h]h-ENOMEM}(hjEhhhNhNubah}(h]h ]h"]h$]h&]uh1jNhj=ubh3 is returned in the case of an out-of-memory error.}(hj=hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjubh)}(hHThe caller should lock exclusively against other modifiers of the array.h]hHThe caller should lock exclusively against other modifiers of the array.}(hj]hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubeh}(h]h ]h"]h$]h&]uh1hhj hhhhhNubh)}(hXNDestroy an associative array, deleting all objects:: void assoc_array_destroy(struct assoc_array *array, const struct assoc_array_ops *ops); This destroys the contents of the associative array and leaves it completely empty. It is not permitted for another thread to be traversing the array under the RCU read lock at the same time as this function is destroying it as no RCU deferral is performed on memory release - something that would require memory to be allocated. The caller should lock exclusively against other modifiers and accessors of the array. h](h)}(h4Destroy an associative array, deleting all objects::h]h3Destroy an associative array, deleting all objects:}(hjuhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjqubji)}(hpvoid assoc_array_destroy(struct assoc_array *array, const struct assoc_array_ops *ops);h]hpvoid assoc_array_destroy(struct assoc_array *array, const struct assoc_array_ops *ops);}hjsbah}(h]h ]h"]h$]h&]jxjyuh1jhhhhKhjqubh)}(hXJThis destroys the contents of the associative array and leaves it completely empty. It is not permitted for another thread to be traversing the array under the RCU read lock at the same time as this function is destroying it as no RCU deferral is performed on memory release - something that would require memory to be allocated.h]hXJThis destroys the contents of the associative array and leaves it completely empty. It is not permitted for another thread to be traversing the array under the RCU read lock at the same time as this function is destroying it as no RCU deferral is performed on memory release - something that would require memory to be allocated.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjqubh)}(hVThe caller should lock exclusively against other modifiers and accessors of the array.h]hVThe caller should lock exclusively against other modifiers and accessors of the array.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjqubeh}(h]h ]h"]h$]h&]uh1hhj hhhhhNubh)}(hXUGarbage collect an associative array:: int assoc_array_gc(struct assoc_array *array, const struct assoc_array_ops *ops, bool (*iterator)(void *object, void *iterator_data), void *iterator_data); This iterates over the objects in an associative array and passes each one to ``iterator()``. If ``iterator()`` returns ``true``, the object is kept. If it returns ``false``, the object will be freed. If the ``iterator()`` function returns ``true``, it must perform any appropriate refcount incrementing on the object before returning. The internal tree will be packed down if possible as part of the iteration to reduce the number of nodes in it. The ``iterator_data`` is passed directly to ``iterator()`` and is otherwise ignored by the function. The function will return ``0`` if successful and ``-ENOMEM`` if there wasn't enough memory. It is possible for other threads to iterate over or search the array under the RCU read lock while this function is in progress. The caller should lock exclusively against other modifiers of the array. h](h)}(h&Garbage collect an associative array::h]h%Garbage collect an associative array:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubji)}(hint assoc_array_gc(struct assoc_array *array, const struct assoc_array_ops *ops, bool (*iterator)(void *object, void *iterator_data), void *iterator_data);h]hint assoc_array_gc(struct assoc_array *array, const struct assoc_array_ops *ops, bool (*iterator)(void *object, void *iterator_data), void *iterator_data);}hjsbah}(h]h ]h"]h$]h&]jxjyuh1jhhhhKhjubh)}(hXQThis iterates over the objects in an associative array and passes each one to ``iterator()``. If ``iterator()`` returns ``true``, the object is kept. If it returns ``false``, the object will be freed. If the ``iterator()`` function returns ``true``, it must perform any appropriate refcount incrementing on the object before returning.h](hNThis iterates over the objects in an associative array and passes each one to }(hjhhhNhNubjO)}(h``iterator()``h]h iterator()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jNhjubh. If }(hjhhhNhNubjO)}(h``iterator()``h]h iterator()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jNhjubh returns }(hjhhhNhNubjO)}(h``true``h]htrue}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jNhjubh$, the object is kept. If it returns }(hjhhhNhNubjO)}(h ``false``h]hfalse}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jNhjubh$, the object will be freed. If the }(hjhhhNhNubjO)}(h``iterator()``h]h iterator()}(hj#hhhNhNubah}(h]h ]h"]h$]h&]uh1jNhjubh function returns }(hjhhhNhNubjO)}(h``true``h]htrue}(hj5hhhNhNubah}(h]h ]h"]h$]h&]uh1jNhjubhW, it must perform any appropriate refcount incrementing on the object before returning.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjubh)}(hoThe internal tree will be packed down if possible as part of the iteration to reduce the number of nodes in it.h]hoThe internal tree will be packed down if possible as part of the iteration to reduce the number of nodes in it.}(hjMhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM hjubh)}(hdThe ``iterator_data`` is passed directly to ``iterator()`` and is otherwise ignored by the function.h](hThe }(hj[hhhNhNubjO)}(h``iterator_data``h]h iterator_data}(hjchhhNhNubah}(h]h ]h"]h$]h&]uh1jNhj[ubh is passed directly to }(hj[hhhNhNubjO)}(h``iterator()``h]h iterator()}(hjuhhhNhNubah}(h]h ]h"]h$]h&]uh1jNhj[ubh* and is otherwise ignored by the function.}(hj[hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM hjubh)}(h[The function will return ``0`` if successful and ``-ENOMEM`` if there wasn't enough memory.h](hThe function will return }(hjhhhNhNubjO)}(h``0``h]h0}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jNhjubh if successful and }(hjhhhNhNubjO)}(h ``-ENOMEM``h]h-ENOMEM}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jNhjubh! if there wasn’t enough memory.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjubh)}(hIt is possible for other threads to iterate over or search the array under the RCU read lock while this function is in progress. The caller should lock exclusively against other modifiers of the array.h]hIt is possible for other threads to iterate over or search the array under the RCU read lock while this function is in progress. The caller should lock exclusively against other modifiers of the array.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubeh}(h]h ]h"]h$]h&]uh1hhj hhhhhNubeh}(h]h ]h"]h$]h&]jjjhjjstartKuh1hhjhhhhhKubeh}(h]manipulation-functionsah ]h"]manipulation functionsah$]h&]uh1hhj5hhhhhKubh)}(hhh](h)}(hAccess Functionsh]hAccess Functions}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMubh)}(h;There are two functions for accessing an associative array:h]h;There are two functions for accessing an associative array:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hhh](h)}(hXIterate over all the objects in an associative array:: int assoc_array_iterate(const struct assoc_array *array, int (*iterator)(const void *object, void *iterator_data), void *iterator_data); This passes each object in the array to the iterator callback function. ``iterator_data`` is private data for that function. This may be used on an array at the same time as the array is being modified, provided the RCU read lock is held. Under such circumstances, it is possible for the iteration function to see some objects twice. If this is a problem, then modification should be locked against. The iteration algorithm should not, however, miss any objects. The function will return ``0`` if no objects were in the array or else it will return the result of the last iterator function called. Iteration stops immediately if any call to the iteration function results in a non-zero return. h](h)}(h6Iterate over all the objects in an associative array::h]h5Iterate over all the objects in an associative array:}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj ubji)}(hint assoc_array_iterate(const struct assoc_array *array, int (*iterator)(const void *object, void *iterator_data), void *iterator_data);h]hint assoc_array_iterate(const struct assoc_array *array, int (*iterator)(const void *object, void *iterator_data), void *iterator_data);}hj sbah}(h]h ]h"]h$]h&]jxjyuh1jhhhhMhj ubh)}(h|This passes each object in the array to the iterator callback function. ``iterator_data`` is private data for that function.h](hHThis passes each object in the array to the iterator callback function. }(hj$ hhhNhNubjO)}(h``iterator_data``h]h iterator_data}(hj, hhhNhNubah}(h]h ]h"]h$]h&]uh1jNhj$ ubh# is private data for that function.}(hj$ hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM$hj ubh)}(hXTThis may be used on an array at the same time as the array is being modified, provided the RCU read lock is held. Under such circumstances, it is possible for the iteration function to see some objects twice. If this is a problem, then modification should be locked against. The iteration algorithm should not, however, miss any objects.h]hXTThis may be used on an array at the same time as the array is being modified, provided the RCU read lock is held. Under such circumstances, it is possible for the iteration function to see some objects twice. If this is a problem, then modification should be locked against. The iteration algorithm should not, however, miss any objects.}(hjD hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM'hj ubh)}(hThe function will return ``0`` if no objects were in the array or else it will return the result of the last iterator function called. Iteration stops immediately if any call to the iteration function results in a non-zero return.h](hThe function will return }(hjR hhhNhNubjO)}(h``0``h]h0}(hjZ hhhNhNubah}(h]h ]h"]h$]h&]uh1jNhjR ubh if no objects were in the array or else it will return the result of the last iterator function called. Iteration stops immediately if any call to the iteration function results in a non-zero return.}(hjR hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM-hj ubeh}(h]h ]h"]h$]h&]uh1hhj hhhhhNubh)}(hX.Find an object in an associative array:: void *assoc_array_find(const struct assoc_array *array, const struct assoc_array_ops *ops, const void *index_key); This walks through the array's internal tree directly to the object specified by the index key. This may be used on an array at the same time as the array is being modified, provided the RCU read lock is held. The function will return the object if found (and set ``*_type`` to the object type) or will return ``NULL`` if the object was not found. h](h)}(h(Find an object in an associative array::h]h'Find an object in an associative array:}(hj| hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM3hjx ubji)}(hvoid *assoc_array_find(const struct assoc_array *array, const struct assoc_array_ops *ops, const void *index_key);h]hvoid *assoc_array_find(const struct assoc_array *array, const struct assoc_array_ops *ops, const void *index_key);}hj sbah}(h]h ]h"]h$]h&]jxjyuh1jhhhhM5hjx ubh)}(h_This walks through the array's internal tree directly to the object specified by the index key.h]haThis walks through the array’s internal tree directly to the object specified by the index key.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM9hjx ubh)}(hqThis may be used on an array at the same time as the array is being modified, provided the RCU read lock is held.h]hqThis may be used on an array at the same time as the array is being modified, provided the RCU read lock is held.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM<hjx ubh)}(hThe function will return the object if found (and set ``*_type`` to the object type) or will return ``NULL`` if the object was not found.h](h6The function will return the object if found (and set }(hj hhhNhNubjO)}(h ``*_type``h]h*_type}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jNhj ubh$ to the object type) or will return }(hj hhhNhNubjO)}(h``NULL``h]hNULL}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jNhj ubh if the object was not found.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM?hjx ubeh}(h]h ]h"]h$]h&]uh1hhj hhhhhNubeh}(h]h ]h"]h$]h&]jjjhjjuh1hhjhhhhhMubeh}(h]access-functionsah ]h"]access functionsah$]h&]uh1hhj5hhhhhMubh)}(hhh](h)}(hIndex Key Formh]hIndex Key Form}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj hhhhhMDubh)}(hThe index key can be of any form, but since the algorithms aren't told how long the key is, it is strongly recommended that the index key includes its length very early on before any variation due to the length would have an effect on comparisons.h]hThe index key can be of any form, but since the algorithms aren’t told how long the key is, it is strongly recommended that the index key includes its length very early on before any variation due to the length would have an effect on comparisons.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMFhj hhubh)}(hThis will cause leaves with different length keys to scatter away from each other - and those with the same length keys to cluster together.h]hThis will cause leaves with different length keys to scatter away from each other - and those with the same length keys to cluster together.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMKhj hhubh)}(h~It is also recommended that the index key begin with a hash of the rest of the key to maximise scattering throughout keyspace.h]h~It is also recommended that the index key begin with a hash of the rest of the key to maximise scattering throughout keyspace.}(hj' hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMNhj hhubh)}(hIThe better the scattering, the wider and lower the internal tree will be.h]hIThe better the scattering, the wider and lower the internal tree will be.}(hj5 hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMQhj hhubh)}(hPoor scattering isn't too much of a problem as there are shortcuts and nodes can contain mixtures of leaves and metadata pointers.h]hPoor scattering isn’t too much of a problem as there are shortcuts and nodes can contain mixtures of leaves and metadata pointers.}(hjC hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMShj hhubh)}(hX;The index key is read in chunks of machine word. Each chunk is subdivided into one nibble (4 bits) per level, so on a 32-bit CPU this is good for 8 levels and on a 64-bit CPU, 16 levels. Unless the scattering is really poor, it is unlikely that more than one word of any particular index key will have to be used.h]hX;The index key is read in chunks of machine word. Each chunk is subdivided into one nibble (4 bits) per level, so on a 32-bit CPU this is good for 8 levels and on a 64-bit CPU, 16 levels. Unless the scattering is really poor, it is unlikely that more than one word of any particular index key will have to be used.}(hjQ hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMVhj hhubeh}(h]index-key-formah ]h"]index key formah$]h&]uh1hhj5hhhhhMDubeh}(h]the-public-apiah ]h"]the public apiah$]h&]uh1hhhhhhhhK9ubh)}(hhh](h)}(hInternal Workingsh]hInternal Workings}(hjr hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjo hhhhhM^ubh)}(hThe associative array data structure has an internal tree. This tree is constructed of two types of metadata blocks: nodes and shortcuts.h]hThe associative array data structure has an internal tree. This tree is constructed of two types of metadata blocks: nodes and shortcuts.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM`hjo hhubh)}(hGA node is an array of slots. Each slot can contain one of four things:h]hGA node is an array of slots. Each slot can contain one of four things:}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMchjo hhubh bullet_list)}(hhh](h)}(h2A NULL pointer, indicating that the slot is empty.h]h)}(hj h]h2A NULL pointer, indicating that the slot is empty.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMehj ubah}(h]h ]h"]h$]h&]uh1hhj hhhhhNubh)}(h A pointer to an object (a leaf).h]h)}(hj h]h A pointer to an object (a leaf).}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMfhj ubah}(h]h ]h"]h$]h&]uh1hhj hhhhhNubh)}(h&A pointer to a node at the next level.h]h)}(hj h]h&A pointer to a node at the next level.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMghj ubah}(h]h ]h"]h$]h&]uh1hhj hhhhhNubh)}(hA pointer to a shortcut. h]h)}(hA pointer to a shortcut.h]hA pointer to a shortcut.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhhj ubah}(h]h ]h"]h$]h&]uh1hhj hhhhhNubeh}(h]h ]h"]h$]h&]bullet*uh1j hhhMehjo hhubh)}(hhh](h)}(hBasic Internal Tree Layouth]hBasic Internal Tree Layout}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj hhhhhMlubh)}(hIgnoring shortcuts for the moment, the nodes form a multilevel tree. The index key space is strictly subdivided by the nodes in the tree and nodes occur on fixed levels. For example::h]hIgnoring shortcuts for the moment, the nodes form a multilevel tree. The index key space is strictly subdivided by the nodes in the tree and nodes occur on fixed levels. For example:}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMnhj hhubji)}(hX$Level: 0 1 2 3 =============== =============== =============== =============== NODE D NODE B NODE C +------>+---+ +------>+---+ +------>+---+ | | 0 | NODE A | | 0 | | | 0 | | +---+ +---+ | +---+ | +---+ | : : | 0 | | : : | : : | +---+ +---+ | +---+ | +---+ | | f | | 1 |---+ | 3 |---+ | 7 |---+ +---+ +---+ +---+ +---+ : : : : | 8 |---+ +---+ +---+ +---+ | NODE E | e |---+ | f | : : +------>+---+ +---+ | +---+ +---+ | 0 | | f | | | f | +---+ +---+ | +---+ : : | NODE F +---+ +------>+---+ | f | | 0 | NODE G +---+ +---+ +------>+---+ : : | | 0 | +---+ | +---+ | 6 |---+ : : +---+ +---+ : : | f | +---+ +---+ | f | +---+h]hX$Level: 0 1 2 3 =============== =============== =============== =============== NODE D NODE B NODE C +------>+---+ +------>+---+ +------>+---+ | | 0 | NODE A | | 0 | | | 0 | | +---+ +---+ | +---+ | +---+ | : : | 0 | | : : | : : | +---+ +---+ | +---+ | +---+ | | f | | 1 |---+ | 3 |---+ | 7 |---+ +---+ +---+ +---+ +---+ : : : : | 8 |---+ +---+ +---+ +---+ | NODE E | e |---+ | f | : : +------>+---+ +---+ | +---+ +---+ | 0 | | f | | | f | +---+ +---+ | +---+ : : | NODE F +---+ +------>+---+ | f | | 0 | NODE G +---+ +---+ +------>+---+ : : | | 0 | +---+ | +---+ | 6 |---+ : : +---+ +---+ : : | f | +---+ +---+ | f | +---+}hj% sbah}(h]h ]h"]h$]h&]jxjyuh1jhhhhMrhj hhubh)}(hIn the above example, there are 7 nodes (A-G), each with 16 slots (0-f). Assuming no other meta data nodes in the tree, the key space is divided thusly:h]hIn the above example, there are 7 nodes (A-G), each with 16 slots (0-f). Assuming no other meta data nodes in the tree, the key space is divided thusly:}(hj3 hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj hhubh block_quote)}(h=========== ==== KEY PREFIX NODE =========== ==== 137* D 138* E 13[0-69-f]* C 1[0-24-f]* B e6* G e[0-57-f]* F [02-df]* A =========== ==== h]htable)}(hhh]htgroup)}(hhh](hcolspec)}(hhh]h}(h]h ]h"]h$]h&]colwidthK uh1jQ hjN ubjR )}(hhh]h}(h]h ]h"]h$]h&]colwidthKuh1jQ hjN ubhthead)}(hhh]hrow)}(hhh](hentry)}(hhh]h)}(h KEY PREFIXh]h KEY PREFIX}(hjv hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjs ubah}(h]h ]h"]h$]h&]uh1jq hjn ubjr )}(hhh]h)}(hNODEh]hNODE}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj ubah}(h]h ]h"]h$]h&]uh1jq hjn ubeh}(h]h ]h"]h$]h&]uh1jl hji ubah}(h]h ]h"]h$]h&]uh1jg hjN ubhtbody)}(hhh](jm )}(hhh](jr )}(hhh]h)}(h137*h]h137*}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj ubah}(h]h ]h"]h$]h&]uh1jq hj ubjr )}(hhh]h)}(hDh]hD}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj ubah}(h]h ]h"]h$]h&]uh1jq hj ubeh}(h]h ]h"]h$]h&]uh1jl hj ubjm )}(hhh](jr )}(hhh]h)}(h138*h]h138*}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj ubah}(h]h ]h"]h$]h&]uh1jq hj ubjr )}(hhh]h)}(hEh]hE}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj ubah}(h]h ]h"]h$]h&]uh1jq hj ubeh}(h]h ]h"]h$]h&]uh1jl hj ubjm )}(hhh](jr )}(hhh]h)}(h 13[0-69-f]*h]h 13[0-69-f]*}(hj& hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj# ubah}(h]h ]h"]h$]h&]uh1jq hj ubjr )}(hhh]h)}(hCh]hC}(hj= hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj: ubah}(h]h ]h"]h$]h&]uh1jq hj ubeh}(h]h ]h"]h$]h&]uh1jl hj ubjm )}(hhh](jr )}(hhh]h)}(h 1[0-24-f]*h]h 1[0-24-f]*}(hj] hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjZ ubah}(h]h ]h"]h$]h&]uh1jq hjW ubjr )}(hhh]h)}(hBh]hB}(hjt hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjq ubah}(h]h ]h"]h$]h&]uh1jq hjW ubeh}(h]h ]h"]h$]h&]uh1jl hj ubjm )}(hhh](jr )}(hhh]h)}(he6*h]he6*}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj ubah}(h]h ]h"]h$]h&]uh1jq hj ubjr )}(hhh]h)}(hGh]hG}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj ubah}(h]h ]h"]h$]h&]uh1jq hj ubeh}(h]h ]h"]h$]h&]uh1jl hj ubjm )}(hhh](jr )}(hhh]h)}(h e[0-57-f]*h]h e[0-57-f]*}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj ubah}(h]h ]h"]h$]h&]uh1jq hj ubjr )}(hhh]h)}(hFh]hF}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj ubah}(h]h ]h"]h$]h&]uh1jq hj ubeh}(h]h ]h"]h$]h&]uh1jl hj ubjm )}(hhh](jr )}(hhh]h)}(h[02-df]*h]h[02-df]*}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj ubah}(h]h ]h"]h$]h&]uh1jq hj ubjr )}(hhh]h)}(hAh]hA}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj ubah}(h]h ]h"]h$]h&]uh1jq hj ubeh}(h]h ]h"]h$]h&]uh1jl hj ubeh}(h]h ]h"]h$]h&]uh1j hjN ubeh}(h]h ]h"]h$]h&]colsKuh1jL hjI ubah}(h]h ]h"]h$]h&]uh1jG hjC ubah}(h]h ]h"]h$]h&]uh1jA hhhMhj hhubh)}(hdSo, for instance, keys with the following example index keys will be found in the appropriate nodes:h]hdSo, for instance, keys with the following example index keys will be found in the appropriate nodes:}(hjL hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj hhubjB )}(hX=============== ======= ==== INDEX KEY PREFIX NODE =============== ======= ==== 13694892892489 13 C 13795289025897 137 D 13889dde88793 138 E 138bbb89003093 138 E 1394879524789 12 C 1458952489 1 B 9431809de993ba \- A b4542910809cd \- A e5284310def98 e F e68428974237 e6 G e7fffcbd443 e F f3842239082 \- A =============== ======= ==== h]jH )}(hhh]jM )}(hhh](jR )}(hhh]h}(h]h ]h"]h$]h&]colwidthKuh1jQ hja ubjR )}(hhh]h}(h]h ]h"]h$]h&]colwidthKuh1jQ hja ubjR )}(hhh]h}(h]h ]h"]h$]h&]colwidthKuh1jQ hja ubjh )}(hhh]jm )}(hhh](jr )}(hhh]h)}(h INDEX KEYh]h INDEX KEY}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj ubah}(h]h ]h"]h$]h&]uh1jq hj ubjr )}(hhh]h)}(hPREFIXh]hPREFIX}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj ubah}(h]h ]h"]h$]h&]uh1jq hj ubjr )}(hhh]h)}(hNODEh]hNODE}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj ubah}(h]h ]h"]h$]h&]uh1jq hj ubeh}(h]h ]h"]h$]h&]uh1jl hj ubah}(h]h ]h"]h$]h&]uh1jg hja ubj )}(hhh](jm )}(hhh](jr )}(hhh]h)}(h13694892892489h]h13694892892489}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj ubah}(h]h ]h"]h$]h&]uh1jq hj ubjr )}(hhh]h)}(h13h]h13}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj ubah}(h]h ]h"]h$]h&]uh1jq hj ubjr )}(hhh]h)}(hj? h]hC}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj ubah}(h]h ]h"]h$]h&]uh1jq hj ubeh}(h]h ]h"]h$]h&]uh1jl hj ubjm )}(hhh](jr )}(hhh]h)}(h13795289025897h]h13795289025897}(hj/hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj,ubah}(h]h ]h"]h$]h&]uh1jq hj)ubjr )}(hhh]h)}(h137h]h137}(hjFhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjCubah}(h]h ]h"]h$]h&]uh1jq hj)ubjr )}(hhh]h)}(hj h]hD}(hj]hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjZubah}(h]h ]h"]h$]h&]uh1jq hj)ubeh}(h]h ]h"]h$]h&]uh1jl hj ubjm )}(hhh](jr )}(hhh]h)}(h 13889dde88793h]h 13889dde88793}(hj|hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjyuba|h}(h]h ]h"]h$]h&]uh1jq hjvubjr )}(hhh]h)}(h138h]h138}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jq hjvubjr )}(hhh]h)}(hj h]hE}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jq hjvubeh}(h]h ]h"]h$]h&]uh1jl hj ubjm )}(hhh](jr )}(hhh]h)}(h138bbb89003093h]h138bbb89003093}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jq hjubjr )}(hhh]h)}(h138h]h138}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jq hjubjr )}(hhh]h)}(hj h]hE}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jq hjubeh}(h]h ]h"]h$]h&]uh1jl hj ubjm )}(hhh](jr )}(hhh]h)}(h 1394879524789h]h 1394879524789}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jq hjubjr )}(hhh]h)}(h12h]h12}(hj-hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj*ubah}(h]h ]h"]h$]h&]uh1jq hjubjr )}(hhh]h)}(hj? h]hC}(hjDhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjAubah}(h]h ]h"]h$]h&]uh1jq hjubeh}(h]h ]h"]h$]h&]uh1jl hj ubjm )}(hhh](jr )}(hhh]h)}(h 1458952489h]h 1458952489}(hjchhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj`ubah}(h]h ]h"]h$]h&]uh1jq hj]ubjr )}(hhh]h)}(h1h]h1}(hjzhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjwubah}(h]h ]h"]h$]h&]uh1jq hj]ubjr )}(hhh]h)}(hjv h]hB}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jq hj]ubeh}(h]h ]h"]h$]h&]uh1jl hj ubjm )}(hhh](jr )}(hhh]h)}(h9431809de993bah]h9431809de993ba}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jq hjubjr )}(hhh]h)}(h\-h]h-}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jq hjubjr )}(hhh]h)}(hj h]hA}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jq hjubeh}(h]h ]h"]h$]h&]uh1jl hj ubjm )}(hhh](jr )}(hhh]h)}(h b4542910809cdh]h b4542910809cd}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jq hjubjr )}(hhh]h)}(h\-h]h-}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jq hjubjr )}(hhh]h)}(hj h]hA}(hj+hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj(ubah}(h]h ]h"]h$]h&]uh1jq hjubeh}(h]h ]h"]h$]h&]uh1jl hj ubjm )}(hhh](jr )}(hhh]h)}(h e5284310def98h]h e5284310def98}(hjJhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjGubah}(h]h ]h"]h$]h&]uh1jq hjDubjr )}(hhh]h)}(heh]he}(hjahhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj^ubah}(h]h ]h"]h$]h&]uh1jq hjDubjr )}(hhh]h)}(hj h]hF}(hjxhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjuubah}(h]h ]h"]h$]h&]uh1jq hjDubeh}(h]h ]h"]h$]h&]uh1jl hj ubjm )}(hhh](jr )}(hhh]h)}(h e68428974237h]h e68428974237}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jq hjubjr )}(hhh]h)}(he6h]he6}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jq hjubjr )}(hhh]h)}(hj h]hG}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jq hjubeh}(h]h ]h"]h$]h&]uh1jl hj ubjm )}(hhh](jr )}(hhh]h)}(h e7fffcbd443h]h e7fffcbd443}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jq hjubjr )}(hhh]h)}(hjch]he}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jq hjubjr )}(hhh]h)}(hj h]hF}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jq hjubeh}(h]h ]h"]h$]h&]uh1jl hj ubjm )}(hhh](jr )}(hhh]h)}(h f3842239082h]h f3842239082}(hj0hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj-ubah}(h]h ]h"]h$]h&]uh1jq hj*ubjr )}(hhh]h)}(h\-h]h-}(hjGhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjDubah}(h]h ]h"]h$]h&]uh1jq hj*ubjr )}(hhh]h)}(hj h]hA}(hj^hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj[ubah}(h]h ]h"]h$]h&]uh1jq hj*ubeh}(h]h ]h"]h$]h&]uh1jl hj ubeh}(h]h ]h"]h$]h&]uh1j hja ubeh}(h]h ]h"]h$]h&]colsKuh1jL hj^ ubah}(h]h ]h"]h$]h&]uh1jG hjZ ubah}(h]h ]h"]h$]h&]uh1jA hhhMhj hhubh)}(hTo save memory, if a node can hold all the leaves in its portion of keyspace, then the node will have all those leaves in it and will not have any metadata pointers - even if some of those leaves would like to be in the same slot.h]hTo save memory, if a node can hold all the leaves in its portion of keyspace, then the node will have all those leaves in it and will not have any metadata pointers - even if some of those leaves would like to be in the same slot.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj hhubh)}(hXA node can contain a heterogeneous mix of leaves and metadata pointers. Metadata pointers must be in the slots that match their subdivisions of key space. The leaves can be in any slot not occupied by a metadata pointer. It is guaranteed that none of the leaves in a node will match a slot occupied by a metadata pointer. If the metadata pointer is there, any leaf whose key matches the metadata key prefix must be in the subtree that the metadata pointer points to.h]hXA node can contain a heterogeneous mix of leaves and metadata pointers. Metadata pointers must be in the slots that match their subdivisions of key space. The leaves can be in any slot not occupied by a metadata pointer. It is guaranteed that none of the leaves in a node will match a slot occupied by a metadata pointer. If the metadata pointer is there, any leaf whose key matches the metadata key prefix must be in the subtree that the metadata pointer points to.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj hhubh)}(h=In the above example list of index keys, node A will contain:h]h=In the above example list of index keys, node A will contain:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj hhubjB )}(hXS==== =============== ================== SLOT CONTENT INDEX KEY (PREFIX) ==== =============== ================== 1 PTR TO NODE B 1* any LEAF 9431809de993ba any LEAF b4542910809cd e PTR TO NODE F e* any LEAF f3842239082 ==== =============== ================== h]jH )}(hhh]jM )}(hhh](jR )}(hhh]h}(h]h ]h"]h$]h&]colwidthKuh1jQ hjubjR )}(hhh]h}(h]h ]h"]h$]h&]colwidthKuh1jQ hjubjR )}(hhh]h}(h]h ]h"]h$]h&]colwidthKuh1jQ hjubjh )}(hhh]jm )}(hhh](jr )}(hhh]h)}(hSLOTh]hSLOT}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jq hjubjr )}(hhh]h)}(hCONTENTh]hCONTENT}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jq hjubjr )}(hhh]h)}(hINDEX KEY (PREFIX)h]hINDEX KEY (PREFIX)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jq hjubeh}(h]h ]h"]h$]h&]uh1jl hjubah}(h]h ]h"]h$]h&]uh1jg hjubj )}(hhh](jm )}(hhh](jr )}(hhh]h)}(hj|h]h1}(hjBhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj?ubah}(h]h ]h"]h$]h&]uh1jq hj<ubjr )}(hhh]h)}(h PTR TO NODE Bh]h PTR TO NODE B}(hjXhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjUubah}(h]h ]h"]h$]h&]uh1jq hj<ubjr )}(hhh]h)}(h1*h]h1*}(hjohhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjlubah}(h]h ]h"]h$]h&]uh1jq hj<ubeh}(h]h ]h"]h$]h&]uh1jl hj9ubjm )}(hhh](jr )}(hhh]h)}(hanyh]hany}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jq hjubjr )}(hhh]h)}(hLEAFh]hLEAF}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jq hjubjr )}(hhh]h)}(h9431809de993bah]h9431809de993ba}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jq hjubeh}(h]h ]h"]h$]h&]uh1jl hj9ubjm )}(hhh](jr )}(hhh]h)}(hanyh]hany}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jq hjubjr )}(hhh]h)}(hLEAFh]hLEAF}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jq hjubjr )}(hhh]h)}(h b4542910809cdh]h b4542910809cd}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jq hjubeh}(h]h ]h"]h$]h&]uh1jl hj9ubjm )}(hhh](jr )}(hhh]h)}(hjch]he}(hj+hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj(ubah}(h]h ]h"]h$]h&]uh1jq hj%ubjr )}(hhh]h)}(h PTR TO NODE Fh]h PTR TO NODE F}(hjAhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj>ubah}(h]h ]h"]h$]h&]uh1jq hj%ubjr )}(hhh]h)}(he*h]he*}(hjXhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjUubah}(h]h ]h"]h$]h&]uh1jq hj%ubeh}(h]h ]h"]h$]h&]uh1jl hj9ubjm )}(hhh](jr )}(hhh]h)}(hanyh]hany}(hjxhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjuubah}(h]h ]h"]h$]h&]uh1jq hjrubjr )}(hhh]h)}(hLEAFh]hLEAF}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jq hjrubjr )}(hhh]h)}(h f3842239082h]h f3842239082}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jq hjrubeh}(h]h ]h"]h$]h&]uh1jl hj9ubeh}(h]h ]h"]h$]h&]uh1j hjubeh}(h]h ]h"]h$]h&]colsKuh1jL hjubah}(h]h ]h"]h$]h&]uh1jG hjubah}(h]h ]h"]h$]h&]uh1jA hhhMhj hhubh)}(h and node B:h]h and node B:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj hhubjB )}(h==== =============== ================== SLOT CONTENT INDEX KEY (PREFIX) ==== =============== ================== 3 PTR TO NODE C 13* any LEAF 1458952489 ==== =============== ================== h]jH )}(hhh]jM )}(hhh](jR )}(hhh]h}(h]h ]h"]h$]h&]colwidthKuh1jQ hjubjR )}(hhh]h}(h]h ]h"]h$]h&]colwidthKuh1jQ hjubjR )}(hhh]h}(h]h ]h"]h$]h&]colwidthKuh1jQ hjubjh )}(hhh]jm )}(hhh](jr )}(hhh]h)}(hSLOTh]hSLOT}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jq hjubjr )}(hhh]h)}(hCONTENTh]hCONTENT}(hj/hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj,ubah}(h]h ]h"]h$]h&]uh1jq hjubjr )}(hhh]h)}(hINDEX KEY (PREFIX)h]hINDEX KEY (PREFIX)}(hjFhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjCubah}(h]h ]h"]h$]h&]uh1jq hjubeh}(h]h ]h"]h$]h&]uh1jl hjubah}(h]h ]h"]h$]h&]uh1jg hjubj )}(hhh](jm )}(hhh](jr )}(hhh]h)}(h3h]h3}(hjohhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjlubah}(h]h ]h"]h$]h&]uh1jq hjiubjr )}(hhh]h)}(h PTR TO NODE Ch]h PTR TO NODE C}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jq hjiubjr )}(hhh]h)}(h13*h]h13*}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jq hjiubeh}(h]h ]h"]h$]h&]uh1jl hjfubjm )}(hhh](jr )}(hhh]h)}(hanyh]hany}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jq hjubjr )}(hhh]h)}(hLEAFh]hLEAF}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jq hjubjr )}(hhh]h)}(h 1458952489h]h 1458952489}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jq hjubeh}(h]h ]h"]h$]h&]uh1jl hjfubeh}(h]h ]h"]h$]h&]uh1j hjubeh}(h]h ]h"]h$]h&]colsKuh1jL hjubah}(h]h ]h"]h$]h&]uh1jG hjubah}(h]h ]h"]h$]h&]uh1jA hhhMhj hhubeh}(h]basic-internal-tree-layoutah ]h"]basic internal tree layoutah$]h&]uh1hhjo hhhhhMlubh)}(hhh](h)}(h Shortcutsh]h Shortcuts}(hj)hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj&hhhhhMubh)}(hShortcuts are metadata records that jump over a piece of keyspace. A shortcut is a replacement for a series of single-occupancy nodes ascending through the levels. Shortcuts exist to save memory and to speed up traversal.h]hShortcuts are metadata records that jump over a piece of keyspace. A shortcut is a replacement for a series of single-occupancy nodes ascending through the levels. Shortcuts exist to save memory and to speed up traversal.}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj&hhubh)}(hX6It is possible for the root of the tree to be a shortcut - say, for example, the tree contains at least 17 nodes all with key prefix ``1111``. The insertion algorithm will insert a shortcut to skip over the ``1111`` keyspace in a single bound and get to the fourth level where these actually become different.h](hIt is possible for the root of the tree to be a shortcut - say, for example, the tree contains at least 17 nodes all with key prefix }(hjEhhhNhNubjO)}(h``1111``h]h1111}(hjMhhhNhNubah}(h]h ]h"]h$]h&]uh1jNhjEubhC. The insertion algorithm will insert a shortcut to skip over the }(hjEhhhNhNubjO)}(h``1111``h]h1111}(hj_hhhNhNubah}(h]h ]h"]h$]h&]uh1jNhjEubh^ keyspace in a single bound and get to the fourth level where these actually become different.}(hjEhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhj&hhubeh}(h] shortcutsah ]h"] shortcutsah$]h&]uh1hhjo hhhhhMubh)}(hhh](h)}(hSplitting And Collapsing Nodesh]hSplitting And Collapsing Nodes}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMubh)}(hXKEach node has a maximum capacity of 16 leaves and metadata pointers. If the insertion algorithm finds that it is trying to insert a 17th object into a node, that node will be split such that at least two leaves that have a common key segment at that level end up in a separate node rooted on that slot for that common key segment.h]hXKEach node has a maximum capacity of 16 leaves and metadata pointers. If the insertion algorithm finds that it is trying to insert a 17th object into a node, that node will be split such that at least two leaves that have a common key segment at that level end up in a separate node rooted on that slot for that common key segment.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hIf the leaves in a full node and the leaf that is being inserted are sufficiently similar, then a shortcut will be inserted into the tree.h]hIf the leaves in a full node and the leaf that is being inserted are sufficiently similar, then a shortcut will be inserted into the tree.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hWhen the number of objects in the subtree rooted at a node falls to 16 or fewer, then the subtree will be collapsed down to a single node - and this will ripple towards the root if possible.h]hWhen the number of objects in the subtree rooted at a node falls to 16 or fewer, then the subtree will be collapsed down to a single node - and this will ripple towards the root if possible.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubeh}(h]splitting-and-collapsing-nodesah ]h"]splitting and collapsing nodesah$]h&]uh1hhjo hhhhhMubh)}(hhh](h)}(hNon-Recursive Iterationh]hNon-Recursive Iteration}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMubh)}(hX"Each node and shortcut contains a back pointer to its parent and the number of slot in that parent that points to it. None-recursive iteration uses these to proceed rootwards through the tree, going to the parent node, slot N + 1 to make sure progress is made without the need for a stack.h]hX"Each node and shortcut contains a back pointer to its parent and the number of slot in that parent that points to it. None-recursive iteration uses these to proceed rootwards through the tree, going to the parent node, slot N + 1 to make sure progress is made without the need for a stack.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hMThe backpointers, however, make simultaneous alteration and iteration tricky.h]hMThe backpointers, however, make simultaneous alteration and iteration tricky.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubeh}(h]non-recursive-iterationah ]h"]non-recursive iterationah$]h&]uh1hhjo hhhhhMubh)}(hhh](h)}(h%Simultaneous Alteration And Iterationh]h%Simultaneous Alteration And Iteration}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMubh)}(h(There are a number of cases to consider:h]h(There are a number of cases to consider:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hhh](h)}(hSimple insert/replace. This involves simply replacing a NULL or old matching leaf pointer with the pointer to the new leaf after a barrier. The metadata blocks don't change otherwise. An old leaf won't be freed until after the RCU grace period. h]h)}(hSimple insert/replace. This involves simply replacing a NULL or old matching leaf pointer with the pointer to the new leaf after a barrier. The metadata blocks don't change otherwise. An old leaf won't be freed until after the RCU grace period.h]hSimple insert/replace. This involves simply replacing a NULL or old matching leaf pointer with the pointer to the new leaf after a barrier. The metadata blocks don’t change otherwise. An old leaf won’t be freed until after the RCU grace period.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1hhjhhhhhNubh)}(hSimple delete. This involves just clearing an old matching leaf. The metadata blocks don't change otherwise. The old leaf won't be freed until after the RCU grace period. h]h)}(hSimple delete. This involves just clearing an old matching leaf. The metadata blocks don't change otherwise. The old leaf won't be freed until after the RCU grace period.h]hSimple delete. This involves just clearing an old matching leaf. The metadata blocks don’t change otherwise. The old leaf won’t be freed until after the RCU grace period.}(hj5hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM hj1ubah}(h]h ]h"]h$]h&]uh1hhjhhhhhNubh)}(hXInsertion replacing part of a subtree that we haven't yet entered. This may involve replacement of part of that subtree - but that won't affect the iteration as we won't have reached the pointer to it yet and the ancestry blocks are not replaced (the layout of those does not change). h]h)}(hXInsertion replacing part of a subtree that we haven't yet entered. This may involve replacement of part of that subtree - but that won't affect the iteration as we won't have reached the pointer to it yet and the ancestry blocks are not replaced (the layout of those does not change).h]hX#Insertion replacing part of a subtree that we haven’t yet entered. This may involve replacement of part of that subtree - but that won’t affect the iteration as we won’t have reached the pointer to it yet and the ancestry blocks are not replaced (the layout of those does not change).}(hjMhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjIubah}(h]h ]h"]h$]h&]uh1hhjhhhhhNubh)}(hXInsertion replacing nodes that we're actively processing. This isn't a problem as we've passed the anchoring pointer and won't switch onto the new layout until we follow the back pointers - at which point we've already examined the leaves in the replaced node (we iterate over all the leaves in a node before following any of its metadata pointers). We might, however, re-see some leaves that have been split out into a new branch that's in a slot further along than we were at. h](h)}(hX^Insertion replacing nodes that we're actively processing. This isn't a problem as we've passed the anchoring pointer and won't switch onto the new layout until we follow the back pointers - at which point we've already examined the leaves in the replaced node (we iterate over all the leaves in a node before following any of its metadata pointers).h]hXhInsertion replacing nodes that we’re actively processing. This isn’t a problem as we’ve passed the anchoring pointer and won’t switch onto the new layout until we follow the back pointers - at which point we’ve already examined the leaves in the replaced node (we iterate over all the leaves in a node before following any of its metadata pointers).}(hjehhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjaubh)}(hWe might, however, re-see some leaves that have been split out into a new branch that's in a slot further along than we were at.h]hWe might, however, re-see some leaves that have been split out into a new branch that’s in a slot further along than we were at.}(hjshhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjaubeh}(h]h ]h"]h$]h&]uh1hhjhhhhhNubh)}(hInsertion replacing nodes that we're processing a dependent branch of. This won't affect us until we follow the back pointers. Similar to (4). h]h)}(hInsertion replacing nodes that we're processing a dependent branch of. This won't affect us until we follow the back pointers. Similar to (4).h]hInsertion replacing nodes that we’re processing a dependent branch of. This won’t affect us until we follow the back pointers. Similar to (4).}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1hhjhhhhhNubh)}(hXUDeletion collapsing a branch under us. This doesn't affect us because the back pointers will get us back to the parent of the new node before we could see the new node. The entire collapsed subtree is thrown away unchanged - and will still be rooted on the same slot, so we shouldn't process it a second time as we'll go back to slot + 1. h]h)}(hXTDeletion collapsing a branch under us. This doesn't affect us because the back pointers will get us back to the parent of the new node before we could see the new node. The entire collapsed subtree is thrown away unchanged - and will still be rooted on the same slot, so we shouldn't process it a second time as we'll go back to slot + 1.h]hXZDeletion collapsing a branch under us. This doesn’t affect us because the back pointers will get us back to the parent of the new node before we could see the new node. The entire collapsed subtree is thrown away unchanged - and will still be rooted on the same slot, so we shouldn’t process it a second time as we’ll go back to slot + 1.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1hhjhhhhhNubeh}(h]h ]h"]h$]h&]jjjhjjuh1hhjhhhhhMubj)}(hXxUnder some circumstances, we need to simultaneously change the parent pointer and the parent slot pointer on a node (say, for example, we inserted another node before it and moved it up a level). We cannot do this without locking against a read - so we have to replace that node too. However, when we're changing a shortcut into a node this isn't a problem as shortcuts only have one slot and so the parent slot number isn't used when traversing backwards over one. This means that it's okay to change the slot number first - provided suitable barriers are used to make sure the parent slot number is read after the back pointer.h](h)}(hXUnder some circumstances, we need to simultaneously change the parent pointer and the parent slot pointer on a node (say, for example, we inserted another node before it and moved it up a level). We cannot do this without locking against a read - so we have to replace that node too.h]hXUnder some circumstances, we need to simultaneously change the parent pointer and the parent slot pointer on a node (say, for example, we inserted another node before it and moved it up a level). We cannot do this without locking against a read - so we have to replace that node too.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM'hjubh)}(hXZHowever, when we're changing a shortcut into a node this isn't a problem as shortcuts only have one slot and so the parent slot number isn't used when traversing backwards over one. This means that it's okay to change the slot number first - provided suitable barriers are used to make sure the parent slot number is read after the back pointer.h]hXbHowever, when we’re changing a shortcut into a node this isn’t a problem as shortcuts only have one slot and so the parent slot number isn’t used when traversing backwards over one. This means that it’s okay to change the slot number first - provided suitable barriers are used to make sure the parent slot number is read after the back pointer.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM,hjubeh}(h]h ]h"]h$]h&]uh1jhjhhhhhNubh)}(hObsolete blocks and leaves are freed up after an RCU grace period has passed, so as long as anyone doing walking or iteration holds the RCU read lock, the old superstructure should not go away on them.h]hObsolete blocks and leaves are freed up after an RCU grace period has passed, so as long as anyone doing walking or iteration holds the RCU read lock, the old superstructure should not go away on them.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM2hjhhubeh}(h]%simultaneous-alteration-and-iterationah ]h"]%simultaneous alteration and iterationah$]h&]uh1hhjo hhhhhMubeh}(h]internal-workingsah ]h"]internal workingsah$]h&]uh1hhhhhhhhM^ubeh}(h](generic-associative-array-implementationah ]h"](generic associative array implementationah$]h&]uh1hhhhhhhhKubeh}(h]h ]h"]h$]h&]sourcehuh1hcurrent_sourceN current_lineNsettingsdocutils.frontendValues)}(hN generatorN datestampN source_linkN source_urlN toc_backlinksjq footnote_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_handlerj+error_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}(jjj2j/jl ji jjjjjjj j jd ja jjj#j j|jyjjjjjju nametypes}(jj2jl jjjj jd jj#j|jjjuh}(jhj/hji j5jjjjjjj jja j jjo j j jyj&jjjjjju footnote_refs} citation_refs} autofootnotes]autofootnote_refs]symbol_footnotes]symbol_footnote_refs] footnotes] citations]autofootnote_startKsymbol_footnote_startK id_counter collectionsCounter}Rparse_messages]hsystem_message)}(hhh]h)}(h:Enumerated list start value not ordinal-1: "4" (ordinal 4)h]h>Enumerated list start value not ordinal-1: “4” (ordinal 4)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]levelKtypeINFOsourcehʌlineKuh1jhjhhhhhKubatransform_messages] transformerN include_log] decorationNhhub.