€•      Œsphinx.addnodes”Œdocument”“”)”}”(Œ	rawsource”Œ ”Œchildren”]”(Œtranslations”ŒLanguagesNode”“”)”}”(hhh]”(h Œpending_xref”“”)”}”(hhh]”Œdocutils.nodes”ŒText”“”ŒChinese (Simplified)”…””}”Œparent”hsbaŒ
attributes”}”(Œids”]”Œclasses”]”Œnames”]”Œdupnames”]”Œbackrefs”]”Œ	refdomain”Œstd”Œreftype”Œdoc”Œ	reftarget”Œ,/translations/zh_CN/trace/ring-buffer-design”Œmodname”NŒ	classname”NŒrefexplicit”ˆuŒtagname”hhhubh)”}”(hhh]”hŒChinese (Traditional)”…””}”hh2sbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ,/translations/zh_TW/trace/ring-buffer-design”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒItalian”…””}”hhFsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ,/translations/it_IT/trace/ring-buffer-design”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒJapanese”…””}”hhZsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ,/translations/ja_JP/trace/ring-buffer-design”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒKorean”…””}”hhnsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ,/translations/ko_KR/trace/ring-buffer-design”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒSpanish”…””}”hh‚sbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ,/translations/sp_SP/trace/ring-buffer-design”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubeh}”(h]”h ]”h"]”h$]”h&]”Œcurrent_language”ŒEnglish”uh1h
hhŒ	_document”hŒsource”NŒline”NubhŒcomment”“”)”}”(hŒ?SPDX-License-Identifier: GPL-2.0 OR GFDL-1.2-no-invariants-only”h]”hŒ?SPDX-License-Identifier: GPL-2.0 OR GFDL-1.2-no-invariants-only”…””}”hh£sbah}”(h]”h ]”h"]”h$]”h&]”Œ	xml:space”Œpreserve”uh1h¡hhhžhhŸŒF/var/lib/git/docbuild/linux/Documentation/trace/ring-buffer-design.rst”h KubhŒsection”“”)”}”(hhh]”(hŒtitle”“”)”}”(hŒLockless Ring Buffer Design”h]”hŒLockless Ring Buffer Design”…””}”(hh»hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hh¶hžhhŸh³h KubhŒ	paragraph”“”)”}”(hŒCopyright 2009 Red Hat Inc.”h]”hŒCopyright 2009 Red Hat Inc.”…””}”(hhËhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Khh¶hžhubhŒ
field_list”“”)”}”(hhh]”(hŒfield”“”)”}”(hhh]”(hŒ
field_name”“”)”}”(hŒAuthor”h]”hŒAuthor”…””}”(hhåhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hãhhàhŸh³h K ubhŒ
field_body”“”)”}”(hŒ$Steven Rostedt <srostedt@redhat.com>”h]”hÊ)”}”(hh÷h]”(hŒSteven Rostedt <”…””}”(hhùhžhhŸNh NubhŒ	reference”“”)”}”(hŒsrostedt@redhat.com”h]”hŒsrostedt@redhat.com”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”Œrefuri”Œmailto:srostedt@redhat.com”uh1j   hhùubhŒ>”…””}”(hhùhžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K	hhõubah}”(h]”h ]”h"]”h$]”h&]”uh1hóhhàubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÞhŸh³h K	hhÛhžhubhß)”}”(hhh]”(hä)”}”(hŒLicense”h]”hŒLicense”…””}”(hj+  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hãhj(  hŸh³h K ubhô)”}”(hŒPThe GNU Free Documentation License, Version 1.2
(dual licensed under the GPL v2)”h]”hÊ)”}”(hŒPThe GNU Free Documentation License, Version 1.2
(dual licensed under the GPL v2)”h]”hŒPThe GNU Free Documentation License, Version 1.2
(dual licensed under the GPL v2)”…””}”(hj=  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K
hj9  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hóhj(  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÞhŸh³h K
hhÛhžhubhß)”}”(hhh]”(hä)”}”(hŒ	Reviewers”h]”hŒ	Reviewers”…””}”(hjZ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hãhjW  hŸh³h K ubhô)”}”(hŒIMathieu Desnoyers, Huang Ying, Hidetoshi Seto,
and Frederic Weisbecker.

”h]”hÊ)”}”(hŒGMathieu Desnoyers, Huang Ying, Hidetoshi Seto,
and Frederic Weisbecker.”h]”hŒGMathieu Desnoyers, Huang Ying, Hidetoshi Seto,
and Frederic Weisbecker.”…””}”(hjl  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Khjh  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hóhjW  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÞhŸh³h KhhÛhžhubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÙhh¶hžhhŸh³h K	ubhÊ)”}”(hŒWritten for: 2.6.31”h]”hŒWritten for: 2.6.31”…””}”(hjŒ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Khh¶hžhubhµ)”}”(hhh]”(hº)”}”(hŒ!Terminology used in this Document”h]”hŒ!Terminology used in this Document”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hjš  hžhhŸh³h KubhŒdefinition_list”“”)”}”(hhh]”(hŒdefinition_list_item”“”)”}”(hŒ3tail
- where new writes happen in the ring buffer.
”h]”(hŒterm”“”)”}”(hŒtail”h]”hŒtail”…””}”(hj¸  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j¶  hŸh³h Khj²  ubhŒ
definition”“”)”}”(hhh]”hŒbullet_list”“”)”}”(hhh]”hŒ	list_item”“”)”}”(hŒ,where new writes happen in the ring buffer.
”h]”hÊ)”}”(hŒ+where new writes happen in the ring buffer.”h]”hŒ+where new writes happen in the ring buffer.”…””}”(hjÖ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KhjÒ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÐ  hjÍ  ubah}”(h]”h ]”h"]”h$]”h&]”Œbullet”Œ-”uh1jË  hŸh³h KhjÈ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ  hj²  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j°  hŸh³h Khj­  ubj±  )”}”(hŒ2head
- where new reads happen in the ring buffer.
”h]”(j·  )”}”(hŒhead”h]”hŒhead”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j¶  hŸh³h Khjþ  ubjÇ  )”}”(hhh]”jÌ  )”}”(hhh]”jÑ  )”}”(hŒ+where new reads happen in the ring buffer.
”h]”hÊ)”}”(hŒ*where new reads happen in the ring buffer.”h]”hŒ*where new reads happen in the ring buffer.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Khj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÐ  hj  ubah}”(h]”h ]”h"]”h$]”h&]”jð  jñ  uh1jË  hŸh³h Khj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ  hjþ  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j°  hŸh³h Khj­  hžhubj±  )”}”(hŒFproducer
- the task that writes into the ring buffer (same as writer)
”h]”(j·  )”}”(hŒproducer”h]”hŒproducer”…””}”(hjD  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j¶  hŸh³h Khj@  ubjÇ  )”}”(hhh]”jÌ  )”}”(hhh]”jÑ  )”}”(hŒ;the task that writes into the ring buffer (same as writer)
”h]”hÊ)”}”(hŒ:the task that writes into the ring buffer (same as writer)”h]”hŒ:the task that writes into the ring buffer (same as writer)”…””}”(hj\  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KhjX  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÐ  hjU  ubah}”(h]”h ]”h"]”h$]”h&]”jð  jñ  uh1jË  hŸh³h KhjR  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ  hj@  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j°  hŸh³h Khj­  hžhubj±  )”}”(hŒwriter
- same as producer
”h]”(j·  )”}”(hŒwriter”h]”hŒwriter”…””}”(hj†  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j¶  hŸh³h Khj‚  ubjÇ  )”}”(hhh]”jÌ  )”}”(hhh]”jÑ  )”}”(hŒsame as producer
”h]”hÊ)”}”(hŒsame as producer”h]”hŒsame as producer”…””}”(hjž  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Khjš  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÐ  hj—  ubah}”(h]”h ]”h"]”h$]”h&]”jð  jñ  uh1jË  hŸh³h Khj”  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ  hj‚  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j°  hŸh³h Khj­  hžhubj±  )”}”(hŒ@consumer
- the task that reads from the buffer (same as reader)
”h]”(j·  )”}”(hŒconsumer”h]”hŒconsumer”…””}”(hjÈ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j¶  hŸh³h K"hjÄ  ubjÇ  )”}”(hhh]”jÌ  )”}”(hhh]”jÑ  )”}”(hŒ5the task that reads from the buffer (same as reader)
”h]”hÊ)”}”(hŒ4the task that reads from the buffer (same as reader)”h]”hŒ4the task that reads from the buffer (same as reader)”…””}”(hjà  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K"hjÜ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÐ  hjÙ  ubah}”(h]”h ]”h"]”h$]”h&]”jð  jñ  uh1jË  hŸh³h K"hjÖ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ  hjÄ  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j°  hŸh³h K"hj­  hžhubj±  )”}”(hŒreader
- same as consumer.
”h]”(j·  )”}”(hŒreader”h]”hŒreader”…””}”(hj
  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j¶  hŸh³h K%hj  ubjÇ  )”}”(hhh]”jÌ  )”}”(hhh]”jÑ  )”}”(hŒsame as consumer.
”h]”hÊ)”}”(hŒsame as consumer.”h]”hŒsame as consumer.”…””}”(hj"  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K%hj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÐ  hj  ubah}”(h]”h ]”h"]”h$]”h&]”jð  jñ  uh1jË  hŸh³h K%hj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ  hj  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j°  hŸh³h K%hj­  hžhubj±  )”}”(hŒ^reader_page
- A page outside the ring buffer used solely (for the most part)
  by the reader.
”h]”(j·  )”}”(hŒreader_page”h]”hŒreader_page”…””}”(hjL  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j¶  hŸh³h K)hjH  ubjÇ  )”}”(hhh]”jÌ  )”}”(hhh]”jÑ  )”}”(hŒNA page outside the ring buffer used solely (for the most part)
by the reader.
”h]”hÊ)”}”(hŒMA page outside the ring buffer used solely (for the most part)
by the reader.”h]”hŒMA page outside the ring buffer used solely (for the most part)
by the reader.”…””}”(hjd  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K(hj`  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÐ  hj]  ubah}”(h]”h ]”h"]”h$]”h&]”jð  jñ  uh1jË  hŸh³h K(hjZ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ  hjH  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j°  hŸh³h K)hj­  hžhubj±  )”}”(hŒ@head_page
- a pointer to the page that the reader will use next
”h]”(j·  )”}”(hŒ	head_page”h]”hŒ	head_page”…””}”(hjŽ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j¶  hŸh³h K,hjŠ  ubjÇ  )”}”(hhh]”jÌ  )”}”(hhh]”jÑ  )”}”(hŒ4a pointer to the page that the reader will use next
”h]”hÊ)”}”(hŒ3a pointer to the page that the reader will use next”h]”hŒ3a pointer to the page that the reader will use next”…””}”(hj¦  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K,hj¢  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÐ  hjŸ  ubah}”(h]”h ]”h"]”h$]”h&]”jð  jñ  uh1jË  hŸh³h K,hjœ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ  hjŠ  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j°  hŸh³h K,hj­  hžhubj±  )”}”(hŒ?tail_page
- a pointer to the page that will be written to next
”h]”(j·  )”}”(hŒ	tail_page”h]”hŒ	tail_page”…””}”(hjÐ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j¶  hŸh³h K/hjÌ  ubjÇ  )”}”(hhh]”jÌ  )”}”(hhh]”jÑ  )”}”(hŒ3a pointer to the page that will be written to next
”h]”hÊ)”}”(hŒ2a pointer to the page that will be written to next”h]”hŒ2a pointer to the page that will be written to next”…””}”(hjè  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K/hjä  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÐ  hjá  ubah}”(h]”h ]”h"]”h$]”h&]”jð  jñ  uh1jË  hŸh³h K/hjÞ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ  hjÌ  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j°  hŸh³h K/hj­  hžhubj±  )”}”(hŒMcommit_page
- a pointer to the page with the last finished non-nested write.
”h]”(j·  )”}”(hŒcommit_page”h]”hŒcommit_page”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j¶  hŸh³h K2hj  ubjÇ  )”}”(hhh]”jÌ  )”}”(hhh]”jÑ  )”}”(hŒ?a pointer to the page with the last finished non-nested write.
”h]”hÊ)”}”(hŒ>a pointer to the page with the last finished non-nested write.”h]”hŒ>a pointer to the page with the last finished non-nested write.”…””}”(hj*  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K2hj&  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÐ  hj#  ubah}”(h]”h ]”h"]”h$]”h&]”jð  jñ  uh1jË  hŸh³h K2hj   ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ  hj  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j°  hŸh³h K2hj­  hžhubj±  )”}”(hX™  cmpxchg
- hardware-assisted atomic transaction that performs the following::

    A = B if previous A == C

    R = cmpxchg(A, C, B) is saying that we replace A with B if and only
        if current A is equal to C, and we put the old (current)
        A into R

    R gets the previous A regardless if A is updated with B or not.

  To see if the update was successful a compare of ``R == C``
  may be used.
”h]”(j·  )”}”(hŒcmpxchg”h]”hŒcmpxchg”…””}”(hjT  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j¶  hŸh³h K@hjP  ubjÇ  )”}”(hhh]”jÌ  )”}”(hhh]”jÑ  )”}”(hX  hardware-assisted atomic transaction that performs the following::

  A = B if previous A == C

  R = cmpxchg(A, C, B) is saying that we replace A with B if and only
      if current A is equal to C, and we put the old (current)
      A into R

  R gets the previous A regardless if A is updated with B or not.

To see if the update was successful a compare of ``R == C``
may be used.
”h]”(hÊ)”}”(hŒBhardware-assisted atomic transaction that performs the following::”h]”hŒAhardware-assisted atomic transaction that performs the following:”…””}”(hjl  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K5hjh  ubhŒliteral_block”“”)”}”(hŒèA = B if previous A == C

R = cmpxchg(A, C, B) is saying that we replace A with B if and only
    if current A is equal to C, and we put the old (current)
    A into R

R gets the previous A regardless if A is updated with B or not.”h]”hŒèA = B if previous A == C

R = cmpxchg(A, C, B) is saying that we replace A with B if and only
    if current A is equal to C, and we put the old (current)
    A into R

R gets the previous A regardless if A is updated with B or not.”…””}”hj|  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1jz  hŸh³h K7hjh  ubhÊ)”}”(hŒHTo see if the update was successful a compare of ``R == C``
may be used.”h]”(hŒ1To see if the update was successful a compare of ”…””}”(hjŠ  hžhhŸNh NubhŒliteral”“”)”}”(hŒ
``R == C``”h]”hŒR == C”…””}”(hj”  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j’  hjŠ  ubhŒ
may be used.”…””}”(hjŠ  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K?hjh  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jÐ  hje  ubah}”(h]”h ]”h"]”h$]”h&]”jð  jñ  uh1jË  hŸh³h K5hjb  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ  hjP  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j°  hŸh³h K@hj­  hžhubeh}”(h]”h ]”h"]”h$]”h&]”uh1j«  hjš  hžhhŸNh Nubeh}”(h]”Œ!terminology-used-in-this-document”ah ]”h"]”Œ!terminology used in this document”ah$]”h&]”uh1h´hh¶hžhhŸh³h Kubhµ)”}”(hhh]”(hº)”}”(hŒThe Generic Ring Buffer”h]”hŒThe Generic Ring Buffer”…””}”(hjÕ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hjÒ  hžhhŸh³h KCubhÊ)”}”(hŒUThe ring buffer can be used in either an overwrite mode or in
producer/consumer mode.”h]”hŒUThe ring buffer can be used in either an overwrite mode or in
producer/consumer mode.”…””}”(hjã  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KEhjÒ  hžhubhÊ)”}”(hŒÇProducer/consumer mode is where if the producer were to fill up the
buffer before the consumer could free up anything, the producer
will stop writing to the buffer. This will lose most recent events.”h]”hŒÇProducer/consumer mode is where if the producer were to fill up the
buffer before the consumer could free up anything, the producer
will stop writing to the buffer. This will lose most recent events.”…””}”(hjñ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KHhjÒ  hžhubhÊ)”}”(hŒ¼Overwrite mode is where if the producer were to fill up the buffer
before the consumer could free up anything, the producer will
overwrite the older data. This will lose the oldest events.”h]”hŒ¼Overwrite mode is where if the producer were to fill up the buffer
before the consumer could free up anything, the producer will
overwrite the older data. This will lose the oldest events.”…””}”(hjÿ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KLhjÒ  hžhubhÊ)”}”(hX1  No two writers can write at the same time (on the same per-cpu buffer),
but a writer may interrupt another writer, but it must finish writing
before the previous writer may continue. This is very important to the
algorithm. The writers act like a "stack". The way interrupts works
enforces this behavior::”h]”hX4  No two writers can write at the same time (on the same per-cpu buffer),
but a writer may interrupt another writer, but it must finish writing
before the previous writer may continue. This is very important to the
algorithm. The writers act like a â€œstackâ€. The way interrupts works
enforces this behavior:”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KPhjÒ  hžhubj{  )”}”(hŒ writer1 start
   <preempted> writer2 start
       <preempted> writer3 start
                   writer3 finishes
               writer2 finishes
writer1 finishes”h]”hŒ writer1 start
   <preempted> writer2 start
       <preempted> writer3 start
                   writer3 finishes
               writer2 finishes
writer1 finishes”…””}”hj  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1jz  hŸh³h KWhjÒ  hžhubhÊ)”}”(hŒhThis is very much like a writer being preempted by an interrupt and
the interrupt doing a write as well.”h]”hŒhThis is very much like a writer being preempted by an interrupt and
the interrupt doing a write as well.”…””}”(hj)  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K^hjÒ  hžhubhÊ)”}”(hX{  Readers can happen at any time. But no two readers may run at the
same time, nor can a reader preempt/interrupt another reader. A reader
cannot preempt/interrupt a writer, but it may read/consume from the
buffer at the same time as a writer is writing, but the reader must be
on another processor to do so. A reader may read on its own processor
and can be preempted by a writer.”h]”hX{  Readers can happen at any time. But no two readers may run at the
same time, nor can a reader preempt/interrupt another reader. A reader
cannot preempt/interrupt a writer, but it may read/consume from the
buffer at the same time as a writer is writing, but the reader must be
on another processor to do so. A reader may read on its own processor
and can be preempted by a writer.”…””}”(hj7  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KahjÒ  hžhubhÊ)”}”(hŒšA writer can preempt a reader, but a reader cannot preempt a writer.
But a reader can read the buffer at the same time (on another processor)
as a writer.”h]”hŒšA writer can preempt a reader, but a reader cannot preempt a writer.
But a reader can read the buffer at the same time (on another processor)
as a writer.”…””}”(hjE  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KhhjÒ  hžhubhÊ)”}”(hŒMThe ring buffer is made up of a list of pages held together by a linked list.”h]”hŒMThe ring buffer is made up of a list of pages held together by a linked list.”…””}”(hjS  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KlhjÒ  hžhubhÊ)”}”(hŒ`At initialization a reader page is allocated for the reader that is not
part of the ring buffer.”h]”hŒ`At initialization a reader page is allocated for the reader that is not
part of the ring buffer.”…””}”(hja  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KnhjÒ  hžhubhÊ)”}”(hŒWThe head_page, tail_page and commit_page are all initialized to point
to the same page.”h]”hŒWThe head_page, tail_page and commit_page are all initialized to point
to the same page.”…””}”(hjo  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KqhjÒ  hžhubhÊ)”}”(hŒ”The reader page is initialized to have its next pointer pointing to
the head page, and its previous pointer pointing to a page before
the head page.”h]”hŒ”The reader page is initialized to have its next pointer pointing to
the head page, and its previous pointer pointing to a page before
the head page.”…””}”(hj}  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KthjÒ  hžhubhÊ)”}”(hX¢  The reader has its own page to use. At start up time, this page is
allocated but is not attached to the list. When the reader wants
to read from the buffer, if its page is empty (like it is on start-up),
it will swap its page with the head_page. The old reader page will
become part of the ring buffer and the head_page will be removed.
The page after the inserted page (old reader_page) will become the
new head page.”h]”hX¢  The reader has its own page to use. At start up time, this page is
allocated but is not attached to the list. When the reader wants
to read from the buffer, if its page is empty (like it is on start-up),
it will swap its page with the head_page. The old reader page will
become part of the ring buffer and the head_page will be removed.
The page after the inserted page (old reader_page) will become the
new head page.”…””}”(hj‹  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KxhjÒ  hžhubhÊ)”}”(hŒ|Once the new page is given to the reader, the reader could do what
it wants with it, as long as a writer has left that page.”h]”hŒ|Once the new page is given to the reader, the reader could do what
it wants with it, as long as a writer has left that page.”…””}”(hj™  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K€hjÒ  hžhubhÊ)”}”(hŒ…A sample of how the reader page is swapped: Note this does not
show the head page in the buffer, it is for demonstrating a swap
only.”h]”hŒ…A sample of how the reader page is swapped: Note this does not
show the head page in the buffer, it is for demonstrating a swap
only.”…””}”(hj§  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KƒhjÒ  hžhubj{  )”}”(hX,  +------+
|reader|          RING BUFFER
|page  |
+------+
                +---+   +---+   +---+
                |   |-->|   |-->|   |
                |   |<--|   |<--|   |
                +---+   +---+   +---+
                 ^ |             ^ |
                 | +-------------+ |
                 +-----------------+


+------+
|reader|          RING BUFFER
|page  |-------------------+
+------+                   v
  |             +---+   +---+   +---+
  |             |   |-->|   |-->|   |
  |             |   |<--|   |<--|   |<-+
  |             +---+   +---+   +---+  |
  |              ^ |             ^ |   |
  |              | +-------------+ |   |
  |              +-----------------+   |
  +------------------------------------+

+------+
|reader|          RING BUFFER
|page  |-------------------+
+------+ <---------------+ v
  |  ^          +---+   +---+   +---+
  |  |          |   |-->|   |-->|   |
  |  |          |   |   |   |<--|   |<-+
  |  |          +---+   +---+   +---+  |
  |  |             |             ^ |   |
  |  |             +-------------+ |   |
  |  +-----------------------------+   |
  +------------------------------------+

+------+
|buffer|          RING BUFFER
|page  |-------------------+
+------+ <---------------+ v
  |  ^          +---+   +---+   +---+
  |  |          |   |   |   |-->|   |
  |  |  New     |   |   |   |<--|   |<-+
  |  | Reader   +---+   +---+   +---+  |
  |  |  page ----^                 |   |
  |  |                             |   |
  |  +-----------------------------+   |
  +------------------------------------+”h]”hX,  +------+
|reader|          RING BUFFER
|page  |
+------+
                +---+   +---+   +---+
                |   |-->|   |-->|   |
                |   |<--|   |<--|   |
                +---+   +---+   +---+
                 ^ |             ^ |
                 | +-------------+ |
                 +-----------------+


+------+
|reader|          RING BUFFER
|page  |-------------------+
+------+                   v
  |             +---+   +---+   +---+
  |             |   |-->|   |-->|   |
  |             |   |<--|   |<--|   |<-+
  |             +---+   +---+   +---+  |
  |              ^ |             ^ |   |
  |              | +-------------+ |   |
  |              +-----------------+   |
  +------------------------------------+

+------+
|reader|          RING BUFFER
|page  |-------------------+
+------+ <---------------+ v
  |  ^          +---+   +---+   +---+
  |  |          |   |-->|   |-->|   |
  |  |          |   |   |   |<--|   |<-+
  |  |          +---+   +---+   +---+  |
  |  |             |             ^ |   |
  |  |             +-------------+ |   |
  |  +-----------------------------+   |
  +------------------------------------+

+------+
|buffer|          RING BUFFER
|page  |-------------------+
+------+ <---------------+ v
  |  ^          +---+   +---+   +---+
  |  |          |   |   |   |-->|   |
  |  |  New     |   |   |   |<--|   |<-+
  |  | Reader   +---+   +---+   +---+  |
  |  |  page ----^                 |   |
  |  |                             |   |
  |  +-----------------------------+   |
  +------------------------------------+”…””}”hjµ  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1jz  hŸh³h K‰hjÒ  hžhubhÊ)”}”(hŒ”It is possible that the page swapped is the commit page and the tail page,
if what is in the ring buffer is less than what is held in a buffer page.”h]”hŒ”It is possible that the page swapped is the commit page and the tail page,
if what is in the ring buffer is less than what is held in a buffer page.”…””}”(hjÃ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K¿hjÒ  hžhubj{  )”}”(hX            reader page    commit page   tail page
              |              |             |
              v              |             |
             +---+           |             |
             |   |<----------+             |
             |   |<------------------------+
             |   |------+
             +---+      |
                        |
                        v
    +---+    +---+    +---+    +---+
<---|   |--->|   |--->|   |--->|   |--->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+”h]”hX            reader page    commit page   tail page
              |              |             |
              v              |             |
             +---+           |             |
             |   |<----------+             |
             |   |<------------------------+
             |   |------+
             +---+      |
                        |
                        v
    +---+    +---+    +---+    +---+
<---|   |--->|   |--->|   |--->|   |--->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+”…””}”hjÑ  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1jz  hŸh³h KÄhjÒ  hžhubhÊ)”}”(hŒ½This case is still valid for this algorithm.
When the writer leaves the page, it simply goes into the ring buffer
since the reader page still points to the next location in the ring
buffer.”h]”hŒ½This case is still valid for this algorithm.
When the writer leaves the page, it simply goes into the ring buffer
since the reader page still points to the next location in the ring
buffer.”…””}”(hjß  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KÓhjÒ  hžhubhÊ)”}”(hŒThe main pointers:”h]”hŒThe main pointers:”…””}”(hjí  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KÙhjÒ  hžhubhŒblock_quote”“”)”}”(hXq  reader page
          - The page used solely by the reader and is not part
            of the ring buffer (may be swapped in)

head page
          - the next page in the ring buffer that will be swapped
            with the reader page.

tail page
          - the page where the next write will take place.

commit page
          - the page that last finished a write.
”h]”j¬  )”}”(hhh]”(j±  )”}”(hŒjreader page
- The page used solely by the reader and is not part
  of the ring buffer (may be swapped in)
”h]”(j·  )”}”(hŒreader page”h]”hŒreader page”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j¶  hŸh³h KÝhj  ubjÇ  )”}”(hhh]”jÌ  )”}”(hhh]”jÑ  )”}”(hŒZThe page used solely by the reader and is not part
of the ring buffer (may be swapped in)
”h]”hÊ)”}”(hŒYThe page used solely by the reader and is not part
of the ring buffer (may be swapped in)”h]”hŒYThe page used solely by the reader and is not part
of the ring buffer (may be swapped in)”…””}”(hj   hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KÜhj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÐ  hj  ubah}”(h]”h ]”h"]”h$]”h&]”jð  jñ  uh1jË  hŸh³h KÜhj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ  hj  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j°  hŸh³h KÝhj  ubj±  )”}”(hŒZhead page
- the next page in the ring buffer that will be swapped
  with the reader page.
”h]”(j·  )”}”(hŒ	head page”h]”hŒ	head page”…””}”(hjJ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j¶  hŸh³h KáhjF  ubjÇ  )”}”(hhh]”jÌ  )”}”(hhh]”jÑ  )”}”(hŒLthe next page in the ring buffer that will be swapped
with the reader page.
”h]”hÊ)”}”(hŒKthe next page in the ring buffer that will be swapped
with the reader page.”h]”hŒKthe next page in the ring buffer that will be swapped
with the reader page.”…””}”(hjb  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Kàhj^  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÐ  hj[  ubah}”(h]”h ]”h"]”h$]”h&]”jð  jñ  uh1jË  hŸh³h KàhjX  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ  hjF  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j°  hŸh³h Káhj  ubj±  )”}”(hŒ;tail page
- the page where the next write will take place.
”h]”(j·  )”}”(hŒ	tail page”h]”hŒ	tail page”…””}”(hjŒ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j¶  hŸh³h Kähjˆ  ubjÇ  )”}”(hhh]”jÌ  )”}”(hhh]”jÑ  )”}”(hŒ/the page where the next write will take place.
”h]”hÊ)”}”(hŒ.the page where the next write will take place.”h]”hŒ.the page where the next write will take place.”…””}”(hj¤  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Kähj   ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÐ  hj  ubah}”(h]”h ]”h"]”h$]”h&]”jð  jñ  uh1jË  hŸh³h Kähjš  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ  hjˆ  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j°  hŸh³h Kähj  ubj±  )”}”(hŒ3commit page
- the page that last finished a write.
”h]”(j·  )”}”(hŒcommit page”h]”hŒcommit page”…””}”(hjÎ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j¶  hŸh³h KçhjÊ  ubjÇ  )”}”(hhh]”jÌ  )”}”(hhh]”jÑ  )”}”(hŒ%the page that last finished a write.
”h]”hÊ)”}”(hŒ$the page that last finished a write.”h]”hŒ$the page that last finished a write.”…””}”(hjæ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Kçhjâ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÐ  hjß  ubah}”(h]”h ]”h"]”h$]”h&]”jð  jñ  uh1jË  hŸh³h KçhjÜ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ  hjÊ  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j°  hŸh³h Kçhj  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j«  hjý  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jû  hŸh³h KÛhjÒ  hžhubhÊ)”}”(hŒ‘The commit page only is updated by the outermost writer in the
writer stack. A writer that preempts another writer will not move the
commit page.”h]”hŒ‘The commit page only is updated by the outermost writer in the
writer stack. A writer that preempts another writer will not move the
commit page.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KéhjÒ  hžhubhÊ)”}”(hŒÆWhen data is written into the ring buffer, a position is reserved
in the ring buffer and passed back to the writer. When the writer
is finished writing data into that position, it commits the write.”h]”hŒÆWhen data is written into the ring buffer, a position is reserved
in the ring buffer and passed back to the writer. When the writer
is finished writing data into that position, it commits the write.”…””}”(hj&  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KíhjÒ  hžhubhÊ)”}”(hŒŸAnother write (or a read) may take place at anytime during this
transaction. If another write happens it must finish before continuing
with the previous write.”h]”hŒŸAnother write (or a read) may take place at anytime during this
transaction. If another write happens it must finish before continuing
with the previous write.”…””}”(hj4  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KñhjÒ  hžhubjü  )”}”(hX`    Write reserve::

      Buffer page
     +---------+
     |written  |
     +---------+  <--- given back to writer (current commit)
     |reserved |
     +---------+ <--- tail pointer
     | empty   |
     +---------+

  Write commit::

      Buffer page
     +---------+
     |written  |
     +---------+
     |written  |
     +---------+  <--- next position for write (current commit)
     | empty   |
     +---------+


If a write happens after the first reserve::

      Buffer page
     +---------+
     |written  |
     +---------+  <-- current commit
     |reserved |
     +---------+  <--- given back to second writer
     |reserved |
     +---------+ <--- tail pointer

 After second writer commits::


      Buffer page
     +---------+
     |written  |
     +---------+  <--(last full commit)
     |reserved |
     +---------+
     |pending  |
     |commit   |
     +---------+ <--- tail pointer

 When the first writer commits::

      Buffer page
     +---------+
     |written  |
     +---------+
     |written  |
     +---------+
     |written  |
     +---------+  <--(last full commit and tail pointer)

”h]”(jü  )”}”(hX‚  Write reserve::

    Buffer page
   +---------+
   |written  |
   +---------+  <--- given back to writer (current commit)
   |reserved |
   +---------+ <--- tail pointer
   | empty   |
   +---------+

Write commit::

    Buffer page
   +---------+
   |written  |
   +---------+
   |written  |
   +---------+  <--- next position for write (current commit)
   | empty   |
   +---------+

”h]”(hÊ)”}”(hŒWrite reserve::”h]”hŒWrite reserve:”…””}”(hjJ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KöhjF  ubj{  )”}”(hŒž Buffer page
+---------+
|written  |
+---------+  <--- given back to writer (current commit)
|reserved |
+---------+ <--- tail pointer
| empty   |
+---------+”h]”hŒž Buffer page
+---------+
|written  |
+---------+  <--- given back to writer (current commit)
|reserved |
+---------+ <--- tail pointer
| empty   |
+---------+”…””}”hjX  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1jz  hŸh³h KøhjF  ubhÊ)”}”(hŒWrite commit::”h]”hŒWrite commit:”…””}”(hjf  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MhjF  ubj{  )”}”(hŒ Buffer page
+---------+
|written  |
+---------+
|written  |
+---------+  <--- next position for write (current commit)
| empty   |
+---------+”h]”hŒ Buffer page
+---------+
|written  |
+---------+
|written  |
+---------+  <--- next position for write (current commit)
| empty   |
+---------+”…””}”hjt  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1jz  hŸh³h MhjF  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jû  hŸh³h KöhjB  ubhÊ)”}”(hŒ,If a write happens after the first reserve::”h]”hŒ+If a write happens after the first reserve:”…””}”(hjˆ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MhjB  ubj{  )”}”(hXn       Buffer page
    +---------+
    |written  |
    +---------+  <-- current commit
    |reserved |
    +---------+  <--- given back to second writer
    |reserved |
    +---------+ <--- tail pointer

After second writer commits::


     Buffer page
    +---------+
    |written  |
    +---------+  <--(last full commit)
    |reserved |
    +---------+
    |pending  |
    |commit   |
    +---------+ <--- tail pointer

When the first writer commits::

     Buffer page
    +---------+
    |written  |
    +---------+
    |written  |
    +---------+
    |written  |
    +---------+  <--(last full commit and tail pointer)”h]”hXn       Buffer page
    +---------+
    |written  |
    +---------+  <-- current commit
    |reserved |
    +---------+  <--- given back to second writer
    |reserved |
    +---------+ <--- tail pointer

