feat: add primitive predicate isReplicatedExecution (#4929)

Author: ggreif

Changelog.md

@@ -1,5 +1,11 @@
 # Motoko compiler changelog
 
+## 0.14.3 (FUTURE)
+
+* motoko (`moc`)
+
+  * Added primitive predicate `isReplicatedExecution` (#4929).
+
 ## 0.14.2 (2025-02-26)
 
 * motoko (`moc`)

src/codegen/compile_classical.ml

@@ -5068,6 +5068,7 @@ module IC = struct
       E.add_func_import env "ic0" "canister_self_size" [] [I32Type];
       E.add_func_import env "ic0" "canister_status" [] [I32Type];
       E.add_func_import env "ic0" "canister_version" [] [I64Type];
+      E.add_func_import env "ic0" "in_replicated_execution" [] [I32Type];
       E.add_func_import env "ic0" "is_controller" (i32s 2) [I32Type];
       E.add_func_import env "ic0" "debug_print" (i32s 2) [];
       E.add_func_import env "ic0" "msg_arg_data_copy" (i32s 3) [];
@@ -5182,6 +5183,7 @@ module IC = struct
 
   let performance_counter = ic_system_call "performance_counter"
   let is_controller = ic_system_call "is_controller"
+  let replicated_execution = ic_system_call "in_replicated_execution"
   let canister_version = ic_system_call "canister_version"
 
   let print_ptr_len env = G.i (Call (nr (E.built_in env "print_ptr")))
@@ -11772,6 +11774,10 @@ and compile_prim_invocation (env : E.t) ae p es at =
     Blob.len env ^^
     IC.is_controller env
 
+  | OtherPrim "replicated_execution", [] ->
+    SR.Vanilla,
+    IC.replicated_execution env
+
   | OtherPrim "canister_version", [] ->
     SR.UnboxedWord64 Type.Nat64,
     IC.canister_version env

src/codegen/compile_enhanced.ml

@@ -4725,6 +4725,7 @@ module IC = struct
       E.add_func_import env "ic0" "canister_self_size" [] [I64Type];
       E.add_func_import env "ic0" "canister_status" [] [I32Type];
       E.add_func_import env "ic0" "canister_version" [] [I64Type];
+      E.add_func_import env "ic0" "in_replicated_execution" [] [I32Type];
       E.add_func_import env "ic0" "is_controller" (i64s 2) [I32Type];
       E.add_func_import env "ic0" "debug_print" (i64s 2) [];
       E.add_func_import env "ic0" "msg_arg_data_copy" (i64s 3) [];
@@ -4871,6 +4872,10 @@ module IC = struct
     ic_system_call "is_controller" env ^^ 
     G.i (Convert (Wasm_exts.Values.I64 I64Op.ExtendUI32))
 
+  let replicated_execution env =
+    ic_system_call "in_replicated_execution" env ^^ 
+    G.i (Convert (Wasm_exts.Values.I64 I64Op.ExtendUI32))
+
   let canister_version env = ic_system_call "canister_version" env
 
   let print_ptr_len env = G.i (Call (nr (E.built_in env "print_ptr")))
@@ -11869,6 +11874,10 @@ and compile_prim_invocation (env : E.t) ae p es at =
     Blob.len env ^^
     IC.is_controller env
 
+  | OtherPrim "replicated_execution", [] ->
+    SR.Vanilla,
+    IC.replicated_execution env
+
   | OtherPrim "canister_version", [] ->
     SR.UnboxedWord64 Type.Nat64,
     IC.canister_version env

src/ir_def/construct.ml

@@ -118,7 +118,8 @@ let primE prim es =
     | OtherPrim "array_len"
     | OtherPrim "blob_size"
     | OtherPrim "text_len" -> T.nat
-    | OtherPrim "is_controller" -> T.bool
+    | OtherPrim "is_controller"
+    | OtherPrim "replicated_execution" -> T.bool
     | OtherPrim "rts_version" -> T.text
     | OtherPrim "rts_memory_size" -> T.nat
     | OtherPrim "rts_heap_size" -> T.nat

src/prelude/prim.mo

@@ -326,6 +326,7 @@ func principalOfBlob(act : Blob) : Principal {
 
 func principalOfActor(act : actor {}) : Principal = (prim "principalOfActor" : (actor {}) -> Principal) act;
 func isController(p : Principal) : Bool = (prim "is_controller" : Principal -> Bool) p;
+func isReplicatedExecution() : Bool = (prim "replicated_execution" : () -> Bool) ();
 func canisterVersion() : Nat64 = (prim "canister_version" : () -> Nat64)();
 
 // Untyped dynamic actor creation from blobs

test/fail/ok/no-timer-canc.tc.ok

@@ -150,6 +150,7 @@ no-timer-canc.mo:3.10-3.21: type error [M0119], object field cancelTimer is not
     intToNat64Wrap : Int -> Nat64;
     intToNat8Wrap : Int -> Nat8;
     isController : Principal -> Bool;
+    isReplicatedExecution : () -> Bool;
     log : Float -> Float;
     nat16ToInt16 : Nat16 -> Int16;
     nat16ToNat : Nat16 -> Nat;

test/fail/ok/no-timer-set.tc.ok

@@ -150,6 +150,7 @@ no-timer-set.mo:3.10-3.18: type error [M0119], object field setTimer is not cont
     intToNat64Wrap : Int -> Nat64;
     intToNat8Wrap : Int -> Nat8;
     isController : Principal -> Bool;
+    isReplicatedExecution : () -> Bool;
     log : Float -> Float;
     nat16ToInt16 : Nat16 -> Int16;
     nat16ToNat : Nat16 -> Nat;

test/fail/ok/suggest-long-ai.tc.ok

@@ -151,6 +151,7 @@ suggest-long-ai.mo:4.6-4.13: type error [M0072], field stableM does not exist in
     intToNat64Wrap : Int -> Nat64;
     intToNat8Wrap : Int -> Nat8;
     isController : Principal -> Bool;
+    isReplicatedExecution : () -> Bool;
     log : Float -> Float;
     nat16ToInt16 : Nat16 -> Int16;
     nat16ToNat : Nat16 -> Nat;

test/fail/ok/suggest-short-ai.tc.ok

@@ -151,6 +151,7 @@ suggest-short-ai.mo:4.6-4.7: type error [M0072], field s does not exist in type:
     intToNat64Wrap : Int -> Nat64;
     intToNat8Wrap : Int -> Nat8;
     isController : Principal -> Bool;
+    isReplicatedExecution : () -> Bool;
     log : Float -> Float;
     nat16ToInt16 : Nat16 -> Int16;
     nat16ToNat : Nat16 -> Nat;

test/run-drun/ok/query.drun-run.ok

@@ -17,3 +17,4 @@ debug.print: 5
 Ok: Reply: 0x4449444c00017d04
 debug.print: 4
 ingress Completed: Reply: 0x4449444c0000
+ingress Completed: Reply: 0x4449444c00017d04

test/run-drun/query.mo

@@ -9,9 +9,15 @@ actor {
     Prim.debugPrintNat c
   };
   public func get() : async Nat {
+    assert Prim.isReplicatedExecution();
+    return c
+  };
+  public query func getq() : async Nat {
+    assert Prim.isReplicatedExecution();
     return c
   };
   public query func read() : async Nat {
+    assert not (Prim.isReplicatedExecution());
     let tmp = c;
     c += 1;
     Prim.debugPrintNat c;
@@ -28,6 +34,7 @@ actor {
 //CALL ingress printCounter 0x4449444C0000
 //CALL query read 0x4449444C0000
 //CALL ingress printCounter 0x4449444C0000
+//CALL ingress getq 0x4449444C0000
 
 //SKIP run
 //SKIP run-ir