su 1.12.11devel
Loading...
Searching...
No Matches
su_alloc.h
Go to the documentation of this file.
1/*
2 * This file is part of the Sofia-SIP package
3 *
4 * Copyright (C) 2006 Nokia Corporation.
5 *
6 * Contact: Pekka Pessi <pekka.pessi@nokia-email.address.hidden>
7 *
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public License
10 * as published by the Free Software Foundation; either version 2.1 of
11 * the License, or (at your option) any later version.
12 *
13 * This library is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
17 *
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with this library; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
21 * 02110-1301 USA
22 *
23 */
24
25#ifndef SU_ALLOC_H
26#define SU_ALLOC_H
27
37#ifndef SU_TYPES_H
38#include <sofia-sip/su_types.h>
39#endif
40
41#include <stdarg.h>
42
43SOFIA_BEGIN_DECLS
44
45#ifndef SU_HOME_T
46#define SU_HOME_T struct su_home_s
47#endif
48
50typedef SU_HOME_T su_home_t;
51typedef struct su_block_s su_block_t;
52
54typedef struct su_alock su_alock_t;
55
57struct su_home_s {
58 int suh_size;
59 su_block_t *suh_blocks;
60 su_alock_t *suh_lock;
61};
62
63#define SU_HOME_INIT(obj) { 0, NULL, NULL }
64
65SU_DLL void *su_home_new(isize_t size)
66 __attribute__((__malloc__));
67SU_DLL void *su_home_ref(su_home_t const *);
68SU_DLL int su_home_unref(su_home_t *);
69
70SU_DLL size_t su_home_refcount(su_home_t *home);
71
72SU_DLL int su_home_destructor(su_home_t *, void (*)(void *));
73
74SU_DLL int su_home_desctructor(su_home_t *, void (*)(void *));
75#ifndef su_home_desctructor
76/* This has typo in before 1.12.4 */
77#define su_home_desctructor(home, destructor) \
78 su_home_destructor((home), (destructor))
79#endif
80
81SU_DLL void *su_home_clone(su_home_t *parent, isize_t size)
82 __attribute__((__malloc__));
83
84SU_DLL int su_home_init(su_home_t *h);
85
86SU_DLL void su_home_deinit(su_home_t *h);
87
88SU_DLL void su_home_preload(su_home_t *h, isize_t n, isize_t size);
89
90SU_DLL su_home_t *su_home_auto(void *area, isize_t size);
91
92#define SU_HOME_AUTO_SIZE(n) \
93 (((n) + ((sizeof(su_home_t) + 7) & (size_t)~8) + \
94 ((3 * sizeof (void *) + 4 * sizeof(unsigned) + \
95 7 * (sizeof (long) + sizeof(void *)) + 7) & (size_t)~8)) \
96 / sizeof(su_home_t))
97
98SU_DLL int su_home_move(su_home_t *dst, su_home_t *src);
99
100SU_DLL int su_home_threadsafe(su_home_t *home);
101
102SU_DLL int su_home_has_parent(su_home_t const *home);
103
104SU_DLL su_home_t *su_home_parent(su_home_t const *home);
105
106SU_DLL void su_home_check(su_home_t const *home);
107
108SU_DLL int su_home_check_alloc(su_home_t const *home, void const *data);
109
110SU_DLL int su_home_mutex_lock(su_home_t *home);
111
112SU_DLL int su_home_mutex_unlock(su_home_t *home);
113
114SU_DLL int su_home_lock(su_home_t *home);
115SU_DLL int su_home_trylock(su_home_t *home);
116SU_DLL int su_home_unlock(su_home_t *home);
117
118SU_DLL void *su_alloc(su_home_t *h, isize_t size)
119 __attribute__((__malloc__));
120SU_DLL void *su_zalloc(su_home_t *h, isize_t size)
121 __attribute__((__malloc__));
122SU_DLL void *su_salloc(su_home_t *h, isize_t size)
123 __attribute__((__malloc__));
124SU_DLL void *su_realloc(su_home_t *h, void *data, isize_t size)
125 __attribute__((__malloc__));
126SU_DLL int su_in_home(su_home_t *h, void const *data);
127
128SU_DLL char *su_strdup(su_home_t *home, char const *s)
129 __attribute__((__malloc__));
130SU_DLL char *su_strcat(su_home_t *home, char const *s1, char const *s2)
131 __attribute__((__malloc__));
132SU_DLL char *su_strndup(su_home_t *home, char const *s, isize_t n)
133 __attribute__((__malloc__));
134
135SU_DLL char *su_strcat_all(su_home_t *home, ...)
136 __attribute__((__malloc__, __sentinel__ (0)));
137
138SU_DLL char *su_sprintf(su_home_t *home, char const *fmt, ...)
139 __attribute__ ((__malloc__, __format__ (printf, 2, 3)));
140
141SU_DLL char *su_vsprintf(su_home_t *home, char const *fmt, va_list ap)
142 __attribute__((__malloc__));
143
144/* free an independent block */
145SU_DLL void su_free(su_home_t *h, void *);
146
148SU_DLL int su_home_is_threadsafe(su_home_t const *home);
149
150/* ---------------------------------------------------------------------- */
151/* Deprecated */
152
153SU_DLL su_home_t *su_home_create(void)
154 __attribute__((__malloc__));
155SU_DLL void su_home_destroy(su_home_t *h);
156
157#define su_home_zap(h) su_home_unref((h))
158
159SOFIA_END_DECLS
160
161#endif /* ! defined(SU_ALLOC_H) */
int su_home_threadsafe(su_home_t *home)
Convert su_home_t object to a thread-safe one.
Definition su_alloc_lock.c:92
char * su_strdup(su_home_t *home, char const *s))
Duplicate a string, allocate memory from home.
Definition su_strdup.c:51
Memory home structure.
Definition su_alloc.h:57
void su_home_destroy(su_home_t *h)
Destroy a home object.
Definition su_alloc.c:944
int su_home_mutex_unlock(su_home_t *home)
Release exclusive lock on home and decrease refcount (if home is threadsafe).
Definition su_alloc.c:1575
int su_home_has_parent(su_home_t const *home)
Return true if home is a clone.
Definition su_alloc.c:747
char * su_strcat_all(su_home_t *home,...)))
Concate multiple strings, allocate memory for result from home.
Definition su_strdup.c:111
void * su_alloc(su_home_t *h, isize_t size))
Allocate a memory block.
Definition su_alloc.c:779
char * su_vsprintf(su_home_t *home, char const *fmt, va_list ap))
Copy a formatted string.
Definition su_sprintf.c:68
int su_home_check_alloc(su_home_t const *home, void const *data)
Check if pointer has been allocated through home.
Definition su_alloc.c:861
int su_home_move(su_home_t *dst, su_home_t *src)
Move allocations from a su_home_t object to another.
Definition su_alloc.c:1087
char * su_sprintf(su_home_t *home, char const *fmt,...)))
Copy a formatted string.
Definition su_sprintf.c:119
void * su_realloc(su_home_t *h, void *data, isize_t size))
Reallocate a memory block.
Definition su_alloc.c:1290
void * su_zalloc(su_home_t *h, isize_t size))
Allocate and zero a memory block.
Definition su_alloc.c:1466
int su_home_trylock(su_home_t *home)
Try to obtain exclusive lock on home without increasing refcount.
Definition su_alloc.c:1627
su_home_t * su_home_parent(su_home_t const *home)
Return home's parent home.
Definition su_alloc.c:753
void su_home_check(su_home_t const *home)
Check home consistency.
Definition su_alloc.c:885
int su_in_home(su_home_t *h, void const *data)
Check if a memory block has been allocated from the home.
Definition su_alloc.c:1427
void * su_home_new(isize_t size))
Create a new su_home_t object.
Definition su_alloc.c:548
void * su_home_ref(su_home_t const *)
Create a new reference to a home object.
Definition su_alloc.c:573
void * su_home_clone(su_home_t *parent, isize_t size))
Clone a su_home_t object.
Definition su_alloc.c:723
size_t su_home_refcount(su_home_t *home)
Return reference count of home.
Definition su_alloc.c:688
char * su_strndup(su_home_t *home, char const *s, isize_t n))
Duplicate a string with given size, allocate memory from home.
Definition su_strdup.c:159
void * su_salloc(su_home_t *h, isize_t size))
Allocate a structure.
Definition su_alloc.c:1512
int su_home_unlock(su_home_t *home)
Release exclusive lock on home.
Definition su_alloc.c:1649
void su_home_deinit(su_home_t *h)
Free memory blocks allocated through home.
Definition su_alloc.c:1060
int su_home_destructor(su_home_t *, void(*)(void *))
Set destructor function.
Definition su_alloc.c:603
struct su_alock su_alock_t
Thread-locking function.
Definition su_alloc.h:54
su_home_t * su_home_auto(void *area, isize_t size)
Preload a memory home from stack.
Definition su_alloc.c:1234
int su_home_unref(su_home_t *)
Unreference a su_home_t object.
Definition su_alloc.c:650
int su_home_mutex_lock(su_home_t *home)
Increase refcount and obtain exclusive lock on home.
Definition su_alloc.c:1551
int su_home_lock(su_home_t *home)
Obtain exclusive lock on home without increasing refcount.
Definition su_alloc.c:1606
su_home_t * su_home_create(void))
Create an su_home_t object.
Definition su_alloc.c:928
void su_free(su_home_t *h, void *)
Free a memory block.
Definition su_alloc.c:802
int su_home_is_threadsafe(su_home_t const *home)
Check if a memory home is threadsafe.
Definition su_alloc.c:1536
SU_HOME_T su_home_t
Memory home type.
Definition su_alloc.h:50
void su_home_preload(su_home_t *h, isize_t n, isize_t size)
Preload a memory home.
Definition su_alloc.c:1202
char * su_strcat(su_home_t *home, char const *s1, char const *s2))
Concate two strings, allocate memory for result from home.
Definition su_strdup.c:77
int su_home_init(su_home_t *h)
Initialize an su_home_t struct.
Definition su_alloc.c:975
Basic integer types for su library.

Sofia-SIP 1.12.11devel - Copyright (C) 2006 Nokia Corporation. All rights reserved. Licensed under the terms of the GNU Lesser General Public License.