After second writer commits::


     Buffer page
    +---------+
    |written  |
    +---------+  <--(last full commit)
    |reserved |
    +---------+
    |pending  |
    |commit   |
    +---------+ <--- tail pointer

When the first writer commits::

     Buffer page
    +---------+
    |written  |
    +---------+
    |written  |
    +---------+
    |written  |
    +---------+  <--(last full commit and tail pointer)”…””}”hj–  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1jz  hŸh³h MhjB  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jû  hŸh³h KöhjÒ  hžhubhÊ)”}”(hX  The commit pointer points to the last write location that was
committed without preempting another write. When a write that
preempted another write is committed, it only becomes a pending commit
and will not be a full commit until all writes have been committed.”h]”hX  The commit pointer points to the last write location that was
committed without preempting another write. When a write that
preempted another write is committed, it only becomes a pending commit
and will not be a full commit until all writes have been committed.”…””}”(hjª  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M1hjÒ  hžhubhÊ)”}”(hŒ‹The commit page points to the page that has the last full commit.
The tail page points to the page with the last write (before
committing).”h]”hŒ‹The commit page points to the page that has the last full commit.
The tail page points to the page with the last write (before
committing).”…””}”(hj¸  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M6hjÒ  hžhubhÊ)”}”(hŒøThe tail page is always equal to or after the commit page. It may
be several pages ahead. If the tail page catches up to the commit
page then no more writes may take place (regardless of the mode
of the ring buffer: overwrite and produce/consumer).”h]”hŒøThe tail page is always equal to or after the commit page. It may
be several pages ahead. If the tail page catches up to the commit
page then no more writes may take place (regardless of the mode
of the ring buffer: overwrite and produce/consumer).”…””}”(hjÆ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M:hjÒ  hžhubhÊ)”}”(hŒThe order of pages is::”h]”hŒThe order of pages is:”…””}”(hjÔ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M?hjÒ  hžhubj{  )”}”(hŒhead page
commit page
tail page”h]”hŒhead page
commit page
tail page”…””}”hjâ  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1jz  hŸh³h MAhjÒ  hžhubhÊ)”}”(hŒPossible scenario::”h]”hŒPossible scenario:”…””}”(hjð  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MEhjÒ  hžhubj{  )”}”(hX+                               tail page
  head page         commit page  |
      |                 |        |
      v                 v        v
    +---+    +---+    +---+    +---+
<---|   |--->|   |--->|   |--->|   |--->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+”h]”hX+                               tail page
  head page         commit page  |
      |                 |        |
      v                 v        v
    +---+    +---+    +---+    +---+
