1/* *********************************************************************

2 * This Original Work is copyright of 51 Degrees Mobile Experts Limited.

4 * Forbury Square, Reading, Berkshire, United Kingdom RG1 3EU.

5 *

6 * This Original Work is licensed under the European Union Public Licence

7 * (EUPL) v.1.2 and is subject to its terms as set out below.

8 *

9 * If a copy of the EUPL was not distributed with this file, You can obtain

10 * one at https://opensource.org/licenses/EUPL-1.2.

11 *

12 * The 'Compatible Licences' set out in the Appendix to the EUPL (as may be

13 * amended by the European Commission) shall be deemed incompatible for

14 * the purposes of the Work and the provisions of the compatibility

15 * clause in Article 5 of the EUPL shall not apply.

16 *

17 * If using the Work as, or as part of, a network application, by

18 * including the attribution notice(s) required under Article 5 of the EUPL

19 * in the end user terms of the application under an appropriate heading,

20 * such notice(s) shall fulfill the requirements of that article.

21 * ********************************************************************* */

22

23#ifndef FIFTYONE_DEGREES_POOL_H_INCLUDED

24#define FIFTYONE_DEGREES_POOL_H_INCLUDED

25

26#ifdef FIFTYONE_DEGREES_IPI_SYMBOLS

27#include "ipiSymbols.h"

28#endif

29

125

126#include <stdio.h>

127#include <errno.h>

128#include <stdint.h>

129#ifdef _MSC_VER

130#pragma warning (push)

131#pragma warning (disable: 5105)

132#include <windows.h>

133#pragma warning (default: 5105)

134#pragma warning (pop)

135#endif

136#include <assert.h>

137#include <limits.h>

138#include "data.h"

139#include "exceptions.h"

140#include "memory.h"

141#ifndef FIFTYONE_DEGREES_NO_THREADING

142#include "threading.h"

143#endif

144#include "common.h"

145

147typedef struct fiftyone_degrees_pool_item_t fiftyoneDegreesPoolItem;

148typedef struct fiftyone_degrees_pool_t fiftyoneDegreesPool;

150

159typedef void*(*fiftyoneDegreesPoolResourceCreate)(

160 fiftyoneDegreesPool *pool,

161 void *state,

162 fiftyoneDegreesException *exception);

163

171typedef size_t(*fiftyoneDegreesPoolResourceSize)(void *state);

172

178typedef void(*fiftyoneDegreesPoolResourceFree)(

179 fiftyoneDegreesPool *pool,

180 void *resource);

181

185typedef struct fiftyone_degrees_pool_item_t {

186 void *resource;

187 uint16_t next;

188 fiftyoneDegreesPool *pool;

189} fiftyoneDegreesPoolItem;

190

194typedef union fiftyone_degrees_pool_head_t {

195 volatile long exchange;

196 struct {

197 uint16_t index;

198 uint16_t aba;

199 } values;

200} fiftyoneDegreesPoolHead;

201

205typedef struct fiftyone_degrees_pool_t {

206 fiftyoneDegreesPoolItem *stack;

208 fiftyoneDegreesPoolHead head;

209 uint16_t count;

210 fiftyoneDegreesPoolResourceFree resourceFree;

211#ifndef FIFTYONE_DEGREES_NO_THREADING

212 volatile long waiting;

213 long waits;

214 fiftyoneDegreesMutex lock;

215#ifdef _MSC_VER

216 CONDITION_VARIABLE released;

217#else

218 pthread_cond_t released;

219#endif

220#endif

221} fiftyoneDegreesPool;

222

241EXTERNAL fiftyoneDegreesPool* fiftyoneDegreesPoolInit(

242 fiftyoneDegreesPool *pool,

243 uint16_t concurrency,

244 void *state,

245 fiftyoneDegreesPoolResourceCreate resourceCreate,

246 fiftyoneDegreesPoolResourceFree resourceFree,

247 fiftyoneDegreesException *exception);

248

261EXTERNAL fiftyoneDegreesPoolItem* fiftyoneDegreesPoolItemGet(

262 fiftyoneDegreesPool *pool,

263 fiftyoneDegreesException *exception);

264

270EXTERNAL void fiftyoneDegreesPoolItemRelease(fiftyoneDegreesPoolItem* item);

271

277EXTERNAL void fiftyoneDegreesPoolFree(fiftyoneDegreesPool* pool);

278

283EXTERNAL void fiftyoneDegreesPoolReset(fiftyoneDegreesPool *pool);

