File: pools.cpp

package info (click to toggle)
entropybroker 2.9-3
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 1,600 kB
  • sloc: cpp: 14,386; sh: 934; makefile: 188; java: 148; perl: 12
file content (815 lines) | stat: -rw-r--r-- 20,737 bytes parent folder | download | duplicates (3)
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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
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
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
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
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
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
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
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
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
#include <math.h>
#include <errno.h>
#include <stdlib.h>
#include <string.h>
#include <stdio.h>
#include <time.h>
#include <vector>
#include <string>
#include <sys/types.h>
#include <dirent.h>
#include <sys/stat.h>
#include <unistd.h>
#include <sys/file.h>
#include <pthread.h>
#include <arpa/inet.h>

#include "error.h"
#include "random_source.h"
#include "log.h"
#include "math.h"
#include "hasher_type.h"
#include "hasher.h"
#include "stirrer_type.h"
#include "stirrer.h"
#include "pool_crypto.h"
#include "pool.h"
#include "utils.h"
#include "fips140.h"
#include "scc.h"
#include "pools.h"

pools::pools(std::string cache_dir_in, unsigned int max_n_mem_pools_in, unsigned int max_n_disk_pools_in, unsigned int min_store_on_disk_n_in, bit_count_estimator *bce_in, int new_pool_size_in_bytes) : cache_dir(cache_dir_in), max_n_mem_pools(max_n_mem_pools_in), max_n_disk_pools(max_n_disk_pools_in), min_store_on_disk_n(min_store_on_disk_n_in), disk_limit_reached_notified(false), bce(bce_in)
{
	pthread_check(pthread_rwlock_init(&list_lck, NULL), "pthread_rwlock_init");
	is_w_locked = false;

	pthread_check(pthread_mutex_init(&lat_lck, NULL), "pthread_mutex_init");
	last_added_to = 0;

	new_pool_size = new_pool_size_in_bytes;

	if (min_store_on_disk_n >= max_n_mem_pools)
		error_exit("min_store_on_disk_n must be less than max_number_of_mem_pools");
	if (min_store_on_disk_n < 0)
		error_exit("min_store_on_disk_n must be at least 0");

	if (max_n_mem_pools < 3)
		error_exit("maximum number of memory pools must be at least 3");

	if (max_n_disk_pools < 0)
		error_exit("maximum number of disk pools must be at least 0");

	load_cachefiles_list();
}

pools::~pools()
{
	store_caches(0);

	pthread_check(pthread_mutex_destroy(&lat_lck), "pthread_mutex_destroy");
	pthread_check(pthread_rwlock_destroy(&list_lck), "pthread_rwlock_destroy");
}

double calc_time_left(double start_ts, double max_time)
{
	return std::max(MIN_SLEEP, max_time - (get_ts() - start_ts));
}

double calc_time_left(double start_ts, unsigned int cur, unsigned int n, double max_duration)
{
	double now_ts = get_ts();
	double time_left = ((max_duration * 0.9) - (now_ts - start_ts)) / double(n - cur);

	if (time_left < MIN_SLEEP)
		return MIN_SLEEP;

	return time_left;
}

void pools::list_wlock()
{
	pthread_check(pthread_rwlock_wrlock(&list_lck), "pthread_rwlock_wrlock");

	my_assert(is_w_locked == false);
	is_w_locked = true;
}

void pools::list_wunlock()
{
	my_assert(is_w_locked);
	is_w_locked = false;

	pthread_check(pthread_rwlock_unlock(&list_lck), "pthread_rwlock_unlock");
}

void pools::list_runlock()
{
	pthread_check(pthread_rwlock_unlock(&list_lck), "pthread_rwlock_unlock");
}

void pools::list_rlock()
{
	pthread_check(pthread_rwlock_rdlock(&list_lck), "pthread_rwlock_rdlock");
}