<---|   |--->|   |--->|   |--->|   |--->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+”…””}”hjþ  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1jz  hŸh³h MGhjÒ  hžhubhÊ)”}”(hX¸  There is a special case that the head page is after either the commit page
and possibly the tail page. That is when the commit (and tail) page has been
swapped with the reader page. This is because the head page is always
part of the ring buffer, but the reader page is not. Whenever there
has been less than a full page that has been committed inside the ring buffer,
and a reader swaps out a page, it will be swapping out the commit page.”h]”hX¸  There is a special case that the head page is after either the commit page
and possibly the tail page. That is when the commit (and tail) page has been
swapped with the reader page. This is because the head page is always
part of the ring buffer, but the reader page is not. Whenever there
has been less than a full page that has been committed inside the ring buffer,
and a reader swaps out a page, it will be swapping out the commit page.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MPhjÒ  hžhubj{  )”}”(hXg            reader page    commit page   tail page
              |              |             |
              v              |             |
             +---+           |             |
             |   |<----------+             |
             |   |<------------------------+
             |   |------+
             +---+      |
                        |
                        v
    +---+    +---+    +---+    +---+
<---|   |--->|   |--->|   |--->|   |--->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+
                        ^
                        |
                    head page”h]”hXg            reader page    commit page   tail page
              |              |             |
              v              |             |
             +---+           |             |
             |   |<----------+             |
             |   |<------------------------+
             |   |------+
             +---+      |
                        |
                        v
    +---+    +---+    +---+    +---+
