Merge pull request #370 from teo-tsirpanis/capi-handle

Refactor handle management.

Author: teo-tsirpanis

.github/workflows/tiledb-go.yml

@@ -37,7 +37,7 @@ jobs:
     strategy:
       matrix:
         # Will be checking following versions
-        go: ["1.22", "1.23"]
+        go: ["1.22", "1.23", "1.24"]
     steps:
 
     # Checks out repository
@@ -74,7 +74,7 @@ jobs:
     strategy:
       matrix:
         # Will be checking following versions
-        go: ["1.22", "1.23"]
+        go: ["1.22", "1.23", "1.24"]
     steps:
     # Checks out repository
     - uses: actions/checkout@v4
@@ -113,7 +113,7 @@ jobs:
     strategy:
       matrix:
         # Will be checking following versions
-        go: ["1.22", "1.23"]
+        go: ["1.22", "1.23", "1.24"]
     steps:
     # Checks out repository
     - uses: actions/checkout@v4

array.go

@@ -13,27 +13,41 @@ import (
 	"unsafe"
 )
 
+type consolidationPlanHandle struct{ *capiHandle }
+
+func freeCapiConsolidationPlan(c unsafe.Pointer) {
+	C.tiledb_consolidation_plan_free((**C.tiledb_consolidation_plan_t)(unsafe.Pointer(&c)))
+}
+
+func newConsolidationPlanHandle(ptr *C.tiledb_consolidation_plan_t) consolidationPlanHandle {
+	return consolidationPlanHandle{newCapiHandle(unsafe.Pointer(ptr), freeCapiConsolidationPlan)}
+}
+
+func (x consolidationPlanHandle) Get() *C.tiledb_consolidation_plan_t {
+	return (*C.tiledb_consolidation_plan_t)(x.capiHandle.Get())
+}
+
 // ConsolidationPlan is a consolidation plan for array
 type ConsolidationPlan struct {
-	tiledbConsolidationPlan *C.tiledb_consolidation_plan_t
+	tiledbConsolidationPlan consolidationPlanHandle
 	context                 *Context
 }
 
+func newConsolidationPlanFromHandle(context *Context, handle consolidationPlanHandle) *ConsolidationPlan {
+	return &ConsolidationPlan{tiledbConsolidationPlan: handle, context: context}
+}
+
 // GetConsolidationPlan creates a consolidation plan for the already opened array.
 // The plan and the array will share the same tiledb context
 func GetConsolidationPlan(arr *Array, fragmentSize uint64) (*ConsolidationPlan, error) {
-	cp := &ConsolidationPlan{
-		context: arr.context,
-	}
-
-	ret := C.tiledb_consolidation_plan_create_with_mbr(cp.context.tiledbContext, arr.tiledbArray, C.uint64_t(fragmentSize), &cp.tiledbConsolidationPlan)
+	var consolidationPlanPtr *C.tiledb_consolidation_plan_t
+	ret := C.tiledb_consolidation_plan_create_with_mbr(arr.context.tiledbContext.Get(), arr.tiledbArray.Get(), C.uint64_t(fragmentSize), &consolidationPlanPtr)
 	runtime.KeepAlive(arr)
 	if ret != C.TILEDB_OK {
-		return nil, fmt.Errorf("error getting consolidation plan for array: %w", cp.context.LastError())
+		return nil, fmt.Errorf("error getting consolidation plan for array: %w", arr.context.LastError())
 	}
-	freeOnGC(cp)
 
-	return cp, nil
+	return newConsolidationPlanFromHandle(arr.context, newConsolidationPlanHandle(consolidationPlanPtr)), nil
 }
 
 // Free releases the internal TileDB core data that was allocated on the C heap.
