added free and null macro

dance858 · dance858 · commit 1c3ebeecbe88 · 2026-02-17T12:25:29.000-08:00
diff --git a/include/memory_wrappers.h b/include/memory_wrappers.h
@@ -0,0 +1,13 @@
+#ifndef MEMORY_WRAPPERS_H
+#define MEMORY_WRAPPERS_H
+
+#include <stdlib.h>
+
+#define FREE_AND_NULL(p)                                                            \
+    do                                                                              \
+    {                                                                               \
+        free(p);                                                                    \
+        (p) = NULL;                                                                 \
+    } while (0)
+
+#endif /* MEMORY_WRAPPERS_H */
diff --git a/include/utils/Vec_macros.h b/include/utils/Vec_macros.h
@@ -19,6 +19,7 @@
 #ifndef VEC_MACROS_H
 #define VEC_MACROS_H
 
+#include "memory_wrappers.h"
 #include <assert.h>
 #include <stdio.h>
 #include <stdlib.h>
@@ -48,7 +49,7 @@
         vec->data = (TYPE *) malloc(capacity * sizeof(TYPE));                       \
         if (vec->data == NULL)                                                      \
         {                                                                           \
-            free(vec);                                                              \
+            FREE_AND_NULL(vec);                                                     \
             return NULL;                                                            \
         }                                                                           \
                                                                                     \
@@ -59,8 +60,9 @@
                                                                                     \
     static inline void TYPE_NAME##Vec_free(TYPE_NAME##Vec *vec)                     \
     {                                                                               \
-        free(vec->data);                                                            \
-        free(vec);                                                                  \
+        if (!vec) return;                                                           \
+        FREE_AND_NULL(vec->data);                                                   \
+        FREE_AND_NULL(vec);                                                         \
     }                                                                               \
                                                                                     \
     static inline void TYPE_NAME##Vec_clear_no_resize(TYPE_NAME##Vec *vec)          \
diff --git a/src/affine/hstack.c b/src/affine/hstack.c
@@ -16,6 +16,7 @@
  * limitations under the License.
  */
 #include "affine.h"
+#include "memory_wrappers.h"
 #include "utils/CSR_sum.h"
 #include <assert.h>
 #include <stdio.h>
@@ -168,7 +169,7 @@ static void free_type_data(expr *node)
     }
 
     free_csr_matrix(hnode->CSR_work);
-    free(hnode->args);
+    FREE_AND_NULL(hnode->args);
 }
 
 expr *new_hstack(expr **args, int n_args, int n_vars)
diff --git a/src/affine/index.c b/src/affine/index.c
@@ -16,6 +16,7 @@
  * limitations under the License.
  */
 #include "affine.h"
+#include "memory_wrappers.h"
 #include "subexpr.h"
 #include <assert.h>
 #include <stdio.h>
@@ -38,7 +39,7 @@ static bool check_for_duplicates(const int *indices, int n_idxs, int max_idx)
         }
         seen[indices[i]] = true;
     }
-    free(seen);
+    FREE_AND_NULL(seen);
     return has_dup;
 }
 
@@ -154,8 +155,7 @@ static bool is_affine(const expr *node)
 static void free_type_data(expr *node)
 {
     index_expr *idx = (index_expr *) node;
-    free(idx->indices);
-    idx->indices = NULL;
+    FREE_AND_NULL(idx->indices);
 }
 
 expr *new_index(expr *child, int d1, int d2, const int *indices, int n_idxs)
diff --git a/src/affine/linear_op.c b/src/affine/linear_op.c
@@ -16,6 +16,7 @@
  * limitations under the License.
  */
 #include "affine.h"
+#include "memory_wrappers.h"
 #include <assert.h>
 #include <stdlib.h>
 #include <string.h>
@@ -60,8 +61,7 @@ static void free_type_data(expr *node)
 
     free_csc_matrix(lin_node->A_csc);
     lin_node->A_csc = NULL;
-    free(lin_node->b);
-    lin_node->b = NULL;
+    FREE_AND_NULL(lin_node->b);
 }
 
 static void jacobian_init(expr *node)
diff --git a/src/affine/sum.c b/src/affine/sum.c
@@ -16,6 +16,7 @@
  * limitations under the License.
  */
 #include "affine.h"
