changed lanes.threads() output so that several lanes with the same name don't clobber each other in the result table

In the original implementations, the debug name was used as key, which meant that several lanes using the same name would cause only the oldest non-collected one to be listed in the results. Now the result is an array of tuples.
author: Benoit Germain <bnt.germain@gmail.com> 2021-06-16 18:41:14 +0200
committer: Benoit Germain <bnt.germain@gmail.com> 2021-06-16 18:41:14 +0200
commit: 5875fe44ba7a240dd101f954c7dc83337a0c2cef (patch)
tree: 5c53b56b750c135163d462a39217fb88f8741ed6
parent: 21b2ac762ff8a5926872963aa2fd8feeb1bf3b39 (diff)
download: lanes-5875fe44ba7a240dd101f954c7dc83337a0c2cef.tar.gz
lanes-5875fe44ba7a240dd101f954c7dc83337a0c2cef.tar.bz2
lanes-5875fe44ba7a240dd101f954c7dc83337a0c2cef.zip
5 files changed, 130 insertions, 49 deletions
diff --git a/CHANGES b/CHANGES
index 2b381bd..c3893d0 100644
--- a/CHANGES
+++ b/CHANGES
@@ -1,5 +1,9 @@
 CHANGES:
+CHANGE 147: BGe 16-Jun-21
+   * changed lanes.threads() output so that several lanes with the same name don't clobber each other in the result table
+   * bumped version to 3.15 because of the API change
 CHANGE 146: BGe 26-Apr-19
   * lane:cancel() rework (see doc).
   * opt.cancelstep is gone, hook is installed by lane:cancel() if requested
@@ -662,15 +666,15 @@ CHANGE 6 (bug fix) AKa 15-Oct-2008:
    Added local caches of the following to src/lanes.lua (was otherwise getting
    errors at least in 'tests/irayo_recursive.lua').
-                local assert= assert
+        local assert= assert
-                local string_gmatch= assert( string.gmatch )
+        local string_gmatch= assert( string.gmatch )
-                local select= assert( select )
+        local select= assert( select )
-                local type= assert( type )
+        local type= assert( type )
-                local pairs= assert( pairs )
+        local pairs= assert( pairs )
-                local tostring= assert( tostring )
+        local tostring= assert( tostring )
-                local error= assert( error )
+        local error= assert( error )
-                local setmetatable= assert( setmetatable )
+        local setmetatable= assert( setmetatable )
-                local rawget= assert( rawget )
+        local rawget= assert( rawget )
    Thanks to Irayo for detecting and reporting this.
diff --git a/docs/index.html b/docs/index.html
index 0b19223..49b862f 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -1,6 +1,6 @@
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
 <!--
-    Documentation for Lua Lanes
+        Documentation for Lua Lanes
 -->
 <html>
@@ -85,13 +85,13 @@
        Lua Lanes is a Lua extension library providing the possibility to run multiple Lua states in parallel. It is intended to be used for optimizing performance on multicore CPU's and to study ways to make Lua programs naturally parallel to begin with.
 </p>
 <p>
-    Lanes is included into your software by the regular <tt>require "lanes"</tt> method. No C side programming is needed; all APIs are Lua side, and most existing extension modules should work seamlessly together with the multiple lanes.
+        Lanes is included into your software by the regular <tt>require "lanes"</tt> method. No C side programming is needed; all APIs are Lua side, and most existing extension modules should work seamlessly together with the multiple lanes.
 </p>
 <p>
-  Starting with version 3.1.6, Lanes should build and run identically with either Lua 5.1 or Lua 5.2. Version 3.10.0 supports Lua 5.3.
+        Starting with version 3.1.6, Lanes should build and run identically with either Lua 5.1 or Lua 5.2. Version 3.10.0 supports Lua 5.3.
 </p>
 <p>
-    See <A HREF="comparison.html">comparison</A> of Lua Lanes with other Lua multithreading solutions.
+        See <A HREF="comparison.html">comparison</A> of Lua Lanes with other Lua multithreading solutions.
 </p>
 <p>
        <h3>Features:</h3>
@@ -134,11 +134,11 @@
                <li>Openwrt (15.05 and later)</li>
                <li>Windows 2000/XP and later <font size="-1">(MinGW or Visual C++ 2005/2008)</font></li>
 <!--
-    Other OS'es here once people help test them. (and the tester's name)
+        Other OS'es here once people help test them. (and the tester's name)
-    Win64, BSD, Linux x64, Linux embedded, QNX, Solaris, ...
+        Win64, BSD, Linux x64, Linux embedded, QNX, Solaris, ...
 -->
-                </ul>
+        </ul>
 </p>
 <p>
@@ -843,7 +843,7 @@
        <table border="1" bgcolor="#E0E0FF" cellpadding="10" style="width:50%">
                <tr>
                        <td>
