File 0538-stdlib-Clarify-ets-docs-about-table-iterat... of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 0538-stdlib-Clarify-ets-docs-about-table-iterations.patch of Package erlang (Revision ac78bcc5a6f7a4d1efd770008567e9f7)

Currently displaying revision ac78bcc5a6f7a4d1efd770008567e9f7 , Show latest

From 429aaac6c25bccfd443e95f1502b680c1cc83a3f Mon Sep 17 00:00:00 2001
From: Sverker Eriksson <sverker@erlang.org>
Date: Mon, 21 Jan 2019 21:02:37 +0100
Subject: [PATCH] stdlib: Clarify ets docs about table iterations

---
 lib/stdlib/doc/src/ets.xml | 121 ++++++++++++++++++++++++++++++++-------------
 1 file changed, 87 insertions(+), 34 deletions(-)

diff --git a/lib/stdlib/doc/src/ets.xml b/lib/stdlib/doc/src/ets.xml
index 70d1aaa74d..ccccf7de88 100644
--- a/lib/stdlib/doc/src/ets.xml
+++ b/lib/stdlib/doc/src/ets.xml
@@ -138,23 +138,56 @@
 operation. In database terms the isolation level can be seen as
 "serializable", as if all isolated operations are carried out serially,
 one after the other in a strict order.
+ </section>
 
- No other support is available within this module that would guarantee
- consistency between objects. However, function
- <seealso marker="#safe_fixtable/2"><c>safe_fixtable/2</c></seealso>
- can be used to guarantee that a sequence of
- <seealso marker="#first/1"><c>first/1</c></seealso> and
- <seealso marker="#next/2"><c>next/2</c></seealso> calls traverse the
- table without errors and that each existing object in the table is
- visited exactly once, even if another (or the same) process
- simultaneously deletes or inserts objects into the table.
- Nothing else is guaranteed; in particular objects that are inserted
- or deleted during such a traversal can be visited once or not at all.
- Functions that internally traverse over a table, like
- <seealso marker="#select/1"><c>select</c></seealso> and
- <seealso marker="#match/1"><c>match</c></seealso>,
- give the same guarantee as
- <seealso marker="#safe_fixtable/2"><c>safe_fixtable</c></seealso>.
+ <section><marker id="traversal"></marker>
+ <title>Table traversal</title>
+ There are different ways to traverse through the objects of a table.
+ <list type="bulleted">
+ <item>Single-step traversal one key at at time, using
+	<seealso marker="#first/1"><c>first/1</c></seealso>,
+	<seealso marker="#next/2"><c>next/2</c></seealso>,
+	<seealso marker="#last/1"><c>last/1</c></seealso> and
+	<seealso marker="#prev/2"><c>prev/2</c></seealso>.
+ </item>
+ <item>Search with simple match patterns, using
+	<seealso marker="#match/1"><c>match/1/2/3</c></seealso>,
+	<seealso marker="#match_delete/2"><c>match_delete/2</c></seealso> and
+	<seealso marker="#match_object/1"><c>match_object/1/2/3</c></seealso>.
+ </item>
+ <item>Search with more powerful match specifications, using
+	<seealso marker="#select/1"><c>select/1/2/3</c></seealso>,
+	<seealso marker="#select_count/2"><c>select_count/2</c></seealso>,
+	<seealso marker="#select_delete/2"><c>select_delete/2</c></seealso>,
+	<seealso marker="#select_replace/2"><c>select_replace/2</c></seealso> and
+	<seealso marker="#select_reverse/1"><c>select_reverse/1/2/3</c></seealso>.
+ </item>
+ <item>Table conversions, using
+	<seealso marker="#tab2file/2"><c>tab2file/2/3</c></seealso> and
+ <seealso marker="#tab2list/1"><c>tab2list/1</c></seealso>.
+ </item>
+ </list>
+ None of these ways of table traversal will guarantee a consistent table snapshot
+ if the table is also updated during the traversal. Moreover, traversals not
+ done in a safe way, on tables where keys are inserted or deleted
+ during the traversal, may yield the following undesired effects:
+ <list type="bulleted">
+ <item>Any key may be missed.</item>
+ <item>Any key may be found more than once.</item>
+ <item>The traversal may fail with <c>badarg</c> exception if keys are deleted.
+ </item>
+ </list>
+ A table traversal is safe if either
+ <list type="bulleted">
+ <item>the table is of type <c>ordered_set</c>.
+ </item>
+ <item>the entire table traversal is done within one ETS function
+ call.
+ </item>
+ <item>function <seealso marker="#safe_fixtable/2"><c>safe_fixtable/2</c></seealso>
+ is used to keep the table fixated during the entire traversal.
+ </item>
+ </list>
 </section>
 
 <section>