+#include "memory_wrappers.h"
 #include "utils/CSR_sum.h"
 #include "utils/int_double_pair.h"
 #include "utils/mini_numpy.h"
@@ -175,7 +176,7 @@ static bool is_affine(const expr *node)
 static void free_type_data(expr *node)
 {
     sum_expr *snode = (sum_expr *) node;
-    free(snode->idx_map);
+    FREE_AND_NULL(snode->idx_map);
 }
 
 expr *new_sum(expr *child, int axis)
diff --git a/src/affine/trace.c b/src/affine/trace.c
@@ -16,6 +16,7 @@
  * limitations under the License.
  */
 #include "affine.h"
+#include "memory_wrappers.h"
 #include "utils/CSR_sum.h"
 #include "utils/int_double_pair.h"
 #include "utils/utils.h"
@@ -139,7 +140,7 @@ static void free_type_data(expr *node)
     if (node)
     {
         trace_expr *tnode = (trace_expr *) node;
-        free(tnode->idx_map);
+        FREE_AND_NULL(tnode->idx_map);
     }
 }
 
diff --git a/src/bivariate/left_matmul.c b/src/bivariate/left_matmul.c
@@ -16,6 +16,7 @@
  * limitations under the License.
  */
 #include "bivariate.h"
+#include "memory_wrappers.h"
 #include "subexpr.h"
 #include "utils/Timer.h"
 #include "utils/linalg_sparse_matmuls.h"
@@ -98,8 +99,8 @@ static void free_type_data(expr *node)
     free_csr_matrix(lin_node->AT);
     free_csc_matrix(lin_node->Jchild_CSC);
     free_csc_matrix(lin_node->J_CSC);
-    free(lin_node->csc_to_csr_workspace);
-    free(lin_node->AT_iwork);
+    FREE_AND_NULL(lin_node->csc_to_csr_workspace);
+    FREE_AND_NULL(lin_node->AT_iwork);
     free_expr(lin_node->param_source);
 }
 
diff --git a/src/bivariate/quad_over_lin.c b/src/bivariate/quad_over_lin.c
@@ -16,6 +16,7 @@
  * limitations under the License.
  */
 #include "bivariate.h"
+#include "memory_wrappers.h"
 #include "subexpr.h"
 #include "utils/CSC_Matrix.h"
 #include <assert.h>
@@ -102,7 +103,7 @@ static void jacobian_init(expr *node)
         }
         assert(nonzero_cols == node->jacobian->nnz);
 
-        free(col_nz);
+        FREE_AND_NULL(col_nz);
 
         /* insert y variable index at correct position */
         insert_idx(y->var_id, node->jacobian->i, node->jacobian->nnz);
diff --git a/src/bivariate/right_matmul.c b/src/bivariate/right_matmul.c
@@ -17,6 +17,7 @@
  */
 #include "affine.h"
 #include "bivariate.h"
+#include "memory_wrappers.h"
 #include "subexpr.h"
 #include "utils/CSR_Matrix.h"
 #include "utils/linalg_sparse_matmuls.h"
@@ -59,7 +60,7 @@ expr *new_right_matmul(expr *param_node, expr *u, const CSR_Matrix *A)
 
     /* functionality for parameter */
     left_matmul_expr *left_matmul_data = (left_matmul_expr *) left_matmul_node;
-    free(left_matmul_data->AT_iwork);
+    FREE_AND_NULL(left_matmul_data->AT_iwork);
     left_matmul_data->AT_iwork = work_transpose;
     left_matmul_data->refresh_param_values = refresh_param_values;
 
diff --git a/src/expr.c b/src/expr.c
@@ -16,6 +16,7 @@
  * limitations under the License.
  */
 #include "expr.h"
+#include "memory_wrappers.h"
 #include "utils/int_double_pair.h"
 #include <stdlib.h>
 #include <string.h>
@@ -61,19 +62,16 @@ void free_expr(expr *node)
     }
 
     /* free value array and jacobian */
-    free(node->value);
+    FREE_AND_NULL(node->value);
     free_csr_matrix(node->jacobian);
     free_csr_matrix(node->wsum_hess);
