mem_dbg.c 22.1 KB
Newer Older
1
/* crypto/mem_dbg.c */
R
Richard Levitte 已提交
2 3
/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
 * All rights reserved.
4
 *
R
Richard Levitte 已提交
5 6 7
 * This package is an SSL implementation written
 * by Eric Young (eay@cryptsoft.com).
 * The implementation was written so as to conform with Netscapes SSL.
8
 *
R
Richard Levitte 已提交
9 10 11 12 13 14
 * This library is free for commercial and non-commercial use as long as
 * the following conditions are aheared to.  The following conditions
 * apply to all code found in this distribution, be it the RC4, RSA,
 * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
 * included with this distribution is covered by the same copyright terms
 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
15
 *
R
Richard Levitte 已提交
16 17 18 19 20 21
 * Copyright remains Eric Young's, and as such any Copyright notices in
 * the code are not to be removed.
 * If this package is used in a product, Eric Young should be given attribution
 * as the author of the parts of the library used.
 * This can be in the form of a textual message at program startup or
 * in documentation (online or textual) provided with the package.
22
 *
23 24 25
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
R
Richard Levitte 已提交
26 27
 * 1. Redistributions of source code must retain the copyright
 *    notice, this list of conditions and the following disclaimer.
28
 * 2. Redistributions in binary form must reproduce the above copyright
R
Richard Levitte 已提交
29 30 31 32 33 34 35 36
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *    "This product includes cryptographic software written by
 *     Eric Young (eay@cryptsoft.com)"
 *    The word 'cryptographic' can be left out if the rouines from the library
 *    being used are not cryptographic related :-).
37
 * 4. If you include any Windows specific code (or a derivative thereof) from
R
Richard Levitte 已提交
38 39
 *    the apps directory (application code) you must include an acknowledgement:
 *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
40
 *
R
Richard Levitte 已提交
41 42 43 44 45 46 47 48 49 50 51
 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
52
 *
R
Richard Levitte 已提交
53 54 55 56
 * The licence and distribution terms for any publically available version or
 * derivative of this code cannot be changed.  i.e. this code cannot simply be
 * copied and put under another distribution licence
 * [including the GNU Public Licence.]
57
 */
58 59 60 61 62 63 64 65
/* ====================================================================
 * Copyright (c) 1998-2006 The OpenSSL Project.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
66
 *    notice, this list of conditions and the following disclaimer.
67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. All advertising materials mentioning features or use of this
 *    software must display the following acknowledgment:
 *    "This product includes software developed by the OpenSSL Project
 *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
 *
 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
 *    endorse or promote products derived from this software without
 *    prior written permission. For written permission, please contact
 *    openssl-core@openssl.org.
 *
 * 5. Products derived from this software may not be called "OpenSSL"
 *    nor may "OpenSSL" appear in their names without prior written
 *    permission of the OpenSSL Project.
 *
 * 6. Redistributions of any form whatsoever must retain the following
 *    acknowledgment:
 *    "This product includes software developed by the OpenSSL Project
 *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
 *
 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 * OF THE POSSIBILITY OF SUCH DAMAGE.
 * ====================================================================
 *
 * This product includes cryptographic software written by Eric Young
 * (eay@cryptsoft.com).  This product includes software written by Tim
 * Hudson (tjh@cryptsoft.com).
 *
 */
111 112 113

#include <stdio.h>
#include <stdlib.h>
114
#include <time.h>
115
#include "internal/cryptlib.h"
116 117 118 119
#include <openssl/crypto.h>
#include <openssl/buffer.h>
#include <openssl/bio.h>
#include <openssl/lhash.h>
120 121 122
#if defined(CRYPTO_MDEBUG_BACKTRACE) && defined(__GNUC__)
# include <execinfo.h>
#endif
123