<---|   |--->|   |--->|   |--->|   |--->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+
                        ^
                        |
                    head page”…””}”hj  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1jz  hŸh³h MYhjÒ  hžhubhÊ)”}”(hŒbIn this case, the head page will not move when the tail and commit
move back into the ring buffer.”h]”hŒbIn this case, the head page will not move when the tail and commit
move back into the ring buffer.”…””}”(hj(  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MlhjÒ  hžhubhÊ)”}”(hX  The reader cannot swap a page into the ring buffer if the commit page
is still on that page. If the read meets the last commit (real commit
not pending or reserved), then there is nothing more to read.
The buffer is considered empty until another full commit finishes.”h]”hX  The reader cannot swap a page into the ring buffer if the commit page
is still on that page. If the read meets the last commit (real commit
not pending or reserved), then there is nothing more to read.
The buffer is considered empty until another full commit finishes.”…””}”(hj6  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MohjÒ  hžhubhÊ)”}”(hŒ¯When the tail meets the head page, if the buffer is in overwrite mode,
the head page will be pushed ahead one. If the buffer is in producer/consumer
mode, the write will fail.”h]”hŒ¯When the tail meets the head page, if the buffer is in overwrite mode,
the head page will be pushed ahead one. If the buffer is in producer/consumer
mode, the write will fail.”…””}”(hjD  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MthjÒ  hžhubhÊ)”}”(hŒOverwrite mode::”h]”hŒOverwrite mode:”…””}”(hjR  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MxhjÒ  hžhubj{  )”}”(hXÅ              tail page
               |
               v
    +---+    +---+    +---+    +---+
<---|   |--->|   |--->|   |--->|   |--->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+
                        ^
                        |
                    head page


            tail page
               |
               v
    +---+    +---+    +---+    +---+
<---|   |--->|   |--->|   |--->|   |--->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+
                                 ^
                                 |
                             head page


                    tail page
                        |
                        v
    +---+    +---+    +---+    +---+
<---|   |--->|   |--->|   |--->|   |--->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+
                                 ^
                                 |
                             head page”h]”hXÅ              tail page
               |
               v
    +---+    +---+    +---+    +---+
<---|   |--->|   |--->|   |--->|   |--->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+
                        ^
                        |
                    head page


            tail page
               |
               v
    +---+    +---+    +---+    +---+
<---|   |--->|   |--->|   |--->|   |--->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+
                                 ^
                                 |
                             head page


                    tail page
                        |
                        v
    +---+    +---+    +---+    +---+