-    free(node->dwork);
-    free(node->iwork);
-    node->value = NULL;
+    FREE_AND_NULL(node->dwork);
+    FREE_AND_NULL(node->iwork);
     node->jacobian = NULL;
     node->wsum_hess = NULL;
-    node->dwork = NULL;
-    node->iwork = NULL;
 
     /* free the node itself */
-    free(node);
+    FREE_AND_NULL(node);
 }
 
 void expr_retain(expr *node)
diff --git a/src/other/prod_axis_one.c b/src/other/prod_axis_one.c
@@ -1,3 +1,4 @@
+#include "memory_wrappers.h"
 #include "other.h"
 #include <assert.h>
 #include <math.h>
@@ -371,9 +372,9 @@ static bool is_affine(const expr *node)
 static void free_type_data(expr *node)
 {
     prod_axis *pnode = (prod_axis *) node;
-    free(pnode->num_of_zeros);
-    free(pnode->zero_index);
-    free(pnode->prod_nonzero);
+    FREE_AND_NULL(pnode->num_of_zeros);
+    FREE_AND_NULL(pnode->zero_index);
+    FREE_AND_NULL(pnode->prod_nonzero);
 }
 
 expr *new_prod_axis_one(expr *child)
diff --git a/src/other/prod_axis_zero.c b/src/other/prod_axis_zero.c
@@ -1,3 +1,4 @@
+#include "memory_wrappers.h"
 #include "other.h"
 #include <assert.h>
 #include <math.h>
@@ -330,9 +331,9 @@ static bool is_affine(const expr *node)
 static void free_type_data(expr *node)
 {
     prod_axis *pnode = (prod_axis *) node;
-    free(pnode->num_of_zeros);
-    free(pnode->zero_index);
-    free(pnode->prod_nonzero);
+    FREE_AND_NULL(pnode->num_of_zeros);
+    FREE_AND_NULL(pnode->zero_index);
+    FREE_AND_NULL(pnode->prod_nonzero);
 }
 
 /* TODO: refactor to remove diagonal entry as nonzero since it's always zero */
diff --git a/src/other/quad_form.c b/src/other/quad_form.c
@@ -1,3 +1,4 @@
+#include "memory_wrappers.h"
 #include "other.h"
 #include "subexpr.h"
 #include "utils/CSC_Matrix.h"
@@ -129,7 +130,7 @@ static void jacobian_init(expr *node)
             }
         }
         assert(nonzero_cols == node->jacobian->nnz);
-        free(col_nz);
+        FREE_AND_NULL(col_nz);
 
         node->jacobian->p[0] = 0;
         node->jacobian->p[1] = node->jacobian->nnz;
diff --git a/src/problem.c b/src/problem.c
@@ -16,6 +16,7 @@
  * limitations under the License.
  */
 #include "problem.h"
+#include "memory_wrappers.h"
 #include "subexpr.h"
 #include "utils/CSR_sum.h"
 #include "utils/utils.h"
@@ -235,7 +236,7 @@ void problem_init_hessian(problem *prob)
     prob->hess_idx_map = (int *) malloc(nnz * sizeof(int));
     int *iwork = (int *) malloc(MAX(nnz, prob->n_vars) * sizeof(int));
     problem_lagrange_hess_fill_sparsity(prob, iwork);
-    free(iwork);
+    FREE_AND_NULL(iwork);
 
     clock_gettime(CLOCK_MONOTONIC, &timer.end);
     prob->stats.time_init_derivatives += GET_ELAPSED_SECONDS(timer);
@@ -286,30 +287,30 @@ void free_problem(problem *prob)
     if (prob == NULL) return;
 
     /* Free allocated arrays */
-    free(prob->constraint_values);
-    free(prob->gradient_values);
+    FREE_AND_NULL(prob->constraint_values);
+    FREE_AND_NULL(prob->gradient_values);
     free_csr_matrix(prob->jacobian);
     free_csr_matrix(prob->lagrange_hessian);
-    free(prob->hess_idx_map);
+    FREE_AND_NULL(prob->hess_idx_map);
 
     /* Free parameter node array (weak references, not owned) */
