fix: compilation unit name conflicts with runtime sub-libraries. (#85)

The libraries in subdirectories under `riot/runtime` have been merged
into `runtime` itself.

In various places we now need to refer to (e.g.) `Runtime.Core` instead
of `Core` directly.

To avoid name conflicts with the `Runtime` module itself (including via
`Lib.Runtime`), I renamed `runtime` to `riot_runtime`.

In all, the following compilation unit names have been purged from the
global namespace:

- Core
- Log
- Runtime
- Scheduler
- Time
- Util

bench/spawn_many.ml

@@ -7,7 +7,7 @@ module Test_app = struct
 
   let loop count =
     match receive_any () with
-    | Loop_stop -> Log.debug (fun f -> f "dead at %d%!" count)
+    | Loop_stop -> Riot_runtime.Log.debug (fun f -> f "dead at %d%!" count)
 
   let main t0 () =
     Logger.info (fun f -> f "boot test app");

riot/dune

@@ -1,4 +1,4 @@
 (library
  (name riot)
  (public_name riot)
- (libraries lib runtime))
+ (libraries lib riot_runtime))

riot/lib/dune

@@ -4,7 +4,7 @@
  (libraries
   global
   logger
-  runtime
+  riot_runtime
   tls
   bytestring
   telemetry

riot/lib/global/dune

@@ -1,4 +1,4 @@
 (library
  (package riot)
  (name global)
- (libraries runtime))
+ (libraries riot_runtime))

riot/lib/global/global.ml

@@ -1,7 +1,7 @@
-include Runtime.Import
+include Riot_runtime.Import
 
 (* TODO(@leostera): move these into the Runtime module below *)
-include Runtime.Core.Process.Exn
-include Runtime.Core.Proc_registry.Exn
+include Riot_runtime.Core.Process.Exn
+include Riot_runtime.Core.Proc_registry.Exn
 
 let ( let* ) = Result.bind

riot/lib/hashmap.ml

@@ -1 +1 @@
-include Runtime.Util.Dashmap
+include Riot_runtime.Util.Dashmap

riot/lib/logger/dune

@@ -1,4 +1,4 @@
 (library
  (package riot)
  (name logger)
- (libraries global runtime))
+ (libraries global riot_runtime))

riot/lib/logger/logger.ml

@@ -1,5 +1,5 @@
-module Scheduler_uid = Runtime.Core.Scheduler_uid
-module Log = Runtime.Log
+module Scheduler_uid = Riot_runtime.Core.Scheduler_uid
+module Log = Riot_runtime.Log
 open Global
 
 type opts = { print_source : bool; print_time : bool; color_output : bool }
@@ -43,7 +43,7 @@ end
 type log = {
   level : level;
   ts : Ptime.t;
-  src : Scheduler_uid.t * Core.Pid.t;
+  src : Scheduler_uid.t * Riot_runtime.Core.Pid.t;
   ns : namespace;
   message : string;
 }
@@ -55,7 +55,7 @@ let on_log log = !__on_log__ log
 let write : type a. level -> namespace -> (a, unit) logger_format -> unit =
  fun level ns msgf ->
   let ts = Ptime_clock.now () in
-  let sch = Scheduler.get_current_scheduler () in
+  let sch = Riot_runtime.Scheduler.get_current_scheduler () in
   let pid = self () in
   let src = (sch.uid, pid) in
   let buf = Buffer.create 128 in

riot/lib/message.ml

@@ -1 +1 @@
-include Runtime.Core.Message
+include Riot_runtime.Core.Message

riot/lib/pid.ml

@@ -1 +1 @@
-include Runtime.Core.Pid
+include Riot_runtime.Core.Pid

riot/lib/process.ml