-                                <pre>   {}|nil = lanes.threads()</pre>
+                                <pre>   {{name = "name", status = "status", ...}|nil = lanes.threads()</pre>
                        </td>
                </tr>
        </table>
@@ -851,7 +851,7 @@
 <p>
        Only available if lane tracking feature is compiled (see <tt>HAVE_LANE_TRACKING</tt> in <tt>lanes.c</tt>) and <a href="#track_lanes"><tt>track_lanes</tt></a> is set.
        <br/>
-        Returns a table where keys are a lane's name and values are the lane's status. Returns <tt>nil</tt> if no lane is running.
+        Returns an array table where each entry is a table containing a lane's name and status. Returns <tt>nil</tt> if no lane is running.
 </p>
@@ -891,7 +891,7 @@
 </p>
 <p>
-  <tt>stack_tbl</tt> is a table describing where the error was thrown.
+<tt>stack_tbl</tt> is a table describing where the error was thrown.
        <br/>
  In <tt>"extended"</tt> mode, <tt>stack_tbl</tt> is an array of tables containing info gathered with <tt>lua_getinfo()</tt> (<tt>"source"</tt>,<tt>"currentline"</tt>,<tt>"name"</tt>,<tt>"namewhat"</tt>,<tt>"what"</tt>).
        <br/>
@@ -1434,7 +1434,7 @@ events to a common Linda, but... :).</font>
                        </ul>
                </li>
                <li>Coroutines cannot be passed. A coroutine's Lua state is tied to the Lua state that created it, and there is no way the mixed C/Lua stack of a coroutine can be transfered from one Lua state to another.</li>
-        <li>Starting with version 3.10.1, if the metatable contains <tt>__lanesignore</tt>, the object is skipped and <tt>nil</tt> is transfered instead.</li>
+                <li>Starting with version 3.10.1, if the metatable contains <tt>__lanesignore</tt>, the object is skipped and <tt>nil</tt> is transfered instead.</li>
        </ul>
 </p>
@@ -1575,7 +1575,7 @@ static int clonable_lanesclone( lua_State* L)
 </p>
 <p>
-    <b>NOTE</b>: In the event the source userdata has uservalues, it is not necessary to create them for the clone, Lanes will handle their cloning.<br/>
+        <b>NOTE</b>: In the event the source userdata has uservalues, it is not necessary to create them for the clone, Lanes will handle their cloning.<br/>
        Of course, more complex objects may require smarter cloning behavior than a simple <tt>memcpy</tt>. Also, the module initialisation code should make each metatable accessible from the module table itself as in:
 <table border="1" bgcolor="#FFFFE0" cellpadding="10" style="width:50%"><tr><td><pre>
 int luaopen_deep_test(lua_State* L)
@@ -1645,13 +1645,13 @@ int luaD_new_clonable( lua_State* L)
 </p>
 <p>
-    Deep userdata in transit inside keeper states (sent in a linda but not yet consumed) don't call <tt>idfunc(eDO_delete)</tt> and aren't considered by reference counting. The rationale is the following:
+        Deep userdata in transit inside keeper states (sent in a linda but not yet consumed) don't call <tt>idfunc(eDO_delete)</tt> and aren't considered by reference counting. The rationale is the following:
-    <br />
+        <br />
-    If some non-keeper state holds a deep userdata for some deep object, then even if the keeper collects its own deep userdata, it shouldn't be cleaned up since the refcount is not 0.
+        If some non-keeper state holds a deep userdata for some deep object, then even if the keeper collects its own deep userdata, it shouldn't be cleaned up since the refcount is not 0.
-    <br />
+        <br />
-    OTOH, if a keeper state holds the last deep userdata for some deep object, then no lane can do actual work with it. Deep userdata's <tt>idfunc()</tt> is never called from a keeper state.
+        OTOH, if a keeper state holds the last deep userdata for some deep object, then no lane can do actual work with it. Deep userdata's <tt>idfunc()</tt> is never called from a keeper state.
-    <br />
+        <br />
-    Therefore, Lanes can just call <tt>idfunc(eDO_delete)</tt> when the last non-keeper-held deep userdata is collected, as long as it doesn't do the same in a keeper state after that, since any remaining deep userdata in keeper states now hold stale pointers.
+        Therefore, Lanes can just call <tt>idfunc(eDO_delete)</tt> when the last non-keeper-held deep userdata is collected, as long as it doesn't do the same in a keeper state after that, since any remaining deep userdata in keeper states now hold stale pointers.
 </p>
 <p>
