su_alloc.c 30.3 KB
Newer Older
Pekka Pessi's avatar
Pekka Pessi committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56
/*
 * This file is part of the Sofia-SIP package
 *
 * Copyright (C) 2005 Nokia Corporation.
 *
 * Contact: Pekka Pessi <pekka.pessi@nokia.com>
 *
 * * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA
 *
 */

/**@ingroup su_alloc
 * @CFILE su_alloc.c  Home-based memory management.
 *
 * @author Pekka Pessi <Pekka.Pessi@nokia.com>.
 * 
 * @date Created: Thu Aug 19 01:12:25 1999 ppessi
 * $Date: 2005/07/20 20:35:57 $
 */

#include "config.h"

char const su_alloc_c_id[] =
"$Id: su_alloc.c,v 1.1.1.1 2005/07/20 20:35:57 kaiv Exp $";

/**@defgroup su_alloc Memory Management Tutorial
 *
 * This page gives a short overview of home-based memory management used
 * with Sofia. Such home-based memory management is useful when a lot of
 * memory blocks are allocated for given task. The allocations are done via
 * the memory home, which keeps a reference to each block. When the memory
 * home is then freed, it will free all blocks to which it has reference.
 *
 * Typically, there is a @e home @e object which contains a su_home_t
 * structure in the beginning of it (sort of inheritance from su_home_t):
 * @code
 * struct context {
 *   su_home_t ctx_home[1];
 *   other_t  *ctx_stuff;
 *   ...
 * }
 * @endcode
 * 
Pekka Pessi's avatar
Pekka Pessi committed
57 58 59 60 61 62 63 64
 * A new home memory pool can be created with su_home_new():
 * @code
 * struct context *ctx = su_home_new(sizeof (struct context));
 * @endcode
 *
 * It is also possible to create a secondary memory pool that can be
 * released separately:
 *
Pekka Pessi's avatar
Pekka Pessi committed
65 66 67 68
 * @code
 * struct context *ctx = su_home_clone(tophome, sizeof (struct context));
 * @endcode
 *
Pekka Pessi's avatar
Pekka Pessi committed
69 70 71 72 73
 * Note that in this case, the tophome has a reference to @a ctx
 * structure; whenever tophome is freed, the @a ctx is also freed. 
 * 
 * You can also create an independent home object by passing NULL as @a
 * tophome argument.
Pekka Pessi's avatar
Pekka Pessi committed
74 75 76
 *
 * The memory allocations using @a ctx proceed  then as follows:
 * @code
Pekka Pessi's avatar
Pekka Pessi committed
77
 *    zeroblock = su_zalloc(ctx->ctx_home, sizeof (*zeroblock));
Pekka Pessi's avatar
Pekka Pessi committed
78 79 80
 * @endcode
 *
 * The home memory pool - the home object and all the memory blocks
Pekka Pessi's avatar
Pekka Pessi committed
81
 * allocated using it - are freed when su_home_unref() is called:
Pekka Pessi's avatar
Pekka Pessi committed
82 83
 *
 * @code
Pekka Pessi's avatar
Pekka Pessi committed
84
 *    su_home_unref(ctx->ctx_home).
Pekka Pessi's avatar
Pekka Pessi committed
85 86
 * @endcode
 *
Pekka Pessi's avatar
Pekka Pessi committed
87 88 89 90 91 92 93 94 95 96 97 98 99 100
 * @note For historical reasons, su_home_unref() is also known as
 * su_home_zap().
 *
 * As you might have guessed, it is also possible to use reference counting
 * with home objects. The function su_home_ref() increases the reference
 * count, su_home_unref() decreases. A newly allocated home object has
 * reference count of 1.
 *
 * @note Please note that it is not possible to create new references to
 * secondary home objects which have a parent home. Reference counting is
 * possible only with objects returned from su_home_new().
 *
 * The memory blocks in a cloned home object are freed when the object with
 * home itself is freed:
Pekka Pessi's avatar
Pekka Pessi committed
101 102 103 104 105
 * @code
 *    su_free(tophome, ctx);
 * @endcode
 * 
 * @note 
Pekka Pessi's avatar
Pekka Pessi committed
106 107 108
 * The su_home_create() and su_home_destroy() are deprecated. The
 * function su_home_create() creates a home object with infinite reference
 * count. Likewise, su_home_init() does the same.
Pekka Pessi's avatar
Pekka Pessi committed
109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140
 *
 * @section su_home_move_example Combining Allocations
 *
 * In some cases, an operation that makes multiple memory allocations may
 * fail, making those allocations redundant. If the allocations are made
 * through a temporary home, they can be conveniently freed by calling
 * su_home_deinit(), for instance. If, however, the operation is successful,
 * and one wants to keep the allocations, the allocations can be combined
 * into an existing home with su_home_move(). For example,
 * @code
 * int example(su_home_t *home, ...) 
 * {
 *   su_home_t temphome[1] = { SU_HOME_INIT(temphome) };
 *   
 *   ... do lot of allocations with temphome ...
 *  
 *   if (success) 
 *     su_home_move(home, temphome);
 *   su_home_deinit(temphome);
 *
 *   return success;
 * }
 * @endcode
 *
 * Note that the @a temphome is deinitialized in every case, but when
 * operation is successful, the allocations are moved from @a temphome to @a
 * home.
 *
 * @section su_alloc_threadsafe Threadsafe Operation
 *
 * If multiple threads need to access same home object, it must be marked as
 * @c threadsafe by calling su_home_threadsafe() with the home pointer as
Pekka Pessi's avatar
Pekka Pessi committed
141 142
 * argument. A cloned home cannot be marked as threadsafe. The
 * threadsafeness is not inherited by clones.
Pekka Pessi's avatar
Pekka Pessi committed
143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162
 */