// keep_n == 0: means dump all
void pools::store_caches(unsigned int keep_n)
{
	if(max_n_disk_pools == 0) {
		dolog(LOG_DEBUG, "Disabled disk pools: not creating any");
		return;
	}

	if (cache_list.size() >= max_n_disk_pools && keep_n != 0)
	{
		if (!disk_limit_reached_notified)
		{
			dolog(LOG_DEBUG, "Maximum number of disk pools reached: not creating a new one");
			disk_limit_reached_notified = true;
		}
	}
	else
	{
		disk_limit_reached_notified = false;
		dolog(LOG_DEBUG, "Storing %d pools on disk (new number of files: %d)", pool_vector.size() - keep_n, cache_list.size() + 1);

		long double now = get_ts_ns();
		char buffer[128];
		snprintf(buffer, sizeof buffer, "%Lf", now);

		std::string new_cache_file = cache_dir + "/" + std::string(buffer) + ".pool";
		FILE *fh = fopen(new_cache_file.c_str(), "wb");
		if (!fh)
			error_exit("Failed to create file %s", new_cache_file.c_str());

		if (flock(fileno(fh), LOCK_EX) == -1)
			error_exit("flock(LOCK_EX) for %s failed", new_cache_file.c_str());

		int bit_sum = 0;
		while(pool_vector.size() > keep_n)
		{
			if (pool_vector.at(0) -> timed_lock_object(1.0) == NULL) // will always succeed due to writelock on list
			{
				int n_bits = pool_vector.at(0) -> get_n_bits_in_pool();
				if (n_bits > 0)
				{
					bit_sum += n_bits;
					pool_vector.at(0) -> dump(fh);
				}

				pool_vector.at(0) -> unlock_object();

				delete pool_vector.at(0);
				pool_vector.erase(pool_vector.begin() + 0);
			}
		}

		cache_list.push_back(std::pair<std::string, int>(new_cache_file, bit_sum));

		fflush(fh);

		if (flock(fileno(fh), LOCK_UN) == -1)
			error_exit("flock(LOCK_UN) for %s failed", new_cache_file.c_str());

		fclose(fh);
	}
}

bool pools::load_caches(unsigned int load_n_bits, pool_crypto *pc)
{
	dolog(LOG_DEBUG, "Loading %d bits from pools", load_n_bits);

	unsigned int bits_loaded = 0;

	unsigned int files_loaded = 0;
	while(!cache_list.empty() && bits_loaded < load_n_bits)
	{
		dolog(LOG_DEBUG, "Load bits from %s", cache_list.at(0).first.c_str());
		FILE *fh = fopen(cache_list.at(0).first.c_str(), "r");
		if (!fh)
			error_exit("Failed to open cache-file %s", cache_list.at(0).first.c_str());

		if (flock(fileno(fh), LOCK_EX) == -1)
			error_exit("flock(LOCK_EX) for %s failed", cache_list.at(0).first.c_str());

		while(!feof(fh))
		{
			/// FIXME ugly hack, should throw an exception in pool-constructor
			if (fgetc(fh) == -1)
				break;
			if (fseek(fh, -1, SEEK_CUR) == -1)
				error_exit("Problem seeking in %s", cache_list.at(0).first.c_str());
			///// FIXME /////

			pool *new_pool = new pool(++files_loaded, fh, bce, pc);

			bits_loaded += new_pool -> get_n_bits_in_pool();

			pool_vector.push_back(new_pool);
		}

		if (unlink(cache_list.at(0).first.c_str()) == -1)
			error_exit("Failed to delete cache-file %s", cache_list.at(0).first.c_str());

		fflush(fh);

		if (flock(fileno(fh), LOCK_UN) == -1)
			error_exit("flock(LOCK_UN) for %s failed", cache_list.at(0).first.c_str());

		fclose(fh);

		cache_list.erase(cache_list.begin());
	}

	if (bits_loaded > 0 || files_loaded > 0)
	{
		dolog(LOG_DEBUG, "%d bits loaded from %d files", bits_loaded, files_loaded);
		return true;
	}

	return false;
}

void pools::flush_empty_pools()
{
	unsigned int deleted = 0;
	for(int index=pool_vector.size() - 1; index >= 0; index--)
	{
		if (pool_vector.at(index) -> timed_lock_object(1.0) == NULL) // will always succeed due to writelock on list
		{
			if (pool_vector.at(index) -> get_n_bits_in_pool() == 0)
			{
				pool *obj = pool_vector.at(index);

				pool_vector.erase(pool_vector.begin() + index);

				obj -> unlock_object();
				delete obj;

				deleted++;
			}
			else
			{
				pool_vector.at(index) -> unlock_object();
			}
		}
	}

	if (deleted)
		dolog(LOG_DEBUG, "Deleted %d empty pool(s), new count: %d", deleted, pool_vector.size());
}

