<p>Harald Welte <strong>merged</strong> this change.</p><p><a href="https://gerrit.osmocom.org/13561">View Change</a></p><div style="white-space:pre-wrap">Approvals:
Harald Welte: Looks good to me, approved
Jenkins Builder: Verified
</div><pre style="font-family: monospace,monospace; white-space: pre-wrap;">Allow application to override default heap allocator<br><br>Let's introduce a mechanism by which libsmpp34-using applications can<br>override the memory allocator functions. This allows us e.g. in the<br>Osmocom context to use talloc which aids us in debugging memory leaks.<br><br>Closes: OS#3913<br>Change-Id: I3656117115e89638c093bfbcbc4369ce302f7a94<br>---<br>M TODO-RELEASE<br>M src/Makefile.am<br>A src/smpp34_heap.c<br>A src/smpp34_heap.h<br>M src/smpp34_params.c<br>M src/smpp34_unpack.c<br>6 files changed, 109 insertions(+), 12 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/TODO-RELEASE b/TODO-RELEASE</span><br><span>index d0852fc..bbc1495 100644</span><br><span>--- a/TODO-RELEASE</span><br><span>+++ b/TODO-RELEASE</span><br><span>@@ -7,3 +7,4 @@</span><br><span> # If any interfaces have been added since the last public release: c:r:a + 1.</span><br><span> # If any interfaces have been removed or changed since the last public release: c:r:0.</span><br><span> #library what description / commit summary line</span><br><span style="color: hsl(120, 100%, 40%);">+libsmpp34 smpp34_heap Adding new API/ABI to override memory allocator</span><br><span>diff --git a/src/Makefile.am b/src/Makefile.am</span><br><span>index 67550f3..55097c4 100644</span><br><span>--- a/src/Makefile.am</span><br><span>+++ b/src/Makefile.am</span><br><span>@@ -10,6 +10,7 @@</span><br><span> $(LIBRARY_SOURCE_DIR)/smpp34.h \</span><br><span> $(LIBRARY_SOURCE_DIR)/smpp34_dumpBuf.c \</span><br><span> $(LIBRARY_SOURCE_DIR)/smpp34_dumpPdu.c \</span><br><span style="color: hsl(120, 100%, 40%);">+ $(LIBRARY_SOURCE_DIR)/smpp34_heap.c \</span><br><span> $(LIBRARY_SOURCE_DIR)/smpp34_pack.c \</span><br><span> $(LIBRARY_SOURCE_DIR)/smpp34_unpack.c \</span><br><span> $(LIBRARY_SOURCE_DIR)/smpp34_structs.c \</span><br><span>@@ -19,6 +20,7 @@</span><br><span> </span><br><span> include_HEADERS = \</span><br><span> $(LIBRARY_SOURCE_DIR)/smpp34.h \</span><br><span style="color: hsl(120, 100%, 40%);">+ $(LIBRARY_SOURCE_DIR)/smpp34_heap.h \</span><br><span> $(LIBRARY_SOURCE_DIR)/smpp34_structs.h \</span><br><span> $(LIBRARY_SOURCE_DIR)/smpp34_params.h</span><br><span> </span><br><span>diff --git a/src/smpp34_heap.c b/src/smpp34_heap.c</span><br><span>new file mode 100644</span><br><span>index 0000000..f93d457</span><br><span>--- /dev/null</span><br><span>+++ b/src/smpp34_heap.c</span><br><span>@@ -0,0 +1,77 @@</span><br><span style="color: hsl(120, 100%, 40%);">+/*</span><br><span style="color: hsl(120, 100%, 40%);">+ * Copyright (C) 2019 Harald Welte</span><br><span style="color: hsl(120, 100%, 40%);">+ * File : smpp34_heap.c</span><br><span style="color: hsl(120, 100%, 40%);">+ * Author: Harald Welte <laforge@gnumonks.org></span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * This file is part of libsmpp34 (c-open-smpp3.4 library).</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * The libsmpp34 library is free software; you can redistribute it and/or</span><br><span style="color: hsl(120, 100%, 40%);">+ * modify it under the terms of the GNU Lesser General Public License as</span><br><span style="color: hsl(120, 100%, 40%);">+ * published by the Free Software Foundation; either version 2.1 of the</span><br><span style="color: hsl(120, 100%, 40%);">+ * License, or (at your option) any later version.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * This library is distributed in the hope that it will be useful, but</span><br><span style="color: hsl(120, 100%, 40%);">+ * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY</span><br><span style="color: hsl(120, 100%, 40%);">+ * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public</span><br><span style="color: hsl(120, 100%, 40%);">+ * License for more details.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * You should have received a copy of the GNU Lesser General Public License</span><br><span style="color: hsl(120, 100%, 40%);">+ * along with this library; if not, write to the Free Software Foundation,</span><br><span style="color: hsl(120, 100%, 40%);">+ * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+#include <stdio.h></span><br><span style="color: hsl(120, 100%, 40%);">+#include <stdlib.h></span><br><span style="color: hsl(120, 100%, 40%);">+#include <stdbool.h></span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+#include "smpp34_heap.h"</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+static void *smpp34_libc_malloc(size_t sz)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ return malloc(sz);</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+static void *smpp34_libc_realloc(void *ptr, size_t sz)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ return realloc(ptr, sz);</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+static void smpp34_libc_free(void *ptr)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ return free(ptr);</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+static bool allocator_used = false;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+static struct smpp34_memory_functions smpp34_allocator = {</span><br><span style="color: hsl(120, 100%, 40%);">+ .malloc_fun = smpp34_libc_malloc,</span><br><span style="color: hsl(120, 100%, 40%);">+ .realloc_fun = smpp34_libc_realloc,</span><br><span style="color: hsl(120, 100%, 40%);">+ .free_fun = smpp34_libc_free,</span><br><span style="color: hsl(120, 100%, 40%);">+};</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+void smpp34_set_memory_functions(const struct smpp34_memory_functions *mf)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ if (allocator_used) {</span><br><span style="color: hsl(120, 100%, 40%);">+ fprintf(stderr, "%s must be called before first use of smpp34_malloc\n", __func__);</span><br><span style="color: hsl(120, 100%, 40%);">+ return;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+ smpp34_allocator = *mf;</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+void *smpp34_malloc(size_t sz)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ allocator_used = true;</span><br><span style="color: hsl(120, 100%, 40%);">+ return smpp34_allocator.malloc_fun(sz);</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+void *smpp34_realloc(void *ptr, size_t sz)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ allocator_used = true;</span><br><span style="color: hsl(120, 100%, 40%);">+ return smpp34_allocator.realloc_fun(ptr, sz);</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+void smpp34_free(void *ptr)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ smpp34_allocator.free_fun(ptr);</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span>diff --git a/src/smpp34_heap.h b/src/smpp34_heap.h</span><br><span>new file mode 100644</span><br><span>index 0000000..6b9ac42</span><br><span>--- /dev/null</span><br><span>+++ b/src/smpp34_heap.h</span><br><span>@@ -0,0 +1,15 @@</span><br><span style="color: hsl(120, 100%, 40%);">+#pragma once</span><br><span style="color: hsl(120, 100%, 40%);">+#include <stddef.h></span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/* override the allocator with these methods; to be called BEFORE allocating anything */</span><br><span style="color: hsl(120, 100%, 40%);">+struct smpp34_memory_functions {</span><br><span style="color: hsl(120, 100%, 40%);">+ void * (*malloc_fun)(size_t sz);</span><br><span style="color: hsl(120, 100%, 40%);">+ void * (*realloc_fun)(void *ptr, size_t sz);</span><br><span style="color: hsl(120, 100%, 40%);">+ void (*free_fun)(void *ptr);</span><br><span style="color: hsl(120, 100%, 40%);">+};</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+void smpp34_set_memory_functions(const struct smpp34_memory_functions *mf);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+void *smpp34_malloc(size_t sz);</span><br><span style="color: hsl(120, 100%, 40%);">+void *smpp34_realloc(void *ptr, size_t sz);</span><br><span style="color: hsl(120, 100%, 40%);">+void smpp34_free(void *ptr);</span><br><span>diff --git a/src/smpp34_params.c b/src/smpp34_params.c</span><br><span>index a91f9eb..e7eb680 100644</span><br><span>--- a/src/smpp34_params.c</span><br><span>+++ b/src/smpp34_params.c</span><br><span>@@ -27,15 +27,16 @@</span><br><span> </span><br><span> #include "smpp34.h"</span><br><span> #include "smpp34_structs.h"</span><br><span style="color: hsl(120, 100%, 40%);">+#include "smpp34_heap.h"</span><br><span> </span><br><span> int </span><br><span> build_udad( udad_t **dest, udad_t *source )</span><br><span> {</span><br><span> </span><br><span> /* Build new DAD-Chain ************************************************/</span><br><span style="color: hsl(0, 100%, 40%);">- udad_t *dummy = (udad_t*)malloc(sizeof( udad_t ));</span><br><span style="color: hsl(120, 100%, 40%);">+ udad_t *dummy = (udad_t*)smpp34_malloc(sizeof( udad_t ));</span><br><span> if( dummy == NULL ){</span><br><span style="color: hsl(0, 100%, 40%);">- printf("Error in malloc()\n" );</span><br><span style="color: hsl(120, 100%, 40%);">+ printf("Error in smpp34_malloc()\n" );</span><br><span> return( -1 );</span><br><span> };</span><br><span> memcpy(dummy, source, sizeof( udad_t ));</span><br><span>@@ -54,7 +55,7 @@</span><br><span> /* Destroy DAD-Chain **************************************************/</span><br><span> while( sourceList != NULL ){</span><br><span> i = sourceList->next;</span><br><span style="color: hsl(0, 100%, 40%);">- free((void*)sourceList);</span><br><span style="color: hsl(120, 100%, 40%);">+ smpp34_free((void*)sourceList);</span><br><span> sourceList = i;</span><br><span> };</span><br><span> </span><br><span>@@ -68,9 +69,9 @@</span><br><span> {</span><br><span> </span><br><span> /* Build new DAD-Chain ************************************************/</span><br><span style="color: hsl(0, 100%, 40%);">- dad_t *dummy = (dad_t*)malloc(sizeof( dad_t ));</span><br><span style="color: hsl(120, 100%, 40%);">+ dad_t *dummy = (dad_t*)smpp34_malloc(sizeof( dad_t ));</span><br><span> if( dummy == NULL ){</span><br><span style="color: hsl(0, 100%, 40%);">- printf("Error in malloc()\n" );</span><br><span style="color: hsl(120, 100%, 40%);">+ printf("Error in smpp34_malloc()\n" );</span><br><span> return( -1 );</span><br><span> };</span><br><span> memcpy(dummy, source, sizeof( dad_t ));</span><br><span>@@ -89,7 +90,7 @@</span><br><span> /* Destroy DAD-Chain **************************************************/</span><br><span> while( sourceList != NULL ){</span><br><span> i = sourceList->next;</span><br><span style="color: hsl(0, 100%, 40%);">- free((void*)sourceList);</span><br><span style="color: hsl(120, 100%, 40%);">+ smpp34_free((void*)sourceList);</span><br><span> sourceList = i;</span><br><span> };</span><br><span> </span><br><span>@@ -102,9 +103,9 @@</span><br><span> {</span><br><span> </span><br><span> /* Build new TLV-Chain ************************************************/</span><br><span style="color: hsl(0, 100%, 40%);">- tlv_t *dummy = (tlv_t*)malloc(sizeof( tlv_t ));</span><br><span style="color: hsl(120, 100%, 40%);">+ tlv_t *dummy = (tlv_t*)smpp34_malloc(sizeof( tlv_t ));</span><br><span> if( dummy == NULL ){</span><br><span style="color: hsl(0, 100%, 40%);">- printf("Error in malloc()\n" );</span><br><span style="color: hsl(120, 100%, 40%);">+ printf("Error in smpp34_malloc()\n" );</span><br><span> return( -1 );</span><br><span> };</span><br><span> memcpy(dummy, source, sizeof( tlv_t ));</span><br><span>@@ -123,7 +124,7 @@</span><br><span> /* Destroy TLV-Chain **************************************************/</span><br><span> while( sourceList != NULL ){</span><br><span> i = sourceList->next;</span><br><span style="color: hsl(0, 100%, 40%);">- free((void*)sourceList);</span><br><span style="color: hsl(120, 100%, 40%);">+ smpp34_free((void*)sourceList);</span><br><span> sourceList = i;</span><br><span> };</span><br><span> </span><br><span>diff --git a/src/smpp34_unpack.c b/src/smpp34_unpack.c</span><br><span>index 749a037..ec73d35 100644</span><br><span>--- a/src/smpp34_unpack.c</span><br><span>+++ b/src/smpp34_unpack.c</span><br><span>@@ -31,6 +31,7 @@</span><br><span> #include "smpp34.h"</span><br><span> #include "smpp34_structs.h"</span><br><span> #include "smpp34_params.h"</span><br><span style="color: hsl(120, 100%, 40%);">+#include "smpp34_heap.h"</span><br><span> </span><br><span> /* GLOBALS ********************************************************************/</span><br><span> /* EXTERN *********************************************************************/</span><br><span>@@ -179,7 +180,7 @@</span><br><span> #define TLV( inst, tlv3, do_tlv ){\</span><br><span> tlv_t *aux_tlv = NULL;\</span><br><span> while( (aux - ini) < t1->command_length ){\</span><br><span style="color: hsl(0, 100%, 40%);">- aux_tlv = (tlv_t *) malloc(sizeof( tlv_t ));\</span><br><span style="color: hsl(120, 100%, 40%);">+ aux_tlv = (tlv_t *) smpp34_malloc(sizeof( tlv_t ));\</span><br><span> memset(aux_tlv, 0, sizeof(tlv_t));\</span><br><span> do_tlv( aux_tlv );\</span><br><span> aux_tlv->next = inst tlv3;\</span><br><span>@@ -191,7 +192,7 @@</span><br><span> udad_t *aux_udad = NULL;\</span><br><span> int c = 0;\</span><br><span> while( c < t1->no_unsuccess ){\</span><br><span style="color: hsl(0, 100%, 40%);">- aux_udad = (udad_t *) malloc(sizeof( udad_t ));\</span><br><span style="color: hsl(120, 100%, 40%);">+ aux_udad = (udad_t *) smpp34_malloc(sizeof( udad_t ));\</span><br><span> memset(aux_udad, 0, sizeof(udad_t));\</span><br><span> do_udad( aux_udad );\</span><br><span> aux_udad->next = inst udad3;\</span><br><span>@@ -204,7 +205,7 @@</span><br><span> dad_t *aux_dad = NULL;\</span><br><span> int c = 0;\</span><br><span> while( c < t1->number_of_dests ){\</span><br><span style="color: hsl(0, 100%, 40%);">- aux_dad = (dad_t *) malloc(sizeof( dad_t ));\</span><br><span style="color: hsl(120, 100%, 40%);">+ aux_dad = (dad_t *) smpp34_malloc(sizeof( dad_t ));\</span><br><span> memset(aux_dad, 0, sizeof(dad_t));\</span><br><span> do_dad( aux_dad );\</span><br><span> aux_dad->next = inst dad3;\</span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.osmocom.org/13561">change 13561</a>. To unsubscribe, or for help writing mail filters, visit <a href="https://gerrit.osmocom.org/settings">settings</a>.</p><div itemscope itemtype="http://schema.org/EmailMessage"><div itemscope itemprop="action" itemtype="http://schema.org/ViewAction"><link itemprop="url" href="https://gerrit.osmocom.org/13561"/><meta itemprop="name" content="View Change"/></div></div>
<div style="display:none"> Gerrit-Project: libsmpp34 </div>
<div style="display:none"> Gerrit-Branch: master </div>
<div style="display:none"> Gerrit-MessageType: merged </div>
<div style="display:none"> Gerrit-Change-Id: I3656117115e89638c093bfbcbc4369ce302f7a94 </div>
<div style="display:none"> Gerrit-Change-Number: 13561 </div>
<div style="display:none"> Gerrit-PatchSet: 7 </div>
<div style="display:none"> Gerrit-Owner: Harald Welte <laforge@gnumonks.org> </div>
<div style="display:none"> Gerrit-Assignee: fixeria <axilirator@gmail.com> </div>
<div style="display:none"> Gerrit-Reviewer: Harald Welte <laforge@gnumonks.org> </div>
<div style="display:none"> Gerrit-Reviewer: Jenkins Builder (1000002) </div>
<div style="display:none"> Gerrit-Reviewer: Pau Espin Pedrol <pespin@sysmocom.de> </div>
<div style="display:none"> Gerrit-CC: Vadim Yanitskiy <axilirator@gmail.com> </div>
<div style="display:none"> Gerrit-CC: fixeria <axilirator@gmail.com> </div>