<---|   |--->|   |--->|   |--->|   |--->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+
                                 ^
                                 |
                             head page”…””}”hj`  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1jz  hŸh³h MzhjÒ  hžhubhÊ)”}”(hŒ…Note, the reader page will still point to the previous head page.
But when a swap takes place, it will use the most recent head page.”h]”hŒ…Note, the reader page will still point to the previous head page.
But when a swap takes place, it will use the most recent head page.”…””}”(hjn  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MhjÒ  hžhubeh}”(h]”Œthe-generic-ring-buffer”ah ]”h"]”Œthe generic ring buffer”ah$]”h&]”uh1h´hh¶hžhhŸh³h KCubhµ)”}”(hhh]”(hº)”}”(hŒ Making the Ring Buffer Lockless:”h]”hŒ Making the Ring Buffer Lockless:”…””}”(hj‡  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hj„  hžhhŸh³h M¢ubhÊ)”}”(hX­  The main idea behind the lockless algorithm is to combine the moving
of the head_page pointer with the swapping of pages with the reader.
State flags are placed inside the pointer to the page. To do this,
each page must be aligned in memory by 4 bytes. This will allow the 2
least significant bits of the address to be used as flags, since
they will always be zero for the address. To get the address,
simply mask out the flags::”h]”hX¬  The main idea behind the lockless algorithm is to combine the moving
of the head_page pointer with the swapping of pages with the reader.
State flags are placed inside the pointer to the page. To do this,
each page must be aligned in memory by 4 bytes. This will allow the 2
least significant bits of the address to be used as flags, since
they will always be zero for the address. To get the address,
simply mask out the flags:”…””}”(hj•  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M¤hj„  hžhubj{  )”}”(hŒMASK = ~3

address & MASK”h]”hŒMASK = ~3

address & MASK”…””}”hj£  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1jz  hŸh³h M¬hj„  hžhubhÊ)”}”(hŒ)Two flags will be kept by these two bits:”h]”hŒ)Two flags will be kept by these two bits:”…””}”(hj±  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M°hj„  hžhubjü  )”}”(hŒ«HEADER
     - the page being pointed to is a head page

UPDATE
     - the page being pointed to is being updated by a writer
       and was or is about to be a head page.
”h]”j¬  )”}”(hhh]”(j±  )”}”(hŒ2HEADER
- the page being pointed to is a head page
”h]”(j·  )”}”(hŒHEADER”h]”hŒHEADER”…””}”(hjÊ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j¶  hŸh³h M³hjÆ  ubjÇ  )”}”(hhh]”jÌ  )”}”(hhh]”jÑ  )”}”(hŒ)the page being pointed to is a head page
”h]”hÊ)”}”(hŒ(the page being pointed to is a head page”h]”hŒ(the page being pointed to is a head page”…””}”(hjâ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M³hjÞ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÐ  hjÛ  ubah}”(h]”h ]”h"]”h$]”h&]”jð  jñ  uh1jË  hŸh³h M³hjØ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ  hjÆ  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j°  hŸh³h M³hjÃ  ubj±  )”}”(hŒiUPDATE
- the page being pointed to is being updated by a writer
  and was or is about to be a head page.
”h]”(j·  )”}”(hŒUPDATE”h]”hŒUPDATE”…””}”(hj	  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j¶  hŸh³h M·hj	  ubjÇ  )”}”(hhh]”jÌ  )”}”(hhh]”jÑ  )”}”(hŒ^the page being pointed to is being updated by a writer
and was or is about to be a head page.
”h]”hÊ)”}”(hŒ]the page being pointed to is being updated by a writer
and was or is about to be a head page.”h]”hŒ]the page being pointed to is being updated by a writer
and was or is about to be a head page.”…””}”(hj$	  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M¶hj 	  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÐ  hj	  ubah}”(h]”h ]”h"]”h$]”h&]”jð  jñ  uh1jË  hŸh³h M¶hj	  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÆ  hj	  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j°  hŸh³h M·hjÃ  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j«  hj¿  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jû  hŸh³h M²hj„  hžhubj{  )”}”(hXI            reader page
              |
              v
            +---+
            |   |------+
            +---+      |
                        |
                        v
    +---+    +---+    +---+    +---+
<---|   |--->|   |-H->|   |--->|   |--->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+”h]”hXI            reader page
              |
              v
            +---+
            |   |------+
            +---+      |
                        |
                        v
    +---+    +---+    +---+    +---+
<---|   |--->|   |-H->|   |--->|   |--->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+”…””}”hjV	  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1jz  hŸh³h M»hj„  hžhubhÊ)”}”(hŒ³The above pointer "-H->" would have the HEADER flag set. That is
the next page is the next page to be swapped out by the reader.
This pointer means the next page is the head page.”h]”hŒ·The above pointer â€œ-H->â€ would have the HEADER flag set. That is
the next page is the next page to be swapped out by the reader.
This pointer means the next page is the head page.”…””}”(hjd	  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MÉhj„  hžhubhÊ)”}”(hŒjWhen the tail page meets the head pointer, it will use cmpxchg to
change the pointer to the UPDATE state::”h]”hŒiWhen the tail page meets the head pointer, it will use cmpxchg to
change the pointer to the UPDATE state:”…””}”(hjr	  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MÍhj„  hžhubj{  )”}”(hX¨              tail page
               |
               v
    +---+    +---+    +---+    +---+
<---|   |--->|   |-H->|   |--->|   |--->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+

            tail page
               |
               v
    +---+    +---+    +---+    +---+
<---|   |--->|   |-U->|   |--->|   |--->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+”h]”hX¨              tail page
               |
               v
    +---+    +---+    +---+    +---+
<---|   |--->|   |-H->|   |--->|   |--->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+

            tail page
               |
               v
    +---+    +---+    +---+    +---+
<---|   |--->|   |-U->|   |--->|   |--->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+”…””}”hj€	  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1jz  hŸh³h MÑhj„  hžhubhÊ)”}”(hŒ0"-U->" represents a pointer in the UPDATE state.”h]”hŒ4â€œ-U->â€ represents a pointer in the UPDATE state.”…””}”(hjŽ	  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Máhj„  hžhubhÊ)”}”(hX   Any access to the reader will need to take some sort of lock to serialize
the readers. But the writers will never take a lock to write to the
ring buffer. This means we only need to worry about a single reader,
and writes only preempt in "stack" formation.”h]”hX  Any access to the reader will need to take some sort of lock to serialize
the readers. But the writers will never take a lock to write to the
ring buffer. This means we only need to worry about a single reader,
and writes only preempt in â€œstackâ€ formation.”…””}”(hjœ	  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mãhj„  hžhubhÊ)”}”(hXG  When the reader tries to swap the page with the ring buffer, it
will also use cmpxchg. If the flag bit in the pointer to the
head page does not have the HEADER flag set, the compare will fail
and the reader will need to look for the new head page and try again.
Note, the flags UPDATE and HEADER are never set at the same time.”h]”hXG  When the reader tries to swap the page with the ring buffer, it
will also use cmpxchg. If the flag bit in the pointer to the
head page does not have the HEADER flag set, the compare will fail
and the reader will need to look for the new head page and try again.
Note, the flags UPDATE and HEADER are never set at the same time.”…””}”(hjª	  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mèhj„  hžhubhÊ)”}”(hŒ-The reader swaps the reader page as follows::”h]”hŒ,The reader swaps the reader page as follows:”…””}”(hj¸	  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mîhj„  hžhubj{  )”}”(hXM  +------+
|reader|          RING BUFFER
|page  |
+------+
                +---+    +---+    +---+
                |   |--->|   |--->|   |
                |   |<---|   |<---|   |
                +---+    +---+    +---+
                 ^ |               ^ |
                 | +---------------+ |
                 +-----H-------------+”h]”hXM  +------+
|reader|          RING BUFFER
|page  |
+------+
                +---+    +---+    +---+
                |   |--->|   |--->|   |
                |   |<---|   |<---|   |
                +---+    +---+    +---+
                 ^ |               ^ |
                 | +---------------+ |
                 +-----H-------------+”…””}”hjÆ	  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1jz  hŸh³h Mðhj„  hžhubhÊ)”}”(hŒXThe reader sets the reader page next pointer as HEADER to the page after
the head page::”h]”hŒWThe reader sets the reader page next pointer as HEADER to the page after
the head page:”…””}”(hjÔ	  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mühj„  hžhubj{  )”}”(hX²  +------+
|reader|          RING BUFFER
|page  |-------H-----------+
+------+                   v
  |             +---+    +---+    +---+
  |             |   |--->|   |--->|   |
  |             |   |<---|   |<---|   |<-+
  |             +---+    +---+    +---+  |
  |              ^ |               ^ |   |
  |              | +---------------+ |   |
  |              +-----H-------------+   |
  +--------------------------------------+”h]”hX²  +------+
|reader|          RING BUFFER
|page  |-------H-----------+
+------+                   v
  |             +---+    +---+    +---+
  |             |   |--->|   |--->|   |
  |             |   |<---|   |<---|   |<-+
  |             +---+    +---+    +---+  |
  |              ^ |               ^ |   |
  |              | +---------------+ |   |
  |              +-----H-------------+   |
  +--------------------------------------+”…””}”hjâ	  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1jz  hŸh³h M hj„  hžhubhÊ)”}”(hŒÔIt does a cmpxchg with the pointer to the previous head page to make it
point to the reader page. Note that the new pointer does not have the HEADER
flag set.  This action atomically moves the head page forward::”h]”hŒÓIt does a cmpxchg with the pointer to the previous head page to make it
point to the reader page. Note that the new pointer does not have the HEADER
flag set.  This action atomically moves the head page forward:”…””}”(hjð	  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mhj„  hžhubj{  )”}”(hX¢  +------+
|reader|          RING BUFFER
|page  |-------H-----------+
+------+                   v
  |  ^          +---+   +---+   +---+
  |  |          |   |-->|   |-->|   |
  |  |          |   |<--|   |<--|   |<-+
  |  |          +---+   +---+   +---+  |
  |  |             |             ^ |   |
  |  |             +-------------+ |   |
  |  +-----------------------------+   |
  +------------------------------------+”h]”hX¢  +------+
|reader|          RING BUFFER
|page  |-------H-----------+
+------+                   v
  |  ^          +---+   +---+   +---+
  |  |          |   |-->|   |-->|   |
  |  |          |   |<--|   |<--|   |<-+
  |  |          +---+   +---+   +---+  |
  |  |             |             ^ |   |
  |  |             +-------------+ |   |
  |  +-----------------------------+   |
  +------------------------------------+”…””}”hjþ	  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1jz  hŸh³h Mhj„  hžhubhÊ)”}”(hŒeAfter the new head page is set, the previous pointer of the head page is
updated to the reader page::”h]”hŒdAfter the new head page is set, the previous pointer of the head page is
updated to the reader page:”…””}”(hj
  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mhj„  hžhubj{  )”}”(hXZ  +------+
|reader|          RING BUFFER
|page  |-------H-----------+
+------+ <---------------+ v
  |  ^          +---+   +---+   +---+
  |  |          |   |-->|   |-->|   |
  |  |          |   |   |   |<--|   |<-+
  |  |          +---+   +---+   +---+  |
  |  |             |             ^ |   |
  |  |             +-------------+ |   |
  |  +-----------------------------+   |
  +------------------------------------+

+------+
|buffer|          RING BUFFER
|page  |-------H-----------+  <--- New head page
+------+ <---------------+ v
  |  ^          +---+   +---+   +---+
  |  |          |   |   |   |-->|   |
  |  |  New     |   |   |   |<--|   |<-+
  |  | Reader   +---+   +---+   +---+  |
  |  |  page ----^                 |   |
  |  |                             |   |
  |  +-----------------------------+   |
  +------------------------------------+”h]”hXZ  +------+
|reader|          RING BUFFER
|page  |-------H-----------+
+------+ <---------------+ v
  |  ^          +---+   +---+   +---+
  |  |          |   |-->|   |-->|   |
  |  |          |   |   |   |<--|   |<-+
  |  |          +---+   +---+   +---+  |
  |  |             |             ^ |   |
  |  |             +-------------+ |   |
  |  +-----------------------------+   |
  +------------------------------------+

+------+
|buffer|          RING BUFFER
|page  |-------H-----------+  <--- New head page
+------+ <---------------+ v
  |  ^          +---+   +---+   +---+
  |  |          |   |   |   |-->|   |
  |  |  New     |   |   |   |<--|   |<-+
  |  | Reader   +---+   +---+   +---+  |
  |  |  page ----^                 |   |
  |  |                             |   |
  |  +-----------------------------+   |
  +------------------------------------+”…””}”hj
  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1jz  hŸh³h M!hj„  hžhubhÊ)”}”(hX‚  Another important point: The page that the reader page points back to
by its previous pointer (the one that now points to the new head page)
never points back to the reader page. That is because the reader page is
not part of the ring buffer. Traversing the ring buffer via the next pointers
will always stay in the ring buffer. Traversing the ring buffer via the
prev pointers may not.”h]”hX‚  Another important point: The page that the reader page points back to
by its previous pointer (the one that now points to the new head page)
never points back to the reader page. That is because the reader page is
not part of the ring buffer. Traversing the ring buffer via the next pointers
will always stay in the ring buffer. Traversing the ring buffer via the
prev pointers may not.”…””}”(hj(
  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M;hj„  hžhubhÊ)”}”(hŒÞNote, the way to determine a reader page is simply by examining the previous
pointer of the page. If the next pointer of the previous page does not
point back to the original page, then the original page is a reader page::”h]”hŒÝNote, the way to determine a reader page is simply by examining the previous
pointer of the page. If the next pointer of the previous page does not
point back to the original page, then the original page is a reader page:”…””}”(hj6
  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MBhj„  hžhubj{  )”}”(hŒû +--------+
 | reader |  next   +----+
 |  page  |-------->|    |<====== (buffer page)
 +--------+         +----+
     |                | ^
     |                v | next
prev |              +----+
     +------------->|    |
                    +----+”h]”hŒû +--------+
 | reader |  next   +----+
 |  page  |-------->|    |<====== (buffer page)
 +--------+         +----+
     |                | ^
     |                v | next
prev |              +----+
     +------------->|    |
                    +----+”…””}”hjD
  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1jz  hŸh³h MGhj„  hžhubhÊ)”}”(hŒ$The way the head page moves forward:”h]”hŒ$The way the head page moves forward:”…””}”(hjR
  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MQhj„  hžhubhÊ)”}”(hXö  When the tail page meets the head page and the buffer is in overwrite mode
and more writes take place, the head page must be moved forward before the
writer may move the tail page. The way this is done is that the writer
performs a cmpxchg to convert the pointer to the head page from the HEADER
flag to have the UPDATE flag set. Once this is done, the reader will
not be able to swap the head page from the buffer, nor will it be able to
move the head page, until the writer is finished with the move.”h]”hXö  When the tail page meets the head page and the buffer is in overwrite mode
and more writes take place, the head page must be moved forward before the
writer may move the tail page. The way this is done is that the writer
performs a cmpxchg to convert the pointer to the head page from the HEADER
flag to have the UPDATE flag set. Once this is done, the reader will
not be able to swap the head page from the buffer, nor will it be able to
move the head page, until the writer is finished with the move.”…””}”(hj`
  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MShj„  hžhubhÊ)”}”(hŒŽThis eliminates any races that the reader can have on the writer. The reader
must spin, and this is why the reader cannot preempt the writer::”h]”hŒThis eliminates any races that the reader can have on the writer. The reader
must spin, and this is why the reader cannot preempt the writer:”…””}”(hjn
  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M[hj„  hžhubj{  )”}”(hX¨              tail page
               |
               v
    +---+    +---+    +---+    +---+
<---|   |--->|   |-H->|   |--->|   |--->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+

            tail page
               |
               v
    +---+    +---+    +---+    +---+
<---|   |--->|   |-U->|   |--->|   |--->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+”h]”hX¨              tail page
               |
               v
    +---+    +---+    +---+    +---+
<---|   |--->|   |-H->|   |--->|   |--->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+

            tail page
               |
               v
    +---+    +---+    +---+    +---+
<---|   |--->|   |-U->|   |--->|   |--->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+”…””}”hj|
  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1jz  hŸh³h M^hj„  hžhubhÊ)”}”(hŒ8The following page will be made into the new head page::”h]”hŒ7The following page will be made into the new head page:”…””}”(hjŠ
  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mnhj„  hžhubj{  )”}”(hŒÒ           tail page
               |
               v
    +---+    +---+    +---+    +---+
<---|   |--->|   |-U->|   |-H->|   |--->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+”h]”hŒÒ           tail page
               |
               v
    +---+    +---+    +---+    +---+