124 125 126 127 128 129 130 131 132 133
/*
 * The state changes to CRYPTO_MEM_CHECK_ON | CRYPTO_MEM_CHECK_ENABLE when
 * the application asks for it (usually after library initialisation for
 * which no book-keeping is desired). State CRYPTO_MEM_CHECK_ON exists only
 * temporarily when the library thinks that certain allocations should not be
 * checked (e.g. the data structures used for memory checking).  It is not
 * suitable as an initial state: the library will unexpectedly enable memory
 * checking when it executes one of those sections that want to disable
 * checking temporarily. State CRYPTO_MEM_CHECK_ENABLE without ..._ON makes
 * no sense whatsoever.
134
 */
135
#ifndef OPENSSL_NO_CRYPTO_MDEBUG
R
Rich Salz 已提交
136
static int mh_mode = CRYPTO_MEM_CHECK_OFF;
137
#endif
138

R
Rich Salz 已提交
139
#ifndef OPENSSL_NO_CRYPTO_MDEBUG
140
static unsigned long order = 0; /* number of memory requests */
B
Ben Laurie 已提交
141 142

DECLARE_LHASH_OF(MEM);
143 144
static LHASH_OF(MEM) *mh = NULL; /* hash-table of memory requests (address as
                                  * key); access requires MALLOC2 lock */
145

146 147
/*-
 * For application-defined information (static C-string `info')
148 149
 * to be displayed in memory leak list.
 * Each thread has its own stack.  For applications, there is
R
Rich Salz 已提交
150 151
 *   OPENSSL_mem_debug_push("...")     to push an entry,
 *   OPENSSL_mem_debug_pop()     to pop an entry,
152
 */
R
Rich Salz 已提交
153
typedef struct app_mem_info_st {
154 155 156 157 158 159 160
    CRYPTO_THREADID threadid;
    const char *file;
    int line;
    const char *info;
    struct app_mem_info_st *next; /* tail of thread's stack */
    int references;
} APP_INFO;
161

R
Rich Salz 已提交
162 163 164 165 166
/*
 * hash-table with those app_mem_info_st's that are at the
 * top of their thread's stack (with `thread' as key); access requires
 * MALLOC2 lock
 */
B
Ben Laurie 已提交
167
DECLARE_LHASH_OF(APP_INFO);
R
Rich Salz 已提交
168
static LHASH_OF(APP_INFO) *amih = NULL;
169

170
/* memory-block description */
R
Rich Salz 已提交
171
typedef struct mem_st {
172 173 174 175 176 177 178 179
    void *addr;
    int num;
    const char *file;
    int line;
    CRYPTO_THREADID threadid;
    unsigned long order;
    time_t time;
    APP_INFO *app_info;
180 181 182 183
#if defined(CRYPTO_MDEBUG_BACKTRACE) && defined(__GNUC__)
    void *array[30];
    size_t array_siz;
#endif
184 185
} MEM;

R
Rich Salz 已提交
186 187
/* num_disable > 0 iff mh_mode == CRYPTO_MEM_CHECK_ON (w/o ..._ENABLE) */
static unsigned int num_disable = 0;
188

189 190
/*
 * Valid iff num_disable > 0.  CRYPTO_LOCK_MALLOC2 is locked exactly in this
191
 * case (by the thread named in disabling_thread).
192
 */
193
static CRYPTO_THREADID disabling_threadid;
194

195
static void app_info_free(APP_INFO *inf)
196
{
R
Rich Salz 已提交
197 198
    if (!inf)
        return;
199
    if (--(inf->references) <= 0) {
R
Rich Salz 已提交
200
        app_info_free(inf->next);
201 202 203
        OPENSSL_free(inf);
    }
}
R
Rich Salz 已提交
204
#endif
205

