\r\n

51Degrees Device Detection C/C++  4.4

A device detection library that is used natively or by 51Degrees products

collection.h

1 /* *********************************************************************
2  * This Original Work is copyright of 51 Degrees Mobile Experts Limited.
3  * Copyright 2022 51 Degrees Mobile Experts Limited, Davidson House,
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_COLLECTION_H_INCLUDED
24 #define FIFTYONE_DEGREES_COLLECTION_H_INCLUDED
25 
236  /* Define NDEBUG if needed, to ensure asserts are disabled in release builds */
237 #if !defined(DEBUG) && !defined(_DEBUG) && !defined(NDEBUG)
238 #define NDEBUG
239 #endif
240 
241 #include "data.h"
242 #include "exceptions.h"
243 #include "cache.h"
244 #include "file.h"
245 #include "memory.h"
246 #include "common.h"
247 #include <stdio.h>
248 #include <string.h>
249 #include <assert.h>
250 
255 #define FIFTYONE_DEGREES_COLLECTION_FREE(c) \
256 if (c != NULL) { c->freeCollection(c); }
257 
258 
266 #ifndef FIFTYONE_DEGREES_MEMORY_ONLY
267 #define FIFTYONE_DEGREES_COLLECTION_RELEASE(c, i) c->release(i)
268 #else
269 #define FIFTYONE_DEGREES_COLLECTION_RELEASE(c, i)
270 #endif
271 
272 
277 #pragma pack(push, 4)
278 typedef struct fiftyone_degrees_collection_header_t {
279  uint32_t startPosition;
280  uint32_t length;
281  uint32_t count;
283 #pragma pack(pop)
284 
289 typedef struct fiftyone_degrees_collection_config_t {
290  uint32_t loaded;
292  uint32_t capacity;
294  uint16_t concurrency;
297 
299 typedef struct fiftyone_degrees_collection_t fiftyoneDegreesCollection;
300 typedef struct fiftyone_degrees_collection_item_t fiftyoneDegreesCollectionItem;
301 typedef struct fiftyone_degrees_collection_file_t fiftyoneDegreesCollectionFile;
310 typedef struct fiftyone_degrees_collection_item_t {
312  void *handle;
318 
330 typedef void* (*fiftyoneDegreesCollectionGetMethod)(
331  fiftyoneDegreesCollection *collection,
332  uint32_t indexOrOffset,
334  fiftyoneDegreesException *exception);
335 
343  void *initial);
344 
355 typedef void* (*fiftyoneDegreesCollectionFileRead)(
356  const fiftyoneDegreesCollectionFile *collection,
357  uint32_t offsetOrIndex,
358  fiftyoneDegreesData *data,
359  fiftyoneDegreesException *exception);
360 
373  void *state,
375  long curIndex,
376  fiftyoneDegreesException *exception);
377 
385 
391  fiftyoneDegreesCollection* collection);
392 
401  void *state,
402  uint32_t key,
403  void *data);
404 
410 typedef struct fiftyone_degrees_collection_t {
421  void *state;
427  uint32_t count;
428  uint32_t elementSize;
429  uint32_t size;
432 
436 typedef struct fiftyone_degrees_collection_memory_t {
438  byte *firstByte;
439  byte *lastByte;
440  void *memoryToFree;
443 
447 typedef struct fiftyone_degrees_collection_file_t {
451  long offset;
456 
462 typedef struct fiftyone_degrees_collection_cache_t {
467 
477 
487  fiftyoneDegreesCollection *collection,
488  uint32_t indexOrOffset,
489  fiftyoneDegreesException *exception);
490 
507  FILE *file,
508  fiftyoneDegreesFilePool *reader,
509  const fiftyoneDegreesCollectionConfig *config,
512 
527 
540  const fiftyoneDegreesCollectionFile *file,
541  uint32_t offset,
542  fiftyoneDegreesException *exception);
543 
561  const fiftyoneDegreesCollectionFile *file,
562  uint32_t index,
563  fiftyoneDegreesData *data,
564  fiftyoneDegreesException *exception);
565 
580  FILE *file,
581  uint32_t elementSize,
582  bool isCount);
583 
600  const fiftyoneDegreesCollectionFile *file,
601  fiftyoneDegreesData *data,
602  uint32_t offset,
603  void *initial,
604  size_t initialSize,
606  fiftyoneDegreesException *exception);
607 
623  uint32_t elementSize,
624  bool isCount);
625 
626 
647  fiftyoneDegreesCollection *collection,
649  uint32_t lowerIndex,
650  uint32_t upperIndex,
651  void *state,
653  fiftyoneDegreesException *exception);
654 
668 EXTERNAL uint32_t fiftyoneDegreesCollectionGetCount(
669  fiftyoneDegreesCollection *collection);
670 
675 #endif
bool fiftyoneDegreesCollectionGetIsMemoryOnly()
Determines if in memory collection methods have been compiled so they are fully optimized.
fiftyoneDegreesCollection * source
The source collection used to load items into the cache.
Definition: collection.h:463
Type of collection where items are cached as they are used.
Definition: collection.h:462
fiftyoneDegreesCollectionFileRead read
Read method used to read an item from file at an offset or index.
Definition: collection.h:452
Collection header structure which defines the size and location of the collection data.
Definition: collection.h:278
void * fiftyoneDegreesCollectionReadFileFixed(const fiftyoneDegreesCollectionFile *file, uint32_t index, fiftyoneDegreesData *data, fiftyoneDegreesException *exception)
Used with collections where each item is a fixed number of bytes recorded in elementSize.
fiftyoneDegreesCache * cache
Loading cache to use as data source.
Definition: collection.h:465
int32_t fiftyoneDegreesCollectionGetInteger32(fiftyoneDegreesCollection *collection, uint32_t indexOrOffset, fiftyoneDegreesException *exception)
Returns a 32 bit integer from collections that provide such values.
fiftyoneDegreesCollectionHeader fiftyoneDegreesCollectionHeaderFromFile(FILE *file, uint32_t elementSize, bool isCount)
Reads the 4 bytes at the current reader position and configures the collection header.
long fiftyoneDegreesCollectionBinarySearch(fiftyoneDegreesCollection *collection, fiftyoneDegreesCollectionItem *item, uint32_t lowerIndex, uint32_t upperIndex, void *state, fiftyoneDegreesCollectionItemComparer comparer, fiftyoneDegreesException *exception)
Where a collection is fixed width and contains an ordered list of items this method is used to perfor...
fiftyoneDegreesCollection * collection
The generic collection.
Definition: collection.h:448
bool(* fiftyoneDegreesCollectionIterateMethod)(void *state, uint32_t key, void *data)
Method used to iterate over data held in a collection.
Definition: collection.h:400
Used to store a handle to the underlying item that could be used to release the item when it's finish...
Definition: collection.h:310
void(* fiftyoneDegreesCollectionReleaseMethod)(fiftyoneDegreesCollectionItem *item)
Releases the item so that the collection can free the memory or take other actions when the caller no...
Definition: collection.h:383
fiftyoneDegreesFileHandle * fiftyoneDegreesCollectionReadFilePosition(const fiftyoneDegreesCollectionFile *file, uint32_t offset, fiftyoneDegreesException *exception)
Get a handle from the file pool associated with the collection and position the file handle at the of...
Used to read data from memory in a similar manner to a file handle.
Definition: memory.h:53
void *(* fiftyoneDegreesCollectionFileRead)(const fiftyoneDegreesCollectionFile *collection, uint32_t offsetOrIndex, fiftyoneDegreesData *data, fiftyoneDegreesException *exception)
Reads the item from the underlying data file.
Definition: collection.h:355
Cache structure to store the root of the red black tree and a list of allocated cache nodes.
Definition: cache.h:187
fiftyoneDegreesCollectionFreeMethod freeCollection
Frees collection and all items retrieved from the collection will become invalid.
Definition: collection.h:417
void *(* fiftyoneDegreesCollectionGetMethod)(fiftyoneDegreesCollection *collection, uint32_t indexOrOffset, fiftyoneDegreesCollectionItem *item, fiftyoneDegreesException *exception)
Gets an item from the collection.
Definition: collection.h:330
fiftyoneDegreesCollection * fiftyoneDegreesCollectionCreateFromFile(FILE *file, fiftyoneDegreesFilePool *reader, const fiftyoneDegreesCollectionConfig *config, fiftyoneDegreesCollectionHeader header, fiftyoneDegreesCollectionFileRead read)
Creates a collection from the file handle at the current position in the file.
uint32_t count
The number of items, or 0 if not available.
Definition: collection.h:427
Type of collection where the collection is streamed from file.
Definition: collection.h:447
fiftyoneDegreesCollection * collection
Collection the item came from which may not have been set.
Definition: collection.h:313
int(* fiftyoneDegreesCollectionItemComparer)(void *state, fiftyoneDegreesCollectionItem *item, long curIndex, fiftyoneDegreesException *exception)
Compares two items and returns the difference between them for the purposes of a binary search of ord...
Definition: collection.h:372
uint32_t capacity
Number of items the cache should store, 0 for no cache.
Definition: collection.h:292
byte * firstByte
The first byte in memory of the collection.
Definition: collection.h:438
uint32_t fiftyoneDegreesCollectionGetCount(fiftyoneDegreesCollection *collection)
Gets the actual number of items in the collection by iterating through to the base collection.
Data structure used for reusing memory which may have been allocated in a previous operation.
Definition: data.h:101
uint32_t count
Number of entities in the collection.
Definition: collection.h:281
fiftyoneDegreesCollectionHeader fiftyoneDegreesCollectionHeaderFromMemory(fiftyoneDegreesMemoryReader *reader, uint32_t elementSize, bool isCount)
Reads the 4 bytes at the current reader position and configures the collection header.
void * handle
A handle that relates to the data.
Definition: collection.h:312
uint32_t startPosition
Start position in the data file of the entities.
Definition: collection.h:279
long offset
Offset to the collection in the source data structure.
Definition: collection.h:451
void * memoryToFree
Memory to free when freeing the collection, or NULL if no memory to free.
Definition: collection.h:440
fiftyoneDegreesCollection * next
The next collection implementation or NULL.
Definition: collection.h:425
fiftyoneDegreesFilePool * reader
Reader used to load items into the cache, or NULL if no cache.
Definition: collection.h:449
uint16_t concurrency
Expected number of concurrent requests, 1 or greater.
Definition: collection.h:294
File handle node in the stack of handles.
Definition: file.h:219
uint32_t elementSize
The size of each entry, or 0 if variable length.
Definition: collection.h:428
fiftyoneDegreesCollectionGetMethod get
Gets an entry into the item provided.
Definition: collection.h:411
void * state
Pointer to data for memory, cache or file.
Definition: collection.h:421
uint32_t loaded
Number of items to load into memory from the start of the collection.
Definition: collection.h:290
Collection configuration structure which defines how the collection should be created by the create m...
Definition: collection.h:289
void * fiftyoneDegreesCollectionReadFileVariable(const fiftyoneDegreesCollectionFile *file, fiftyoneDegreesData *data, uint32_t offset, void *initial, size_t initialSize, fiftyoneDegreesCollectionGetFileVariableSizeMethod getFinalSize, fiftyoneDegreesException *exception)
Reads a variable size item from the file where the initial bytes can be used to calculate the size of...
void(* fiftyoneDegreesCollectionFreeMethod)(fiftyoneDegreesCollection *collection)
Frees all the memory and handles associated with the collection.
Definition: collection.h:390
Structure used to represent a 51Degrees exception and passed into methods that might generate excepti...
Definition: exceptions.h:111
Type of collection where the collection is held in continuous memory.
Definition: collection.h:436
fiftyoneDegreesCollection * fiftyoneDegreesCollectionCreateFromMemory(fiftyoneDegreesMemoryReader *reader, fiftyoneDegreesCollectionHeader header)
Creates the collection from a memory reader where the collection maps to the memory allocated to the ...
Stack of handles used to read data from a single source file.
Definition: file.h:227
uint32_t length
Length in bytes of all the entities.
Definition: collection.h:280
All the shared methods and fields required by file, memory and cached collections.
Definition: collection.h:410
fiftyoneDegreesData data
Item data including allocated memory.
Definition: collection.h:311
fiftyoneDegreesCollectionReleaseMethod release
Releases the item handle.
Definition: collection.h:415
byte * lastByte
The last byte in memory of the collection.
Definition: collection.h:439
fiftyoneDegreesCollection * collection
The generic collection.
Definition: collection.h:437
uint32_t size
Number of bytes in the source data structure containing the collection's data.
Definition: collection.h:429
uint32_t(* fiftyoneDegreesCollectionGetFileVariableSizeMethod)(void *initial)
Passed a pointer to the first part of a variable size item and returns the size of the entire item.
Definition: collection.h:342