Add a loader state for HiPE code loading

Just like the BEAM loader state (as returned by
erlang:prepare_loading/2), the HiPE loader state is contained in a magic
binary.

Eventually, we will separate HiPE loading into a prepare and a finalise
phase, like the BEAM loader, where the prepare phase will be implemented
by hipe_unified_loader and the finalise phase be implemented in C by
hipe_load.c and beam_load.c, making prepare side-effect free and
finalise atomic. The finalise phase will be exposed through the
erlang:finish_loading/1 API, just like the BEAM loader, as this will
allow HiPE and BEAM modules to be mixed in the same atomic "commit".

The usage of a loader state makes it easier to keep track of all
resources allocated during loading, and will not only make it easy to
prevent leaks when hipe_unified_loader crashes, but also paves the way
for proper, leak-free, unloading of HiPE modules.

6 files changed, 300 insertions, 19 deletions

diff --git a/erts/emulator/hipe/hipe_bif0.c b/erts/emulator/hipe/hipe_bif0.c
index 6f9bfe2f40..daa198d695 100644
--- a/erts/emulator/hipe/hipe_bif0.c
+++ b/erts/emulator/hipe/hipe_bif0.c
@@ -44,6 +44,7 @@
 #include "hipe_mode_switch.h"
 #include "hipe_native_bif.h"
 #include "hipe_bif0.h"
+#include "hipe_load.h"
 /* We need hipe_literals.h for HIPE_SYSTEM_CRC, but it redefines
    a few constants. #undef them here to avoid warnings. */
 #undef F_TIMO
@@ -375,15 +376,31 @@ BIF_RETTYPE hipe_bifs_ref_set_2(BIF_ALIST_2)
 }
 
 /*
+ * BIFs for loading code.
+ */
+
+static HipeLoaderState *get_loader_state(Eterm term)
+{
+    ProcBin *pb;
+
+    if (!ERTS_TERM_IS_MAGIC_BINARY(term)) return NULL;
+
+    pb = (ProcBin*) binary_val(term);
+    return hipe_get_loader_state(pb->val);
+}
+
+
+/*
  * Allocate memory and copy machine code to it.
  */