206
int CRYPTO_mem_ctrl(int mode)
207
{
208
#ifdef OPENSSL_NO_CRYPTO_MDEBUG
R
Rich Salz 已提交
209 210
    return mode - mode;
#else
211 212 213 214
    int ret = mh_mode;

    CRYPTO_w_lock(CRYPTO_LOCK_MALLOC);
    switch (mode) {
R
Rich Salz 已提交
215 216 217 218
    default:
        break;

    case CRYPTO_MEM_CHECK_ON:
219 220 221
        mh_mode = CRYPTO_MEM_CHECK_ON | CRYPTO_MEM_CHECK_ENABLE;
        num_disable = 0;
        break;
R
Rich Salz 已提交
222 223

    case CRYPTO_MEM_CHECK_OFF:
224
        mh_mode = 0;
R
Rich Salz 已提交
225
        num_disable = 0;
226 227
        break;

R
Rich Salz 已提交
228 229
    /* switch off temporarily (for library-internal use): */
    case CRYPTO_MEM_CHECK_DISABLE:
230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258
        if (mh_mode & CRYPTO_MEM_CHECK_ON) {
            CRYPTO_THREADID cur;
            CRYPTO_THREADID_current(&cur);
            /* see if we don't have the MALLOC2 lock already */
            if (!num_disable
                || CRYPTO_THREADID_cmp(&disabling_threadid, &cur)) {
                /*
                 * Long-time lock CRYPTO_LOCK_MALLOC2 must not be claimed
                 * while we're holding CRYPTO_LOCK_MALLOC, or we'll deadlock
                 * if somebody else holds CRYPTO_LOCK_MALLOC2 (and cannot
                 * release it because we block entry to this function). Give
                 * them a chance, first, and then claim the locks in
                 * appropriate order (long-time lock first).
                 */
                CRYPTO_w_unlock(CRYPTO_LOCK_MALLOC);
                /*
                 * Note that after we have waited for CRYPTO_LOCK_MALLOC2 and
                 * CRYPTO_LOCK_MALLOC, we'll still be in the right "case" and
                 * "if" branch because MemCheck_start and MemCheck_stop may
                 * never be used while there are multiple OpenSSL threads.
                 */
                CRYPTO_w_lock(CRYPTO_LOCK_MALLOC2);
                CRYPTO_w_lock(CRYPTO_LOCK_MALLOC);
                mh_mode &= ~CRYPTO_MEM_CHECK_ENABLE;
                CRYPTO_THREADID_cpy(&disabling_threadid, &cur);
            }
            num_disable++;
        }
        break;
R
Rich Salz 已提交
259 260

    case CRYPTO_MEM_CHECK_ENABLE:
261 262 263 264 265 266 267 268 269 270 271 272 273
        if (mh_mode & CRYPTO_MEM_CHECK_ON) {
            if (num_disable) {  /* always true, or something is going wrong */
                num_disable--;
                if (num_disable == 0) {
                    mh_mode |= CRYPTO_MEM_CHECK_ENABLE;
                    CRYPTO_w_unlock(CRYPTO_LOCK_MALLOC2);
                }
            }
        }
        break;
    }
    CRYPTO_w_unlock(CRYPTO_LOCK_MALLOC);
    return (ret);
R
Rich Salz 已提交
274
#endif
275
}
276

R
Rich Salz 已提交
277
#ifndef OPENSSL_NO_CRYPTO_MDEBUG
R
Rich Salz 已提交
278 279

static int mem_check_on(void)
280 281
{
    int ret = 0;
282

283 284 285 286
    if (mh_mode & CRYPTO_MEM_CHECK_ON) {
        CRYPTO_THREADID cur;
        CRYPTO_THREADID_current(&cur);
        CRYPTO_r_lock(CRYPTO_LOCK_MALLOC);
287

288 289
        ret = (mh_mode & CRYPTO_MEM_CHECK_ENABLE)
            || CRYPTO_THREADID_cmp(&disabling_threadid, &cur);
290

291 292 293 294
        CRYPTO_r_unlock(CRYPTO_LOCK_MALLOC);
    }
    return (ret);
}
295