#include <stdlib.h>
#include <stddef.h>
#include <memory.h>
#include <limits.h>

#include <assert.h>

#include <su_config.h>

#include "su_alloc.h"
char const su_alloc_h_id[] = SU_ALLOC_H;

#include "su_alloc_stat.h"
char const su_alloc_stat_h_id[] = SU_ALLOC_STAT_H;

void (*su_home_locker)(void *mutex);
void (*su_home_unlocker)(void *mutex);

Pekka Pessi's avatar
Pekka Pessi committed
163 164 165 166
void (*su_home_mutex_locker)(void *mutex);
void (*su_home_mutex_unlocker)(void *mutex);

#define MEMLOCK(h)   \
Pekka Pessi's avatar
Pekka Pessi committed
167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192
  (((h) && (h)->suh_lock ? su_home_locker((h)->suh_lock) : (void)0), (h)->suh_blocks)
#define UNLOCK(h) (((h) && (h)->suh_lock ? su_home_unlocker((h)->suh_lock) : (void)0), NULL)

#ifdef NDEBUG
#define MEMCHECK 0
#define MEMCHECK_EXTRA 0
#elif !defined(MEMCHECK)
/* Default settings for valgrinding */
#define MEMCHECK 1
#define MEMCHECK_EXTRA 0
#elif !defined(MEMCHECK_EXTRA)
#define MEMCHECK_EXTRA sizeof (unsigned)
#endif

enum { 
  SUB_N = 31,			/**< Initial size */
  SUB_P = 29			/**< Secondary probe.
				 * Secondary probe must be relative prime 
				 * with all sub_n values */
};		

#define ALIGNMENT (8)
#define ALIGN(n)  (((n) + (ALIGNMENT - 1)) & ~(ALIGNMENT - 1))
#define SIZEBITS (sizeof (unsigned) * 8 - 1)

typedef struct {
Pekka Pessi's avatar
Pekka Pessi committed
193 194 195
  unsigned long sua_size:SIZEBITS; /**< Size of the block */
  unsigned sua_home:1;		/**< Is this another home? */
  void    *sua_data;		/**< Data pointer */
Pekka Pessi's avatar
Pekka Pessi committed
196 197 198
} su_alloc_t;

struct su_block_s {
Pekka Pessi's avatar
Pekka Pessi committed
199 200
  su_home_t  *sub_parent;	/**< Parent home */
  unsigned    sub_ref;		/**< Reference count */
Pekka Pessi's avatar
Pekka Pessi committed
201 202 203 204
  unsigned    sub_used;		/**< Number of blocks allocated */
  unsigned    sub_n;		/**< Size of hash table  */
  unsigned short sub_prsize;
  unsigned short sub_prused;
Pekka Pessi's avatar
Pekka Pessi committed
205 206
  char       *sub_preload;
  su_home_stat_t *sub_stats;	/**< Statistics.. */
Pekka Pessi's avatar
Pekka Pessi committed
207 208 209 210 211 212 213 214
  su_alloc_t  sub_nodes[SUB_N];	/**< Pointers to data/lower blocks */
};

static void su_home_check_blocks(su_block_t const *b);

static void su_home_stats_alloc(su_block_t *sub, void *p, unsigned size);
static void su_home_stats_free(su_block_t *sub, void *p, unsigned size);

Pekka Pessi's avatar
Pekka Pessi committed
215 216
static void _su_home_deinit(su_home_t *home);

Pekka Pessi's avatar
Pekka Pessi committed
217 218 219 220 221 222 223 224 225 226 227 228 229 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 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299
#define SU_ALLOC_STATS 1

#if SU_ALLOC_STATS
unsigned count_su_block_find, count_su_block_find_loop;
unsigned size_su_block_find, used_su_block_find;
unsigned max_size_su_block_find, max_used_su_block_find;
unsigned su_block_find_collision, su_block_find_collision_used, 
  su_block_find_collision_size;
#endif

static inline su_alloc_t *su_block_find(su_block_t *b, void *p)
{
  int h, h0;

#if SU_ALLOC_STATS  
  unsigned collision = 0;

  count_su_block_find++;
  size_su_block_find += b->sub_n;
  used_su_block_find += b->sub_used;
  if (b->sub_n > max_size_su_block_find)
    max_size_su_block_find = b->sub_n;
  if (b->sub_used > max_used_su_block_find)
    max_used_su_block_find = b->sub_used;
#endif

  assert(p != NULL);

  h = h0 = ((unsigned long)p) % b->sub_n;

  do {
    if (b->sub_nodes[h].sua_data == p)
      return &b->sub_nodes[h];
    h += SUB_P;
    if (h >= b->sub_n)
      h -= b->sub_n;
#if SU_ALLOC_STATS
    if (++collision > su_block_find_collision)
      su_block_find_collision = collision, 
	su_block_find_collision_used = b->sub_used,
	su_block_find_collision_size = b->sub_n;
    count_su_block_find_loop++;
#endif
  } while (h != h0);

  return NULL;
}

static inline su_alloc_t *su_block_add(su_block_t *b, void *p)
{
  unsigned h;

  assert(p != NULL);

  h = ((unsigned long)p) % b->sub_n;

  while (b->sub_nodes[h].sua_data) {
    h += SUB_P;
    if (h >= b->sub_n)
      h -= b->sub_n;
  }

  b->sub_used++;
  b->sub_nodes[h].sua_data = p;

  return &b->sub_nodes[h];
}

static inline int su_is_preloaded(su_block_t const *sub, char *data)
{
  return
    sub->sub_preload && 
    sub->sub_preload <= data && 
    sub->sub_preload + sub->sub_prsize > data;
}