-    free(prob->param_nodes);
+    FREE_AND_NULL(prob->param_nodes);
 
     /* Release expression references (decrements refcount) */
     free_expr(prob->objective);
     for (int i = 0; i < prob->n_constraints; i++)
     {
         free_expr(prob->constraints[i]);
     }
-    free(prob->constraints);
+    FREE_AND_NULL(prob->constraints);
 
     if (prob->verbose)
     {
         print_end_message(&prob->stats);
     }
 
     /* Free problem struct */
-    free(prob);
+    FREE_AND_NULL(prob);
 }
 
 double problem_objective_forward(problem *prob, const double *u)
diff --git a/src/utils/CSC_Matrix.c b/src/utils/CSC_Matrix.c
@@ -16,6 +16,7 @@
  * limitations under the License.
  */
 #include "utils/CSC_Matrix.h"
+#include "memory_wrappers.h"
 #include "utils/iVec.h"
 #include <assert.h>
 #include <stdlib.h>
@@ -32,10 +33,10 @@ CSC_Matrix *new_csc_matrix(int m, int n, int nnz)
 
     if (!matrix->p || !matrix->i || !matrix->x)
     {
-        free(matrix->p);
-        free(matrix->i);
-        free(matrix->x);
-        free(matrix);
+        FREE_AND_NULL(matrix->p);
+        FREE_AND_NULL(matrix->i);
+        FREE_AND_NULL(matrix->x);
+        FREE_AND_NULL(matrix);
         return NULL;
     }
 
@@ -50,10 +51,10 @@ void free_csc_matrix(CSC_Matrix *matrix)
 {
     if (matrix)
     {
-        free(matrix->p);
-        free(matrix->i);
-        free(matrix->x);
-        free(matrix);
+        FREE_AND_NULL(matrix->p);
+        FREE_AND_NULL(matrix->i);
+        FREE_AND_NULL(matrix->x);
+        FREE_AND_NULL(matrix);
     }
 }
 
@@ -105,7 +106,7 @@ CSR_Matrix *ATA_alloc(const CSC_Matrix *A)
     symmetrize_csr(Cp, Ci->data, n, C);
 
     /* free workspace */
-    free(Cp);
+    FREE_AND_NULL(Cp);
     iVec_free(Ci);
 
     return C;
@@ -211,7 +212,7 @@ CSC_Matrix *csr_to_csc(const CSR_Matrix *A)
         }
     }
 
-    free(count);
+    FREE_AND_NULL(count);
     return C;
 }
 
@@ -395,7 +396,7 @@ CSR_Matrix *BTA_alloc(const CSC_Matrix *A, const CSC_Matrix *B)
     memcpy(C->i, Ci->data, nnz * sizeof(int));
 
     /* free workspace */
-    free(Cp);
+    FREE_AND_NULL(Cp);
     iVec_free(Ci);
 
     return C;
diff --git a/src/utils/CSR_Matrix.c b/src/utils/CSR_Matrix.c
diff --git a/src/utils/int_double_pair.c b/src/utils/int_double_pair.c
diff --git a/src/utils/linalg_sparse_matmuls.c b/src/utils/linalg_sparse_matmuls.c
diff --git a/tests/profiling/profile_left_matmul.h b/tests/profiling/profile_left_matmul.h
diff --git a/tests/utils/test_csr_csc_conversion.h b/tests/utils/test_csr_csc_conversion.h
diff --git a/tests/utils/test_csr_matrix.h b/tests/utils/test_csr_matrix.h

Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,7 @@`
`16`	`16`	`* limitations under the License.`
`17`	`17`	`*/`
`18`	`18`	`#include "affine.h"`
	`19`	`+#include "memory_wrappers.h"`
`19`	`20`	`#include "utils/CSR_sum.h"`
`20`	`21`	`#include <assert.h>`
`21`	`22`	`#include <stdio.h>`
`@@ -168,7 +169,7 @@ static void free_type_data(expr *node)`
`168`	`169`	`}`
`169`	`170`
`170`	`171`	`free_csr_matrix(hnode->CSR_work);`
`171`		`- free(hnode->args);`
	`172`	`+ FREE_AND_NULL(hnode->args);`
`172`	`173`	`}`
`173`	`174`
`174`	`175`	`expr new_hstack(expr *args, int n_args, int n_vars)`