B
Ben Laurie 已提交
296
static int mem_cmp(const MEM *a, const MEM *b)
297
{
298
#ifdef _WIN64
299 300 301 302 303 304 305
    const char *ap = (const char *)a->addr, *bp = (const char *)b->addr;
    if (ap == bp)
        return 0;
    else if (ap > bp)
        return 1;
    else
        return -1;
306
#else
307
    return (const char *)a->addr - (const char *)b->addr;
308
#endif
309 310
}

B
Ben Laurie 已提交
311
static IMPLEMENT_LHASH_COMP_FN(mem, MEM)
312

B
Ben Laurie 已提交
313
static unsigned long mem_hash(const MEM *a)
314
{
315
    size_t ret;
316

317
    ret = (size_t)a->addr;
318 319 320 321

    ret = ret * 17851 + (ret >> 14) * 7 + (ret >> 4) * 251;
    return (ret);
}
322

B
Ben Laurie 已提交
323
static IMPLEMENT_LHASH_HASH_FN(mem, MEM)
324

325
/* static int app_info_cmp(APP_INFO *a, APP_INFO *b) */
326
static int app_info_cmp(const void *a_void, const void *b_void)
327 328 329 330 331
{
    return CRYPTO_THREADID_cmp(&((const APP_INFO *)a_void)->threadid,
                               &((const APP_INFO *)b_void)->threadid);
}

B
Ben Laurie 已提交
332
static IMPLEMENT_LHASH_COMP_FN(app_info, APP_INFO)
333

B
Ben Laurie 已提交
334
static unsigned long app_info_hash(const APP_INFO *a)
335 336 337 338 339 340 341 342 343
{
    unsigned long ret;

    ret = CRYPTO_THREADID_hash(&a->threadid);
    /* This is left in as a "who am I to question legacy?" measure */
    ret = ret * 17851 + (ret >> 14) * 7 + (ret >> 4) * 251;
    return (ret);
}

B
Ben Laurie 已提交
344
static IMPLEMENT_LHASH_HASH_FN(app_info, APP_INFO)
345

U
Ulf Möller 已提交
346
static APP_INFO *pop_info(void)
347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369
{
    APP_INFO tmp;
    APP_INFO *ret = NULL;

    if (amih != NULL) {
        CRYPTO_THREADID_current(&tmp.threadid);
        if ((ret = lh_APP_INFO_delete(amih, &tmp)) != NULL) {
            APP_INFO *next = ret->next;

            if (next != NULL) {
                next->references++;
                (void)lh_APP_INFO_insert(amih, next);
            }
            if (--(ret->references) <= 0) {
                ret->next = NULL;
                if (next != NULL)
                    next->references--;
                OPENSSL_free(ret);
            }
        }
    }
    return (ret);
}
370

R
Rich Salz 已提交
371
int CRYPTO_mem_debug_push(const char *info, const char *file, int line)
372 373 374 375
{
    APP_INFO *ami, *amim;
    int ret = 0;

R
Rich Salz 已提交
376 377
    if (mem_check_on()) {
        CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_DISABLE);
378

R
Rich Salz 已提交
379
        if ((ami = OPENSSL_malloc(sizeof(*ami))) == NULL)
380 381 382 383 384 385 386 387 388 389 390 391 392 393 394
            goto err;
        if (amih == NULL) {
            if ((amih = lh_APP_INFO_new()) == NULL) {
                OPENSSL_free(ami);
                goto err;
            }
        }

        CRYPTO_THREADID_current(&ami->threadid);
        ami->file = file;
        ami->line = line;
        ami->info = info;
        ami->references = 1;
        ami->next = NULL;

R
Rich Salz 已提交
395
        if ((amim = lh_APP_INFO_insert(amih, ami)) != NULL)
396
            ami->next = amim;
R
Rich Salz 已提交
397
        ret = 1;
398
 err:
R
Rich Salz 已提交
399
        CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE);
400
    }
401

402 403
    return (ret);
}
404

R
Rich Salz 已提交
405
int CRYPTO_mem_debug_pop(void)
406 407
{
    int ret = 0;
408

R
Rich Salz 已提交
409 410
    if (mem_check_on()) {
        CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_DISABLE);
411
        ret = (pop_info() != NULL);
R
Rich Salz 已提交
412
        CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE);
