Introduce ports (local and external)

Also add bif erlang:is_port/1 which is called by code compiled with OTP-21 Later versions of the compiler use is_port opcode instead. Signed-off-by: Paul Guyot <[email protected]>
pguyot · Dec 23, 2024 · ee1158f · ee1158f
1 parent fe45624
commit ee1158f
Show file tree

Hide file tree

Showing 15 changed files with 423 additions and 63 deletions.
diff --git a/src/libAtomVM/bif.c b/src/libAtomVM/bif.c
@@ -186,6 +186,15 @@ term bif_erlang_is_pid_1(Context *ctx, uint32_t fail_label, term arg1)
     return term_is_pid(arg1) ? TRUE_ATOM : FALSE_ATOM;
 }
 
+// Generated by OTP-21 compiler
+term bif_erlang_is_port_1(Context *ctx, uint32_t fail_label, term arg1)
+{
+    UNUSED(ctx);
+    UNUSED(fail_label);
+
+    return term_is_port(arg1) ? TRUE_ATOM : FALSE_ATOM;
+}
+
 term bif_erlang_is_reference_1(Context *ctx, uint32_t fail_label, term arg1)
 {
     UNUSED(ctx);

diff --git a/src/libAtomVM/bif.h b/src/libAtomVM/bif.h
@@ -56,6 +56,7 @@ term bif_erlang_is_integer_1(Context *ctx, uint32_t fail_label, term arg1);
 term bif_erlang_is_list_1(Context *ctx, uint32_t fail_label, term arg1);
 term bif_erlang_is_number_1(Context *ctx, uint32_t fail_label, term arg1);
 term bif_erlang_is_pid_1(Context *ctx, uint32_t fail_label, term arg1);
+term bif_erlang_is_port_1(Context *ctx, uint32_t fail_label, term arg1);
 term bif_erlang_is_reference_1(Context *ctx, uint32_t fail_label, term arg1);
 term bif_erlang_is_tuple_1(Context *ctx, uint32_t fail_label, term arg1);
 term bif_erlang_is_map_1(Context *ctx, uint32_t fail_label, term arg1);

diff --git a/src/libAtomVM/bifs.gperf b/src/libAtomVM/bifs.gperf
@@ -51,6 +51,7 @@ erlang:is_integer/1, {.bif.base.type = BIFFunctionType, .bif.bif1_ptr = bif_erla
 erlang:is_list/1, {.bif.base.type = BIFFunctionType, .bif.bif1_ptr = bif_erlang_is_list_1}
 erlang:is_number/1, {.bif.base.type = BIFFunctionType, .bif.bif1_ptr = bif_erlang_is_number_1}
 erlang:is_pid/1, {.bif.base.type = BIFFunctionType, .bif.bif1_ptr = bif_erlang_is_pid_1}
+erlang:is_port/1, {.bif.base.type = BIFFunctionType, .bif.bif1_ptr = bif_erlang_is_port_1}
 erlang:is_reference/1, {.bif.base.type = BIFFunctionType, .bif.bif1_ptr = bif_erlang_is_reference_1}
 erlang:is_tuple/1, {.bif.base.type = BIFFunctionType, .bif.bif1_ptr = bif_erlang_is_tuple_1}
 erlang:is_map/1, {.bif.base.type = BIFFunctionType, .bif.bif1_ptr = bif_erlang_is_map_1}

diff --git a/src/libAtomVM/context.c b/src/libAtomVM/context.c
@@ -440,10 +440,11 @@ static struct ResourceMonitor *context_monitors_handle_terminate(Context *ctx)
                 term_put_tuple_element(info_tuple, 1, ref);
                 if (ctx->native_handler != NULL) {
                     term_put_tuple_element(info_tuple, 2, PORT_ATOM);
+                    term_put_tuple_element(info_tuple, 3, term_port_from_local_process_id(ctx->process_id));
                 } else {
                     term_put_tuple_element(info_tuple, 2, PROCESS_ATOM);
+                    term_put_tuple_element(info_tuple, 3, term_from_local_process_id(ctx->process_id));
                 }
-                term_put_tuple_element(info_tuple, 3, term_from_local_process_id(ctx->process_id));
                 term_put_tuple_element(info_tuple, 4, ctx->exit_reason);
 
                 mailbox_send(target, info_tuple);

diff --git a/src/libAtomVM/externalterm.c b/src/libAtomVM/externalterm.c
@@ -51,6 +51,7 @@
 #define EXPORT_EXT 113
 #define MAP_EXT 116
 #define SMALL_ATOM_UTF8_EXT 119
+#define V4_PORT_EXT 120
 #define INVALID_TERM_SIZE -1
 
 #define NEW_FLOAT_EXT_SIZE 9
@@ -422,6 +423,31 @@ static int serialize_term(uint8_t *buf, term t, GlobalContext *glb)
             WRITE_32_UNALIGNED(buf + k + 8, term_get_external_node_creation(t));
         }
         return k + 12;
+    } else if (term_is_local_port(t)) {
+        if (!IS_NULL_PTR(buf)) {
+            buf[0] = V4_PORT_EXT;
+        }
+        size_t k = 1;
+        term node_name = glb->node_name;
+        uint32_t creation = node_name == NONODE_AT_NOHOST_ATOM ? 0 : glb->creation;
+        k += serialize_term(IS_NULL_PTR(buf) ? NULL : buf + k, node_name, glb);
+        if (!IS_NULL_PTR(buf)) {
+            WRITE_64_UNALIGNED(buf + k, term_to_local_process_id(t));
+            WRITE_32_UNALIGNED(buf + k + 8, creation); // creation
+        }
+        return k + 12;
+    } else if (term_is_external_port(t)) {
+        if (!IS_NULL_PTR(buf)) {
+            buf[0] = V4_PORT_EXT;
+        }
+        size_t k = 1;
+        term node = term_get_external_node(t);
+        k += serialize_term(IS_NULL_PTR(buf) ? NULL : buf + k, node, glb);
+        if (!IS_NULL_PTR(buf)) {
+            WRITE_64_UNALIGNED(buf + k, term_get_external_port_number(t));
+            WRITE_32_UNALIGNED(buf + k + 8, term_get_external_node_creation(t));
+        }
+        return k + 12;
     } else if (term_is_local_reference(t)) {
         if (!IS_NULL_PTR(buf)) {
             buf[0] = NEWER_REFERENCE_EXT;
@@ -759,6 +785,34 @@ static term parse_external_terms(const uint8_t *external_term_buf, size_t *eterm
             }
         }
 
+        case V4_PORT_EXT: {
+            size_t node_size;
+            term node = parse_external_terms(external_term_buf + 1, &node_size, copy, heap, glb);
+            if (UNLIKELY(!term_is_atom(node))) {
+                return term_invalid_term();
+            }
+            uint64_t number = READ_64_UNALIGNED(external_term_buf + node_size + 1);
+            uint32_t creation = READ_32_UNALIGNED(external_term_buf + node_size + 9);
+            *eterm_size = node_size + 13;
+            if (node != NONODE_AT_NOHOST_ATOM) {
+                term this_node = glb->node_name;
+                uint32_t this_creation = this_node == NONODE_AT_NOHOST_ATOM ? 0 : glb->creation;
+                if (node == this_node && creation == this_creation) {
+                    if (UNLIKELY(number > TERM_MAX_LOCAL_PROCESS_ID)) {
+                        return term_invalid_term();
+                    }
+                    return term_port_from_local_process_id(number);
+                } else {
+                    return term_make_external_port_number(node, number, creation, heap);
+                }
+            } else {
+                if (UNLIKELY(number > TERM_MAX_LOCAL_PROCESS_ID || creation != 0)) {
+                    return term_invalid_term();
+                }
+                return term_port_from_local_process_id(number);
+            }
+        }
+
         case NEWER_REFERENCE_EXT: {
             uint16_t len = READ_16_UNALIGNED(external_term_buf + 1);
             if (UNLIKELY(len > 5)) {
@@ -1079,7 +1133,8 @@ static int calculate_heap_usage(const uint8_t *external_term_buf, size_t remaini
             return 0;
         }
 
-        case NEW_PID_EXT: {
+        case NEW_PID_EXT:
+        case V4_PORT_EXT: {
             if (UNLIKELY(remaining < 1)) {
                 return INVALID_TERM_SIZE;
             }

diff --git a/src/libAtomVM/memory.c b/src/libAtomVM/memory.c
@@ -479,6 +479,9 @@ unsigned long memory_estimate_usage(term t)
         } else if (term_is_local_pid(t)) {
             t = temp_stack_pop(&temp_stack);
 
+        } else if (term_is_local_port(t)) {
+            t = temp_stack_pop(&temp_stack);
+
         } else if (term_is_nonempty_list(t)) {
             acc += 2;
             if (UNLIKELY(temp_stack_push(&temp_stack, term_get_list_tail(t)) != TempStackOk)) {
@@ -624,6 +627,10 @@ static void memory_scan_and_copy(HeapFragment *old_fragment, term *mem_start, co
                     TRACE("- Found external pid.\n");
                     break;
 
+                case TERM_BOXED_EXTERNAL_PORT:
+                    TRACE("- Found external port.\n");
+                    break;
+
                 case TERM_BOXED_EXTERNAL_REF:
                     TRACE("- Found external ref.\n");
                     break;
@@ -751,6 +758,10 @@ static void memory_scan_and_rewrite(size_t count, term *terms, const term *old_s
                     ptr += term_get_size_from_boxed_header(t);
                     break;
 
+                case TERM_BOXED_EXTERNAL_PORT:
+                    ptr += EXTERNAL_PORT_SIZE - 1;
+                    break;
+
                 case TERM_BOXED_EXTERNAL_REF:
                     ptr += term_get_size_from_boxed_header(t);
                     break;
@@ -828,6 +839,9 @@ HOT_FUNC static term memory_shallow_copy_term(HeapFragment *old_fragment, term t
     } else if (term_is_local_pid(t)) {
         return t;
 
+    } else if (term_is_local_port(t)) {
+        return t;
+
     } else if (term_is_cp(t)) {
         // CP is valid only on stack
         return t;

diff --git a/src/libAtomVM/nifs.c b/src/libAtomVM/nifs.c
@@ -160,6 +160,7 @@ static term nif_ets_lookup(Context *ctx, int argc, term argv[]);
 static term nif_ets_lookup_element(Context *ctx, int argc, term argv[]);
 static term nif_ets_delete(Context *ctx, int argc, term argv[]);
 static term nif_erlang_pid_to_list(Context *ctx, int argc, term argv[]);
+static term nif_erlang_port_to_list(Context *ctx, int argc, term argv[]);
 static term nif_erlang_ref_to_list(Context *ctx, int argc, term argv[]);
 static term nif_erlang_fun_to_list(Context *ctx, int argc, term argv[]);
 static term nif_erlang_function_exported(Context *ctx, int argc, term argv[]);
@@ -590,6 +591,12 @@ static const struct Nif pid_to_list_nif =
     .nif_ptr = nif_erlang_pid_to_list
 };
 
+static const struct Nif port_to_list_nif =
+{
+    .base.type = NIFFunctionType,
+    .nif_ptr = nif_erlang_port_to_list
+};
+
 static const struct Nif ref_to_list_nif =
 {
     .base.type = NIFFunctionType,
@@ -992,7 +999,7 @@ static term nif_erlang_open_port_2(Context *ctx, int argc, term argv[])
     if (!new_ctx) {
         RAISE_ERROR(BADARG_ATOM);
     } else {
-        return term_from_local_process_id(new_ctx->process_id);
+        return term_port_from_local_process_id(new_ctx->process_id);
     }
 }
 
@@ -1003,7 +1010,7 @@ static term nif_erlang_register_2(Context *ctx, int argc, term argv[])
     term reg_name_term = argv[0];
     VALIDATE_VALUE(reg_name_term, term_is_atom);
     term pid_or_port_term = argv[1];
-    VALIDATE_VALUE(pid_or_port_term, term_is_local_pid);
+    VALIDATE_VALUE(pid_or_port_term, term_is_local_pid_or_port);
 
     int atom_index = term_to_atom_index(reg_name_term);
     int32_t pid = term_to_local_process_id(pid_or_port_term);
@@ -1069,7 +1076,7 @@ static NativeHandlerResult process_echo_mailbox(Context *ctx)
         }
         result = NativeTerminate;
         term reply = term_alloc_tuple(2, &ctx->heap);
-        term_put_tuple_element(reply, 0, term_from_local_process_id(ctx->process_id));
+        term_put_tuple_element(reply, 0, term_port_from_local_process_id(ctx->process_id));
         term_put_tuple_element(reply, 1, CLOSED_ATOM);
         port_send_message(ctx->global, pid, reply);
     } else {
@@ -1101,7 +1108,7 @@ static NativeHandlerResult process_console_message(Context *ctx, term msg)
         result = NativeTerminate;
         term pid = term_get_tuple_element(msg, 0);
         term reply = term_alloc_tuple(2, &ctx->heap);
-        term_put_tuple_element(reply, 0, term_from_local_process_id(ctx->process_id));
+        term_put_tuple_element(reply, 0, term_port_from_local_process_id(ctx->process_id));
         term_put_tuple_element(reply, 1, CLOSED_ATOM);
         port_send_message(ctx->global, pid, reply);
     } else if (is_tagged_tuple(msg, IO_REQUEST_ATOM, 4)) {
@@ -1407,7 +1414,7 @@ static term nif_erlang_send_2(Context *ctx, int argc, term argv[])
     term target = argv[0];
     GlobalContext *glb = ctx->global;
 
-    if (term_is_local_pid(target)) {
+    if (term_is_local_pid_or_port(target)) {
         int32_t local_process_id = term_to_local_process_id(target);
 
         globalcontext_send_message(glb, local_process_id, argv[1]);
@@ -3487,6 +3494,23 @@ static term nif_erlang_pid_to_list(Context *ctx, int argc, term argv[])
     return make_list_from_ascii_buf((uint8_t *) buf, str_len, ctx);
 }
 
+static term nif_erlang_port_to_list(Context *ctx, int argc, term argv[])
+{
+    UNUSED(argc);
+
+    term t = argv[0];
+    VALIDATE_VALUE(t, term_is_port);
+    size_t max_len = term_is_external(t) ? EXTERNAL_PORT_AS_CSTRING_LEN : LOCAL_PORT_AS_CSTRING_LEN;
+
+    char buf[max_len];
+    int str_len = term_snprint(buf, max_len, t, ctx->global);
+    if (UNLIKELY(str_len < 0)) {
+        RAISE_ERROR(OUT_OF_MEMORY_ATOM);
+    }
+
+    return make_list_from_ascii_buf((uint8_t *) buf, str_len, ctx);
+}
+
 static term nif_erlang_ref_to_list(Context *ctx, int argc, term argv[])
 {
     UNUSED(argc);
@@ -3747,7 +3771,7 @@ static term nif_erlang_monitor(Context *ctx, int argc, term argv[])
         RAISE_ERROR(BADARG_ATOM);
     }
 
-    VALIDATE_VALUE(target_pid, term_is_local_pid);
+    VALIDATE_VALUE(target_pid, term_is_local_pid_or_port);
 
     int local_process_id = term_to_local_process_id(target_pid);
     Context *target = globalcontext_get_process_lock(ctx->global, local_process_id);
@@ -3815,7 +3839,7 @@ static term nif_erlang_link(Context *ctx, int argc, term argv[])
 
     term target_pid = argv[0];
 
-    VALIDATE_VALUE(target_pid, term_is_local_pid);
+    VALIDATE_VALUE(target_pid, term_is_local_pid_or_port);
 
     int local_process_id = term_to_local_process_id(target_pid);
     Context *target = globalcontext_get_process_lock(ctx->global, local_process_id);
@@ -3846,7 +3870,7 @@ static term nif_erlang_unlink(Context *ctx, int argc, term argv[])
 
     term target_pid = argv[0];
 
-    VALIDATE_VALUE(target_pid, term_is_local_pid);
+    VALIDATE_VALUE(target_pid, term_is_local_pid_or_port);
 
     int local_process_id = term_to_local_process_id(target_pid);
     Context *target = globalcontext_get_process_lock(ctx->global, local_process_id);

diff --git a/src/libAtomVM/nifs.gperf b/src/libAtomVM/nifs.gperf
@@ -117,6 +117,7 @@ erlang:throw/1, &throw_nif
 erlang:raise/3, &raise_nif
 erlang:unlink/1, &unlink_nif
 erlang:pid_to_list/1, &pid_to_list_nif
+erlang:port_to_list/1, &port_to_list_nif
 erlang:ref_to_list/1, &ref_to_list_nif
 erlang:fun_to_list/1, &fun_to_list_nif
 erlang:function_exported/3, &function_exported_nif

diff --git a/src/libAtomVM/opcodesswitch.h b/src/libAtomVM/opcodesswitch.h
@@ -2404,7 +2404,7 @@ HOT_FUNC int scheduler_entry_point(GlobalContext *glb)
                 #ifdef IMPL_EXECUTE_LOOP
                     term recipient_term = x_regs[0];
                     int local_process_id;
-                    if (term_is_local_pid(recipient_term)) {
+                    if (term_is_local_pid_or_port(recipient_term)) {
                         local_process_id = term_to_local_process_id(recipient_term);
                     } else if (term_is_atom(recipient_term)) {
                         local_process_id = globalcontext_get_registered_process(ctx->global, term_to_atom_index(recipient_term));
@@ -3004,18 +3004,7 @@ HOT_FUNC int scheduler_entry_point(GlobalContext *glb)
                 #ifdef IMPL_EXECUTE_LOOP
                     TRACE("is_port/2, label=%i, arg1=%lx\n", label, arg1);
 
-                    if (term_is_local_pid(arg1)) {
-                        int local_process_id = term_to_local_process_id(arg1);
-                        Context *target = globalcontext_get_process_lock(ctx->global, local_process_id);
-                        bool is_port_driver = false;
-                        if (target) {
-                            is_port_driver = context_is_port_driver(target);
-                            globalcontext_get_process_unlock(ctx->global, target);
-                        }
-                        if (!is_port_driver) {
-                            pc = mod->labels[label];
-                        }
-                    } else {
+                    if (!term_is_port(arg1)) {
                         pc = mod->labels[label];
                     }
                 #endif