diff --git a/src/lanes.c b/src/lanes.c
index 8f159a9..f3fdc76 100644
--- a/src/lanes.c
+++ b/src/lanes.c
@@ -1652,26 +1652,31 @@ LUAG_FUNC( thread_index)
 // Return a list of all known lanes
 LUAG_FUNC( threads)
 {
-        int const top = lua_gettop( L);
+  int const top = lua_gettop( L);
-        Universe* U = universe_get( L);
+  Universe* U = universe_get( L);
-        // List _all_ still running threads
+  // List _all_ still running threads
-        //
+  //
-        MUTEX_LOCK( &U->tracking_cs);
+  MUTEX_LOCK( &U->tracking_cs);
-        if( U->tracking_first && U->tracking_first != TRACKING_END)
+  if( U->tracking_first && U->tracking_first != TRACKING_END)
-        {
+  {
-                Lane* s = U->tracking_first;
+    Lane* s = U->tracking_first;
-                lua_newtable( L);                                          // {}
+    int index = 0;
-                while( s != TRACKING_END)
+    lua_newtable( L);                                          // {}
-                {
+    while( s != TRACKING_END)
-                        lua_pushstring( L, s->debug_name);                       // {} "name"
+    {
-                        push_thread_status( L, s);                               // {} "name" "status"
+      // insert a { name, status } tuple, so that several lanes with the same name can't clobber each other
-                        lua_rawset( L, -3);                                      // {}
+      lua_newtable( L);                                        // {} {}
-                        s = s->tracking_next;
+      lua_pushstring( L, s->debug_name);                       // {} {} "name"
-                }
+      lua_setfield( L, -2, "name");                            // {} {}
-        }
+      push_thread_status( L, s);                               // {} {} "status"
-        MUTEX_UNLOCK( &U->tracking_cs);
+      lua_setfield( L, -2, "status");                          // {} {}
-        return lua_gettop( L) - top;
+      lua_rawseti( L, -2, ++ index);                           // {}
+      s = s->tracking_next;
+    }
+  }
+  MUTEX_UNLOCK( &U->tracking_cs);
+  return lua_gettop( L) - top; // 0 or 1
 }
 #endif // HAVE_LANE_TRACKING
diff --git a/src/lanes.h b/src/lanes.h
index da0dd26..1a38ba5 100644
--- a/src/lanes.h
+++ b/src/lanes.h
@@ -11,7 +11,7 @@
 #endif // (defined PLATFORM_WIN32) || (defined PLATFORM_POCKETPC)
 #define LANES_VERSION_MAJOR 3
-#define LANES_VERSION_MINOR 14
+#define LANES_VERSION_MINOR 15
 #define LANES_VERSION_PATCH 0
 #define LANES_MIN_VERSION_REQUIRED(MAJOR, MINOR, PATCH)     ((LANES_VERSION_MAJOR>MAJOR) || (LANES_VERSION_MAJOR==MAJOR && (LANES_VERSION_MINOR>MINOR || (LANES_VERSION_MINOR==MINOR && LANES_VERSION_PATCH>=PATCH))))
diff --git a/tests/track_lanes.lua b/tests/track_lanes.lua
new file mode 100644
index 0000000..46cfdad
--- /dev/null
+++ b/tests/track_lanes.lua
@@ -0,0 +1,72 @@
+local lanes = require "lanes" .configure{ with_timers = false, track_lanes = true}
+local wait
+do
+    local linda = lanes.linda()
+    wait = function( seconds_)
+        linda:receive( seconds_, "dummy_key")
+    end
+end
+print "hello"
+local track = function( title_)
+    print( title_)
+    for k, v in pairs( lanes.threads())
+    do
+        print( k, v.name, v.status)
+    end
+    print( "\n")
+end
+local sleeper = function( name_, seconds_)
+    -- print( "entering '" .. name_ .. "'")
+    local lanes = require "lanes"
+    -- no set_debug_threadname in main thread
+    if set_debug_threadname
+    then
+        -- print( "set_debug_threadname('" .. name_ .. "')")
+        set_debug_threadname( name_)
+    end
+    -- suspend the lane for the specified duration with a failed linda read
+    wait( seconds_)
+    -- print( "exiting '" .. name_ .. "'")
+end
+-- sleeper( "main", 1)
+-- the generator
+local g = lanes.gen( "*", sleeper)
+-- start a forever-waiting lane (nil timeout)
+g( "forever")
+-- start a lane that will last 2 seconds
+g( "two_seconds", 2)
+ 
+-- give a bit of time to reach the linda waiting call
+wait( 0.1)
+-- list the known lanes
+track( "============= START")
+-- wait until "two_seconds has completed"
+wait(2.1)
+track( "============= two_seconds dead")
+-- this will collect the completed lane (and remove it from the tracking queue)
+-- collectgarbage()
+-- track( "============= two_seconds dead (after collectgarbage)")
+-- start another lane that will last 2 seconds, with the same name
+g( "two_seconds", 2)
+ 
+-- give a bit of time to reach the linda waiting call
+wait( 0.1)
+-- list the known lanes
+track( "============= ANOTHER")
+print "done"
+\ No newline at end of file
author	Benoit Germain <bnt.germain@gmail.com>	2021-06-16 18:41:14 +0200
committer	Benoit Germain <bnt.germain@gmail.com>	2021-06-16 18:41:14 +0200
commit	5875fe44ba7a240dd101f954c7dc83337a0c2cef (patch)
tree	5c53b56b750c135163d462a39217fb88f8741ed6
parent	21b2ac762ff8a5926872963aa2fd8feeb1bf3b39 (diff)
download	lanes-5875fe44ba7a240dd101f954c7dc83337a0c2cef.tar.gz lanes-5875fe44ba7a240dd101f954c7dc83337a0c2cef.tar.bz2 lanes-5875fe44ba7a240dd101f954c7dc83337a0c2cef.zip