Implement some missing serialize operators

Also fix a design flaw with how generic heap pointers are serialized

Author: GrieferAtWork

include/deemon/dec.h

@@ -358,23 +358,23 @@ struct Dee_dec_deptab {
 #define Dee_dec_deptab_init(self) \
 	(void)((self)->ddpt_depv = NULL, (self)->ddpt_depc = (self)->ddpt_depa = 0)
 
-struct Dee_dec_objtab_entry {
-	DeeObject       *dote_obj; /* [1..1] Address of some object that was already encoded */
-	Dee_dec_addr32_t dote_off; /* Offset from `dw_base' to the `DeeObject *' where the object is written */
-	Dee_dec_addr32_t dote_siz; /* # of bytes associated with this object */
+struct Dee_dec_ptrtab_entry {
+	void            *dpte_ptr; /* [1..1] Source address that was already encoded */
+	Dee_dec_addr32_t dote_off; /* Offset from `dw_base' to where "dpte_ptr" was written */
+	Dee_dec_addr32_t dote_siz; /* # of bytes associated with "dpte_ptr" */
 };
-#define Dee_dec_objtab_entry_getminaddr(self) ((__BYTE_TYPE__ *)(self)->dote_obj)
-#define Dee_dec_objtab_entry_getmaxaddr(self) ((__BYTE_TYPE__ *)(self)->dote_obj + (self)->dote_siz - 1)
+#define Dee_dec_ptrtab_entry_getminaddr(self) ((__BYTE_TYPE__ *)(self)->dpte_ptr)
+#define Dee_dec_ptrtab_entry_getmaxaddr(self) ((__BYTE_TYPE__ *)(self)->dpte_ptr + (self)->dote_siz - 1)
 
-struct Dee_dec_objtab {
-	struct Dee_dec_objtab_entry *dot_objv; /* [0..dot_objc][SORT(dote_obj ASC)][owned] List of already-encoded objects */
-	size_t                       dot_objc; /* Amount of non-NULL key-item pairs. */
-	size_t                       dot_obja; /* Amount of non-NULL key-item pairs. */
+struct Dee_dec_ptrtab {
+	struct Dee_dec_ptrtab_entry *dpt_ptrv; /* [0..dpt_ptrc][SORT(dpte_ptr ASC)][owned] List of already-encoded objects */
+	size_t                       dpt_ptrc; /* Amount of non-NULL key-item pairs. */
+	size_t                       dpt_ptra; /* Amount of non-NULL key-item pairs. */
 };
-#define Dee_dec_objtab_init(self) \
-	(void)((self)->dot_objv = NULL, (self)->dot_objc = (self)->dot_obja = 0)
-#define Dee_dec_objtab_fini(self) \
-	Dee_Free((self)->dot_objv)
+#define Dee_dec_ptrtab_init(self) \
+	(void)((self)->dpt_ptrv = NULL, (self)->dpt_ptrc = (self)->dpt_ptra = 0)
+#define Dee_dec_ptrtab_fini(self) \
+	Dee_Free((self)->dpt_ptrv)
 
 struct Dee_dec_fdeptab {
 	__BYTE_TYPE__ *dfdt_depv; /* [0..dfdt_depc][owned] Flat array of `Dec_Dstr' (each aligned to `__ALIGNOF_SIZE_T__') */
@@ -411,7 +411,7 @@ typedef struct Dee_dec_writer {
 	struct Dee_dec_fdeptab  dw_fdeps;  /* Table of dependent files */
 	Dee_dec_addr32_t        dw_gchead; /* [0..1] Offset to first `struct gc_head_link' (tracking for these objects must begin after relocations were done) */
 	Dee_dec_addr32_t        dw_gctail; /* [0..1] Offset to last `struct gc_head_link' (links between these objects were already established via `dw_srel') */
-	struct Dee_dec_objtab   dw_known;  /* Table of known, already-encoded objects */
+	struct Dee_dec_ptrtab   dw_known;  /* Table of known, already-encoded pointers */
 	unsigned int            dw_flags;  /* Dec writer flags (set of `DeeDecWriter_F_*') */
 } DeeDecWriter;
 

include/deemon/none-operator.h

@@ -113,9 +113,9 @@ DFUNDEF int (DCALL _DeeNone_reti0_6)(void *, void *, void *, void *, void *, voi
 #endif /* !DCALL_CALLER_CLEANUP */
 
 /* Default no-op constructor callbacks (these should be used by TP_FABSTRACT types) */
-#define DeeNone_OperatorCtor     (*(int (DCALL *)(DeeObject *__restrict))&_DeeNone_reti0_1)
-#define DeeNone_OperatorCopy     (*(int (DCALL *)(DeeObject *__restrict, DeeObject *__restrict))&_DeeNone_reti0_2)
-#define DeeNone_OperatorWriteDec (*(int (DCALL *)(DeeObject *__restrict, struct Dee_serial *__restrict, Dee_seraddr_t))&_DeeNone_reti0_3)
+#define DeeNone_OperatorCtor      (*(int (DCALL *)(DeeObject *__restrict))&_DeeNone_reti0_1)
+#define DeeNone_OperatorCopy      (*(int (DCALL *)(DeeObject *__restrict, DeeObject *__restrict))&_DeeNone_reti0_2)
+#define DeeNone_OperatorSerialize (*(int (DCALL *)(DeeObject *__restrict, struct Dee_serial *__restrict, Dee_seraddr_t))&_DeeNone_reti0_3)
 
 DECL_END
 

include/deemon/serial.h

@@ -74,18 +74,27 @@ struct Dee_serial_type {
 	(DCALL *set_addr2mem)(DeeSerial *__restrict self, Dee_seraddr_t addr);
 
 	/* Allocate generic heap memory (as per "Dee_Malloc()")
+	 * @param: ref: When non-NULL, a reference pointer describing where data originates from.
+	 *              This should **ONLY** be given when serializing "[owned][const]" fields of
+	 *              a containing object (e.g. "DeeClassDescriptorObject::cd_clsop_list"), but
+	 *              **MUST** be "NULL" when serializing "[owned][lock(...)]" fields (e.g.
+	 *              "DeeListObject::l_list::ol_elemv").
+	 *              The reason why this is needed is to allow later "DeeSerial_PutPointer()"
+	 *              calls to connect the dots and understand that a given pointer actually
+	 *              points into a block previously returned by `DeeSerial_Malloc()', similar
+	 *              to how it can do so for `DeeSerial_ObjectMalloc()'
 	 * @return: * : Serialized address of heap buffer
 	 * @return: Dee_SERADDR_INVALID: Allocation failed (for "set_malloc" and "set_calloc": error was thrown) */
-	WUNUSED_T NONNULL_T((1)) Dee_seraddr_t (DCALL *set_malloc)(DeeSerial *__restrict self, size_t num_bytes);
-	WUNUSED_T NONNULL_T((1)) Dee_seraddr_t (DCALL *set_calloc)(DeeSerial *__restrict self, size_t num_bytes);
-	WUNUSED_T NONNULL_T((1)) Dee_seraddr_t (DCALL *set_trymalloc)(DeeSerial *__restrict self, size_t num_bytes);
-	WUNUSED_T NONNULL_T((1)) Dee_seraddr_t (DCALL *set_trycalloc)(DeeSerial *__restrict self, size_t num_bytes);
+	WUNUSED_T NONNULL_T((1)) Dee_seraddr_t (DCALL *set_malloc)(DeeSerial *__restrict self, size_t num_bytes, /*0..1*/ void *ref);
+	WUNUSED_T NONNULL_T((1)) Dee_seraddr_t (DCALL *set_calloc)(DeeSerial *__restrict self, size_t num_bytes, /*0..1*/ void *ref);
+	WUNUSED_T NONNULL_T((1)) Dee_seraddr_t (DCALL *set_trymalloc)(DeeSerial *__restrict self, size_t num_bytes, /*0..1*/ void *ref);
+	WUNUSED_T NONNULL_T((1)) Dee_seraddr_t (DCALL *set_trycalloc)(DeeSerial *__restrict self, size_t num_bytes, /*0..1*/ void *ref);
 
 	/* Free generic heap memory (as per "Dee_Free()")
 	 * Only allowed to be called for the most-recent non-Dee_SERADDR_INVALID
 	 * return value of one of the allocation functions above. Behavior is hard
 	 * undefined if you try to free a buffer that isn't the most recent one. */
-	NONNULL_T((1)) void (DCALL *set_free)(DeeSerial *__restrict self, Dee_seraddr_t addr);
+	NONNULL_T((1)) void (DCALL *set_free)(DeeSerial *__restrict self, Dee_seraddr_t addr, /*0..1*/ void *ref);
 
 	/* Allocate generic object heap memory (as per "DeeObject_Malloc()")
 	 * These functions will have automatically pre-initialized:
@@ -100,7 +109,7 @@ struct Dee_serial_type {
 
 	/* Free generic heap memory (as per "DeeObject_Free()")
 	 * Same restrictions of `set_free' regarding order of free() operations also apply to this */
-	NONNULL_T((1)) void (DCALL *set_object_free)(DeeSerial *__restrict self, Dee_seraddr_t addr);
+	NONNULL_T((1, 3)) void (DCALL *set_object_free)(DeeSerial *__restrict self, Dee_seraddr_t addr, DeeObject *__restrict ref);
 
 	/* Same as above, but must be used for GC-objects (as per "DeeGCObject_Malloc()") */
 	WUNUSED_T NONNULL_T((1, 3)) Dee_seraddr_t (DCALL *set_gcobject_malloc)(DeeSerial *__restrict self, size_t num_bytes, DeeObject *__restrict ref);
@@ -109,7 +118,7 @@ struct Dee_serial_type {
 	WUNUSED_T NONNULL_T((1, 3)) Dee_seraddr_t (DCALL *set_gcobject_trycalloc)(DeeSerial *__restrict self, size_t num_bytes, DeeObject *__restrict ref);
 
 	/* Free generic heap memory (as per "DeeGCObject_Free()") */
-	NONNULL_T((1)) void (DCALL *set_gcobject_free)(DeeSerial *__restrict self, Dee_seraddr_t addr);
+	NONNULL_T((1, 3)) void (DCALL *set_gcobject_free)(DeeSerial *__restrict self, Dee_seraddr_t addr, DeeObject *__restrict ref);
 
 	/* Serialize a `void *' field at `addrof_pointer' as being populated with the
 	 * effectively final value of `DeeSerial_Addr2Mem(self, addrof_target, void)'
@@ -166,12 +175,25 @@ struct Dee_serial {
 	((T *)(*(self)->ser_type->set_addr2mem)(self, addr))
 
 /* Allocate generic heap memory (as per "Dee_Malloc()")
+ * @param: ref: When non-NULL, a reference pointer describing where data originates from.
+ *              This should **ONLY** be given when serializing "[owned][const]" fields of
+ *              a containing object (e.g. "DeeClassDescriptorObject::cd_clsop_list"), but
+ *              **MUST** be "NULL" when serializing "[owned][lock(...)]" fields (e.g.
+ *              "DeeListObject::l_list::ol_elemv").
+ *              The reason why this is needed is to allow later "DeeSerial_PutPointer()"
+ *              calls to connect the dots and understand that a given pointer actually
+ *              points into a block previously returned by `DeeSerial_Malloc()', similar
+ *              to how it can do so for `DeeSerial_ObjectMalloc()'
+ *              TLDR:
+ *              - If you use "DeeSerial_TryMalloc()" because of a lock, you probably want to pass "NULL"
+ *              - Otherwise, pass the [const] source pointer
+ *
  * @return: * : Serialized address of heap buffer
  * @return: Dee_SERADDR_INVALID: Allocation failed (for "DeeSerial_Malloc" and "DeeSerial_Calloc": error was thrown) */
-#define DeeSerial_Malloc(self, num_bytes)    (*(self)->ser_type->set_malloc)(self, num_bytes)
-#define DeeSerial_Calloc(self, num_bytes)    (*(self)->ser_type->set_calloc)(self, num_bytes)
-#define DeeSerial_TryMalloc(self, num_bytes) (*(self)->ser_type->set_trymalloc)(self, num_bytes)
-#define DeeSerial_TryCalloc(self, num_bytes) (*(self)->ser_type->set_trycalloc)(self, num_bytes)
+#define DeeSerial_Malloc(self, num_bytes, ref)    (*(self)->ser_type->set_malloc)(self, num_bytes, ref)
+#define DeeSerial_Calloc(self, num_bytes, ref)    (*(self)->ser_type->set_calloc)(self, num_bytes, ref)
+#define DeeSerial_TryMalloc(self, num_bytes, ref) (*(self)->ser_type->set_trymalloc)(self, num_bytes, ref)
+#define DeeSerial_TryCalloc(self, num_bytes, ref) (*(self)->ser_type->set_trycalloc)(self, num_bytes, ref)
 
 /* Free generic heap memory (as per "Dee_Free()")
  * Only allowed to be called for the most-recent non-Dee_SERADDR_INVALID
@@ -180,7 +202,7 @@ struct Dee_serial {
  *
  * NOTE: DON'T call this method for error-cleanup -- On error, the
  *       owner of the serializer will free all allocated memory! */
-#define DeeSerial_Free(self, addr) (*(self)->ser_type->set_free)(self, addr)
+#define DeeSerial_Free(self, addr, ref) (*(self)->ser_type->set_free)(self, addr, ref)
 
 /* Allocate generic object heap memory (as per "DeeObject_Malloc()")
  * These functions will have automatically pre-initialized:
@@ -198,7 +220,7 @@ struct Dee_serial {
  *
  * NOTE: DON'T call this method for error-cleanup -- On error, the
  *       owner of the serializer will free all allocated memory! */
-#define DeeSerial_ObjectFree(self, addr) (*(self)->ser_type->set_object_free)(self, addr)
+#define DeeSerial_ObjectFree(self, addr, ref) (*(self)->ser_type->set_object_free)(self, addr, ref)
 
 /* Same as above, but must be used for GC-objects (as per "DeeGCObject_Malloc()") */
 #define DeeSerial_GCObjectMalloc(self, num_bytes, ref)    (*(self)->ser_type->set_gcobject_malloc)(self, num_bytes, Dee_AsObject(ref))
@@ -210,7 +232,7 @@ struct Dee_serial {
  *
  * NOTE: DON'T call this method for error-cleanup -- On error, the
  *       owner of the serializer will free all allocated memory! */
-#define DeeSerial_GCObjectFree(self, addr) (*(self)->ser_type->set_gcobject_free)(self, addr)
+#define DeeSerial_GCObjectFree(self, addr, ref) (*(self)->ser_type->set_gcobject_free)(self, addr, ref)
 
 
 /* Serialize a `void *' field at `addrof_pointer' as being populated with the

src/deemon/compiler/asm/modgen.c

@@ -117,9 +117,9 @@ module_compile(struct Dee_serial *__restrict writer,
 	} else {
 		size_t i, count = current_rootscope->rs_bucketm + 1;
 		Dee_seraddr_t out__mo_bucketv;
-		struct Dee_module_symbol *in__mo_bucketv = current_rootscope->rs_bucketv;
 		struct Dee_module_symbol *ou__mo_bucketv;
-		out__mo_bucketv = DeeSerial_Malloc(writer, count * sizeof(struct Dee_module_symbol));
+		struct Dee_module_symbol *in__mo_bucketv = current_rootscope->rs_bucketv;
+		out__mo_bucketv = DeeSerial_Malloc(writer, count * sizeof(struct Dee_module_symbol), NULL);
 		if (!Dee_SERADDR_ISOK(out__mo_bucketv))
 			goto err;
 		if (DeeSerial_PutAddr(writer, ADDROF(mo_bucketv), out__mo_bucketv))
@@ -162,7 +162,7 @@ module_compile(struct Dee_serial *__restrict writer,
 		uint16_t count = current_rootscope->rs_importc;
 		Dee_seraddr_t out__mo_importv;
 		DREF DeeModuleObject **ou__mo_importv;
-		out__mo_importv = DeeSerial_Malloc(writer, count * sizeof(DREF DeeModuleObject *));
+		out__mo_importv = DeeSerial_Malloc(writer, count * sizeof(DREF DeeModuleObject *), NULL);
 		if (!Dee_SERADDR_ISOK(out__mo_importv))
 			goto err;
 		if (DeeSerial_PutAddr(writer, ADDROF(mo_importv), out__mo_importv))

src/deemon/execute/code.c

@@ -2618,7 +2618,7 @@ DFUNDEF WUNUSED ATTR_INS(3, 4) NONNULL((1)) int
 (DCALL DeeSerial_XPutObjectVectorDup)(DeeSerial *__restrict writer, Dee_seraddr_t addr,
                                       DeeObject *const *objv, size_t objc) {
 	size_t i;
-	Dee_seraddr_t md_addr = DeeSerial_Malloc(writer, objc * sizeof(DREF DeeObject *));
+	Dee_seraddr_t md_addr = DeeSerial_Malloc(writer, objc * sizeof(DREF DeeObject *), (void *)objv);
 	if (!Dee_SERADDR_ISOK(md_addr))
 		goto err;
 	for (i = 0; i < objc; ++i) {
@@ -2679,14 +2679,13 @@ code_serialize(DeeCodeObject *__restrict self, DeeSerial *__restrict writer) {
 			goto err;
 	}
 	if (self->co_exceptv) {
-		struct except_handler *out_exceptv, *in_exceptv;
+		struct except_handler *out_exceptv, *in_exceptv = self->co_exceptv;
 		uint16_t i, exceptc = self->co_exceptc;
 		size_t sizeof_exceptv = exceptc * sizeof(struct except_handler);
-		Dee_seraddr_t addrof_out_exceptv = DeeSerial_Malloc(writer, sizeof_exceptv);
+		Dee_seraddr_t addrof_out_exceptv = DeeSerial_Malloc(writer, sizeof_exceptv, in_exceptv);
 		if (!Dee_SERADDR_ISOK(addrof_out_exceptv))
 			goto err;
 		out_exceptv = DeeSerial_Addr2Mem(writer, addrof_out_exceptv, struct except_handler);
-		in_exceptv  = self->co_exceptv;
 		for (i = 0; i < exceptc; ++i) {
 			out_exceptv[i] = in_exceptv[i];
 			if (in_exceptv[i].eh_mask) {