Some crypto applications are now being built on Unix, so they should on VMS as well...
[openssl.git] / crypto / mem.c
1 /* crypto/mem.c */
2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
3  * All rights reserved.
4  *
5  * This package is an SSL implementation written
6  * by Eric Young (eay@cryptsoft.com).
7  * The implementation was written so as to conform with Netscapes SSL.
8  * 
9  * This library is free for commercial and non-commercial use as long as
10  * the following conditions are aheared to.  The following conditions
11  * apply to all code found in this distribution, be it the RC4, RSA,
12  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
13  * included with this distribution is covered by the same copyright terms
14  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
15  * 
16  * Copyright remains Eric Young's, and as such any Copyright notices in
17  * the code are not to be removed.
18  * If this package is used in a product, Eric Young should be given attribution
19  * as the author of the parts of the library used.
20  * This can be in the form of a textual message at program startup or
21  * in documentation (online or textual) provided with the package.
22  * 
23  * Redistribution and use in source and binary forms, with or without
24  * modification, are permitted provided that the following conditions
25  * are met:
26  * 1. Redistributions of source code must retain the copyright
27  *    notice, this list of conditions and the following disclaimer.
28  * 2. Redistributions in binary form must reproduce the above copyright
29  *    notice, this list of conditions and the following disclaimer in the
30  *    documentation and/or other materials provided with the distribution.
31  * 3. All advertising materials mentioning features or use of this software
32  *    must display the following acknowledgement:
33  *    "This product includes cryptographic software written by
34  *     Eric Young (eay@cryptsoft.com)"
35  *    The word 'cryptographic' can be left out if the rouines from the library
36  *    being used are not cryptographic related :-).
37  * 4. If you include any Windows specific code (or a derivative thereof) from 
38  *    the apps directory (application code) you must include an acknowledgement:
39  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
40  * 
41  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51  * SUCH DAMAGE.
52  * 
53  * The licence and distribution terms for any publically available version or
54  * derivative of this code cannot be changed.  i.e. this code cannot simply be
55  * copied and put under another distribution licence
56  * [including the GNU Public Licence.]
57  */
58
59 #include <stdio.h>
60 #include <stdlib.h>
61 #include <openssl/crypto.h>
62 #ifdef CRYPTO_MDEBUG_TIME
63 # include <time.h>      
64 #endif
65 #include <openssl/buffer.h>
66 #include <openssl/bio.h>
67 #include <openssl/lhash.h>
68 #include "cryptlib.h"
69
70 /* #ifdef CRYPTO_MDEBUG */
71 /* static int mh_mode=CRYPTO_MEM_CHECK_ON; */
72 /* #else */
73 static int mh_mode=CRYPTO_MEM_CHECK_OFF;
74 /* #endif */
75 /* State CRYPTO_MEM_CHECK_ON exists only temporarily when the library
76  * thinks that certain allocations should not be checked (e.g. the data
77  * structures used for memory checking).  It is not suitable as an initial
78  * state: the library will unexpectedly enable memory checking when it
79  * executes one of those sections that want to disable checking
80  * temporarily.
81  *
82  * State CRYPTO_MEM_CHECK_ENABLE without ..._ON makes no sense whatsoever.
83  */
84
85 static unsigned long order=0;
86
87 static LHASH *mh=NULL;
88
89 typedef struct mem_st
90         {
91         char *addr;
92         int num;
93         const char *file;
94         int line;
95 #ifdef CRYPTO_MDEBUG_THREAD
96         unsigned long thread;
97 #endif
98         unsigned long order;
99 #ifdef CRYPTO_MDEBUG_TIME
100         time_t time;
101 #endif
102         } MEM;
103
104 int CRYPTO_mem_ctrl(int mode)
105         {
106         int ret=mh_mode;
107
108         CRYPTO_w_lock(CRYPTO_LOCK_MALLOC);
109         switch (mode)
110                 {
111         /* for applications: */
112         case CRYPTO_MEM_CHECK_ON: /* aka MemCheck_start() */
113                 mh_mode = CRYPTO_MEM_CHECK_ON|CRYPTO_MEM_CHECK_ENABLE;
114                 break;
115         case CRYPTO_MEM_CHECK_OFF: /* aka MemCheck_stop() */
116                 mh_mode = 0;
117                 break;
118
119         /* switch off temporarily (for library-internal use): */
120         case CRYPTO_MEM_CHECK_DISABLE: /* aka MemCheck_off() */
121                 mh_mode&= ~CRYPTO_MEM_CHECK_ENABLE;
122                 break;
123         case CRYPTO_MEM_CHECK_ENABLE: /* aka MemCheck_on() */
124                 if (mh_mode&CRYPTO_MEM_CHECK_ON)
125                         mh_mode|=CRYPTO_MEM_CHECK_ENABLE;
126                 break;
127
128         default:
129                 break;
130                 }
131         CRYPTO_w_unlock(CRYPTO_LOCK_MALLOC);
132         return(ret);
133         }
134
135 static int mem_cmp(MEM *a, MEM *b)
136         {
137         return(a->addr - b->addr);
138         }
139
140 static unsigned long mem_hash(MEM *a)
141         {
142         unsigned long ret;
143
144         ret=(unsigned long)a->addr;
145
146         ret=ret*17851+(ret>>14)*7+(ret>>4)*251;
147         return(ret);
148         }
149
150 static char *(*malloc_locked_func)()=(char *(*)())malloc;
151 static void (*free_locked_func)()=(void (*)())free;
152 static char *(*malloc_func)()=  (char *(*)())malloc;
153 static char *(*realloc_func)()= (char *(*)())realloc;
154 static void (*free_func)()=     (void (*)())free;
155
156 void CRYPTO_set_mem_functions(char *(*m)(), char *(*r)(), void (*f)())
157         {
158         if ((m == NULL) || (r == NULL) || (f == NULL)) return;
159         malloc_func=m;
160         realloc_func=r;
161         free_func=f;
162         malloc_locked_func=m;
163         free_locked_func=f;
164         }
165
166 void CRYPTO_set_locked_mem_functions(char *(*m)(), void (*f)())
167         {
168         if ((m == NULL) || (f == NULL)) return;
169         malloc_locked_func=m;
170         free_locked_func=f;
171         }
172
173 void CRYPTO_get_mem_functions(char *(**m)(), char *(**r)(), void (**f)())
174         {
175         if (m != NULL) *m=malloc_func;
176         if (r != NULL) *r=realloc_func;
177         if (f != NULL) *f=free_func;
178         }
179
180 void CRYPTO_get_locked_mem_functions(char *(**m)(), void (**f)())
181         {
182         if (m != NULL) *m=malloc_locked_func;
183         if (f != NULL) *f=free_locked_func;
184         }
185
186 void *CRYPTO_malloc_locked(int num)
187         {
188         return(malloc_locked_func(num));
189         }
190
191 void CRYPTO_free_locked(void *str)
192         {
193         free_locked_func(str);
194         }
195
196 void *CRYPTO_malloc(int num)
197         {
198         return(malloc_func(num));
199         }
200
201 void *CRYPTO_realloc(void *str, int num)
202         {
203         return(realloc_func(str,num));
204         }
205
206 void CRYPTO_free(void *str)
207         {
208         free_func(str);
209         }
210
211 static unsigned long break_order_num=0;
212 void *CRYPTO_dbg_malloc(int num, const char *file, int line)
213         {
214         char *ret;
215         MEM *m,*mm;
216
217         if ((ret=malloc_func(num)) == NULL)
218                 return(NULL);
219
220         if (mh_mode & CRYPTO_MEM_CHECK_ENABLE)
221                 {
222                 MemCheck_off();
223                 if ((m=(MEM *)Malloc(sizeof(MEM))) == NULL)
224                         {
225                         Free(ret);
226                         MemCheck_on();
227                         return(NULL);
228                         }
229                 CRYPTO_w_lock(CRYPTO_LOCK_MALLOC);
230                 if (mh == NULL)
231                         {
232                         if ((mh=lh_new(mem_hash,mem_cmp)) == NULL)
233                                 {
234                                 Free(ret);
235                                 Free(m);
236                                 ret=NULL;
237                                 goto err;
238                                 }
239                         }
240
241                 m->addr=ret;
242                 m->file=file;
243                 m->line=line;
244                 m->num=num;
245 #ifdef CRYPTO_MDEBUG_THREAD
246                 m->thread=CRYPTO_thread_id();
247 #endif
248                 if (order == break_order_num)
249                         {
250                         /* BREAK HERE */
251                         m->order=order;
252                         }
253                 m->order=order++;
254 #ifdef CRYPTO_MDEBUG_TIME
255                 m->time=time(NULL);
256 #endif
257                 if ((mm=(MEM *)lh_insert(mh,(char *)m)) != NULL)
258                         {
259                         /* Not good, but don't sweat it */
260                         Free(mm);
261                         }
262 err:
263                 CRYPTO_w_unlock(CRYPTO_LOCK_MALLOC);
264                 MemCheck_on();
265                 }
266         return(ret);
267         }
268
269 void CRYPTO_dbg_free(void *addr)
270         {
271         MEM m,*mp;
272
273         if ((mh_mode & CRYPTO_MEM_CHECK_ENABLE) && (mh != NULL))
274                 {
275                 MemCheck_off();
276                 CRYPTO_w_lock(CRYPTO_LOCK_MALLOC);
277                 m.addr=addr;
278                 mp=(MEM *)lh_delete(mh,(char *)&m);
279                 if (mp != NULL)
280                         Free(mp);
281                 CRYPTO_w_unlock(CRYPTO_LOCK_MALLOC);
282                 MemCheck_on();
283                 }
284         free_func(addr);
285         }
286
287 void *CRYPTO_dbg_realloc(void *addr, int num, const char *file, int line)
288         {
289         char *ret;
290         MEM m,*mp;
291
292         ret=realloc_func(addr,num);
293         if (ret == addr) return(ret);
294
295         if (mh_mode & CRYPTO_MEM_CHECK_ENABLE)
296                 {
297                 MemCheck_off();
298                 if (ret == NULL) return(NULL);
299                 m.addr=addr;
300                 CRYPTO_w_lock(CRYPTO_LOCK_MALLOC);
301                 mp=(MEM *)lh_delete(mh,(char *)&m);
302                 if (mp != NULL)
303                         {
304                         mp->addr=ret;
305                         lh_insert(mh,(char *)mp);
306                         }
307                 CRYPTO_w_unlock(CRYPTO_LOCK_MALLOC);
308                 MemCheck_on();
309                 }
310         return(ret);
311         }
312
313 void *CRYPTO_remalloc(void *a, int n)
314         {
315         if (a != NULL) Free(a);
316         a=(char *)Malloc(n);
317         return(a);
318         }
319
320 void *CRYPTO_dbg_remalloc(void *a, int n, const char *file, int line)
321         {
322         if (a != NULL) CRYPTO_dbg_free(a);
323         a=(char *)CRYPTO_dbg_malloc(n,file,line);
324         return(a);
325         }
326
327
328 typedef struct mem_leak_st
329         {
330         BIO *bio;
331         int chunks;
332         long bytes;
333         } MEM_LEAK;
334
335 static void print_leak(MEM *m, MEM_LEAK *l)
336         {
337         char buf[128];
338 #ifdef CRYPTO_MDEBUG_TIME
339         struct tm *lcl;
340 #endif
341
342         if(m->addr == (char *)l->bio)
343             return;
344
345 #ifdef CRYPTO_MDEBUG_TIME
346         lcl = localtime(&m->time);
347 #endif
348
349         sprintf(buf,
350 #ifdef CRYPTO_MDEBUG_TIME
351                 "[%02d:%02d:%02d] "
352 #endif
353                 "%5lu file=%s, line=%d, "
354 #ifdef CRYPTO_MDEBUG_THREAD
355                 "thread=%lu, "
356 #endif
357                 "number=%d, address=%08lX\n",
358 #ifdef CRYPTO_MDEBUG_TIME
359                 lcl->tm_hour,lcl->tm_min,lcl->tm_sec,
360 #endif
361                 m->order,m->file,m->line,
362 #ifdef CRYPTO_MDEBUG_THREAD
363                 m->thread,
364 #endif
365                 m->num,(unsigned long)m->addr);
366
367         BIO_puts(l->bio,buf);
368         l->chunks++;
369         l->bytes+=m->num;
370         }
371
372 void CRYPTO_mem_leaks(BIO *b)
373         {
374         MEM_LEAK ml;
375         char buf[80];
376
377         if (mh == NULL) return;
378         ml.bio=b;
379         ml.bytes=0;
380         ml.chunks=0;
381         CRYPTO_w_lock(CRYPTO_LOCK_MALLOC);
382         lh_doall_arg(mh,(void (*)())print_leak,(char *)&ml);
383         CRYPTO_w_unlock(CRYPTO_LOCK_MALLOC);
384         if (ml.chunks != 0)
385                 {
386                 sprintf(buf,"%ld bytes leaked in %d chunks\n",
387                         ml.bytes,ml.chunks);
388                 BIO_puts(b,buf);
389                 }
390
391 #if 0
392         lh_stats_bio(mh,b);
393         lh_node_stats_bio(mh,b);
394         lh_node_usage_stats_bio(mh,b);
395 #endif
396         }
397
398 static void (*mem_cb)()=NULL;
399
400 static void cb_leak(MEM *m, char *cb)
401         {
402         void (*mem_callback)()=(void (*)())cb;
403         mem_callback(m->order,m->file,m->line,m->num,m->addr);
404         }
405
406 void CRYPTO_mem_leaks_cb(void (*cb)())
407         {
408         if (mh == NULL) return;
409         CRYPTO_w_lock(CRYPTO_LOCK_MALLOC);
410         mem_cb=cb;
411         lh_doall_arg(mh,(void (*)())cb_leak,(char *)mem_cb);
412         mem_cb=NULL;
413         CRYPTO_w_unlock(CRYPTO_LOCK_MALLOC);
414         }
415
416 #ifndef NO_FP_API
417 void CRYPTO_mem_leaks_fp(FILE *fp)
418         {
419         BIO *b;
420
421         if (mh == NULL) return;
422         if ((b=BIO_new(BIO_s_file())) == NULL)
423                 return;
424         BIO_set_fp(b,fp,BIO_NOCLOSE);
425         CRYPTO_mem_leaks(b);
426         BIO_free(b);
427         }
428 #endif
429