<---|   |--->|   |-U->|   |-H->|   |--->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+”…””}”hj˜
  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1jz  hŸh³h Mphj„  hžhubhÊ)”}”(hŒ[After the new head page has been set, we can set the old head page
pointer back to NORMAL::”h]”hŒZAfter the new head page has been set, we can set the old head page
pointer back to NORMAL:”…””}”(hj¦
  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mxhj„  hžhubj{  )”}”(hŒÒ           tail page
               |
               v
    +---+    +---+    +---+    +---+
<---|   |--->|   |--->|   |-H->|   |--->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+”h]”hŒÒ           tail page
               |
               v
    +---+    +---+    +---+    +---+
<---|   |--->|   |--->|   |-H->|   |--->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+”…””}”hj´
  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1jz  hŸh³h M{hj„  hžhubhÊ)”}”(hŒHAfter the head page has been moved, the tail page may now move forward::”h]”hŒGAfter the head page has been moved, the tail page may now move forward:”…””}”(hjÂ
  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mƒhj„  hžhubj{  )”}”(hŒí                    tail page
                        |
                        v
    +---+    +---+    +---+    +---+
<---|   |--->|   |--->|   |-H->|   |--->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+”h]”hŒí                    tail page
                        |
                        v
    +---+    +---+    +---+    +---+
<---|   |--->|   |--->|   |-H->|   |--->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+”…””}”hjÐ
  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1jz  hŸh³h M…hj„  hžhubhÊ)”}”(hŒFThe above are the trivial updates. Now for the more complex scenarios.”h]”hŒFThe above are the trivial updates. Now for the more complex scenarios.”…””}”(hjÞ
  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MŽhj„  hžhubhÊ)”}”(hX}  As stated before, if enough writes preempt the first write, the
tail page may make it all the way around the buffer and meet the commit
page. At this time, we must start dropping writes (usually with some kind
of warning to the user). But what happens if the commit was still on the
reader page? The commit page is not part of the ring buffer. The tail page
must account for this::”h]”hX|  As stated before, if enough writes preempt the first write, the
tail page may make it all the way around the buffer and meet the commit
page. At this time, we must start dropping writes (usually with some kind
of warning to the user). But what happens if the commit was still on the
reader page? The commit page is not part of the ring buffer. The tail page
must account for this:”…””•h      }”(hjì
  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M‘hj„  hžhubj{  )”}”(hXî            reader page    commit page
              |              |
              v              |
             +---+           |
             |   |<----------+
             |   |
             |   |------+
             +---+      |
                        |
                        v
    +---+    +---+    +---+    +---+
<---|   |--->|   |-H->|   |--->|   |--->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+
               ^
               |
           tail page”h]”hXî            reader page    commit page
              |              |
              v              |
             +---+           |
             |   |<----------+
             |   |
             |   |------+
             +---+      |
                        |
                        v
    +---+    +---+    +---+    +---+