static inline int su_alloc_check(su_block_t const *sub, su_alloc_t const *sua)
{
#if MEMCHECK_EXTRA
  int size, term;
  assert(sua);
  if (sua) {
    size = sua->sua_size;
Pekka Pessi's avatar
Pekka Pessi committed
300
    memcpy(&term, (char *)sua->sua_data + size, sizeof (term));
Pekka Pessi's avatar
Pekka Pessi committed
301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321
    assert(-term == size);
    return -term == size;
  }
  else
    return 0;
#endif
  return sua != NULL;
}

/** Allocate the block hash table.
 *
 * The function su_hash_alloc() allocates a block hash table of @a n
 * elements.
 *
 * @param home  pointer to home object
 * @param n     number of buckets in hash table
 *
 * @return
 *   This function returns a pointer to the allocated hash table or
 *   NULL if an error occurred.
 */
Pekka Pessi's avatar
Pekka Pessi committed
322
static inline su_block_t *su_hash_alloc(int n)
Pekka Pessi's avatar
Pekka Pessi committed
323
{
Pekka Pessi's avatar
Pekka Pessi committed
324
  su_block_t *b = calloc(1, offsetof(su_block_t, sub_nodes[n]));
Pekka Pessi's avatar
Pekka Pessi committed
325 326 327 328 329 330 331 332 333 334 335

  if (b) {
    b->sub_n = n;
    b->sub_used = 0; 
  }

  return b;
}

/** Allocate a memory block.
 *
Pekka Pessi's avatar
Pekka Pessi committed
336
 * Precondition: locked home
Pekka Pessi's avatar
Pekka Pessi committed
337
 *
Pekka Pessi's avatar
Pekka Pessi committed
338 339 340 341 342
 * @param home home to allocate
 * @param sub  block structure used to allocate
 * @param size
 * @param zero if true, zero allocated block;
 *             if > 1, allocate a subhome
Pekka Pessi's avatar
Pekka Pessi committed
343 344
 *
 */
Pekka Pessi's avatar
Pekka Pessi committed
345 346 347 348 349
static 
void *sub_alloc(su_home_t *home, 
		su_block_t *sub,
		long size, 
		int zero)
Pekka Pessi's avatar
Pekka Pessi committed
350
{
Pekka Pessi's avatar
Pekka Pessi committed
351
  void *data;
Pekka Pessi's avatar
Pekka Pessi committed
352
  int preload = 0;
Pekka Pessi's avatar
Pekka Pessi committed
353 354
  
  assert (size >= 0);
Pekka Pessi's avatar
Pekka Pessi committed
355 356 357 358 359 360 361 362 363 364 365 366 367

  if (sub == NULL || 3 * sub->sub_used > 2 * sub->sub_n) {
    int i, n, n2, used;
    su_block_t *b2;

    if (sub)
      n = home->suh_blocks->sub_n, n2 = 4 * n + 3, used = sub->sub_used;
    else
      n = 0, n2 = SUB_N, used = 0;

    // assert(n2 % SUB_P != 0);
    // printf("su_alloc(home = %p): realloc block hash of size %d\n", home, n2);

Pekka Pessi's avatar
Pekka Pessi committed
368 369
    if (!(b2 = su_hash_alloc(n2)))
      return NULL;
Pekka Pessi's avatar
Pekka Pessi committed
370 371 372 373 374 375 376 377

    for (i = 0; i < n; i++) {
      if (sub->sub_nodes[i].sua_data) 
	su_block_add(b2, sub->sub_nodes[i].sua_data)[0] = sub->sub_nodes[i];
    }

    if (sub) {
      b2->sub_parent = sub->sub_parent;
Pekka Pessi's avatar
Pekka Pessi committed
378
      b2->sub_ref = sub->sub_ref;
Pekka Pessi's avatar
Pekka Pessi committed
379 380 381 382 383 384
      b2->sub_preload = sub->sub_preload;
      b2->sub_prsize = sub->sub_prsize;
      b2->sub_prused = sub->sub_prused;
      b2->sub_stats = sub->sub_stats;
    }

Pekka Pessi's avatar
Pekka Pessi committed
385 386
    home->suh_blocks = b2;

Pekka Pessi's avatar
Pekka Pessi committed
387 388 389 390
    free(sub), sub = b2;
  }

  /* Use preloaded memory */
Pekka Pessi's avatar
Pekka Pessi committed
391
  if (size && sub && sub->sub_preload && zero <= 1) {
Pekka Pessi's avatar
Pekka Pessi committed
392 393 394 395 396
    preload = sub->sub_prused + size + MEMCHECK_EXTRA; 
    preload = ALIGN(preload);
    if (preload <= sub->sub_prsize) {
      data = (char *)sub->sub_preload + sub->sub_prused;
      sub->sub_prused = preload;
Pekka Pessi's avatar
Pekka Pessi committed
397 398
      if (zero)
	memset(data, 0, size);
Pekka Pessi's avatar
Pekka Pessi committed
399 400 401 402 403
    }
    else {
      preload = 0;
    }
  }
Pekka Pessi's avatar
Pekka Pessi committed
404 405 406 407 408

  if (preload)
    ;
  else if (zero)
    data = calloc(1, size + MEMCHECK_EXTRA);
Pekka Pessi's avatar
Pekka Pessi committed
409 410 411 412
  else
    data = malloc(size + MEMCHECK_EXTRA);

  if (data) {
Pekka Pessi's avatar
Pekka Pessi committed
413 414
    su_alloc_t *sua;

Pekka Pessi's avatar
Pekka Pessi committed
415 416 417 418 419
#if MEMCHECK_EXTRA
    int term = -size;
    memcpy((char *)data + size, &term, sizeof (term));
#endif

Pekka Pessi's avatar
Pekka Pessi committed
420 421 422 423 424 425 426 427 428 429 430 431 432 433 434
    if (zero > 1) {
      su_home_t *subhome = data;

      assert(preload == 0);

      subhome->suh_blocks = su_hash_alloc(SUB_N);
      if (!subhome->suh_blocks) 
	return (void)free(data), NULL;
	
      subhome->suh_blocks->sub_parent = home;
    }

    sua = su_block_add(sub, data); assert(sua);
    sua->sua_size = size;
    sua->sua_home = zero > 1;
Pekka Pessi's avatar
Pekka Pessi committed
435 436 437 438 439

    if (sub->sub_stats)
      su_home_stats_alloc(sub, data, size);
  }

Pekka Pessi's avatar
Pekka Pessi committed
440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609
  return data;
}