413 414 415
    }
    return (ret);
}
416

417
static unsigned long break_order_num = 0;
R
Rich Salz 已提交
418 419 420

void CRYPTO_mem_debug_malloc(void *addr, size_t num, int before_p,
                             const char *file, int line)
421 422 423 424 425 426 427 428 429 430 431
{
    MEM *m, *mm;
    APP_INFO tmp, *amim;

    switch (before_p & 127) {
    case 0:
        break;
    case 1:
        if (addr == NULL)
            break;

R
Rich Salz 已提交
432 433
        if (mem_check_on()) {
            CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_DISABLE);
R
Rich Salz 已提交
434
            if ((m = OPENSSL_malloc(sizeof(*m))) == NULL) {
435
                OPENSSL_free(addr);
R
Rich Salz 已提交
436
                CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE);
437 438 439 440 441 442 443 444 445 446 447 448 449 450 451
                return;
            }
            if (mh == NULL) {
                if ((mh = lh_MEM_new()) == NULL) {
                    OPENSSL_free(addr);
                    OPENSSL_free(m);
                    addr = NULL;
                    goto err;
                }
            }

            m->addr = addr;
            m->file = file;
            m->line = line;
            m->num = num;
R
Rich Salz 已提交
452
            CRYPTO_THREADID_current(&m->threadid);
453 454 455 456 457 458

            if (order == break_order_num) {
                /* BREAK HERE */
                m->order = order;
            }
            m->order = order++;
R
Rich Salz 已提交
459
# if defined(CRYPTO_MDEBUG_BACKTRACE) && defined(__GNUC__)
460
            m->array_siz = backtrace(m->array, OSSL_NELEM(m->array));
R
Rich Salz 已提交
461 462
# endif
            m->time = time(NULL);
463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479

            CRYPTO_THREADID_current(&tmp.threadid);
            m->app_info = NULL;
            if (amih != NULL
                && (amim = lh_APP_INFO_retrieve(amih, &tmp)) != NULL) {
                m->app_info = amim;
                amim->references++;
            }

            if ((mm = lh_MEM_insert(mh, m)) != NULL) {
                /* Not good, but don't sweat it */
                if (mm->app_info != NULL) {
                    mm->app_info->references--;
                }
                OPENSSL_free(mm);
            }
 err:
R
Rich Salz 已提交
480
            CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE);
481 482 483 484 485
        }
        break;
    }
    return;
}
486

R
Rich Salz 已提交
487
void CRYPTO_mem_debug_free(void *addr, int before_p)
488 489 490 491 492 493 494 495
{
    MEM m, *mp;

    switch (before_p) {
    case 0:
        if (addr == NULL)
            break;

R
Rich Salz 已提交
496 497
        if (mem_check_on() && (mh != NULL)) {
            CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_DISABLE);
498 499 500 501

            m.addr = addr;
            mp = lh_MEM_delete(mh, &m);
            if (mp != NULL) {
R
Rich Salz 已提交
502
                app_info_free(mp->app_info);
503 504 505
                OPENSSL_free(mp);
            }

R
Rich Salz 已提交
506
            CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE);
507 508 509 510 511 512
        }
        break;
    case 1:
        break;
    }
}
513

R
Rich Salz 已提交
514 515
void CRYPTO_mem_debug_realloc(void *addr1, void *addr2, size_t num,
                              int before_p, const char *file, int line)