@@ -1,5 +1,5 @@
-open Runtime.Import
-module P = Runtime.Core.Process
+open Riot_runtime.Import
+module P = Riot_runtime.Core.Process
 
 open Logger.Make (struct
   let namespace = [ "riot"; "process" ]

riot/lib/queue.ml

@@ -1 +1 @@
-include Runtime.Util.Lf_queue
+include Riot_runtime.Util.Lf_queue

riot/lib/ref.ml

@@ -1 +1 @@
-include Runtime.Core.Ref
+include Riot_runtime.Core.Ref

riot/lib/runtime_lib.ml

@@ -1,6 +1,6 @@
 open Global
 
-let set_log_level = Runtime.Log.set_log_level
+let set_log_level = Riot_runtime.Log.set_log_level
 
 let syscalls () =
   let pool = _get_pool () in
@@ -26,11 +26,11 @@ module Stats = struct
     let total_schedulers = pool.schedulers |> List.length in
     let breakdown =
       pool.schedulers
-      |> List.map (fun (sch : Scheduler.t) ->
+      |> List.map (fun (sch : Riot_runtime.Scheduler.t) ->
              Format.asprintf "  sch #%a [live_procs=%d; timers=%d]"
-               Runtime.Core.Scheduler_uid.pp sch.uid
-               (Runtime.Core.Proc_queue.size sch.run_queue)
-               (Runtime.Time.Timer_wheel.size sch.timers))
+               Riot_runtime.Core.Scheduler_uid.pp sch.uid
+               (Riot_runtime.Core.Proc_queue.size sch.run_queue)
+               (Riot_runtime.Time.Timer_wheel.size sch.timers))
       |> String.concat "\n"
     in
     info (fun f ->

riot/lib/telemetry_app.ml

@@ -5,7 +5,7 @@ type event = Telemetry.event = ..
 let name = "Riot.Telemetry"
 
 module Dispatcher = struct
-  type Core.Message.t += Event of Telemetry.event
+  type Riot_runtime.Core.Message.t += Event of Telemetry.event
 
   let __main_dispatcher__ : Pid.t ref = ref Pid.zero
 

riot/riot.ml

@@ -1,5 +1,15 @@
 include Lib
 
+open struct
+  open Riot_runtime
+  module Log = Log
+  module Core = Core
+  module Import = Import
+  module Util = Util
+  module Scheduler = Scheduler
+  module Time = Time
+end
+
 open Logger.Make (struct
   let namespace = [ "riot" ]
 end)

riot/riot.mli

@@ -141,7 +141,7 @@ module Process : sig
       [None] if no process was registered for that name.
   *)
 
-  val sid : t -> Core.Scheduler_uid.t
+  val sid : t -> Riot_runtime.Core.Scheduler_uid.t
   (** [sid t] returns the scheduler id for the scheduler in charge of the
       process. *)
 

riot/runtime/core/core.ml

@@ -0,0 +1,13 @@
+module Core = Core
+module Mailbox = Mailbox
+module Message = Message
+module Pid = Pid
+module Proc_effect = Proc_effect
+module Proc_queue = Proc_queue
+module Proc_registry = Proc_registry
+module Proc_set = Proc_set
+module Proc_state = Proc_state
+module Proc_table = Proc_table
+module Process = Process
+module Ref = Ref
+module Scheduler_uid = Scheduler_uid

riot/runtime/dune

@@ -1,4 +1,14 @@
 (library
  (package riot)
- (name runtime)
- (libraries core log scheduler time util rio))
+ (name riot_runtime)
+ (libraries
+  gluon
+  mtime
+  mtime.clock.os
+  ptime
+  ptime.clock.os
+  rio
+  runtime_events
+  unix))
+
+(include_subdirs unqualified)

riot/runtime/runtime.ml → riot/runtime/riot_runtime.ml

@@ -2,6 +2,7 @@ module Log = Log
 module Core = Core
 module Import = Import
 module Util = Util
+module Scheduler = Scheduler
 module Time = Time
 
 let set_log_level = Log.set_log_level

riot/runtime/time/time.ml

@@ -0,0 +1 @@
+module Timer_wheel = Timer_wheel

riot/runtime/util/util.ml

@@ -0,0 +1,9 @@
+module Dashmap = Dashmap
+module Lf_queue = Lf_queue
+module Min_heap = Min_heap
+module Thread_local = Thread_local
+module Timeout = Timeout
+module Trace = Trace
+module Uid = Uid
+module Util = Util
+module Weak_ref = Weak_ref

test/send_after_test.ml

@@ -43,7 +43,7 @@ let main () =
       Logger.info (fun f -> f "send_after_test: OK")
   | _ ->
       let messages = messages |> List.map msg_to_str |> String.concat "," in
-      Log.error (fun f -> f "bad message sequence: %s" messages);
+      Riot_runtime.Log.error (fun f -> f "bad message sequence: %s" messages);
       sleep 0.1;
       shutdown ~status:1 ()