/**Create a new su_home_t object.
 *
 * Create a home object used to collect multiple memory allocations under
 * one handle. The memory allocations made using this home object is freed
 * either when this home is destroyed. An independent home object is created
 * if NULL is passed as @a parent argument.
 *
 * @param parent  a parent object (may be NULL)
 * @param size    size of home object
 *
 * The memory home object allocated with su_home_new() can be freed with
 * su_home_unref().
 *
 * @return
 * This function returns a pointer to an su_home_t object, or NULL upon
 * an error.
 */
void *su_home_new(int size)
{
  su_home_t *home;

  assert(size >= sizeof (*home));

  if (size < sizeof (*home))
    return NULL;

  home = calloc(1, size);
  if (home) {
    home->suh_blocks = su_hash_alloc(SUB_N);
    if (home->suh_blocks)
      home->suh_blocks->sub_ref = 1;
    else
      free(home), home = NULL;
  }

  return home;
}

/** Create a new reference to a home object. */
void *su_home_ref(su_home_t *home)
{
  if (home) {
    su_block_t *sub = MEMLOCK(home);

    if (sub == NULL || sub->sub_ref == 0) {
      assert(sub && sub->sub_ref != 0);
      UNLOCK(home);
      return NULL;
    }
    
    if (sub->sub_ref != UINT_MAX)
      sub->sub_ref++;
    UNLOCK(home);
  }

  return home;
}

/**Unreference a su_home_t object.
 *
 * The function su_home_unref() decrements the reference count on a home
 * object and destroys and frees it and the memory allocations using it.
 *
 * @param home memory pool object to be destroyed
 */
void su_home_unref(su_home_t *home)
{
  su_block_t *sub;

  if (home == NULL)
    return;

  sub = MEMLOCK(home);

  if (sub == NULL) {
    /* Xyzzy */
  }
  else if (sub->sub_parent) {
    assert(sub->sub_ref == 0);
    assert(home->suh_lock == NULL);
    su_free(sub->sub_parent, home);
  }
  else if (sub->sub_ref == UINT_MAX) {
    UNLOCK(home);
  }
  else if (--sub->sub_ref > 0) {
    UNLOCK(home);
  }
  else {
    _su_home_deinit(home);
    free(home);
    /* UNLOCK(home); */
  }
}


/**Clone a su_home_t object.
 *
 * Clone a secondary home object used to collect multiple memoryf
 * allocations under one handle. The memory is freed either when the cloned
 * home is destroyed or when the parent home is destroyed. A cloned home
 * cannot be reference counted, or made threadsafe.
 *
 * An independent
 * home object is created if NULL is passed as @a parent argument.
 *
 * @param parent  a parent object (may be NULL)
 * @param size    size of home object
 *
 * The memory home object allocated with su_home_new() can be freed with
 * su_home_unref().
 *
 * @return
 * This function returns a pointer to an su_home_t object, or NULL upon
 * an error.
 */
void *su_home_clone(su_home_t *parent, int size)
{
  su_home_t *home;

  assert(size >= sizeof (*home));

  if (size < sizeof (*home))
    return NULL;

  if (parent) {
    su_block_t *sub = MEMLOCK(parent);
    home = sub_alloc(parent, sub, size, 2);
    UNLOCK(parent);
  }
  else {
    home = su_home_new(size);
  }

  return home;
}

/** Return true if home is a clone. */
int su_home_has_parent(su_home_t const *home)
{
  return home && !home->suh_lock && 
    home->suh_blocks && home->suh_blocks->sub_parent;
}

/** Allocate a memory block.
 *
 * The function su_alloc() allocates a memory block of a given @a size.
 *
 * If @a home is NULL, this function behaves exactly like malloc().
 *
 * @param home  pointer to home object
 * @param size  size of the memory block to be allocated
 *
 * @return
 * This function returns a pointer to the allocated memory block or
 * NULL if an error occurred.
 */
void *su_alloc(su_home_t *home, int size)
{
  void *data;

  if (home) {
    data = sub_alloc(home, MEMLOCK(home), size, 1);
    UNLOCK(home);
  }
  else
    data = malloc(size);
Pekka Pessi's avatar
Pekka Pessi committed
610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626

  return data;
}

/**Free a memory block.
 *
 * The function su_free() frees a single memory block. The @a home must be
 * the owner of the memory block (usually the memory home used to allocate
 * the memory block, or NULL if no home was used).
 *
 * @param home  pointer to home object
 * @param data  pointer to the memory block to be freed
 */