@@ -871,6 +904,9 @@ ets:is_compiled_ms(Broken).</code>
 <seealso marker="#first/1"><c>first/1</c></seealso> and
 <seealso marker="#next/2"><c>next/2</c></seealso>.
 If the table is empty, <c>'$end_of_table'</c> is returned.
+	Use <seealso marker="#safe_fixtable/2"><c>safe_fixtable/2</c></seealso>
+	 to guarantee <seealso marker="#traversal">safe traversal</seealso>
+	 for subsequent calls to <seealso marker="#match/1"><c>match/1</c></seealso>.
 </desc>
 </func>
 
@@ -936,6 +972,10 @@ ets:is_compiled_ms(Broken).</code>
 <seealso marker="#first/1"><c>first/1</c></seealso> and
 <seealso marker="#next/2"><c>next/2</c></seealso>.
 If the table is empty, <c>'$end_of_table'</c> is returned.
+	Use <seealso marker="#safe_fixtable/2"><c>safe_fixtable/2</c></seealso>
+	 to guarantee <seealso marker="#traversal">safe traversal</seealso>
+	 for subsequent calls to <seealso marker="#match_object/1">
+	 <c>match_object/1</c></seealso>.
 </desc>
 </func>
 
@@ -1192,12 +1232,13 @@ ets:select(Table, MatchSpec),</code>
 To find the first key in the table, use
 <seealso marker="#first/1"><c>first/1</c></seealso>.
 Unless a table of type <c>set</c>, <c>bag</c>, or
- <c>duplicate_bag</c> is protected using
+ <c>duplicate_bag</c> is fixated using
 <seealso marker="#safe_fixtable/2"><c>safe_fixtable/2</c></seealso>,
- a traversal can fail if
- concurrent updates are made to the table. For table
- type <c>ordered_set</c>, the function returns the next key in
- order, even if the object does no longer exist.
+ a call to <c>next/2</c> will fail if <c><anno>Key1</anno></c> no longer
+	 exists in the table. For table type <c>ordered_set</c>, the function
+	 always returns the next key after <c><anno>Key1</anno></c> in term
+	 order, regardless whether <c><anno>Key1</anno></c> ever existed in the
+	 table.
 </desc>
 </func>
 
@@ -1212,7 +1253,7 @@ ets:select(Table, MatchSpec),</code>
 table types, the function is synonymous to
 <seealso marker="#next/2"><c>next/2</c></seealso>.
 If no previous key exists, <c>'$end_of_table'</c> is returned.
- To find the last key in the table, use
+ To find the last key in an <c>ordered_set</c> table, use
 <seealso marker="#last/1"><c>last/1</c></seealso>.
 </desc>
 </func>
@@ -1287,7 +1328,16 @@ ets:select(ets:repair_continuation(Broken,MS)).</code>
 <fsummary>Fix an ETS table for safe traversal.</fsummary>
 <desc>
 Fixes a table of type <c>set</c>, <c>bag</c>, or