284

288

289#endif

fiftyoneDegreesPoolFree

void fiftyoneDegreesPoolFree(fiftyoneDegreesPool *pool)

Releases the items used by the pool freeing the resources used by each item by calling the resourceFr...

fiftyoneDegreesPoolItemGet

fiftyoneDegreesPoolItem * fiftyoneDegreesPoolItemGet(fiftyoneDegreesPool *pool, fiftyoneDegreesException *exception)

Gets the next free item from the pool for exclusive use by the caller.

fiftyoneDegreesPoolItemRelease

void fiftyoneDegreesPoolItemRelease(fiftyoneDegreesPoolItem *item)

Releases the item back to the pool it belongs ready to be reused by another operation.

fiftyoneDegreesPoolResourceFree

void(* fiftyoneDegreesPoolResourceFree)(fiftyoneDegreesPool *pool, void *resource)

Frees a resource previously created with fiftyoneDegreesPoolResourceCreate.

Definition pool.h:178

fiftyoneDegreesPoolResourceSize

size_t(* fiftyoneDegreesPoolResourceSize)(void *state)

Used to determine the additional size beyond the pointer used for each resource added to the pool.

Definition pool.h:171

fiftyoneDegreesPoolResourceCreate

void *(* fiftyoneDegreesPoolResourceCreate)(fiftyoneDegreesPool *pool, void *state, fiftyoneDegreesException *exception)

Used to create a new resource for use in the pool.

Definition pool.h:159

fiftyoneDegreesPoolReset

void fiftyoneDegreesPoolReset(fiftyoneDegreesPool *pool)

Resets the pool without releasing any resources.

fiftyoneDegreesPoolInit

fiftyoneDegreesPool * fiftyoneDegreesPoolInit(fiftyoneDegreesPool *pool, uint16_t concurrency, void *state, fiftyoneDegreesPoolResourceCreate resourceCreate, fiftyoneDegreesPoolResourceFree resourceFree, fiftyoneDegreesException *exception)

Initialises a pool data structure to support the number of concurrent requests that can be made to th...

fiftyoneDegreesMutex

pthread_mutex_t fiftyoneDegreesMutex

MUTEX AND THREADING MACROS.

Definition threading.h:112

fiftyoneDegreesException

Structure used to represent a 51Degrees exception and passed into methods that might generate excepti...

Definition exceptions.h:115

fiftyoneDegreesPool

Pool of resources stored as items in a stack.

Definition pool.h:205

fiftyoneDegreesPool::released

pthread_cond_t released

Wakes a waiting thread.

Definition pool.h:218

fiftyoneDegreesPool::lock

fiftyoneDegreesMutex lock

Guards the count and the wait for an item.

Definition pool.h:214

fiftyoneDegreesPool::stack

fiftyoneDegreesPoolItem * stack

Pointer to the memory used by the stack.

Definition pool.h:206

fiftyoneDegreesPool::resourceFree

fiftyoneDegreesPoolResourceFree resourceFree

Frees a resource.

Definition pool.h:210

fiftyoneDegreesPool::waits

long waits

Counts waits for an item, for the tests.

Definition pool.h:213

fiftyoneDegreesPool::waiting

volatile long waiting

Number of threads waiting for an item.

Definition pool.h:212

fiftyoneDegreesPool::count

uint16_t count

Number of resource items that stack can hold.

Definition pool.h:209

fiftyoneDegreesPool::head

fiftyoneDegreesPoolHead head

Head of the stack.

Definition pool.h:208

fiftyoneDegreesPoolItem

Pool item node in the stack of items.

Definition pool.h:185

fiftyoneDegreesPoolItem::resource

void * resource

Pointer to the resource in the pool.

Definition pool.h:186

fiftyoneDegreesPoolItem::next

uint16_t next

The next item in the stack.

Definition pool.h:187

fiftyoneDegreesPoolItem::pool

fiftyoneDegreesPool * pool

Reader the handle belongs to.

Definition pool.h:188

fiftyoneDegreesPoolHead

The head of the stack used for pop and push operations.

Definition pool.h:194

fiftyoneDegreesPoolHead::exchange

volatile long exchange

Number used in the compare exchange operation.

Definition pool.h:195

fiftyoneDegreesPoolHead::aba

uint16_t aba

ABA value used to ensure proper operation.

Definition pool.h:198

fiftyoneDegreesPoolHead::index

uint16_t index

Index of the item in the linked list.

Definition pool.h:197