void su_free(su_home_t *home, void *data)
{
  if (home && data) {
    su_alloc_t *allocation;
Pekka Pessi's avatar
Pekka Pessi committed
627
    su_block_t *sub = MEMLOCK(home);
Pekka Pessi's avatar
Pekka Pessi committed
628 629 630 631 632 633 634 635 636 637

    assert(sub);
    allocation = su_block_find(sub, data);
    assert(allocation);

    if (su_alloc_check(sub, allocation)) {

      if (sub->sub_stats)
	su_home_stats_free(sub, data, allocation->sua_size);

Pekka Pessi's avatar
Pekka Pessi committed
638
      if (allocation->sua_home)
Pekka Pessi's avatar
Pekka Pessi committed
639 640 641 642 643 644 645
	su_home_deinit(data);

#if MEMCHECK != 0
      memset(data, 0xaa, allocation->sua_size);
#endif

      /* Is this preloaded data? */
Pekka Pessi's avatar
Pekka Pessi committed
646
      if (su_is_preloaded(sub, data))
Pekka Pessi's avatar
Pekka Pessi committed
647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669
	data = NULL;

      memset(allocation, 0, sizeof (*allocation));
      sub->sub_used--;
    }

    UNLOCK(home);
  }

  free(data);
}

/** Check home consistency.
 *
 * The function su_home_check() ensures that the home structure and all
 * memory blocks allocated through it are consistent.  It can be used to
 * catch memory allocation and usage errors.
 *
 * @param home Pointer to a memory home.
 */
void su_home_check(su_home_t const *home)
{
#if MEMCHECK != 0
Pekka Pessi's avatar
Pekka Pessi committed
670
  su_block_t const *b = MEMLOCK(home);
Pekka Pessi's avatar
Pekka Pessi committed
671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689

  su_home_check_blocks(b);

  UNLOCK(home);
#endif
}

/** Check home blocks. */
static
void su_home_check_blocks(su_block_t const *b)
{
#if MEMCHECK != 0
  if (b) {
    unsigned i, used;
    assert(b->sub_used <= b->sub_n);

    for (i = 0, used = 0; i < b->sub_n; i++)
      if (b->sub_nodes[i].sua_data) {
	su_alloc_check(b, &b->sub_nodes[i]), used++;
Pekka Pessi's avatar
Pekka Pessi committed
690
	if (b->sub_nodes[i].sua_home)
Pekka Pessi's avatar
Pekka Pessi committed
691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730
	  su_home_check((su_home_t *)b->sub_nodes[i].sua_data);
      }

    assert(used == b->sub_used);
  }
#endif
}

/**
 * Create an su_home_t object.
 *
 * The function su_home_create() creates a home object.  A home object is
 * used to collect multiple memory allocations, so that they all can be
 * freed by calling su_home_destroy().
 *
 * @return This function returns a pointer to an @c su_home_t object, or @c
 * NULL upon an error. 
 *
 * @deprecated
 * Use su_home_clone() instead of su_home_create().
 */
su_home_t *su_home_create(void)
{
  su_home_t *home = su_salloc(NULL, sizeof (*home));

  if (home) {
    su_home_init(home);
  }

  return home;
}

/** Deinitialize a home object
 *
 *   The function su_home_destroy() frees a home object, and all memory
 *   blocks associated with it.
 *
 *   @param home pointer to a home object
 *
 * @deprecated
Pekka Pessi's avatar
Pekka Pessi committed
731
 * Use su_home_deinit() instead of su_home_destroy().
Pekka Pessi's avatar
Pekka Pessi committed
732 733 734 735 736 737 738 739 740
 */
void su_home_destroy(su_home_t *home)
{
  su_home_deinit(home);
  /* free(home); - what if this is cloned one? */
}

/** Initialize an su_home_t object.
 *
Pekka Pessi's avatar
Pekka Pessi committed
741
 * The function su_home_init() initializes an object derived from su_home_t.
Pekka Pessi's avatar
Pekka Pessi committed
742 743 744 745 746 747 748 749 750 751 752 753
 *
 * @param home pointer to home object
 *
 * @return
 *    The function su_home_init() returns 0 when successful,
 *    or -1 upon an error.
 */
int su_home_init(su_home_t *home)
{
  if (home == NULL)
    return -1;

Pekka Pessi's avatar
Pekka Pessi committed
754
  home->suh_blocks = su_hash_alloc(SUB_N);
Pekka Pessi's avatar
Pekka Pessi committed
755

Pekka Pessi's avatar
Pekka Pessi committed
756
  return 0;
Pekka Pessi's avatar
Pekka Pessi committed
757 758 759 760 761 762
}

/** Internal deinitialization */
static
void _su_home_deinit(su_home_t *home)
{
Pekka Pessi's avatar
Pekka Pessi committed
763
  if (home->suh_blocks) {
Pekka Pessi's avatar
Pekka Pessi committed
764 765 766 767 768 769 770 771 772
    unsigned i;
    su_block_t *b;

    b = home->suh_blocks;

    su_home_check_blocks(b);

    for (i = 0; i < b->sub_n; i++) {
      if (b->sub_nodes[i].sua_data) {
Pekka Pessi's avatar
Pekka Pessi committed
773 774 775 776 777 778 779
	if (b->sub_nodes[i].sua_home) {
	  su_home_t *subhome = b->sub_nodes[i].sua_data;
	  su_home_deinit((su_home_t *)subhome);
	}
	else if (su_is_preloaded(b, b->sub_nodes[i].sua_data))
	  continue;
	free(b->sub_nodes[i].sua_data);
Pekka Pessi's avatar
Pekka Pessi committed
780 781 782 783 784 785 786 787 788 789 790 791
      }
    }

    if (b->sub_preload)
      free(b->sub_preload);
    if (b->sub_stats)
      free(b->sub_stats);
    free(b);

    home->suh_blocks = NULL;
  }

Pekka Pessi's avatar
Pekka Pessi committed
792
  home->suh_lock = NULL;
Pekka Pessi's avatar
Pekka Pessi committed
793 794 795 796 797 798 799 800 801 802 803
}