516 517
{
    MEM m, *mp;
518

519 520 521 522 523 524 525 526
    switch (before_p) {
    case 0:
        break;
    case 1:
        if (addr2 == NULL)
            break;

        if (addr1 == NULL) {
R
Rich Salz 已提交
527
            CRYPTO_mem_debug_malloc(addr2, num, 128 | before_p, file, line);
528 529 530
            break;
        }

R
Rich Salz 已提交
531 532
        if (mem_check_on()) {
            CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_DISABLE);
533 534 535 536 537 538

            m.addr = addr1;
            mp = lh_MEM_delete(mh, &m);
            if (mp != NULL) {
                mp->addr = addr2;
                mp->num = num;
539 540 541
#if defined(CRYPTO_MDEBUG_BACKTRACE) && defined(__GNUC__)
                mp->array_siz = backtrace(mp->array, OSSL_NELEM(mp->array));
#endif
542 543 544
                (void)lh_MEM_insert(mh, mp);
            }

R
Rich Salz 已提交
545
            CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE);
546 547 548 549 550 551 552 553 554
        }
        break;
    }
    return;
}

typedef struct mem_leak_st {
    BIO *bio;
    int chunks;
555
    int seen;
556 557
    long bytes;
} MEM_LEAK;
558

B
Ben Laurie 已提交
559
static void print_leak_doall_arg(const MEM *m, MEM_LEAK *l)
560 561 562 563 564 565 566
{
    char buf[1024];
    char *bufp = buf;
    APP_INFO *amip;
    int ami_cnt;
    struct tm *lcl = NULL;
    CRYPTO_THREADID ti;
567

568 569
#define BUF_REMAIN (sizeof buf - (size_t)(bufp - buf))

570 571 572
    /* Is one "leak" the BIO we were given? */
    if (m->addr == (char *)l->bio) {
        l->seen = 1;
573
        return;
574
    }
575

R
Rich Salz 已提交
576 577 578 579
    lcl = localtime(&m->time);
    BIO_snprintf(bufp, BUF_REMAIN, "[%02d:%02d:%02d] ",
                 lcl->tm_hour, lcl->tm_min, lcl->tm_sec);
    bufp += strlen(bufp);
580 581 582 583 584

    BIO_snprintf(bufp, BUF_REMAIN, "%5lu file=%s, line=%d, ",
                 m->order, m->file, m->line);
    bufp += strlen(bufp);

R
Rich Salz 已提交
585 586 587
    BIO_snprintf(bufp, BUF_REMAIN, "thread=%lu, ",
                 CRYPTO_THREADID_hash(&m->threadid));
    bufp += strlen(bufp);
588

589 590
    BIO_snprintf(bufp, BUF_REMAIN, "number=%d, address=%p\n",
                 m->num, m->addr);
591 592 593 594 595 596 597 598 599
    bufp += strlen(bufp);

    BIO_puts(l->bio, buf);

    l->chunks++;
    l->bytes += m->num;

    amip = m->app_info;
    ami_cnt = 0;
R
Rich Salz 已提交
600

601 602 603 604 605 606 607 608 609 610 611 612 613
    if (amip) {
        CRYPTO_THREADID_cpy(&ti, &amip->threadid);

        do {
            int buf_len;
            int info_len;

            ami_cnt++;
            memset(buf, '>', ami_cnt);
            BIO_snprintf(buf + ami_cnt, sizeof buf - ami_cnt,
                         " thread=%lu, file=%s, line=%d, info=\"",
                         CRYPTO_THREADID_hash(&amip->threadid), amip->file,
                         amip->line);
614
            buf_len = strlen(buf);
615 616 617 618 619
            info_len = strlen(amip->info);
            if (128 - buf_len - 3 < info_len) {
                memcpy(buf + buf_len, amip->info, 128 - buf_len - 3);
                buf_len = 128 - 3;
            } else {
R
Rich Salz 已提交
620
                OPENSSL_strlcpy(buf + buf_len, amip->info, sizeof buf - buf_len);
621 622 623
                buf_len = strlen(buf);
            }
            BIO_snprintf(buf + buf_len, sizeof buf - buf_len, "\"\n");
624

625
            BIO_puts(l->bio, buf);
626

627 628 629
            amip = amip->next;
        }
        while (amip && !CRYPTO_THREADID_cmp(&amip->threadid, &ti));
630
    }
631

632 633 634 635
#if defined(CRYPTO_MDEBUG_BACKTRACE) && defined(__GNUC__)
    {
        size_t i;
        char **strings = backtrace_symbols(m->array, m->array_siz);
R
Rich Salz 已提交
636

637 638 639 640 641
        for (i = 0; i < m->array_siz; i++)
            fprintf(stderr, "##> %s\n", strings[i]);
        free(strings);
    }
#endif
642
}
643