@@ -42,16 +56,14 @@ func GetConsolidationPlan(arr *Array, fragmentSize uint64) (*ConsolidationPlan,
 // can safely be called many times on the same object; if it has already
 // been freed, it will not be freed again.
 func (cp *ConsolidationPlan) Free() {
-	if cp.tiledbConsolidationPlan != nil {
-		C.tiledb_consolidation_plan_free(&cp.tiledbConsolidationPlan)
-	}
+	cp.tiledbConsolidationPlan.Free()
 }
 
 // NumNodes returns the number of nodes for the plan
 func (cp *ConsolidationPlan) NumNodes() (uint64, error) {
 	var numNodes C.uint64_t
 
-	ret := C.tiledb_consolidation_plan_get_num_nodes(cp.context.tiledbContext, cp.tiledbConsolidationPlan, &numNodes)
+	ret := C.tiledb_consolidation_plan_get_num_nodes(cp.context.tiledbContext.Get(), cp.tiledbConsolidationPlan.Get(), &numNodes)
 	runtime.KeepAlive(cp)
 	if ret != C.TILEDB_OK {
 		return 0, fmt.Errorf("error getting consolidation plan num nodes: %w", cp.context.LastError())
@@ -64,7 +76,7 @@ func (cp *ConsolidationPlan) NumNodes() (uint64, error) {
 func (cp *ConsolidationPlan) NumFragments(nodeIndex uint64) (uint64, error) {
 	var numFragments C.uint64_t
 
-	ret := C.tiledb_consolidation_plan_get_num_fragments(cp.context.tiledbContext, cp.tiledbConsolidationPlan, C.uint64_t(nodeIndex), &numFragments)
+	ret := C.tiledb_consolidation_plan_get_num_fragments(cp.context.tiledbContext.Get(), cp.tiledbConsolidationPlan.Get(), C.uint64_t(nodeIndex), &numFragments)
 	runtime.KeepAlive(cp)
 	if ret != C.TILEDB_OK {
 		return 0, fmt.Errorf("error getting consolidation plan num fragments: %w", cp.context.LastError())
@@ -77,7 +89,7 @@ func (cp *ConsolidationPlan) NumFragments(nodeIndex uint64) (uint64, error) {
 func (cp *ConsolidationPlan) FragmentURI(nodeIndex, fragmentIndex uint64) (string, error) {
 	var curi *C.char
 
-	ret := C.tiledb_consolidation_plan_get_fragment_uri(cp.context.tiledbContext, cp.tiledbConsolidationPlan, C.uint64_t(nodeIndex), C.uint64_t(fragmentIndex), &curi)
+	ret := C.tiledb_consolidation_plan_get_fragment_uri(cp.context.tiledbContext.Get(), cp.tiledbConsolidationPlan.Get(), C.uint64_t(nodeIndex), C.uint64_t(fragmentIndex), &curi)
 	runtime.KeepAlive(cp)
 	if ret != C.TILEDB_OK {
 		return "", fmt.Errorf("error getting consolidation plan fragment uri for node %d and fragment %d: %w", nodeIndex, fragmentIndex, cp.context.LastError())
@@ -89,7 +101,7 @@ func (cp *ConsolidationPlan) FragmentURI(nodeIndex, fragmentIndex uint64) (strin
 // DumpJSON returns a json serialization of the plan
 func (cp *ConsolidationPlan) DumpJSON() (string, error) {
 	var cjson *C.char
-	ret := C.tiledb_consolidation_plan_dump_json_str(cp.context.tiledbContext, cp.tiledbConsolidationPlan, &cjson)
+	ret := C.tiledb_consolidation_plan_dump_json_str(cp.context.tiledbContext.Get(), cp.tiledbConsolidationPlan.Get(), &cjson)
 	runtime.KeepAlive(cp)
 	if ret != C.TILEDB_OK {
 		return "", fmt.Errorf("error getting consolidation plan json dump: %w", cp.context.LastError())
@@ -119,7 +131,7 @@ func (a *Array) ConsolidateFragments(config *Config, fragmentList []string) erro
 	list, freeMemory := cStringArray(fragmentList)
 	defer freeMemory()
 
-	ret := C.tiledb_array_consolidate_fragments(a.context.tiledbContext, curi, (**C.char)(slicePtr(list)), C.uint64_t(len(list)), config.tiledbConfig)
+	ret := C.tiledb_array_consolidate_fragments(a.context.tiledbContext.Get(), curi, (**C.char)(slicePtr(list)), C.uint64_t(len(list)), config.tiledbConfig.Get())
 	runtime.KeepAlive(a)
 	if ret != C.TILEDB_OK {
 		return fmt.Errorf("error consolidating tiledb array fragment list: %w", a.context.LastError())