/** Free memory blocks allocated through home.
 *
 * The function @c su_home_deinit() frees the memory blocks associated with
 * the home object.
 *
 * @param home pointer to home object
 */
void su_home_deinit(su_home_t *home)
{
Pekka Pessi's avatar
Pekka Pessi committed
804 805
  if (MEMLOCK(home)) {
    assert(home->suh_blocks && home->suh_blocks->sub_ref == 0);
Pekka Pessi's avatar
Pekka Pessi committed
806
    _su_home_deinit(home);
Pekka Pessi's avatar
Pekka Pessi committed
807 808
    /* UNLOCK(home); */
  }
Pekka Pessi's avatar
Pekka Pessi committed
809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833
}

/**Move allocations from a su_home_t object to another.
 *
 * The function su_home_move() moves allocations made through the @a src
 * home object under the @a dst home object. It is handy, for example, if an
 * operation allocates some number of blocks that should be freed upon an
 * error. It uses a temporary home and moves the blocks from temporary to a
 * proper home when successful, but frees the temporary home upon an error.
 *
 * @param dst destination home
 * @param src source home
 *
 * @retval 0 if succesful
 * @retval -1 upon an error
 */
int su_home_move(su_home_t *dst, su_home_t *src)
{
  unsigned i, n, n2, used;
  su_block_t *s, *d, *d2;

  if (src == NULL || dst == src)
    return 0;

  if (dst) {
Pekka Pessi's avatar
Pekka Pessi committed
834
    s = MEMLOCK(src); d = MEMLOCK(dst);
Pekka Pessi's avatar
Pekka Pessi committed
835 836 837 838 839 840 841 842 843 844 845 846 847

    if (s && s->sub_n) {
      if (d) 
	used = s->sub_used + d->sub_used;
      else
	used = s->sub_used;

      if ((used && d == NULL) || 3 * used > 2 * d->sub_n) {
	if (d)
	  for (n = n2 = d->sub_n; 3 * used > 2 * n2; n2 = 4 * n2 + 3)
	    ;
	else
	  n = 0, n2 = s->sub_n;
Pekka Pessi's avatar
Pekka Pessi committed
848 849

	if (!(d2 = su_hash_alloc(n2))) {
Pekka Pessi's avatar
Pekka Pessi committed
850 851 852 853 854 855 856 857 858 859 860 861
	  UNLOCK(dst); UNLOCK(src);
	  return -1;
	}

	dst->suh_blocks = d2;

      	for (i = 0; i < n; i++)
	  if (d->sub_nodes[i].sua_data) 
	    su_block_add(d2, d->sub_nodes[i].sua_data)[0] = d->sub_nodes[i];

	if (d) {
	  d2->sub_parent = d->sub_parent;
Pekka Pessi's avatar
Pekka Pessi committed
862
	  d2->sub_ref = d->sub_ref;
Pekka Pessi's avatar
Pekka Pessi committed
863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889
	  d2->sub_preload = d->sub_preload;
	  d2->sub_prsize = d->sub_prsize;
	  d2->sub_prused = d->sub_prused;
	  d2->sub_stats = d->sub_stats;
	}

	free(d), d = d2;
      }

      if ((n = s->sub_n)) {
	for (i = 0; i < n; i++)
	  if (s->sub_nodes[i].sua_data) {
	    su_block_add(d, s->sub_nodes[i].sua_data)[0] = s->sub_nodes[i];
	  }

	s->sub_used = 0;

	memset(s->sub_nodes, 0, n * sizeof (s->sub_nodes[0]));
      }

      if (s->sub_stats) {
      }
    }

    UNLOCK(dst); UNLOCK(src);
  }
  else {
Pekka Pessi's avatar
Pekka Pessi committed
890
    s = MEMLOCK(src); 
Pekka Pessi's avatar
Pekka Pessi committed
891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916

    if (s && s->sub_used) {
      s->sub_used = 0;
      memset(s->sub_nodes, 0, s->sub_n * sizeof (s->sub_nodes[0]));
    }

    UNLOCK(src);
  }

  return 0;
}

/** Preload a memory home.
 *
 * The function su_home_preload() preloads a memory home 
 */
void su_home_preload(su_home_t *home, int n, int isize)
{
  su_block_t *sub;

  if (home == NULL)
    return;

  if (home->suh_blocks == NULL) 
    su_home_init(home);

Pekka Pessi's avatar
Pekka Pessi committed
917
  sub = MEMLOCK(home);
Pekka Pessi's avatar
Pekka Pessi committed
918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969
  if (!sub->sub_preload) {
    int size;
    void *preload;

    size = n * ALIGN(isize);
    if (size > USHRT_MAX)
      size = USHRT_MAX & (ALIGNMENT - 1);

    preload = malloc(size);

    home->suh_blocks->sub_preload = preload;
    home->suh_blocks->sub_prsize = size;
  }
  UNLOCK(home);
}

/** Reallocate a memory block.
 *
 *   The function su_realloc() allocates a memory block of @a size bytes.
 *   It copies the old block contents to the new block and frees the old
 *   block.
 *
 *   If @a home is NULL, this function behaves exactly like realloc().
 *
 *   @param home  pointer to memory pool object
 *   @param data  pointer to old memory block
 *   @param size  size of the memory block to be allocated
 *   
 * @return
 *   This function returns a pointer to the allocated memory block or
 *   NULL if an error occurred.
 */