typedef struct
{
	int index;
	int n_bits;
}
merge_t;

int merge_compare_bits(const void *a, const void *b)
{
	merge_t *ma = (merge_t *)a;
	merge_t *mb = (merge_t *)b;

	return ma -> n_bits - mb -> n_bits;
}

void pools::merge_pools(pool_crypto *pc)
{
	if (pool_vector.empty())
		return;

	int n_merged = 0;
	int n_in = pool_vector.size();

	int process_n = 0;
	merge_t *list = reinterpret_cast<merge_t *>(malloc(n_in * sizeof(merge_t)));
	for(int index=0; index<n_in; index++)
	{
		if (pool_vector.at(index) -> timed_lock_object(0.01))
			continue;

		list[process_n].index = index;
		list[process_n].n_bits = pool_vector.at(index) -> get_n_bits_in_pool();

		if (list[process_n].n_bits > 0)
			process_n++;
		else
			pool_vector.at(index) -> unlock_object();
	}

	if (process_n > 0)
	{
		qsort(list, process_n, sizeof(merge_t), merge_compare_bits);

		int stir_size = pc -> get_stirrer() -> get_stir_size();

		int add_index = -1, max_n_bits = -1;;
		for(int index=0; index<process_n; index++)
		{
			if (add_index == -1)
			{
				add_index = index++;
				max_n_bits = pool_vector.at(list[add_index].index) -> get_pool_size();

				if (index == process_n)
					break;
			}

			if (list[add_index].n_bits + list[index].n_bits > max_n_bits + stir_size)
			{
				add_index = -1;
				index--;
			}
			else
			{
				int i1 = list[add_index].index;
				int i2 = list[index].index;

				int data_size = pool_vector.at(i2) -> get_pool_size_bytes();
				unsigned char *data = pool_vector.at(i2) -> expose_contents();

				pool_vector.at(i1) -> add_entropy_data(data, data_size, pc, list[index].n_bits);

				n_merged++;
			}
		}
	}

	for(int index=0; index<process_n; index++)
		pool_vector.at(list[index].index) -> unlock_object();

	free(list);

	if (n_merged)
		dolog(LOG_INFO, "%d pool(s) merged, new count: %d", n_merged, pool_vector.size());
}

void pools::load_cachefiles_list()
{
	DIR *dirp = opendir(cache_dir.c_str());
	if (!dirp)
		error_exit("Failed to open directory %s", cache_dir.c_str());

	struct dirent *de = NULL;
	while((de = readdir(dirp)) != NULL)
	{
		std::string file_name = cache_dir + "/" + std::string(de -> d_name);

		struct stat ss;
		if (stat(file_name.c_str(), &ss) == -1)
		{
			if (errno == EEXIST)
				dolog(LOG_WARNING, "File %s suddenly disappeared?!", file_name.c_str());

			error_exit("Error doing stat on %s", file_name.c_str());
		}

		if (ss.st_mode & S_IFDIR)
			continue;

		if (file_name.substr(file_name.size() - 5, 5) == ".pool")
		{
			dolog(LOG_DEBUG, "Added %s to cache list", file_name.c_str());
			cache_list.push_back(std::pair<std::string, int>(file_name, pool::get_file_bit_count(file_name)));
		}
	}

	closedir(dirp);
}

bool pools::verify_quality(unsigned char *data, int n, bool ignore_rngtest_fips140, fips140 *pfips, bool ignore_rngtest_scc, scc *pscc)
{
	if (!ignore_rngtest_fips140 || !ignore_rngtest_scc)
	{
		for(int rngtest_loop=0; rngtest_loop<n; rngtest_loop++)
		{
			pfips -> add(data[rngtest_loop]);
			pscc -> add(data[rngtest_loop]);
		}
	}

	bool rc_fips140 = true, rc_scc = true;

	if (!ignore_rngtest_fips140)
		rc_fips140 = pfips -> is_ok();

	if (!ignore_rngtest_scc)
		rc_scc = pfips -> is_ok();

	return rc_fips140 == true && rc_scc == true;
}

