xref: /optee_os/core/kernel/handle.c (revision 988ea29c4666687dcc038a35efd6412567be57bf)
11bb92983SJerome Forissier // SPDX-License-Identifier: BSD-2-Clause
2c0346845SJens Wiklander /*
3c0346845SJens Wiklander  * Copyright (c) 2014, Linaro Limited
4*988ea29cSBalint Dobszay  * Copyright (c) 2020, Arm Limited
5c0346845SJens Wiklander  */
6c0346845SJens Wiklander #include <stdlib.h>
7c0346845SJens Wiklander #include <string.h>
8c0346845SJens Wiklander #include <kernel/handle.h>
9c0346845SJens Wiklander 
10c0346845SJens Wiklander /*
11c0346845SJens Wiklander  * Define the initial capacity of the database. It should be a low number
12c0346845SJens Wiklander  * multiple of 2 since some databases a likely to only use a few handles.
13c0346845SJens Wiklander  * Since the algorithm is to doubles up when growing it shouldn't cause a
14c0346845SJens Wiklander  * noticable overhead on large databases.
15c0346845SJens Wiklander  */
16c0346845SJens Wiklander #define HANDLE_DB_INITIAL_MAX_PTRS	4
17c0346845SJens Wiklander 
handle_db_destroy(struct handle_db * db,void (* ptr_destructor)(void * ptr))1852ae1039SJens Wiklander void handle_db_destroy(struct handle_db *db, void (*ptr_destructor)(void *ptr))
19c0346845SJens Wiklander {
20c0346845SJens Wiklander 	if (db) {
2152ae1039SJens Wiklander 		if (ptr_destructor) {
2252ae1039SJens Wiklander 			size_t n = 0;
2352ae1039SJens Wiklander 
2452ae1039SJens Wiklander 			for (n = 0; n < db->max_ptrs; n++)
2552ae1039SJens Wiklander 				if (db->ptrs[n])
2652ae1039SJens Wiklander 					ptr_destructor(db->ptrs[n]);
2752ae1039SJens Wiklander 		}
28c0346845SJens Wiklander 		free(db->ptrs);
29c0346845SJens Wiklander 		db->ptrs = NULL;
30c0346845SJens Wiklander 		db->max_ptrs = 0;
31c0346845SJens Wiklander 	}
32c0346845SJens Wiklander }
33c0346845SJens Wiklander 
handle_db_is_empty(struct handle_db * db)34*988ea29cSBalint Dobszay bool handle_db_is_empty(struct handle_db *db)
35*988ea29cSBalint Dobszay {
36*988ea29cSBalint Dobszay 	size_t n = 0;
37*988ea29cSBalint Dobszay 
38*988ea29cSBalint Dobszay 	if (db) {
39*988ea29cSBalint Dobszay 		for (n = 0; n < db->max_ptrs; n++) {
40*988ea29cSBalint Dobszay 			if (db->ptrs[n])
41*988ea29cSBalint Dobszay 				return false;
42*988ea29cSBalint Dobszay 		}
43*988ea29cSBalint Dobszay 	}
44*988ea29cSBalint Dobszay 	return true;
45*988ea29cSBalint Dobszay }
46*988ea29cSBalint Dobszay 
handle_get(struct handle_db * db,void * ptr)47c0346845SJens Wiklander int handle_get(struct handle_db *db, void *ptr)
48c0346845SJens Wiklander {
49c0346845SJens Wiklander 	size_t n;
50c0346845SJens Wiklander 	void *p;
51c0346845SJens Wiklander 	size_t new_max_ptrs;
52c0346845SJens Wiklander 
53c0346845SJens Wiklander 	if (!db || !ptr)
54c0346845SJens Wiklander 		return -1;
55c0346845SJens Wiklander 
56c0346845SJens Wiklander 	/* Try to find an empty location */
57c0346845SJens Wiklander 	for (n = 0; n < db->max_ptrs; n++) {
58c0346845SJens Wiklander 		if (!db->ptrs[n]) {
59c0346845SJens Wiklander 			db->ptrs[n] = ptr;
60c0346845SJens Wiklander 			return n;
61c0346845SJens Wiklander 		}
62c0346845SJens Wiklander 	}
63c0346845SJens Wiklander 
64c0346845SJens Wiklander 	/* No location available, grow the ptrs array */
65c0346845SJens Wiklander 	if (db->max_ptrs)
66c0346845SJens Wiklander 		new_max_ptrs = db->max_ptrs * 2;
67c0346845SJens Wiklander 	else
68c0346845SJens Wiklander 		new_max_ptrs = HANDLE_DB_INITIAL_MAX_PTRS;
69c0346845SJens Wiklander 	p = realloc(db->ptrs, new_max_ptrs * sizeof(void *));
70c0346845SJens Wiklander 	if (!p)
71c0346845SJens Wiklander 		return -1;
72c0346845SJens Wiklander 	db->ptrs = p;
73c0346845SJens Wiklander 	memset(db->ptrs + db->max_ptrs, 0,
74c0346845SJens Wiklander 	       (new_max_ptrs - db->max_ptrs) * sizeof(void *));
75c0346845SJens Wiklander 	db->max_ptrs = new_max_ptrs;
76c0346845SJens Wiklander 
77c0346845SJens Wiklander 	/* Since n stopped at db->max_ptrs there is an empty location there */
78c0346845SJens Wiklander 	db->ptrs[n] = ptr;
79c0346845SJens Wiklander 	return n;
80c0346845SJens Wiklander }
81c0346845SJens Wiklander 
handle_put(struct handle_db * db,int handle)82c0346845SJens Wiklander void *handle_put(struct handle_db *db, int handle)
83c0346845SJens Wiklander {
84c0346845SJens Wiklander 	void *p;
85c0346845SJens Wiklander 
86c0346845SJens Wiklander 	if (!db || handle < 0 || (size_t)handle >= db->max_ptrs)
87c0346845SJens Wiklander 		return NULL;
88c0346845SJens Wiklander 
89c0346845SJens Wiklander 	p = db->ptrs[handle];
90c0346845SJens Wiklander 	db->ptrs[handle] = NULL;
91c0346845SJens Wiklander 	return p;
92c0346845SJens Wiklander }
93c0346845SJens Wiklander 
handle_lookup(struct handle_db * db,int handle)94c0346845SJens Wiklander void *handle_lookup(struct handle_db *db, int handle)
95c0346845SJens Wiklander {
96c0346845SJens Wiklander 	if (!db || handle < 0 || (size_t)handle >= db->max_ptrs)
97c0346845SJens Wiklander 		return NULL;
98c0346845SJens Wiklander 
99c0346845SJens Wiklander 	return db->ptrs[handle];
100c0346845SJens Wiklander }
101