void *su_realloc(su_home_t *home, void *data, int size)
{
  void *ndata;
  su_alloc_t *sua;
  su_block_t *sub;
  int p;
  int term = -size;

  if (!home) 
    return realloc(data, size);

  if (size == 0) {
    if (data)
      su_free(home, data);
    return NULL;
  }

  if (!data)
    return su_alloc(home, size);

Pekka Pessi's avatar
Pekka Pessi committed
970
  sub = MEMLOCK(home);
Pekka Pessi's avatar
Pekka Pessi committed
971 972 973 974 975
  sua = su_block_find(sub, data);

  if (!su_alloc_check(sub, sua))
    return UNLOCK(home);
  
Pekka Pessi's avatar
Pekka Pessi committed
976
  assert(!sua->sua_home);
Pekka Pessi's avatar
Pekka Pessi committed
977
  
Pekka Pessi's avatar
Pekka Pessi committed
978
  if (sua->sua_home)
Pekka Pessi's avatar
Pekka Pessi committed
979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076
    return UNLOCK(home);
  
  if (!su_is_preloaded(sub, data)) {
    ndata = realloc(data, size + MEMCHECK_EXTRA);
    if (ndata) {
      if (sub->sub_stats) {
	su_home_stats_free(sub, data, sua->sua_size);
	su_home_stats_alloc(sub, data, size);
      }

#if MEMCHECK_EXTRA
      memcpy((char *)ndata + size, &term, sizeof (term));
#else
      (void)term;
#endif
      memset(sua, 0, sizeof *sua);
      sub->sub_used--;
      su_block_add(sub, ndata)->sua_size = size;
    }
    UNLOCK(home);

    return ndata;
  }

  p = (char *)data - home->suh_blocks->sub_preload;
  p += sua->sua_size + MEMCHECK_EXTRA;
  p = ALIGN(p);

  if (p == sub->sub_prused) {
    int p2 = (char *)data - sub->sub_preload + size + MEMCHECK_EXTRA;
    p2 = ALIGN(p2);
    if (p2 <= sub->sub_prsize) {
      /* Extend/reduce existing preload */
      sub->sub_prused = p2;
      sua->sua_size = size;
#if MEMCHECK_EXTRA
      memcpy((char *)data + size, &term, sizeof (term));
#endif
      UNLOCK(home);
      return data;
    }
  }
  else if (size < sua->sua_size) {
    /* Reduce existing preload */
#if MEMCHECK_EXTRA
    memcpy((char *)data + size, &term, sizeof (term));
#endif
    sua->sua_size = size;
    UNLOCK(home);
    return data;
  }

  ndata = malloc(size + MEMCHECK_EXTRA);

  if (ndata) {
    if (p == sub->sub_prused)
      /* Free preload */
      sub->sub_prused = (char *)data - home->suh_blocks->sub_preload;
    
    memcpy(ndata, data, sua->sua_size < size ? sua->sua_size : size);
#if MEMCHECK_EXTRA
    memcpy((char *)ndata + size, &term, sizeof (term));
#endif

    if (sub->sub_stats) {
      su_home_stats_free(sub, data, sua->sua_size);
      su_home_stats_alloc(sub, data, size);
    }

    memset(sua, 0, sizeof *sua); sub->sub_used--;

    su_block_add(sub, ndata)->sua_size = size;
  }

  UNLOCK(home);

  return ndata;
}


/**Allocate and zero a memory block.
 *
 * The function su_zalloc() allocates a memory block with a given size from
 * given memory home @a home and zeroes the allocated block.
 *
 *  @param home  pointer to memory pool object
 *  @param size  size of the memory block
 *
 * @note The memory home pointer @a home may be @c NULL. In that case, the
 * allocated memory block is not associated with any memory home, and it
 * must be freed by calling su_free() or free().
 *
 * @return
 * The function su_zalloc() returns a pointer to the allocated memory block,
 * or NULL upon an error.
 */
void *su_zalloc(su_home_t *home, int  size)
{
Pekka Pessi's avatar
Pekka Pessi committed
1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088
  void *data;

  assert (size >= 0);

  if (home) {
    data = sub_alloc(home, MEMLOCK(home), size, 1);
    UNLOCK(home);
  }
  else
    data = calloc(1, size);

  return data;
Pekka Pessi's avatar
Pekka Pessi committed
1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123
}

/** Allocate a structure
 *
 * The function su_salloc() allocates a structure with a given size, zeros
 * it, and initializes the size field to the given size.  The size field
 * is the first in the structure.
 *
 * @param home  pointer to memory pool object
 * @param size  size of the structure
 *
 * @par Example
 * The structure is defined and allocated as follows:
 * @code
 *   struct test {
 *     int   tst_size;
 *     char *tst_name;
 *     void *tst_ptr[3];
 *   };
 * 
 *   struct test *t;
 *   ...
 *   t = su_salloc(home, sizeof (*t)); 
 *   assert(t && t->t_size == sizeof (*t));
 *   t->name
 * @endcode
 * After calling su_salloc() we get a pointer t to a struct test,
 * initialized to zero except the 
 *
 *
 * @return This function returns a pointer to the allocated structure, or
 * NULL upon an error.
 */
void *su_salloc(su_home_t *home, int size)
{
Pekka Pessi's avatar
Pekka Pessi committed
1124 1125
  void *data;

Pekka Pessi's avatar
Pekka Pessi committed
1126 1127 1128 1129 1130
  struct { int size; } *retval;

  if (size < sizeof (*retval))
    size = sizeof (*retval);

Pekka Pessi's avatar
Pekka Pessi committed
1131
  assert (size >= 0);
Pekka Pessi's avatar
Pekka Pessi committed
1132

Pekka Pessi's avatar
Pekka Pessi committed
1133 1134 1135
  if (home) {
    retval = sub_alloc(home, MEMLOCK(home), size, 1);
    UNLOCK(home);
Pekka Pessi's avatar
Pekka Pessi committed
1136
  }
Pekka Pessi's avatar
Pekka Pessi committed
1137 1138 1139 1140 1141
  else
    retval = calloc(1, size);

  if (retval)
    retval->size = size;
Pekka Pessi's avatar
Pekka Pessi committed
1142 1143 1144 1145 1146 1147 1148

  return retval;
}