// returns a locked pool
int pools::find_non_full_pool(bool timed, double max_duration)
{
	// be carefull that start_ts is not used when timed == false!!!
	double start_ts = timed ? get_ts() : 0;

	int n = pool_vector.size();

	// please note: it is not required that this offset is cryptographically
	// random, it is only used to "spread the load" over all the pools
	int index_offset = rand();
	if (index_offset >= INT_MAX - (n + 1))
		index_offset /= 2;

	for(int loop_index=0; loop_index<n; loop_index++)
	{
		int index = abs(loop_index + index_offset) % n;

		pthread_cond_t *cond = NULL;
		if (timed)
		{
			double cur_max_duration = calc_time_left(start_ts, loop_index, n, max_duration);

			cond = pool_vector.at(index) -> timed_lock_object(cur_max_duration);
		}
		else
			cond = pool_vector.at(index) -> lock_object();

		if (!cond)
		{
			if (!pool_vector.at(index) -> is_almost_full())
				return index;

			pool_vector.at(index) -> unlock_object();
		}
	}

	return -1;
}

// returns a locked pool
int pools::select_pool_to_add_to(bool timed, double max_time, pool_crypto *pc)
{
	double start_ts = timed ? get_ts() : 0.0;

	list_rlock();
	double left = timed ? calc_time_left(start_ts, max_time) : -1.0;

	int index = find_non_full_pool(timed, left);

	if (index == -1)
	{
		list_runlock();
		list_wlock();
		// at this point (due to context switching between the unlock and the
		// wlock), there may already be a non-empty pool: that is not a problem

		if (pool_vector.size() >= max_n_mem_pools)
			store_caches(std::max(0, int(pool_vector.size()) - int(min_store_on_disk_n)));

		// see if the number of in-memory pools is reduced after the call to store_caches
		// it might have not stored any on disk if the limit on the number of files has been reached
		if (pool_vector.size() < max_n_mem_pools)
		{
			dolog(LOG_DEBUG, "Adding empty pool to queue (new number of pools: %d)", pool_vector.size() + 1);

			pool_vector.push_back(new pool(new_pool_size, bce, pc));
		}

		list_wunlock();
		list_rlock();

		left = timed ? calc_time_left(start_ts, max_time) :  -1.0;

		index = find_non_full_pool(timed, left);
		if (index == -1)
		{
			// this can happen if
			// 1. the number of in-memory-pools limit has been reached and
			// 2. the number of on-disk-pools limit has been reached
			my_mutex_lock(&lat_lck);
			last_added_to++;
			last_added_to %= pool_vector.size();
			index = last_added_to;
			my_mutex_unlock(&lat_lck);

			left = calc_time_left(start_ts, max_time);

			if (pool_vector.at(index) -> timed_lock_object(left))
				index = -1;
		}
	}

	if (index != -1)
	{
		my_mutex_lock(&lat_lck);
		last_added_to = index;
		my_mutex_unlock(&lat_lck);
	}

	return index;
}

int pools::get_bit_sum_unlocked(double max_duration)
{
	double start_ts = get_ts();

	int bit_count = 0;
	unsigned int n = pool_vector.size();
	for(unsigned int index=0; index<n; index++)
	{
		double time_left = calc_time_left(start_ts, index, n, max_duration);

		if (!pool_vector.at(index) -> timed_lock_object(time_left))
		{
			bit_count += pool_vector.at(index) -> get_n_bits_in_pool();

			pool_vector.at(index) -> unlock_object();
		}
	}

	return bit_count;
}

