File: twmap.hh

package info (click to toggle)
weakforced 3.0.0-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 3,040 kB
  • sloc: cpp: 20,397; python: 2,002; sh: 700; makefile: 432
file content (990 lines) | stat: -rw-r--r-- 32,647 bytes parent folder | download
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
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
/*
 * This file is part of PowerDNS or weakforced.
 * Copyright -- PowerDNS.COM B.V. and its contributors
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of version 3 of the GNU General Public License as
 * published by the Free Software Foundation.
 *
 * In addition, for the avoidance of any doubt, permission is granted to
 * link this program with OpenSSL and to (re)distribute the binaries
 * produced as the result of such linking.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#pragma once
#include <string>
#include <vector>
#include <memory>
#include <map>
#include <unordered_map>
#include <ctime>
#include <atomic>
#include <mutex>
#include <thread>
#include <boost/variant.hpp>
#include <boost/optional.hpp>
#include <iostream>
#include <sstream>
#include "ext/hyperloglog.hpp"
#include "ext/count_min_sketch.hpp"
#include "iputils.hh"
#include "dolog.hh"
#include "wforce_ns.hh"
#include "ext/threadname.hh"

using std::thread;

class TWStatsMember;

typedef std::unique_ptr<TWStatsMember> TWStatsMemberP;
typedef std::vector<std::pair<std::time_t, TWStatsMemberP>> TWStatsBuf;

// Not all stats member subclasses will implement all of these methods in a useful way (e.g. add string is meaningless to an integer-based class)
class TWStatsMember
{
public:
  virtual ~TWStatsMember() = default;
  virtual void add(int a) = 0; // add an integer to the stored value
  virtual void add(const std::string& s) = 0; // add a string to the stored window (this has different semantics for each subclass)
  virtual void add(const std::string& s, int a) = 0; // add a string/integer combo to the stored window (only applies to some stats types)
  virtual void sub(int a) = 0; // subtract an integer from the stored value
  virtual void sub(const std::string& s) = 0; // remove a string from the stored value
  virtual int get() = 0; // return the current stat
  virtual int get(const std::string& s) = 0; // return the current stat
  virtual void set(int) = 0; // Set the stored value to the supplied integer
  virtual void set(const std::string& s) = 0; // Set the stored value based on the supplied string
  virtual void erase() = 0; // Remove all data - notice this isn't necessarily the same as set(0) or set("")
  virtual int sum(const TWStatsBuf& vec) = 0; // combine an array of stored values
  virtual int sum(const std::string& s, const TWStatsBuf& vec) = 0; // combine an array of stored values
  virtual void dump(std::ostream& os) = 0; // serialize a TWStatsMember
  virtual void restore(std::istream& is) = 0; // unserialize a TWStatsMember
};

class TWStatsMemberInt : public TWStatsMember
{
public:
  TWStatsMemberInt() {}
  TWStatsMemberInt(const TWStatsMemberInt&) = delete;
  TWStatsMemberInt& operator=(const TWStatsMemberInt&) = delete;
  TWStatsMemberInt(TWStatsMemberInt&&) = delete; // move construct
  TWStatsMemberInt& operator=(TWStatsMemberInt &&) = delete; // move assign
  void add(int a) override { i += a; }
  void add(const std::string& s) override { int a = std::stoi(s); i += a; return; }
  void add(const std::string& s, int a) override { return; }
  void sub(int a) override { i -= a;  }
  void sub(const std::string& s) override { int a = std::stoi(s); i -= a; return; }
  int get() override { return i; }
  int get(const std::string& s) override { return i; }
  void set(int a) override { i = a; }
  void set(const std::string& s) override { return; }
  void erase() override { i = 0; }
  int sum(const TWStatsBuf& vec) override
  {
    int count = 0;
    for (auto a=vec.begin(); a!=vec.end(); ++a)
      {
        count += a->second->get();
      }
    return count;
  }
  int sum(const std::string& s, const TWStatsBuf& vec) override { return 0; }
  void dump(std::ostream& os) override {
    uint32_t neti = htonl(i);
    os.write((char*)&neti, sizeof(neti));
    if(os.fail()) {
      throw std::runtime_error("TWStatsMemberInt: Failed to dump");
    }
  }
  void restore(std::istream& is) override {
    uint32_t neti = 0;
    is.read((char*)&neti, sizeof(neti));
    i = ntohl(neti);
  }
private:
  int i=0;
};

#define HLL_NUM_REGISTER_BITS 6

class TWStatsMemberHLL : public TWStatsMember
{
public:
  TWStatsMemberHLL()
  {
    hllp = wforce::make_unique<hll::HyperLogLog>(num_bits);
  }
  TWStatsMemberHLL(const TWStatsMemberHLL&) = delete;
  TWStatsMemberHLL& operator=(const TWStatsMemberHLL&) = delete;
  TWStatsMemberHLL(TWStatsMemberHLL&&) = delete; // move construct
  TWStatsMemberHLL& operator=(TWStatsMemberHLL &&) = delete; // move assign
  void add(int a) override { std::string str; str = std::to_string(a); hllp->add(str.c_str(), str.length()); return; }
  void add(const std::string& s) override { hllp->add(s.c_str(), s.length()); }
  void add(const std::string& s, int a) override { return; }
  void sub(int a) override { return; }
  void sub(const std::string& s) override { return; }
  int get() override { return std::lround(hllp->estimate()); }
  int get(const std::string& s) override { hllp->add(s.c_str(), s.length()); return std::lround(hllp->estimate()); } // add and return value
  void set(int a) override { return; }
  void set(const std::string& s) override { hllp->clear(); hllp->add(s.c_str(), s.length()); }
  void erase() override { hllp->clear(); }
  int sum(const TWStatsBuf& vec) override
  {
    hll::HyperLogLog hllsum(num_bits);
    for (auto a = vec.begin(); a != vec.end(); ++a)
      {
	// XXX yes not massively pretty
	hllsum.merge(*((dynamic_cast<TWStatsMemberHLL&>(*(a->second))).hllp));
      }
    return std::lround(hllsum.estimate());
  }
  int sum(const std::string& s, const TWStatsBuf& vec) override { return 0; }
  void dump(std::ostream& os) override {
    hllp->dump(os);
  }
  void restore(std::istream& is) override {
    hllp->restore(is);
  }
  static void setNumBits(unsigned int nbits) {
    if (nbits < 4)
      nbits = 4;
    if (num_bits >30)
      nbits = 30;
    num_bits = nbits;
  }
private:
  std::unique_ptr<hll::HyperLogLog> hllp;
  static unsigned int num_bits;
};

#define COUNTMIN_EPS 0.05
#define COUNTMIN_GAMMA 0.2

class TWStatsMemberCountMin : public TWStatsMember
{
public:
  TWStatsMemberCountMin()
  {
    cm = wforce::make_unique<CountMinSketch>(eps, gamma);
  }
  TWStatsMemberCountMin(const TWStatsMemberCountMin&) = delete;
  TWStatsMemberCountMin& operator=(const TWStatsMemberCountMin&) = delete;
  TWStatsMemberCountMin(TWStatsMemberCountMin&&) = delete; // move construct
  TWStatsMemberCountMin& operator=(TWStatsMemberCountMin &&) = delete; // move assign
  void add(int a) override { return; }
  void add(const std::string& s) override { cm->update(s.c_str(), 1); }
  void add(const std::string& s, int a) override { cm->update(s.c_str(), a); }
  void sub(int a) override { return; }
  void sub(const std::string& s) override { return; }
  int get() override { return cm->totalcount(); }
  int get(const std::string& s) override { return cm->estimate(s.c_str()); }
  void set(int a) override { return; }
  void set(const std::string& s) override { return; }
  void erase() override { cm->erase(); return; }
  int sum(const TWStatsBuf& vec) override
  {
    int count = 0;
    for (auto a=vec.begin(); a!=vec.end(); ++a)
      {
	count += a->second->get();
      }
    return count;
  }
  int sum(const std::string&s, const TWStatsBuf& vec) override
  {
    int count = 0;
    for (auto a=vec.begin(); a!=vec.end(); ++a)
      {
	count += a->second->get(s);
      }
    return count;
  }
  void dump(std::ostream& os) override {
    cm->dump(os);
  }
  void restore(std::istream& is) override {
    cm->restore(is);
  }
  static void setGamma(float g)
  {
    if (g > 1)
      g = 1;
    if (g < 0)
      g = 0;
    gamma = g;
  }
  static void setEPS(float e)
  {
    if (e < 0.01)
      e = 0.01;
    if (e > 1)
      e = 1;
    eps = e;
  }
private:
  std::unique_ptr<CountMinSketch> cm;
  static float eps;
  static float gamma;
};

template<typename T> TWStatsMemberP createInstance() { return wforce::make_unique<T>(); }

typedef std::map<std::string, TWStatsMemberP(*)()> map_type;

// The idea here is that the type mechanism is extensible, e.g. could add a bloom filter etc.
// XXX Should make this dynamically extensible
class TWStatsTypeMap
{
public:
  map_type type_map;
  static TWStatsTypeMap& getInstance()
  {
    // this is thread-safe in C++11
    static TWStatsTypeMap myInstance;
    return myInstance;
  }
  TWStatsTypeMap(const TWStatsTypeMap& src) = delete; // copy construct
  TWStatsTypeMap(TWStatsTypeMap&&) = delete; // move construct
  TWStatsTypeMap& operator=(const TWStatsTypeMap& rhs) = delete; // copy assign
  TWStatsTypeMap& operator=(TWStatsTypeMap &&) = delete; // move assign
  
protected:
  TWStatsTypeMap()
  {
    type_map["int"] = &createInstance<TWStatsMemberInt>;
    type_map["hll"] = &createInstance<TWStatsMemberHLL>;
    type_map["countmin"] = &createInstance<TWStatsMemberCountMin>;
  }
};

typedef std::vector<std::pair<std::time_t, std::stringstream>> TWStatsBufSerial;

// this class is not protected by mutexes because it sits behind TWStatsDB which has a mutex
// controlling all access
class TWStatsEntry
{
public:
  TWStatsEntry(int nw, int ws, std::time_t st, const std::string& field_type) :
    num_windows(nw), window_size(ws), start_time(st)
  {
    auto& field_types = TWStatsTypeMap::getInstance();
    
    auto it = field_types.type_map.find(field_type);
    if (it != field_types.type_map.end()) {
      for (int i=0; i< num_windows; i++) {
	stats_array.push_back(std::pair<std::time_t, TWStatsMemberP>((std::time_t)0, it->second()));
      }
    }
  }

  // prevent copies at compile time
  TWStatsEntry(const TWStatsEntry&) = delete;
  TWStatsEntry& operator=(const TWStatsEntry&) = delete;

  void add(int a) {
    clean_windows();
    int cur_window = current_window();
    auto& sm = stats_array[cur_window];
    sm.second->add(a);
    update_write_timestamp(cur_window);
  }
  void add(const std::string& s) {
    clean_windows();
    int cur_window = current_window();
    auto& sm = stats_array[cur_window];
    sm.second->add(s);
    update_write_timestamp(cur_window);
  }
  void add(const std::string& s, int a) {
    clean_windows();
    int cur_window = current_window();
    auto& sm = stats_array[cur_window];
    sm.second->add(s, a);
    update_write_timestamp(cur_window);
  }
  void sub(int a) {
    clean_windows();
    int cur_window = current_window();
    auto& sm = stats_array[cur_window];
    sm.second->sub(a);
    update_write_timestamp(cur_window);
  }
  void sub(const std::string& s) {
    clean_windows();
    int cur_window = current_window();
    auto& sm = stats_array[cur_window];
    sm.second->sub(s);
    update_write_timestamp(cur_window);
  }
  int get() {
    clean_windows();
    int cur_window = current_window();
    return stats_array[cur_window].second->get();
  }
  int get(const std::string& s) {
    clean_windows();
    int cur_window = current_window();
    return stats_array[cur_window].second->get(s);
  }
  int get_current() { 
    clean_windows();
    int cur_window = current_window();
    return stats_array[cur_window].second->get();
  }
  int get_current(const std::string& s) {
    clean_windows();
    int cur_window = current_window();
    return stats_array[cur_window].second->get(s);    
  }
  void get_windows(std::vector<int>& ret_vec) {
    clean_windows();
    int cur_window = current_window();
    for (int i=cur_window+num_windows; i>cur_window; i--) {
      int index = i % num_windows;
      ret_vec.push_back(stats_array[index].second->get());
    }
  }
  void get_windows(const std::string& s, std::vector<int>& ret_vec) {
    clean_windows();
    int cur_window = current_window();
    for (int i=cur_window+num_windows; i>cur_window; i--) {
      int index = i % num_windows;
      ret_vec.push_back(stats_array[index].second->get(s));
    }
  }
  int sum() {
    clean_windows();
    int cur_window = current_window();
    if (sum_cache_valid == true)
      return sum_cache_value;
    else {
      sum_cache_value = stats_array[cur_window].second->sum(stats_array);
      return sum_cache_value;
    }
  }
  int sum(const std::string& s) {
    clean_windows();
    int cur_window = current_window();
    if (ssum_cache_valid == true)
      return ssum_cache_value;
    else {
      ssum_cache_value = stats_array[cur_window].second->sum(s, stats_array);
      return ssum_cache_value;
    }
  }
  void reset() {
    for (TWStatsBuf::iterator i = stats_array.begin(); i != stats_array.end(); ++i) {
      i->second->erase();
      i->first = 0;
    }
    sum_cache_valid = false;
    ssum_cache_valid = false;
  }
  void dump(TWStatsBufSerial& statsvec, std::time_t& stime)
  {
    for (TWStatsBuf::iterator i = stats_array.begin(); i != stats_array.end(); ++i) {
      std::stringstream ss;
      i->second->dump(ss);
      statsvec.emplace_back(std::make_pair(i->first, std::move(ss)));
    }
    stime = start_time;
  }
  void restore(TWStatsBufSerial& statsvec, std::time_t stime)
  {
    start_time = stime;
    last_cleaned = 0;
    sum_cache_valid = false;
    ssum_cache_valid = false;
    unsigned int j = 0;
    for (auto i = statsvec.begin(); i != statsvec.end(); ++i, ++j) {
      stats_array[j].first = i->first;
      stats_array[j].second->restore(i->second);
    }
  }
protected:
  void update_write_timestamp(int cur_window)
  {
    std::time_t now, write_time;
    std::time(&now);
    // only do this if the window first mod time is 0
    if (stats_array[cur_window].first == 0) {
      write_time = now - ((now - start_time) % window_size);
      stats_array[cur_window].first = write_time;
    }
    sum_cache_valid = false;
    ssum_cache_valid = false;
  }
  int current_window() {
    std::time_t now, diff;
    std::time(&now);
    diff = now - start_time;
    int cw = (diff/window_size) % num_windows;
    return cw;
  }
  void clean_windows()
  {
    // this function checks the time difference since each array member was first written
    // and expires (zeros) any windows as necessary. This needs to be done before any data is read or written
    std::time_t now, expire_diff;
    std::time(&now);
    expire_diff = window_size * num_windows;

    // optimization - only clean windows if they need cleaning
    if ((now-last_cleaned) < window_size)
      return;

    for (TWStatsBuf::iterator i = stats_array.begin(); i != stats_array.end(); ++i) {
      std::time_t last_write = i->first;
      if ((last_write != 0) && (now - last_write) >= expire_diff) {
	i->second->erase();
	i->first = 0;
	sum_cache_valid = false;
	ssum_cache_valid = false;
      }
    }
    last_cleaned = now;
  }
private:
  TWStatsBuf stats_array;
  int num_windows;
  int window_size;
  std::time_t start_time;
  std::time_t last_cleaned{0};
  bool sum_cache_valid = false;
  int sum_cache_value = 0;
  bool ssum_cache_valid = false;
  int ssum_cache_value = 0;
};

typedef std::unique_ptr<TWStatsEntry> TWStatsEntryP;

// key is field name, value is field type
typedef std::map<std::string, std::string> FieldMap;
// key is field name, value is a start time and a bunch of time windows
typedef std::map<std::string, std::pair<std::time_t, TWStatsBufSerial>> TWStatsDBDumpEntry;
// A vector of field name plus the count from each of the windows
typedef std::vector<std::pair<std::string, std::vector<int>>> TWStatsDBEntry;

const unsigned int ctwstats_map_size_soft = 524288;

template <typename T>
class TWStatsDB
{
public:
  typedef std::list<T> TWKeyTrackerType;
  explicit TWStatsDB(const std::string& name, int w_siz, int num_w)
  {
    window_size = w_siz ? w_siz : 1;
    num_windows = num_w ? num_w : 1;
    std::time(&start_time);
    map_size_soft = ctwstats_map_size_soft;
    db_name = name;
  }
  // detect attempts to copy at compile time
  TWStatsDB(const TWStatsDB&) = delete;
  TWStatsDB& operator=(const TWStatsDB&) = delete;
  
  std::string getDBName()
  {
    return db_name;
  }
  
  static void twExpireThread(std::shared_ptr<TWStatsDB<std::string>> sdbp)
  {
    setThreadName("wf/tw-expire");
    sdbp->expireEntries();
  }	
  void expireEntries();
  bool setFields(const FieldMap& fields);
  const FieldMap& getFields() {
    return field_map;
  }
  void incr(const T& key, const std::string& field_name);
  void decr(const T& key, const std::string& field_name);
  void add(const T& key, const std::string& field_name, int a); 
  void add(const T& key, const std::string& field_name, const std::string& s); 
  void add(const T& key, const std::string& field_name, const std::string& s, int a); 
  void sub(const T& key, const std::string& field_name, int a); 
  void sub(const T& key, const std::string& field_name, const std::string& s); 
  int get(const T& key, const std::string& field_name); // gets all values summed/combined over all windows
  int get(const T& key, const std::string& field_name, const std::string& s); // gets all values summed/combined over all windows for a particular value
  int get_current(const T& key, const std::string& field_name); // gets the value just for the current window
  int get_current(const T& key, const std::string& field_name, const std::string& s); // gets the value just for the current window for a particular value
  bool get_windows(const T& key, const std::string& field_name, std::vector<int>& ret_vec); // gets each window value returned in a vector
  bool get_windows(const T& key, const std::string& field_name, const std::string& s, std::vector<int>& ret_vec); // gets each window value returned in a vector for a particular value
  bool get_all_fields(const T& key,  std::vector<std::pair<std::string, int>>& ret_vec);
  bool get_all_fields_windows(const T& key,  TWStatsDBEntry& ret_vec) const;
  void reset(const T&key); // Reset to zero all fields for a given key
  void reset_field(const T&key, const std::string& field_name); // Reset to zero a particular field
  void set_map_size_soft(unsigned int size);
  unsigned int get_size();
  unsigned int get_max_size();
  uint8_t getv4Prefix() { return v4_prefix; }
  uint8_t getv6Prefix() { return v6_prefix; }
  void setv4Prefix(uint8_t prefix) { v4_prefix = prefix; }
  void setv6Prefix(uint8_t prefix) { v6_prefix = prefix; }
  int windowSize() { return window_size; }
  int numWindows() { return num_windows; }
  void set_expire_sleep(unsigned int ms) { expire_ms = ms; }
  // This function is very dangerous since it relies on later calling endDBDump() to unlock the mutex
  // But it is essential, otherwise the iterator will become garbage as the DB is modified
  typename TWKeyTrackerType::const_iterator startDBDump() const
  {
    mutx.lock();
    return key_tracker.cbegin();
  }
  // While the mutex is being held, no modifications can be made to the DB;
  // this could cause replication packets to get backed up and lost
  bool DBDumpEntry(typename TWKeyTrackerType::const_iterator& i,
                   TWStatsDBDumpEntry& entry,
                   T& key) const
  {
    const auto it = stats_db.find(*i);
    if (it != stats_db.end()) {
      key = it->first;
      for (auto fm = it->second.second.begin(); fm != it->second.second.end(); ++fm) {
        TWStatsBufSerial sbs;
        std::time_t stime;
        fm->second->dump(sbs, stime);
        entry.emplace(std::make_pair(fm->first, std::make_pair(stime, std::move(sbs))));
      }
      return true;
    }
    return false;
  }
  // This returns counts for each of the windows rather than the serialized
  // internal data which DBDumpEntry returns
  bool DBGetEntry(typename TWKeyTrackerType::const_iterator& i,
                  TWStatsDBEntry& ret_vec,
                  T& key) const
  {
    const auto it = stats_db.find(*i);
    if (it != stats_db.end()) {
      key = it->first;
      get_all_fields_windows_unsafe(key, ret_vec);
      return true;
    }
    return false;
  }
  const typename TWKeyTrackerType::const_iterator DBDumpIteratorEnd() const
  {
    return key_tracker.cend();
  }
  void endDBDump() const
  {
    mutx.unlock();
  }
  // Restore StatsDB entries
  void restoreEntry(const T& key, TWStatsDBDumpEntry& entry)
  {
    for (auto fm = entry.begin(); fm != entry.end(); ++fm) {
      find_create_key_field(key, fm->first, [fm, this](std::map<std::string, TWStatsEntryP>::iterator it, typename TWKeyTrackerType::iterator& kt)
			    {
			      it->second->restore(fm->second.second, fm->second.first);
			      this->update_write_timestamp(kt);
			    });
    }
  }
protected:
  template<typename Fn>
  bool find_create_key_field(const T& key, const std::string& field_name,
					   Fn fn);
  template<typename Fn>
  bool find_key_field(const T& key, const std::string& field_name,
					   Fn fn);
  template<typename Fn>
  bool _find_create_key_field(const T& key, const std::string& field_name,
					   Fn fn, bool create);
  // This function does not lock the mutex
  bool get_all_fields_windows_unsafe(const T& key,  TWStatsDBEntry& ret_vec) const;
  
void update_write_timestamp(typename TWKeyTrackerType::iterator& kt)
  {
    // this is always called from a mutex lock (or should be)
    // move this key to the end of the key tracker list
    key_tracker.splice(key_tracker.end(),
		       key_tracker,
		       kt);
  }
private:
  TWKeyTrackerType key_tracker;
  typedef std::unordered_map<T, std::pair<typename TWKeyTrackerType::iterator, std::map<std::string, TWStatsEntryP>>> TWStatsDBMap;
  TWStatsDBMap stats_db;
  FieldMap field_map;
  int window_size;
  int num_windows;
  unsigned int map_size_soft;
  std::time_t start_time;
  mutable std::mutex mutx;
  std::string db_name;
  uint8_t v4_prefix=32;
  uint8_t v6_prefix=128;
  unsigned int expire_ms=250; // expiry thread sleep time
};

// Template methods
template <typename T>
bool TWStatsDB<T>::setFields(const FieldMap& fields)
{
  auto& field_types = TWStatsTypeMap::getInstance();
  for (auto f : fields) {
    if (field_types.type_map.find(f.second) == field_types.type_map.end()) {
      return false;
    }
  }
  field_map = fields;
  return true;
}

template <typename T>
void TWStatsDB<T>::expireEntries()
{
  struct timespec wait_interval;
  // spend some time every now and again expiring entries which haven't been updated
  if (expire_ms >= 1000) {
    wait_interval.tv_sec = expire_ms / 1000;
    wait_interval.tv_nsec = (expire_ms % 1000) * 1000000;
  }
  else {
    wait_interval.tv_sec = 0;
    wait_interval.tv_nsec = expire_ms * 1000000;
  }
  
  for (;;) {
    nanosleep(&wait_interval, nullptr);
    {
      std::lock_guard<std::mutex> lock(mutx);
  
      // don't bother expiring if the map isn't too big
      if (stats_db.size() <= map_size_soft)
	continue;

      unsigned int num_expire = stats_db.size() - map_size_soft;
      unsigned int num_expired = num_expire;

      vinfolog("About to expire %d entries from stats db %s", num_expire, db_name);

      // this just uses the front of the key tracker list, which always contains the Least Recently Modified keys
      while (num_expire--) {
	const typename TWStatsDBMap::iterator it = stats_db.find(key_tracker.front());
	if (it != stats_db.end()) {
	  stats_db.erase(it);
	  key_tracker.pop_front();
	}
      }
      vinfolog("Finished expiring %d entries from stats db %s", num_expired, db_name);
    }
  }
}

template <typename T>
template <typename Fn>
bool TWStatsDB<T>::find_key_field(const T& key, const std::string& field_name, Fn fn)
{
  std::lock_guard<std::mutex> lock(mutx);
  return _find_create_key_field(key, field_name, fn, false);
}

template <typename T>
template <typename Fn>
bool TWStatsDB<T>::find_create_key_field(const T& key, const std::string& field_name,
					 Fn fn)
{
  std::lock_guard<std::mutex> lock(mutx);
  return _find_create_key_field(key, field_name, fn, true);
}

template <typename T>
template <typename Fn>
bool TWStatsDB<T>::_find_create_key_field(const T& key, const std::string& field_name,
					  Fn fn, bool create)
{
  bool retval = false;

  // first check if the field name is in the field map - if not we throw the query out straight away
  auto myfield = field_map.find(field_name);
  if (myfield == field_map.end())
    return false;

  // Now we get the field type from the registered field types map
  auto& field_types = TWStatsTypeMap::getInstance();
  auto mytype = field_types.type_map.find(myfield->second);
  if (mytype == field_types.type_map.end())
    return false;

  // otherwise look to see if the key and field name have been already inserted
  auto mysdb = stats_db.find(key);
  if (mysdb != stats_db.end()) {
    // the key already exists let's look for the field
    auto myfm = mysdb->second.second.find(field_name);
    if (myfm != mysdb->second.second.end()) {
      // awesome this key/field combination has already been created so call the supplied lambda
      fn(myfm, mysdb->second.first);
      retval = true;
    }
    else {
      if (create) {
	// if we get here it means the key exists, but not the field so we need to add it
	mysdb->second.second.emplace(std::make_pair(field_name, wforce::make_unique<TWStatsEntry>(num_windows, window_size, start_time, mytype->first)));
	retval = _find_create_key_field(key, field_name, fn, false);
      }
    }
  }
  else {
    if (create) {
      // if we get here, we have no key and no field
      // add the key at the end of the key tracker list
      typename TWKeyTrackerType::iterator kit = key_tracker.insert(key_tracker.end(), key);
      std::map<std::string, TWStatsEntryP> myfm;
      myfm.emplace(std::make_pair(field_name, wforce::make_unique<TWStatsEntry>(num_windows, window_size, start_time, mytype->first)));
      stats_db.emplace(std::make_pair(key, std::make_pair(kit, std::move(myfm))));
      retval = _find_create_key_field(key, field_name, fn, false);
    }
  }
  return(retval);
}


template <typename T>
void TWStatsDB<T>::incr(const T& key, const std::string& field_name)
{
  add(key, field_name, 1);
}

template <typename T>
void TWStatsDB<T>::decr(const T& key, const std::string& field_name)
{
  sub(key, field_name, 1);
}

template <typename T>
void TWStatsDB<T>::add(const T& key, const std::string& field_name, int a)
{
  find_create_key_field(key, field_name, [a, this](std::map<std::string, TWStatsEntryP>::iterator it, typename TWKeyTrackerType::iterator& kt)
			    {
			      it->second->add(a);
			      this->update_write_timestamp(kt);
			    });
}

template <typename T>
void TWStatsDB<T>::add(const T& key, const std::string& field_name, const std::string& s)
{
  find_create_key_field(key, field_name, [s, this](std::map<std::string, TWStatsEntryP>::iterator it, typename TWKeyTrackerType::iterator& kt)
			{
			  it->second->add(s);
			  this->update_write_timestamp(kt);
			});
}

template <typename T>
void TWStatsDB<T>::add(const T& key, const std::string& field_name, const std::string& s, int a)
{
  find_create_key_field(key, field_name, [&s, a, this](std::map<std::string, TWStatsEntryP>::iterator it, typename TWKeyTrackerType::iterator& kt)
			{
			  it->second->add(s, a);
			  this->update_write_timestamp(kt);
			});
}

template <typename T>
void TWStatsDB<T>::sub(const T& key, const std::string& field_name, int a)
{
  find_create_key_field(key, field_name, [a, this](std::map<std::string, TWStatsEntryP>::iterator it, typename TWKeyTrackerType::iterator& kt)
			{
			  it->second->sub(a);
			  update_write_timestamp(kt);
			});
}

template <typename T>
void TWStatsDB<T>::sub(const T& key, const std::string& field_name, const std::string& s)
{
  find_create_key_field(key, field_name, [s, this](std::map<std::string, TWStatsEntryP>::iterator it, typename TWKeyTrackerType::iterator& kt)
			{
			  it->second->sub(s);
			  update_write_timestamp(kt);
			});
}

template <typename T>
int TWStatsDB<T>::get(const T& key, const std::string& field_name)
{
  int retval=0;
  
  find_key_field(key, field_name, [&retval](std::map<std::string, TWStatsEntryP>::iterator it, typename TWKeyTrackerType::iterator& kt)
		 {
		   retval = it->second->sum();
		 });
  return retval;
}

template <typename T>
int TWStatsDB<T>::get(const T& key, const std::string& field_name, const std::string& s)
{
  int retval=0;
  
  find_key_field(key, field_name, [&retval, s](std::map<std::string, TWStatsEntryP>::iterator it, typename TWKeyTrackerType::iterator& kt)
		 {
		   retval = it->second->sum(s);
		 });
  return retval;
}

template <typename T>
int TWStatsDB<T>::get_current(const T& key, const std::string& field_name)
{
  int retval=0;
  
  find_key_field(key, field_name, [&retval](std::map<std::string, TWStatsEntryP>::iterator it, typename TWKeyTrackerType::iterator& kt)
		 {
		   retval = it->second->get();
		 });
  return retval;
}

template <typename T>
int TWStatsDB<T>::get_current(const T& key, const std::string& field_name, const std::string& val)
{
  int retval=0;
  
  find_key_field(key, field_name, [&retval, val](std::map<std::string, TWStatsEntryP>::iterator it, typename TWKeyTrackerType::iterator& kt)
		 {
		   retval = it->second->get(val);
		 });
  return retval;
}


template <typename T>
bool TWStatsDB<T>::get_windows(const T& key, const std::string& field_name, std::vector<int>& ret_vec)
{
  bool retval=false;
  
  retval = find_key_field(key, field_name, [&ret_vec](std::map<std::string, TWStatsEntryP>::iterator it, typename TWKeyTrackerType::iterator& kt)
		 {
		   it->second->get_windows(ret_vec);
		 });
  return(retval);
}

template <typename T>
bool TWStatsDB<T>::get_windows(const T& key, const std::string& field_name, const std::string& val, std::vector<int>& ret_vec)
{
  bool retval=false;
  
  retval = find_key_field(key, field_name, [&val, &ret_vec](std::map<std::string, TWStatsEntryP>::iterator it, typename TWKeyTrackerType::iterator& kt)
		 {
		   it->second->get_windows(val, ret_vec);
		 });
  return(retval);
}

template <typename T>
bool TWStatsDB<T>::get_all_fields(const T& key, std::vector<std::pair<std::string, int>>& ret_vec)
{
  std::lock_guard<std::mutex> lock(mutx);  

  auto mysdb = stats_db.find(key);
  if (mysdb == stats_db.end()) {
    return false;
  }
  else {
    auto& myfm = mysdb->second.second;
    // go through all the fields, get them and add to a vector
    for (auto it = myfm.begin(); it != myfm.end(); ++it) {
      ret_vec.push_back(make_pair(it->first, it->second->sum()));
    }
  }
  return true;
}

template <typename T>
bool TWStatsDB<T>::get_all_fields_windows(const T& key, TWStatsDBEntry& ret_vec) const
{
  std::lock_guard<std::mutex> lock(mutx);
  return get_all_fields_windows_unsafe(key, ret_vec);
}

template <typename T>
bool TWStatsDB<T>::get_all_fields_windows_unsafe(const T& key, TWStatsDBEntry& ret_vec) const
{
  auto mysdb = stats_db.find(key);
  if (mysdb == stats_db.end()) {
    return false;
  }
  else {
    auto& myfm = mysdb->second.second;
    // go through all the fields, get them and add to a vector
    for (auto fit = myfm.begin(); fit != myfm.end(); ++fit) {
      std::vector<int> ivec;
      fit->second->get_windows(ivec);
      ret_vec.push_back(make_pair(fit->first, ivec));
    }
  }
  return true;
}

template <typename T>
void TWStatsDB<T>::reset(const T& key)
{
  std::lock_guard<std::mutex> lock(mutx);  

  auto mysdb = stats_db.find(key);
  if (mysdb != stats_db.end()) {
    auto& myfm = mysdb->second.second;
    // go through all the fields and reset them
    for (auto it = myfm.begin(); it != myfm.end(); ++it) {
      it->second->reset();
    }
  }
}

template <typename T>
void TWStatsDB<T>::reset_field(const T& key, const std::string& field_name)
{
  std::lock_guard<std::mutex> lock(mutx);

  auto mysdb = stats_db.find(key);
  if (mysdb != stats_db.end()) {
    auto myfm = mysdb->second.second.find(field_name);
    if (myfm != mysdb->second.second.end()) {
      // Reset that field
      myfm->second->reset();
    }
  }
}

template <typename T>
void TWStatsDB<T>::set_map_size_soft(unsigned int size) 
{
  std::lock_guard<std::mutex> lock(mutx);

  map_size_soft = size;
  stats_db.reserve(size);
}

template <typename T>
unsigned int TWStatsDB<T>::get_size()
{
  std::lock_guard<std::mutex> lock(mutx);

  return stats_db.size();
}

template <typename T>
unsigned int TWStatsDB<T>::get_max_size()
{
  std::lock_guard<std::mutex> lock(mutx);

  return map_size_soft;
}