/** Obtain exclusive lock on home (if home is threadsafe). */
int su_home_mutex_lock(su_home_t *home)
{
Pekka Pessi's avatar
Pekka Pessi committed
1149
  if (home == NULL)
Pekka Pessi's avatar
Pekka Pessi committed
1150 1151
    return -1;

Pekka Pessi's avatar
Pekka Pessi committed
1152 1153 1154 1155 1156 1157 1158 1159
  if (home->suh_lock) {
    su_home_ref(home);
    su_home_mutex_locker(home->suh_lock);
  }
  else if (home->suh_blocks) {
    if (!su_home_ref(home))
      return -1;
  }
Pekka Pessi's avatar
Pekka Pessi committed
1160 1161 1162 1163 1164 1165 1166

  return 0;
}

/** Release exclusive lock on home (if home is threadsafe) */
int su_home_mutex_unlock(su_home_t *home)
{
Pekka Pessi's avatar
Pekka Pessi committed
1167
  if (home == NULL)
Pekka Pessi's avatar
Pekka Pessi committed
1168 1169
    return -1;

Pekka Pessi's avatar
Pekka Pessi committed
1170 1171 1172 1173 1174 1175 1176
  if (home->suh_lock) {
    su_home_mutex_unlocker(home->suh_lock);
    su_home_unref(home);
  }
  else if (home->suh_blocks) {
    su_home_unref(home);
  }
Pekka Pessi's avatar
Pekka Pessi committed
1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187

  return 0;
}

/** Initialize statistics structure */
void su_home_init_stats(su_home_t *home)
{
  su_block_t *sub = home->suh_blocks;
  int size;

  if (!sub)
Pekka Pessi's avatar
Pekka Pessi committed
1188
    sub = home->suh_blocks = su_hash_alloc(SUB_N);
Pekka Pessi's avatar
Pekka Pessi committed
1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282
  if (!sub)
    return;

  if (!sub->sub_stats) {
    size = sizeof (*sub->sub_stats);
    sub->sub_stats = malloc(size);
    if (!sub->sub_stats)
      return;
  }
  else
    size = sub->sub_stats->hs_size;
  
  memset(sub->sub_stats, 0, size);
  sub->sub_stats->hs_size = size;
  sub->sub_stats->hs_blocksize = sub->sub_n;
}

/** Retrieve statistics from memory home.
 */
void su_home_get_stats(su_home_t *home, int include_clones, su_home_stat_t hs[1])
{
  int size = hs->hs_size;

  memset(hs, 0, size);

  hs->hs_size = size;

  if (home->suh_blocks && home->suh_blocks->sub_stats) {
    int sub_size = home->suh_blocks->sub_stats->hs_size;
    if (sub_size > size)
      sub_size = size;
    memcpy(hs, home->suh_blocks->sub_stats, sub_size);
    hs->hs_size = size;
  }
}

static 
void su_home_stats_alloc(su_block_t *sub, void *p, unsigned size)
{
  su_home_stat_t *hs = sub->sub_stats;

  unsigned rsize = ALIGN(size);

  hs->hs_rehash += (sub->sub_n != hs->hs_blocksize);
  hs->hs_blocksize = sub->sub_n;

  hs->hs_allocs.hsa_number++;
  hs->hs_allocs.hsa_bytes += size;
  hs->hs_allocs.hsa_rbytes += rsize;
  if (hs->hs_allocs.hsa_rbytes > hs->hs_allocs.hsa_maxrbytes)
    hs->hs_allocs.hsa_maxrbytes = hs->hs_allocs.hsa_rbytes;

  hs->hs_blocks.hsb_number++;
  hs->hs_blocks.hsb_bytes += size;
  hs->hs_blocks.hsb_rbytes += rsize;
}

static 
void su_home_stats_free(su_block_t *sub, void *p, unsigned size)
{
  su_home_stat_t *hs = sub->sub_stats;

  unsigned rsize = ALIGN(size);

  hs->hs_frees.hsf_number++;
  hs->hs_frees.hsf_bytes += size;
  hs->hs_frees.hsf_rbytes += rsize;

  hs->hs_blocks.hsb_number--;
  hs->hs_blocks.hsb_bytes -= size;
  hs->hs_blocks.hsb_rbytes -= rsize;
}

void su_home_stat_add(su_home_stat_t total[1], su_home_stat_t const hs[1])
{
  total->hs_clones               += hs->hs_clones;
  total->hs_rehash               += hs->hs_rehash;

  if (total->hs_blocksize < hs->hs_blocksize)
    total->hs_blocksize = hs->hs_blocksize;

  total->hs_allocs.hsa_number    += hs->hs_allocs.hsa_number;
  total->hs_allocs.hsa_bytes     += hs->hs_allocs.hsa_bytes;
  total->hs_allocs.hsa_rbytes    += hs->hs_allocs.hsa_rbytes;
  total->hs_allocs.hsa_maxrbytes += hs->hs_allocs.hsa_maxrbytes;

  total->hs_frees.hsf_number     += hs->hs_frees.hsf_number;
  total->hs_frees.hsf_bytes      += hs->hs_frees.hsf_bytes;
  total->hs_frees.hsf_rbytes     += hs->hs_frees.hsf_rbytes;

  total->hs_blocks.hsb_number    += hs->hs_blocks.hsb_number;
  total->hs_blocks.hsb_bytes     += hs->hs_blocks.hsb_bytes;
  total->hs_blocks.hsb_rbytes    += hs->hs_blocks.hsb_rbytes;
}