<---|   |--->|   |-H->|   |--->|   |--->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+
               ^
               |
           tail page”…””}”hjú
  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1jz  hŸh³h M™hj„  hžhubhÊ)”}”(hŒŽIf the tail page were to simply push the head page forward, the commit when
leaving the reader page would not be pointing to the correct page.”h]”hŒŽIf the tail page were to simply push the head page forward, the commit when
leaving the reader page would not be pointing to the correct page.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M«hj„  hžhubhÊ)”}”(hŒËThe solution to this is to test if the commit page is on the reader page
before pushing the head page. If it is, then it can be assumed that the
tail page wrapped the buffer, and we must drop new writes.”h]”hŒËThe solution to this is to test if the commit page is on the reader page
before pushing the head page. If it is, then it can be assumed that the
tail page wrapped the buffer, and we must drop new writes.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M®hj„  hžhubhÊ)”}”(hX  This is not a race condition, because the commit page can only be moved
by the outermost writer (the writer that was preempted).
This means that the commit will not move while a writer is moving the
tail page. The reader cannot swap the reader page if it is also being
used as the commit page. The reader can simply check that the commit
is off the reader page. Once the commit page leaves the reader page
it will never go back on it unless a reader does another swap with the
buffer page that is also the commit page.”h]”hX  This is not a race condition, because the commit page can only be moved
by the outermost writer (the writer that was preempted).
This means that the commit will not move while a writer is moving the
tail page. The reader cannot swap the reader page if it is also being
used as the commit page. The reader can simply check that the commit
is off the reader page. Once the commit page leaves the reader page
it will never go back on it unless a reader does another swap with the
buffer page that is also the commit page.”…””}”(hj$  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M²hj„  hžhubeh}”(h]”Œmaking-the-ring-buffer-lockless”ah ]”h"]”Œ making the ring buffer lockless:”ah$]”h&]”uh1h´hh¶hžhhŸh³h M¢ubhµ)”}”(hhh]”(hº)”}”(hŒNested writes”h]”hŒNested writes”…””}”(hj=  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hj:  hžhhŸh³h M½ubhÊ)”}”(hŒÊIn the pushing forward of the tail page we must first push forward
the head page if the head page is the next page. If the head page
is not the next page, the tail page is simply updated with a cmpxchg.”h]”hŒÊIn the pushing forward of the tail page we must first push forward
the head page if the head page is the next page. If the head page
is not the next page, the tail page is simply updated with a cmpxchg.”…””}”(hjK  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M¿hj:  hžhubhÊ)”}”(hŒaOnly writers move the tail page. This must be done atomically to protect
against nested writers::”h]”hŒ`Only writers move the tail page. This must be done atomically to protect
against nested writers:”…””}”(hjY  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MÃhj:  hžhubj{  )”}”(hŒZtemp_page = tail_page
next_page = temp_page->next
cmpxchg(tail_page, temp_page, next_page)”h]”hŒZtemp_page = tail_page
next_page = temp_page->next
cmpxchg(tail_page, temp_page, next_page)”…””}”hjg  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1jz  hŸh³h MÆhj:  hžhubhÊ)”}”(hŒ¯The above will update the tail page if it is still pointing to the expected
page. If this fails, a nested write pushed it forward, the current write
does not need to push it::”h]”hŒ®The above will update the tail page if it is still pointing to the expected
page. If this fails, a nested write pushed it forward, the current write
does not need to push it:”…””}”(hju  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MÊhj:  hžhubj{  )”}”(hX
             temp page
               |
               v
            tail page
               |
               v
    +---+    +---+    +---+    +---+
<---|   |--->|   |--->|   |--->|   |--->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+”h]”hX
             temp page
               |
               v
            tail page
               |
               v
    +---+    +---+    +---+    +---+
<---|   |--->|   |--->|   |--->|   |--->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+”…””}”hjƒ  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1jz  hŸh³h MÏhj:  hžhubhÊ)”}”(hŒ7Nested write comes in and moves the tail page forward::”h]”hŒ6Nested write comes in and moves the tail page forward:”…””}”(hj‘  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MÚhj:  hžhubj{  )”}”(hX                       tail page (moved by nested writer)
            temp page   |
               |        |
               v        v
    +---+    +---+    +---+    +---+
<---|   |--->|   |--->|   |--->|   |--->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+”h]”hX                       tail page (moved by nested writer)
            temp page   |
               |        |
               v        v
    +---+    +---+    +---+    +---+
<---|   |--->|   |--->|   |--->|   |--->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+”…””}”hjŸ  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1jz  hŸh³h MÜhj:  hžhubhÊ)”}”(hŒ¡The above would fail the cmpxchg, but since the tail page has already
been moved forward, the writer will just try again to reserve storage
on the new tail page.”h]”hŒ¡The above would fail the cmpxchg, but since the tail page has already
been moved forward, the writer will just try again to reserve storage
on the new tail page.”…””}”(hj­  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Måhj:  hžhubhÊ)”}”(hŒ7But the moving of the head page is a bit more complex::”h]”hŒ6But the moving of the head page is a bit more complex:”…””}”(hj»  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Méhj:  hžhubj{  )”}”(hŒÓ            tail page
               |
               v
    +---+    +---+    +---+    +---+
<---|   |--->|   |-H->|   |--->|   |--->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+”h]”hŒÓ            tail page
               |
               v
    +---+    +---+    +---+    +---+
<---|   |--->|   |-H->|   |--->|   |--->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+”…””}”hjÉ  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1jz  hŸh³h Mëhj:  hžhubhÊ)”}”(hŒ4The write converts the head page pointer to UPDATE::”h]”hŒ3The write converts the head page pointer to UPDATE:”…””}”(hj×  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Móhj:  hžhubj{  )”}”(hŒÓ            tail page
               |
               v
    +---+    +---+    +---+    +---+
<---|   |--->|   |-U->|   |--->|   |--->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+”h]”hŒÓ            tail page
               |
               v
    +---+    +---+    +---+    +---+
<---|   |--->|   |-U->|   |--->|   |--->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+”…””}”hjå  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1jz  hŸh³h Mõhj:  hžhubhÊ)”}”(hX
  But if a nested writer preempts here, it will see that the next
page is a head page, but it is also nested. It will detect that
it is nested and will save that information. The detection is the
fact that it sees the UPDATE flag instead of a HEADER or NORMAL
pointer.”h]”hX
  But if a nested writer preempts here, it will see that the next
page is a head page, but it is also nested. It will detect that
it is nested and will save that information. The detection is the
fact that it sees the UPDATE flag instead of a HEADER or NORMAL
pointer.”…””}”(hjó  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mýhj:  hžhubhÊ)”}”(hŒ6The nested writer will set the new head page pointer::”h]”hŒ5The nested writer will set the new head page pointer:”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mhj:  hžhubj{  )”}”(hŒÒ           tail page
               |
               v
    +---+    +---+    +---+    +---+
<---|   |--->|   |-U->|   |-H->|   |--->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+”h]”hŒÒ           tail page
               |
               v
    +---+    +---+    +---+    +---+
<---|   |--->|   |-U->|   |-H->|   |--->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+”…””}”hj  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1jz  hŸh³h Mhj:  hžhubhÊ)”}”(hŒŽBut it will not reset the update back to normal. Only the writer
that converted a pointer from HEAD to UPDATE will convert it back
to NORMAL::”h]”hŒBut it will not reset the update back to normal. Only the writer
that converted a pointer from HEAD to UPDATE will convert it back
to NORMAL:”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mhj:  hžhubj{  )”}”(hŒí                    tail page
                        |
                        v
    +---+    +---+    +---+    +---+
<---|   |--->|   |-U->|   |-H->|   |--->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+”h]”hŒí                    tail page
                        |
                        v
    +---+    +---+    +---+    +---+
<---|   |--->|   |-U->|   |-H->|   |--->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+”…””}”hj+  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1jz  hŸh³h Mhj:  hžhubhÊ)”}”(hŒbAfter the nested writer finishes, the outermost writer will convert
the UPDATE pointer to NORMAL::”h]”hŒaAfter the nested writer finishes, the outermost writer will convert
the UPDATE pointer to NORMAL:”…””}”(hj9  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mhj:  hžhubj{  )”}”(hŒí                    tail page
                        |
                        v
    +---+    +---+    +---+    +---+
<---|   |--->|   |--->|   |-H->|   |--->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+”h]”hŒí                    tail page
                        |
                        v
    +---+    +---+    +---+    +---+
<---|   |--->|   |--->|   |-H->|   |--->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+”…””}”hjG  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1jz  hŸh³h Mhj:  hžhubhÊ)”}”(hŒjIt can be even more complex if several nested writes came in and moved
the tail page ahead several pages::”h]”hŒiIt can be even more complex if several nested writes came in and moved
the tail page ahead several pages:”…””}”(hjU  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M&hj:  hžhubj{  )”}”(hŒã(first writer)

            tail page
               |
               v
    +---+    +---+    +---+    +---+
<---|   |--->|   |-H->|   |--->|   |--->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+”h]”hŒã(first writer)

            tail page
               |
               v
    +---+    +---+    +---+    +---+
<---|   |--->|   |-H->|   |--->|   |--->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+”…””}”hjc  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1jz  hŸh³h M*hj:  hžhubhÊ)”}”(hŒ4The write converts the head page pointer to UPDATE::”h]”hŒ3The write converts the head page pointer to UPDATE:”…””}”(hjq  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M4hj:  hžhubj{  )”}”(hŒÓ            tail page
               |
               v
    +---+    +---+    +---+    +---+
<---|   |--->|   |-U->|   |--->|   |--->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+”h]”hŒÓ            tail page
               |
               v
    +---+    +---+    +---+    +---+
<---|   |--->|   |-U->|   |--->|   |--->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+”…””}”hj  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1jz  hŸh³h M6hj:  hžhubhÊ)”}”(hŒINext writer comes in, and sees the update and sets up the new
head page::”h]”hŒHNext writer comes in, and sees the update and sets up the new
head page:”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M>hj:  hžhubj{  )”}”(hŒã(second writer)

           tail page
               |
               v
    +---+    +---+    +---+    +---+
<---|   |--->|   |-U->|   |-H->|   |--->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+”h]”hŒã(second writer)

           tail page
               |
               v
    +---+    +---+    +---+    +---+
<---|   |--->|   |-U->|   |-H->|   |--->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+”…””}”hj›  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1jz  hŸh³h MAhj:  hžhubhÊ)”}”(hŒ†The nested writer moves the tail page forward. But does not set the old
update page to NORMAL because it is not the outermost writer::”h]”hŒ…The nested writer moves the tail page forward. But does not set the old
update page to NORMAL because it is not the outermost writer:”…””}”(hj©  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MKhj:  hžhubj{  )”}”(hŒí                    tail page
                        |
                        v
    +---+    +---+    +---+    +---+
<---|   |--->|   |-U->|   |-H->|   |--->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+”h]”hŒí                    tail page
                        |
                        v
    +---+    +---+    +---+    +---+
<---|   |--->|   |-U->|   |-H->|   |--->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+”…””}”hj·  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1jz  hŸh³h MNhj:  hžhubhÊ)”}”(hŒqAnother writer preempts and sees the page after the tail page is a head page.
It changes it from HEAD to UPDATE::”h]”hŒpAnother writer preempts and sees the page after the tail page is a head page.
It changes it from HEAD to UPDATE:”…””}”(hjÅ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MVhj:  hžhubj{  )”}”(hŒý(third writer)

                    tail page
                        |
                        v
    +---+    +---+    +---+    +---+
<---|   |--->|   |-U->|   |-U->|   |--->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+”h]”hŒý(third writer)

                    tail page
                        |
                        v
    +---+    +---+    +---+    +---+
<---|   |--->|   |-U->|   |-U->|   |--->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+”…””}”hjÓ  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1jz  hŸh³h MYhj:  hžhubhÊ)”}”(hŒ,The writer will move the head page forward::”h]”hŒ+The writer will move the head page forward:”…””}”(hjá  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mchj:  hžhubj{  )”}”(hŒý(third writer)

                    tail page
                        |
                        v
    +---+    +---+    +---+    +---+
<---|   |--->|   |-U->|   |-U->|   |-H->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+”h]”hŒý(third writer)

                    tail page
                        |
                        v
    +---+    +---+    +---+    +---+
<---|   |--->|   |-U->|   |-U->|   |-H->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+”…””}”hjï  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1jz  hŸh³h Mfhj:  hžhubhÊ)”}”(hŒ_But now that the third writer did change the HEAD flag to UPDATE it
will convert it to normal::”h]”hŒ^But now that the third writer did change the HEAD flag to UPDATE it
will convert it to normal:”…””}”(hjý  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mphj:  hžhubj{  )”}”(hŒý(third writer)

                    tail page
                        |
                        v
    +---+    +---+    +---+    +---+
<---|   |--->|   |-U->|   |--->|   |-H->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+”h]”hŒý(third writer)

                    tail page
                        |
                        v
    +---+    +---+    +---+    +---+
<---|   |--->|   |-U->|   |--->|   |-H->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+”…””}”hj  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1jz  hŸh³h Mthj:  hžhubhÊ)”}”(hŒGThen it will move the tail page, and return back to the second writer::”h]”hŒFThen it will move the tail page, and return back to the second writer:”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mhj:  hžhubj{  )”}”(hX  (second writer)

                             tail page
                                 |
                                 v
    +---+    +---+    +---+    +---+
<---|   |--->|   |-U->|   |--->|   |-H->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+”h]”hX  (second writer)

                             tail page
                                 |
                                 v
    +---+    +---+    +---+    +---+
<---|   |--->|   |-U->|   |--->|   |-H->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+”…””}”hj'  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1jz  hŸh³h M‚hj:  hžhubhÊ)”}”(hŒ°The second writer will fail to move the tail page because it was already
moved, so it will try again and add its data to the new tail page.
It will return to the first writer::”h]”hŒ¯The second writer will fail to move the tail page because it was already
moved, so it will try again and add its data to the new tail page.
It will return to the first writer:”…””}”(hj5  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mhj:  hžhubj{  )”}”(hX  (first writer)

                             tail page
                                 |
                                 v
    +---+    +---+    +---+    +---+
<---|   |--->|   |-U->|   |--->|   |-H->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+”h]”hX  (first writer)

                             tail page
                                 |
                                 v
    +---+    +---+    +---+    +---+
<---|   |--->|   |-U->|   |--->|   |-H->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+”…””}”hjC  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1jz  hŸh³h M’hj:  hžhubhÊ)”}”(hŒ©The first writer cannot know atomically if the tail page moved
while it updates the HEAD page. It will then update the head page to
what it thinks is the new head page::”h]”hŒ¨The first writer cannot know atomically if the tail page moved
while it updates the HEAD page. It will then update the head page to
what it thinks is the new head page:”…””}”(hjQ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Mœhj:  hžhubj{  )”}”(hX  (first writer)

                             tail page
                                 |
                                 v
    +---+    +---+    +---+    +---+
<---|   |--->|   |-U->|   |-H->|   |-H->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+”h]”hX  (first writer)

                             tail page
                                 |
                                 v
    +---+    +---+    +---+    +---+
<---|   |--->|   |-U->|   |-H->|   |-H->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+”…””}”hj_  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1jz  hŸh³h M¡hj:  hžhubhÊ)”}”(hX  Since the cmpxchg returns the old value of the pointer the first writer
will see it succeeded in updating the pointer from NORMAL to HEAD.
But as we can see, this is not good enough. It must also check to see
if the tail page is either where it use to be or on the next page::”h]”hX  Since the cmpxchg returns the old value of the pointer the first writer
will see it succeeded in updating the pointer from NORMAL to HEAD.
But as we can see, this is not good enough. It must also check to see
if the tail page is either where it use to be or on the next page:”…””}”(hjm  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M«hj:  hžhubj{  )”}”(hX  (first writer)

               A        B    tail page
               |        |        |
               v        v        v
    +---+    +---+    +---+    +---+
<---|   |--->|   |-U->|   |-H->|   |-H->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+”h]”hX  (first writer)

               A        B    tail page
               |        |        |
               v        v        v
    +---+    +---+    +---+    +---+
<---|   |--->|   |-U->|   |-H->|   |-H->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+”…””}”hj{  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1jz  hŸh³h M±hj:  hžhubhÊ)”}”(hŒÓIf tail page != A and tail page != B, then it must reset the pointer
back to NORMAL. The fact that it only needs to worry about nested
writers means that it only needs to check this after setting the HEAD page::”h]”hŒÒIf tail page != A and tail page != B, then it must reset the pointer
back to NORMAL. The fact that it only needs to worry about nested
writers means that it only needs to check this after setting the HEAD page:”…””}”(hj‰  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h M»hj:  hžhubj{  )”}”(hX  (first writer)

               A        B    tail page
               |        |        |
               v        v        v
    +---+    +---+    +---+    +---+
<---|   |--->|   |-U->|   |--->|   |-H->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+”h]”hX  (first writer)

               A        B    tail page
               |        |        |
               v        v        v
    +---+    +---+    +---+    +---+
<---|   |--->|   |-U->|   |--->|   |-H->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+”…””}”hj—  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1jz  hŸh³h MÀhj:  hžhubhÊ)”}”(hŒÄNow the writer can update the head page. This is also why the head page must
remain in UPDATE and only reset by the outermost writer. This prevents
the reader from seeing the incorrect head page::”h]”hŒÃNow the writer can update the head page. This is also why the head page must
remain in UPDATE and only reset by the outermost writer. This prevents
the reader from seeing the incorrect head page:”…””}”(hj¥  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h MÊhj:  hžhubj{  )”}”(hX  (first writer)

               A        B    tail page
               |        |        |
               v        v        v
    +---+    +---+    +---+    +---+
<---|   |--->|   |--->|   |--->|   |-H->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+”h]”hX  (first writer)

               A        B    tail page
               |        |        |
               v        v        v
    +---+    +---+    +---+    +---+
<---|   |--->|   |--->|   |--->|   |-H->
--->|   |<---|   |<---|   |<---|   |<---
    +---+    +---+    +---+    +---+”…””}”hj³  sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1jz  hŸh³h MÏhj:  hžhubeh}”(h]”Œnested-writes”ah ]”h"]”Œnested writes”ah$]”h&]”uh1h´hh¶hžhhŸh³h M½ubeh}”(h]”Œlockless-ring-buffer-design”ah ]”h"]”Œlockless ring buffer design”ah$]”h&]”uh1h´hhhžhhŸh³h Kubeh}”(h]”h ]”h"]”h$]”h&]”Œsource”h³uh1hŒcurrent_source”NŒcurrent_line”NŒsettings”Œdocutils.frontend”ŒValues”“”)”}”(h¹NŒ	generator”NŒ	datestamp”NŒsource_link”NŒ
source_url”NŒtoc_backlinks”Œentry”Œfootnote_backlinks”KŒsectnum_xform”KŒstrip_comments”NŒstrip_elements_with_classes”NŒstrip_classes”NŒreport_level”KŒ
halt_level”KŒexit_status_level”KŒdebug”NŒwarning_stream”NŒ	traceback”ˆŒinput_encoding”Œ	utf-8-sig”Œinput_encoding_error_handler”Œstrict”Œoutput_encoding”Œutf-8”Œoutput_encoding_error_handler”jô  Œerror_encoding”Œutf-8”Œerror_encoding_error_handler”Œbackslashreplace”Œlanguage_code”Œen”Œrecord_dependencies”NŒconfig”NŒ	id_prefix”hŒauto_id_prefix”Œid”Œdump_settings”NŒdump_internals”NŒdump_transforms”NŒdump_pseudo_xml”NŒexpose_internals”NŒstrict_visitor”NŒ_disable_config”NŒ_source”h³Œ_destination”NŒ_config_files”]”Œ7/var/lib/git/docbuild/linux/Documentation/docutils.conf”aŒfile_insertion_enabled”ˆŒraw_enabled”KŒline_length_limit”M'Œpep_references”NŒpep_base_url”Œhttps://peps.python.org/”Œpep_file_url_template”Œpep-%04d”Œrfc_references”NŒrfc_base_url”Œ&https://datatracker.ietf.org/doc/html/”Œ	tab_width”KŒtrim_footnote_reference_space”‰Œsyntax_highlight”Œlong”Œsmart_quotes”ˆŒsmartquotes_locales”]”Œcharacter_level_inline_markup”‰Œdoctitle_xform”‰Œdocinfo_xform”KŒsectsubtitle_xform”‰Œimage_loading”Œlink”Œembed_stylesheet”‰Œcloak_email_addresses”ˆŒsection_self_link”‰Œenv”NubŒreporter”NŒindirect_targets”]”Œsubstitution_defs”}”Œsubstitution_names”}”Œrefnames”}”Œrefids”}”Œnameids”}”(jÎ  jË  jÏ  jÌ  j  j~  j7  j4  jÆ  jÃ  uŒ	nametypes”}”(jÎ  ‰jÏ  ‰j  ‰j7  ‰jÆ  ‰uh}”(jË  h¶jÌ  jš  j~  jÒ  j4  j„  jÃ  j:  uŒfootnote_refs”}”Œcitation_refs”}”Œautofootnotes”]”Œautofootnote_refs”]”Œsymbol_footnotes”]”Œsymbol_footnote_refs”]”Œ	footnotes”]”Œ	citations”]”Œautofootnote_start”KŒsymbol_footnote_start”K Œ
id_counter”Œcollections”ŒCounter”“”}”…”R”Œparse_messages”]”Œtransform_messages”]”Œtransformer”NŒinclude_log”]”Œ
decoration”Nhžhub.