B
Ben Laurie 已提交
644
static IMPLEMENT_LHASH_DOALL_ARG_FN(print_leak, const MEM, MEM_LEAK)
645

646
int CRYPTO_mem_leaks(BIO *b)
647 648 649 650
{
    MEM_LEAK ml;

    if (mh == NULL && amih == NULL)
651
        return 1;
652

R
Rich Salz 已提交
653
    CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_DISABLE);
654 655 656 657

    ml.bio = b;
    ml.bytes = 0;
    ml.chunks = 0;
658
    ml.seen = 0;
659 660
    if (mh != NULL)
        lh_MEM_doall_arg(mh, LHASH_DOALL_ARG_FN(print_leak), MEM_LEAK, &ml);
661 662 663 664 665
    /* Don't count the BIO that was passed in as a "leak" */
    if (ml.seen && ml.chunks >= 1 && ml.bytes >= (int)sizeof (*b)) {
        ml.chunks--;
        ml.bytes -= (int)sizeof (*b);
    }
666 667 668 669 670 671 672
    if (ml.chunks != 0) {
        BIO_printf(b, "%ld bytes leaked in %d chunks\n", ml.bytes, ml.chunks);
    } else {
        /*
         * Make sure that, if we found no leaks, memory-leak debugging itself
         * does not introduce memory leaks (which might irritate external
         * debugging tools). (When someone enables leak checking, but does not
R
Rich Salz 已提交
673
         * call this function, we declare it to be their fault.)
674 675 676 677 678 679
         */
        int old_mh_mode;

        CRYPTO_w_lock(CRYPTO_LOCK_MALLOC);

        /*
R
Rich Salz 已提交
680 681
         * avoid deadlock when lh_free() uses CRYPTO_mem_debug_free(), which uses
         * mem_check_on
682 683 684 685
         */
        old_mh_mode = mh_mode;
        mh_mode = CRYPTO_MEM_CHECK_OFF;

R
Rich Salz 已提交
686 687
        lh_MEM_free(mh);
        mh = NULL;
688 689 690 691 692 693 694 695 696 697
        if (amih != NULL) {
            if (lh_APP_INFO_num_items(amih) == 0) {
                lh_APP_INFO_free(amih);
                amih = NULL;
            }
        }

        mh_mode = old_mh_mode;
        CRYPTO_w_unlock(CRYPTO_LOCK_MALLOC);
    }
R
Rich Salz 已提交
698
    CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE);
699
    return ml.chunks == 0 ? 1 : 0;
700
}
701

R
Rich Salz 已提交
702
# ifndef OPENSSL_NO_STDIO
703
int CRYPTO_mem_leaks_fp(FILE *fp)
704 705
{
    BIO *b;
706
    int ret;
707 708

    if (mh == NULL)
709
        return 0;
710 711 712 713 714
    /*
     * Need to turn off memory checking when allocated BIOs ... especially as
     * we're creating them at a time when we're trying to check we've not
     * left anything un-free()'d!!
     */
R
Rich Salz 已提交
715
    CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_DISABLE);
716
    b = BIO_new(BIO_s_file());
R
Rich Salz 已提交
717
    CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE);
718
    if (b == NULL)
719
        return -1;
720
    BIO_set_fp(b, fp, BIO_NOCLOSE);
721
    ret = CRYPTO_mem_leaks(b);
722
    BIO_free(b);
723
    return ret;
724
}
R
Rich Salz 已提交
725
# endif
726

R
Rich Salz 已提交
727
#endif