int pools::get_bits_from_pools(int n_bits_requested, unsigned char **buffer, bool allow_prng, bool ignore_rngtest_fips140, fips140 *pfips, bool ignore_rngtest_scc, scc *pscc, double max_duration, pool_crypto *pc)
{
	my_assert(n_bits_requested > 0);

	pthread_testcancel();
	pthread_check(pthread_setcancelstate(PTHREAD_CANCEL_DISABLE, NULL), "pthread_setcancelstate");

	double start_ts = get_ts();

	int n_to_do_bytes = (n_bits_requested + 7) / 8;
	int n_to_do_bits = n_to_do_bytes * 8;
	int n_bits_retrieved = 0;

	unsigned char *cur_p = *buffer = reinterpret_cast<unsigned char *>(malloc_locked(n_to_do_bytes + 1));
	if (!cur_p)
		error_exit("transmit_bits_to_client memory allocation failure");

	// load bits from disk if needed
	bool have_bits = true;
	for(;;)
	{
		list_rlock();
		if (!have_bits)
			break;

		int bits_needed_to_load = n_bits_requested - get_bit_sum_unlocked(max_duration);

		// no unlock in the break: need to have the list locked later on
		if (bits_needed_to_load <= 0)
			break;

		// a 'list_relock' would be nice
		list_runlock();
		pthread_testcancel();
		list_wlock();

		merge_pools(pc);
		flush_empty_pools();

		// due to the un- and relock this might have changed
		// also merging pools might change this value
		have_bits = load_caches(bits_needed_to_load, pc);

		list_wunlock();
		pthread_testcancel();
	}
	// at this point the list is read locked

	unsigned int n = pool_vector.size();

	int pool_block_size = -1, get_per_pool_n = -1;
	if (n == 0)
	{
		pool_block_size = pc -> get_hasher() -> get_hash_size() / 2;
		get_per_pool_n = std::max(pool_block_size, n_bits_requested);
	}
	else
	{
		pool_block_size = pool_vector.at(0) -> get_get_size();
		get_per_pool_n = std::max(pool_block_size, n_bits_requested / int(n));
	}
	get_per_pool_n = std::min(get_per_pool_n, new_pool_size);

	int index_offset = rand();
	if (index_offset >= INT_MAX - int(n + 1))
		index_offset /= 2;

	int round = 0;

	for(;n_to_do_bits > 0 && round < 2;)
	{
		// please note: it is not required that this offset is cryptographically
		// random, it is only used to "spread the load" over all the pools
		for(unsigned int loop_index=0; loop_index<n && n_to_do_bits > 0; loop_index++)
		{
			int index = abs((int)(loop_index + index_offset)) % n;

			double time_left = calc_time_left(start_ts, loop_index, n, max_duration);

			pthread_cond_t *cond = NULL;
			if (round > 0)
				cond = pool_vector.at(index) -> timed_lock_object(time_left);
			else
				cond = pool_vector.at(index) -> lock_object();

			if (!cond)
			{
				int cur_n_to_get_bits = (round > 0 && allow_prng) ? get_per_pool_n : n_to_do_bits;
				int cur_n_to_get_bytes = (cur_n_to_get_bits + 7) / 8;

				unsigned int got_n_bytes = pool_vector.at(index) -> get_entropy_data(cur_p, cur_n_to_get_bytes, round > 0 ? allow_prng : false, pc);
				unsigned int got_n_bits = got_n_bytes * 8;

				if (got_n_bits > 0 && verify_quality(cur_p, got_n_bytes, ignore_rngtest_fips140, pfips, ignore_rngtest_scc, pscc))
				{
					cur_p += got_n_bytes;
					n_to_do_bits -= got_n_bits;
					n_bits_retrieved += got_n_bits;

					dolog(LOG_DEBUG, "Retrieved %d bits from pool %d", got_n_bits, index);
				}

				pool_vector.at(index) -> unlock_object();
			}
		}

		round++;
	}

	list_runlock();

	pthread_check(pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, NULL), "pthread_setcancelstate");
	pthread_testcancel();

	return n_bits_retrieved;
}