- <c>duplicate_bag</c> for safe traversal.
+ <c>duplicate_bag</c> for <seealso marker="#traversal">
+	safe traversal</seealso> using
+	<seealso marker="#first/1"><c>first/1</c></seealso> &amp;
+	<seealso marker="#next/2"><c>next/2</c></seealso>,
+	<seealso marker="#match/3"><c>match/3</c></seealso> &amp;
+	<seealso marker="#match/1"><c>match/1</c></seealso>,
+	<seealso marker="#match_object/3"><c>match_object/3</c></seealso> &amp;
+	<seealso marker="#match_object/1"><c>match_object/1</c></seealso>, or
+	<seealso marker="#select/3"><c>select/3</c></seealso> &amp;
+	<seealso marker="#select/1"><c>select/1</c></seealso>.
 A process fixes a table by calling
 <c>safe_fixtable(<anno>Tab</anno>, true)</c>. The table remains
 fixed until the process releases it by calling
@@ -1300,11 +1350,11 @@ ets:select(ets:repair_continuation(Broken,MS)).</code>
 When a table is fixed, a sequence of
 <seealso marker="#first/1"><c>first/1</c></seealso> and
 <seealso marker="#next/2"><c>next/2</c></seealso> calls are
- guaranteed to succeed, and each object in
- the table is returned only once, even if objects
- are removed or inserted during the traversal. The keys for new
- objects inserted during the traversal can be returned by
- <c>next/2</c> (it depends on the internal ordering of the keys).
+ guaranteed to succeed even if keys are removed during the
+	 traversal. The keys for objects inserted or deleted during a
+	 traversal may or may not be returned by <c>next/2</c> depending on
+	 the ordering of keys within the table and if the key exists at the time
+	 <c>next/2</c> is called.
 Example:
 <code type="none">
 clean_all_with_value(Tab,X) ->
@@ -1322,7 +1372,7 @@ clean_all_with_value(Tab,X,Key) ->
 true
 end,
 clean_all_with_value(Tab,X,ets:next(Tab,Key)).</code>
- Notice that no deleted objects are removed from a
+ Notice that deleted objects are not freed from a
 fixed table until it has been released. If a process fixes a
 table but never releases it, the memory used by the deleted
 objects is never freed. The performance of operations on
@@ -1332,9 +1382,9 @@ clean_all_with_value(Tab,X,Key) ->
 <c>info(Tab, safe_fixed_monotonic_time)</c></seealso>. A system with
 many processes fixing tables can need a monitor that sends alarms
 when tables have been fixed for too long.
- Notice that for table type <c>ordered_set</c>,
- <c>safe_fixtable/2</c> is not necessary, as calls to
- <c>first/1</c> and <c>next/2</c> always succeed.
+ Notice that <c>safe_fixtable/2</c> is not necessary for table type
+	<c>ordered_set</c> and for traversals done by a single ETS function call,
+	like <seealso marker="#select/2"><c>select/2</c></seealso>.
 </desc>
 </func>
 
@@ -1462,7 +1512,10 @@ is_integer(X), is_integer(Y), X + Y < 4711]]></code>
 table, which is still faster than traversing the table object by
 object using <seealso marker="#first/1"><c>first/1</c></seealso>
 and <seealso marker="#next/2"><c>next/2</c></seealso>.
- If the table is empty, <c>'$end_of_table'</c> is returned.
+ If the table is empty, <c>'$end_of_table'</c> is returned.
+	 Use <seealso marker="#safe_fixtable/2"><c>safe_fixtable/2</c></seealso>
+	 to guarantee <seealso marker="#traversal">safe traversal</seealso>
+	 for subsequent calls to <seealso marker="#select/1"><c>select/1</c></seealso>.
 </desc>
 </func>
 
-- 
2.16.4

Places

File 0538-stdlib-Clarify-ets-docs-about-table-iterations.patch of Package erlang (Revision ac78bcc5a6f7a4d1efd770008567e9f7)

Places