-BIF_RETTYPE hipe_bifs_enter_code_2(BIF_ALIST_2)
+BIF_RETTYPE hipe_bifs_enter_code_3(BIF_ALIST_3)
 {
     Uint nrbytes;
     void *bytes;
     void *address;
     Eterm trampolines;
     Eterm *hp;
+    HipeLoaderState *stp;
 #ifndef DEBUG
     ERTS_DECLARE_DUMMY(Uint bitoffs);
     ERTS_DECLARE_DUMMY(Uint bitsize);
@@ -392,13 +409,15 @@ BIF_RETTYPE hipe_bifs_enter_code_2(BIF_ALIST_2)
     Uint bitsize;
 #endif
 
-    if (is_not_binary(BIF_ARG_1))
+    if (is_not_binary(BIF_ARG_1) ||
+	(!(stp = get_loader_state(BIF_ARG_3))))
 	BIF_ERROR(BIF_P, BADARG);
     nrbytes = binary_size(BIF_ARG_1);
     ERTS_GET_BINARY_BYTES(BIF_ARG_1, bytes, bitoffs, bitsize);
     ASSERT(bitoffs == 0);
     ASSERT(bitsize == 0);
     trampolines = NIL;
+    // XXX: Trampolines are not tracked and freed
     address = hipe_alloc_code(nrbytes, BIF_ARG_2, &trampolines, BIF_P);
     if (!address) {
 	Uint nrcallees;
@@ -407,11 +426,15 @@ BIF_RETTYPE hipe_bifs_enter_code_2(BIF_ALIST_2)
 	    nrcallees = arityval(tuple_val(BIF_ARG_2)[0]);
 	else
 	    nrcallees = 0;
+	// XXX: Is there any reason to not just BIF_ERROR, so that the runtime
+	// survives?
 	erts_exit(ERTS_ERROR_EXIT, "%s: failed to allocate %lu bytes and %lu trampolines\r\n",
 		 __func__, (unsigned long)nrbytes, (unsigned long)nrcallees);
     }
     memcpy(address, bytes, nrbytes);
     hipe_flush_icache_range(address, nrbytes);
+    stp->text_segment = address;
+    stp->text_segment_size = nrbytes;
     hp = HAlloc(BIF_P, 3);
     hp[0] = make_arityval(2);
     hp[1] = address_to_term(address, BIF_P);
@@ -424,25 +447,34 @@ BIF_RETTYPE hipe_bifs_enter_code_2(BIF_ALIST_2)
 /*
  * Allocate memory for arbitrary non-Erlang data.
  */
-BIF_RETTYPE hipe_bifs_alloc_data_2(BIF_ALIST_2)
+BIF_RETTYPE hipe_bifs_alloc_data_3(BIF_ALIST_3)
 {
-    Uint align, nrbytes;
-    void *block;
+    Uint align;
+    HipeLoaderState *stp;
 
     if (is_not_small(BIF_ARG_1) || is_not_small(BIF_ARG_2) ||
+	(!(stp = get_loader_state(BIF_ARG_3))) ||
 	(align = unsigned_val(BIF_ARG_1), !IS_POWER_OF_TWO(align)))
 	BIF_ERROR(BIF_P, BADARG);
-    nrbytes = unsigned_val(BIF_ARG_2);
-    if (nrbytes == 0)
+
+    if (stp->data_segment_size || stp->data_segment)
+	BIF_ERROR(BIF_P, BADARG);
+
+    stp->data_segment_size = unsigned_val(BIF_ARG_2);
+    if (stp->data_segment_size == 0)
 	BIF_RET(make_small(0));
-    block = erts_alloc(ERTS_ALC_T_HIPE, nrbytes);
-    if ((unsigned long)block & (align-1)) {
-	fprintf(stderr, "%s: erts_alloc(%lu) returned %p which is not %lu-byte aligned\r\n",
-		__FUNCTION__, (unsigned long)nrbytes, block, (unsigned long)align);
-	erts_free(ERTS_ALC_T_HIPE, block);
+    stp->data_segment = erts_alloc(ERTS_ALC_T_HIPE, stp->data_segment_size);
+    if ((unsigned long)stp->data_segment & (align-1)) {
+	fprintf(stderr, "%s: erts_alloc(%lu) returned %p which is not %lu-byte "
+		"aligned\r\n",
+		__FUNCTION__, (unsigned long)stp->data_segment_size,
+		stp->data_segment, (unsigned long)align);
+	erts_free(ERTS_ALC_T_HIPE, stp->data_segment);
+	stp->data_segment = NULL;
+	stp->data_segment_size = 0;
 	BIF_ERROR(BIF_P, EXC_NOTSUP);
     }
-    BIF_RET(address_to_term(block, BIF_P));
+    BIF_RET(address_to_term(stp->data_segment, BIF_P));
 }
 
 /*
@@ -1711,12 +1743,14 @@ void hipe_purge_module(Module* modp)
                 prevp = &p->next_in_mod;
         }
     }
-    if (modp->old.hipe_code_start) {
+    if (modp->old.hipe_code && modp->old.hipe_code->text_segment) {
 #ifdef DEBUG
-        sys_memset(modp->old.hipe_code_start, 0xfe, modp->old.hipe_code_size);
+        sys_memset(modp->old.hipe_code->text_segment, 0xfe,
+                   modp->old.hipe_code->text_segment_size);
 #endif
-        hipe_free_code(modp->old.hipe_code_start);
-        modp->old.hipe_code_start = NULL;
+        hipe_free_code(modp->old.hipe_code->text_segment);
+        modp->old.hipe_code->text_segment = NULL;
+        modp->old.hipe_code->text_segment_size = 0;
     }
 }
 
@@ -1870,3 +1904,23 @@ BIF_RETTYPE hipe_bifs_patch_call_3(BIF_ALIST_3)
 	BIF_ERROR(BIF_P, BADARG);
     BIF_RET(NIL);
 }
+
+BIF_RETTYPE hipe_bifs_alloc_loader_state_1(BIF_ALIST_1)
+{
+    Binary *magic;
+    Eterm *hp;
+    Eterm res;
+
+    if (is_not_atom(BIF_ARG_1))
+	BIF_ERROR(BIF_P, BADARG);
+
+    magic = hipe_alloc_loader_state(BIF_ARG_1);
+
+    if (!magic)
+	BIF_ERROR(BIF_P, BADARG);
+
+    hp = HAlloc(BIF_P, PROC_BIN_SIZE);
+    res = erts_mk_magic_binary_term(&hp, &MSO(BIF_P), magic);
+    erts_refc_dec(&magic->refc, 1);
+    BIF_RET(res);
+}
diff --git a/erts/emulator/hipe/hipe_bif0.tab b/erts/emulator/hipe/hipe_bif0.tab
index ff9c1d06fb..1e4bde5ef2 100644
--- a/erts/emulator/hipe/hipe_bif0.tab
+++ b/erts/emulator/hipe/hipe_bif0.tab
@@ -44,8 +44,8 @@ bif hipe_bifs:ref/1
 bif hipe_bifs:ref_get/1
 bif hipe_bifs:ref_set/2
 
-bif hipe_bifs:enter_code/2
-bif hipe_bifs:alloc_data/2
+bif hipe_bifs:enter_code/3
+bif hipe_bifs:alloc_data/3
 bif hipe_bifs:constants_size/0
 bif hipe_bifs:merge_term/1
 
@@ -83,6 +83,8 @@ bif hipe_bifs:patch_call/3
 bif hipe_bifs:add_ref/2
 bif hipe_bifs:remove_refs_from/1
 
+bif hipe_bifs:alloc_loader_state/1
+
 # atoms used by add_ref/2
 atom call
 atom load_mfa
diff --git a/erts/emulator/hipe/hipe_load.c b/erts/emulator/hipe/hipe_load.c
new file mode 100644
index 0000000000..5bce3f1aee
--- /dev/null
+++ b/erts/emulator/hipe/hipe_load.c
@@ -0,0 +1,101 @@
+/*
+ * %CopyrightBegin%
+
+ *
+ * Copyright Ericsson AB 2016. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * %CopyrightEnd%
+ */
+/*
+ * hipe_load.c
+ *
+ * HiPE atomic code loader
+ */
+
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+#include "sys.h"
+#include "global.h"
+#include "erl_binary.h"
+#include "hipe_load.h"
+
+/*
+ * This destructor function can safely be called multiple times.
+ */
+static void
+hipe_loader_state_dtor(Binary* magic)
+{
+    HipeLoaderState* stp = ERTS_MAGIC_BIN_DATA(magic);
+    if (stp->module == NIL) return;
+
+    erts_fprintf(stderr, "Destroying HiPE loader state for module %T\n",
+		 stp->module);
+
+    // TODO: Needs to be freed separately. We'd like have a unified executable
+    // code allocator, so postpone this for now.
+    /* if (stp->text_segment) */
+    /* 	erts_free(ERTS_ALC_T_HIPE, stp->text_segment); */
+    stp->text_segment = NULL;
+    stp->text_segment_size = 0;
+
+    if (stp->data_segment)
+	erts_free(ERTS_ALC_T_HIPE, stp->data_segment);
+    stp->data_segment = NULL;
+    stp->data_segment_size = 0;
+
+    stp->module = NIL;
+}
+
+Binary *hipe_alloc_loader_state(Eterm module)
+{
+    HipeLoaderState *stp;
+    Binary *magic;
+
+    if (is_not_atom(module)) return NULL;
+
+    erts_fprintf(stderr, "Creating HiPE loader state for module %T\n", module);
+
+    magic = erts_create_magic_binary(sizeof(HipeLoaderState),
+				     hipe_loader_state_dtor);
+    erts_refc_inc(&magic->refc, 1);
+    stp = ERTS_MAGIC_BIN_DATA(magic);
+
+    stp->module = module;
+    stp->text_segment = NULL;
+    stp->text_segment_size = 0;
+    stp->data_segment = NULL;
+    stp->data_segment_size = 0;
+
+    return magic;
+}
+
+void hipe_free_loader_state(Binary *magic)
+{
+    if (ERTS_MAGIC_BIN_DESTRUCTOR(magic) != hipe_loader_state_dtor)
+	return;
+
+    /* Why does BEAM do a refc_dec here? What is holding that reference? */
+    hipe_loader_state_dtor(magic);
+}
+
+HipeLoaderState *
+hipe_get_loader_state(Binary *magic)
+{
+    if (ERTS_MAGIC_BIN_DESTRUCTOR(magic) != hipe_loader_state_dtor)
+	return NULL;
+
+    return (HipeLoaderState*) ERTS_MAGIC_BIN_DATA(magic);
+}
diff --git a/erts/emulator/hipe/hipe_load.h b/erts/emulator/hipe/hipe_load.h
new file mode 100644
index 0000000000..9e24e915ed
--- /dev/null
+++ b/erts/emulator/hipe/hipe_load.h
@@ -0,0 +1,45 @@
+/*
+ * %CopyrightBegin%
+ *
+ * Copyright Ericsson AB 2016. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * %CopyrightEnd%
+ */
+/*
+ * hipe_load.h
+ *
+ * HiPE atomic code loader
+ */
+#ifndef HIPE_LOAD_H
+#define HIPE_LOAD_H
+
+#include "global.h"
+
+typedef struct hipe_loader_state {
+    Eterm module;                   /* Module name, atom */
+
+    void *text_segment;
+    Uint text_segment_size;
+
+    void *data_segment;
+    Uint data_segment_size;
+
+} HipeLoaderState;
+
+extern Binary *hipe_alloc_loader_state(Eterm module);
+extern void hipe_free_loader_state(Binary *binary);
+extern HipeLoaderState *hipe_get_loader_state(Binary *binary);
+
+#endif /* HIPE_LOAD_H */
diff --git a/erts/emulator/hipe/hipe_module.c b/erts/emulator/hipe/hipe_module.c
new file mode 100644
index 0000000000..1553bf9087
--- /dev/null
+++ b/erts/emulator/hipe/hipe_module.c
@@ -0,0 +1,37 @@
+/*
+ * %CopyrightBegin%
+ *
+ * Copyright Ericsson AB 2016. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * %CopyrightEnd%
+ */
+
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+#include "sys.h"
+#include "hipe_module.h"
+
+void hipe_free_module(HipeModule *mod)
+{
+#ifdef DEBUG
+    sys_memzero(mod->text_segment, mod->text_segment_size);
+#endif
+    /* XXX: erts_free(ERTS_ALC_T_HIPE, mod->text_segment); */
+    if (mod->data_segment) /* Some modules lack data segments */
+	erts_free(ERTS_ALC_T_HIPE, mod->data_segment);
+
+    erts_free(ERTS_ALC_T_HIPE, mod);
+}
diff --git a/erts/emulator/hipe/hipe_module.h b/erts/emulator/hipe/hipe_module.h
new file mode 100644
index 0000000000..1e1302fc0a
--- /dev/null
+++ b/erts/emulator/hipe/hipe_module.h
@@ -0,0 +1,42 @@
+/*
+ * %CopyrightBegin%
+
+ *
+ * Copyright Ericsson AB 2016. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * %CopyrightEnd%
+ */
+/*
+ * hipe_module.h
+ *
+ *
+ */
+#ifndef HIPE_MODULE_H
+#define HIPE_MODULE_H
+
+/* Forward-declare type to resolve circular dependency with module.h */
+typedef struct hipe_module HipeModule;
+
+#include "global.h"
+
+struct hipe_module {
+    void *text_segment;
+    Uint text_segment_size;
+    void *data_segment;
+};
+
+extern void hipe_free_module(HipeModule *mod);
+
+#endif /* HIPE_MODULE_H */