int pools::add_bits_to_pools(unsigned char *data, int n_bytes, bool ignore_rngtest_fips140, fips140 *pfips, bool ignore_rngtest_scc, scc *pscc, double max_duration, pool_crypto *pc)
{
	my_assert(n_bytes > 0);

	pthread_testcancel();
	pthread_check(pthread_setcancelstate(PTHREAD_CANCEL_DISABLE, NULL), "pthread_setcancelstate");

	double start_ts = get_ts();

	int n_bits_added = 0;
	int start_n = n_bytes;

	int round = 0, n_was_locked = 0;
	bool first = true;
	while(n_bytes > 0)
	{
		if (first)
		{
			list_rlock();
			first = false;
		}

		int n = pool_vector.size();

		list_runlock();
		pthread_testcancel();

		double time_left = calc_time_left(start_ts, start_n - n_bytes, start_n, max_duration);

		int index = select_pool_to_add_to(round > 0, time_left, pc); // returns a locked object
		// the list is now read-locked

		if (index == -1)
		{
			if (++n_was_locked >= n)
			{
				n_was_locked = 0;
				round++;
			}
		}
		else
		{
			int space_available = pool_vector.at(index) -> get_pool_size() - pool_vector.at(index) -> get_n_bits_in_pool();
			// in that case we're already mixing in so we can change all data anyway
			// this only happens when all pools are full
			if (space_available <= pool_vector.at(index) -> get_get_size_in_bits())
				space_available = pool_vector.at(index) -> get_pool_size();

			unsigned int n_bytes_to_add = std::min(n_bytes, (space_available + 7) / 8);
			dolog(LOG_DEBUG, "Adding %d bits to pool %d", n_bytes_to_add * 8, index);

			if (verify_quality(data, n_bytes_to_add, ignore_rngtest_fips140, pfips, ignore_rngtest_scc, pscc))
				n_bits_added += pool_vector.at(index) -> add_entropy_data(data, n_bytes_to_add, pc);

			n_bytes -= n_bytes_to_add;
			data += n_bytes_to_add;

			pool_vector.at(index) -> unlock_object();
		}
	}

	list_runlock();

	pthread_check(pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, NULL), "pthread_setcancelstate");
	pthread_testcancel();

	return n_bits_added;
}

int pools::get_bit_sum(double max_duration)
{
	pthread_testcancel();
	pthread_check(pthread_setcancelstate(PTHREAD_CANCEL_DISABLE, NULL), "pthread_setcancelstate");

	list_rlock();
	int bit_count = get_bit_sum_unlocked(max_duration);
	list_runlock();

	pthread_check(pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, NULL), "pthread_setcancelstate");
	pthread_testcancel();

	return bit_count;
}

int pools::add_event(long double event, unsigned char *event_data, int n_event_data, double max_time, pool_crypto *pc)
{
	pthread_testcancel();
	pthread_check(pthread_setcancelstate(PTHREAD_CANCEL_DISABLE, NULL), "pthread_setcancelstate");

	int index = select_pool_to_add_to(true, max_time, pc); // returns a locked object
	// the list is now read-locked and the object as well

	int rc = 0;
	if (index != -1)
	{
		rc = pool_vector.at(index) -> add_event(event, event_data, n_event_data, pc);

		pool_vector.at(index) -> unlock_object();
	}

	list_runlock();

	pthread_check(pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, NULL), "pthread_setcancelstate");
	pthread_testcancel();

	return rc;
}

bool pools::all_pools_full(double max_duration)
{
	pthread_testcancel();
	pthread_check(pthread_setcancelstate(PTHREAD_CANCEL_DISABLE, NULL), "pthread_setcancelstate");

	double start_ts = get_ts();

	bool rc = true;

	list_rlock();

	unsigned int n = pool_vector.size();

	if (n < max_n_mem_pools)
		rc = false;
	else
	{
		for(unsigned int loop=0; loop<n; loop++)
		{
			double time_left = calc_time_left(start_ts, loop, n, max_duration);

			if (!pool_vector.at(loop) -> timed_lock_object(time_left))
			{
				if (!pool_vector.at(loop) -> is_almost_full())
				{
					pool_vector.at(loop) -> unlock_object();

					rc = false;
					break;
				}

				pool_vector.at(loop) -> unlock_object();
			}
		}
	}

	list_runlock();

	pthread_check(pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, NULL), "pthread_setcancelstate");
	pthread_testcancel();

	return rc;
}

int pools::get_memory_pool_count()
{
	list_rlock();
	int n = pool_vector.size();
	list_runlock();

	return n;
}

int pools::get_disk_pool_count()
{
	list_rlock();
	int n = cache_list.size();
	list_runlock();

	return n;
}

int pools::get_disk_pool_bit_count()
{
	int bit_sum = 0;

	list_rlock();
	for(unsigned int index=0; index<cache_list.size(); index++)
		bit_sum += cache_list.at(index).second;
	list_runlock();

	return bit_sum;
}