summaryrefslogtreecommitdiffstats
path: root/libglusterfs/src/gfdb/gfdb_data_store.c
blob: a3b680f3e7e90b63ad3dcb58e609c6003103d257 (plain)
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
/*
   Copyright (c) 2015 Red Hat, Inc. <http://www.redhat.com>
   This file is part of GlusterFS.

   This file is licensed to you under your choice of the GNU Lesser
   General Public License, version 3 or any later version (LGPLv3 or
   later), or the GNU General Public License, version 2 (GPLv2), in all
   cases as published by the Free Software Foundation.
*/

#include "gfdb_sqlite3.h"
#include "gfdb_data_store.h"
#include "list.h"
#include "libglusterfs-messages.h"

/******************************************************************************
 *
 *                     Database Connection utils/internals
 *
 * ****************************************************************************/

/* GFDB Connection Node:
 * ~~~~~~~~~~~~~~~~~~~~
 * Represents the connection to the database while using libgfdb
 * The connection node is not thread safe as far as fini_db is concerned.
 * You can use a single connection node
 * to do multithreaded db operations like insert/delete/find of records.
 * But you need to wait for all the operating threads to complete i.e
 * pthread_join() and then do fini_db() to kill the connection node.
 * gfdb_conn_node_t is an opaque structure.
 * */
struct gfdb_conn_node_t {
        gfdb_connection_t       gfdb_connection;
        struct list_head        conn_list;
};


/*
 * db_conn_list is the circular linked list which
 * will have all the database connections for the process
 *
 * */
static gfdb_conn_node_t *db_conn_list;

/*
 * db_conn_mutex is the mutex for db_conn_list
 *
 * */
static pthread_mutex_t db_conn_mutex = PTHREAD_MUTEX_INITIALIZER;


/*Checks the sanity of the connection node*/
#define CHECK_CONN_NODE(_conn_node)\
do {\
        GF_ASSERT (_conn_node);\
        GF_ASSERT (_conn_node->gfdb_connection.gf_db_connection);\
} while (0)

/* Checks the sanity of the connection node and goto */
#define CHECK_CONN_NODE_GOTO(_conn_node, label)\
do {\
        if (!_conn_node) {\
                goto label;\
        };\
        if (!_conn_node->gfdb_connection.gf_db_connection) {\
                goto label;\
        };\
} while (0)

/*Check if the conn node is first in the list*/
#define IS_FIRST_NODE(db_conn_list, _conn_node)\
        ((_conn_node == db_conn_list) ? _gf_true : _gf_false)


/*Check if the conn node is the only node in the list*/
#define IS_THE_ONLY_NODE(_conn_node)\
((_conn_node->conn_list.next == _conn_node->conn_list.prev)\
        ? _gf_true : _gf_false)



/*Internal Function: Adds connection node to the end of
 * the db connection list.*/
static int
add_connection_node (gfdb_conn_node_t *_conn_node) {
        int ret = -1;

        GF_ASSERT (_conn_node);

        /*Lock the list*/
        ret = pthread_mutex_lock (&db_conn_mutex);
        if (ret) {
                gf_msg (GFDB_DATA_STORE, GF_LOG_ERROR, ret,
                        LG_MSG_LOCK_LIST_FAILED, "Failed lock db connection "
                        "list %s", strerror(ret));
                ret = -1;
                goto out;
        }

        if (db_conn_list == NULL) {
                db_conn_list = _conn_node;
        } else {
                list_add_tail (&_conn_node->conn_list,
                                &db_conn_list->conn_list);
        }

        /*unlock the list*/
        ret = pthread_mutex_unlock (&db_conn_mutex);
        if (ret) {
                gf_msg (GFDB_DATA_STORE, GF_LOG_ERROR, ret,
                        LG_MSG_UNLOCK_LIST_FAILED, "Failed unlock db "
                        "connection list %s", strerror(ret));
                ret = -1;
                /*TODO What if the unlock fails.
                * Will it lead to deadlock?
                * Most of the gluster code
                * no check for unlock or destory of mutex!*/
        }
        ret = 0;
out:
        return ret;
}


/*Internal Function:
 * Delete connection node from the list*/
static int
delete_conn_node (gfdb_conn_node_t *_conn_node)
{
        int ret = -1;

        GF_ASSERT (_conn_node);

        /*Lock of the list*/
        ret = pthread_mutex_lock (&db_conn_mutex);
        if (ret) {
                gf_msg (GFDB_DATA_STORE, GF_LOG_ERROR, ret,
                        LG_MSG_LOCK_LIST_FAILED, "Failed lock on db connection"
                        " list %s", strerror(ret));
                goto out;
        }

        /*Remove the connection object from list*/
        if (IS_THE_ONLY_NODE(_conn_node)) {
                db_conn_list = NULL;
                GF_FREE (_conn_node);
        } else {
                if (IS_FIRST_NODE(db_conn_list, _conn_node)) {
                        db_conn_list = list_entry (db_conn_list->conn_list.next,
                                                gfdb_conn_node_t,
                                                conn_list);
                }
                list_del(&_conn_node->conn_list);
                GF_FREE (_conn_node);
        }

        /*Release the list lock*/
        ret =  pthread_mutex_unlock (&db_conn_mutex);
        if (ret) {
                gf_msg (GFDB_DATA_STORE, GF_LOG_WARNING, ret,
                        LG_MSG_UNLOCK_LIST_FAILED, "Failed unlock on db "
                        "connection list %s", strerror(ret));
                /*TODO What if the unlock fails.
                * Will it lead to deadlock?
                * Most of the gluster code
                * no check for unlock or destory of mutex!*/
                ret = -1;
                goto out;
        }
        ret = 0;
out:
        return ret;
}


/*Internal function: Used initialize/map db operation of
 * specified type of db plugin*/
static int
init_db_operations (gfdb_db_type_t gfdb_db_type,
                        gfdb_db_operations_t *gfdb_db_operations) {

        int ret = -1;

        GF_ASSERT (gfdb_db_operations);

        /*Clear the gfdb_db_operations*/
        gfdb_db_operations = memset(gfdb_db_operations, 0,
                                        sizeof(*gfdb_db_operations));
        switch (gfdb_db_type) {
        case GFDB_SQLITE3:
                gf_sqlite3_fill_db_operations (gfdb_db_operations);
                ret = 0;
                break;
        case GFDB_HYPERDEX:
        case GFDB_HASH_FILE_STORE:
        case GFDB_ROCKS_DB:
                gf_msg (GFDB_DATA_STORE, GF_LOG_ERROR, 0,
                        LG_MSG_UNSUPPORTED_PLUGIN, "Plugin not supported");
                break;
        case GFDB_INVALID_DB:
        case GFDB_DB_END:
                gf_msg (GFDB_DATA_STORE, GF_LOG_ERROR, 0,
                        LG_MSG_INVALID_DB_TYPE, "Invalid DB Type");
                break;
        }
        return ret;
}


/******************************************************************************
 *
 *                      LIBGFDB API Functions
 *
 * ****************************************************************************/


/*Libgfdb API Function: Used to initialize a db connection
 *                      (Constructor function for db connection object)
 * Arguments:
 *      args         :  Dictionary containing database specific parameters
 *                      eg: For sqlite3, pagesize, cachesize, db name, db path
                        etc
 *      gfdb_db_type :  Type of data base used i.e sqlite or hyperdex etc
 * Returns : if successful return the GFDB Connection node to the caller or
 *          NULL in case of failure*/
gfdb_conn_node_t *
init_db (dict_t *args, gfdb_db_type_t gfdb_db_type)
{
        int ret                                 = -1;
        gfdb_conn_node_t *_conn_node            = NULL;
        gfdb_db_operations_t *db_operations_t   = NULL;

        /*Create data base connection object*/
        _conn_node = GF_CALLOC (1, sizeof(gfdb_conn_node_t),
                                        gf_mt_db_conn_node_t);
        if (!_conn_node) {
                gf_msg (GFDB_DATA_STORE, GF_LOG_ERROR, ENOMEM,
                        LG_MSG_NO_MEMORY, "Failed mem alloc for "
                        "gfdb_conn_node_t");
                goto alloc_failed;
        }

        /*Init the list component of db conneciton object*/
        INIT_LIST_HEAD (&_conn_node->conn_list);


        /*Add created connection node to the list*/
        ret = add_connection_node (_conn_node);
        if (ret) {
                gf_msg (GFDB_DATA_STORE, GF_LOG_ERROR, 0,
                        LG_MSG_ADD_TO_LIST_FAILED, "Failed to add connection "
                        "node to list");
                goto _conn_failed;
        }

        db_operations_t = &_conn_node->gfdb_connection.gfdb_db_operations;

        /*init the db ops object of db connection object*/
        ret = init_db_operations(gfdb_db_type, db_operations_t);
        if (ret) {
                gf_msg (GFDB_DATA_STORE, GF_LOG_ERROR, 0,
                        LG_MSG_INIT_DB_FAILED, "Failed initializing database "
                        "operation failed.");
                ret = -1;
                goto init_db_failed;
        }

        /*Calling the init_db_op of the respected db type*/
        GF_ASSERT (db_operations_t->init_db_op);
        ret = db_operations_t->init_db_op (args, &_conn_node->gfdb_connection.
                                                gf_db_connection);
        if (ret) {
                gf_msg (GFDB_DATA_STORE, GF_LOG_ERROR, 0,
                        LG_MSG_INIT_DB_FAILED, "Failed initializing database");
                ret = -1;
                goto init_db_failed;
        }
        _conn_node->gfdb_connection.gfdb_db_type = gfdb_db_type;
        ret = 0;

        return _conn_node;

        /*****Error Handling********/
        /* If init_db_operations or init_db of plugin failed delete
        * conn node from the list.
        * connection node will be free by delete_conn_node*/
init_db_failed:
        ret = delete_conn_node (_conn_node);
        if (ret) {
                gf_msg (GFDB_DATA_STORE, GF_LOG_ERROR, 0,
                        LG_MSG_DELETE_FROM_LIST_FAILED, "Failed deleting "
                        "connection node from list");
        }
        return NULL;
        /*if adding to the list failed free connection node*/
_conn_failed:
        GF_FREE (_conn_node);
        /*if allocation failed*/
alloc_failed:
        return NULL;
        /*****Error Handling********/
}





/*Libgfdb API Function: Used to terminate/de-initialize db connection
 *                      (Destructor function for db connection object)
 * Arguments:
 *      _conn_node  :  GFDB Connection node
 * Returns : if successful return 0 or
 *          -ve value in case of failure*/
int
fini_db (gfdb_conn_node_t *_conn_node)
{
        int ret = -1;
        gfdb_db_operations_t *db_operations_t   = NULL;

        CHECK_CONN_NODE_GOTO (_conn_node, empty);

        db_operations_t = &_conn_node->gfdb_connection.gfdb_db_operations;

        GF_ASSERT (db_operations_t->fini_db_op);

        ret = db_operations_t->fini_db_op(&_conn_node->gfdb_connection.
                                                        gf_db_connection);
        if (ret) {
                gf_msg (GFDB_DATA_STORE, GF_LOG_ERROR, 0,
                        LG_MSG_CLOSE_CONNECTION_FAILED, "Failed close the db "
                        "connection");
                goto out;
        }

        ret = delete_conn_node (_conn_node);
        if (ret) {
                gf_msg (GFDB_DATA_STORE, GF_LOG_ERROR, 0,
                        LG_MSG_DELETE_FROM_LIST_FAILED, "Failed deleting "
                        "connection node from list");
        }
empty:
        ret = 0;
out:
        return ret;
}






/*Libgfdb API Function: Used to insert/update records in the database
 *                      NOTE: In current gfdb_sqlite plugin we use that
 *                      same function to delete the record. Set the
 *                      gfdb_fop_path to GFDB_FOP_UNDEL to delete the
 *                      link of inode from GF_FLINK_TB and
 *                      GFDB_FOP_UNDEL_ALL to delete all the records from
 *                      GF_FLINK_TB and GF_FILE_TB.
 *                      TODO: Should seperate this function into the
 *                      delete_record function
 *                      Refer CTR Xlator features/changetimerecorder for usage
 * Arguments:
 *      _conn_node     :  GFDB Connection node
 *      gfdb_db_record :  Record to be inserted/updated
 * Returns : if successful return 0 or
 *          -ve value in case of failure*/
int
insert_record (gfdb_conn_node_t *_conn_node,
                        gfdb_db_record_t *gfdb_db_record)
{
        int ret = 0;
        gfdb_db_operations_t *db_operations_t   = NULL;
        void *gf_db_connection                  = NULL;

        CHECK_CONN_NODE(_conn_node);

        db_operations_t = &_conn_node->gfdb_connection.gfdb_db_operations;
        gf_db_connection = _conn_node->gfdb_connection.gf_db_connection;

        if (db_operations_t->insert_record_op) {

                ret = db_operations_t->insert_record_op (gf_db_connection,
                                                        gfdb_db_record);
                if (ret) {
                        gf_msg (GFDB_DATA_STORE, GF_LOG_ERROR, 0,
                                LG_MSG_INSERT_OR_UPDATE_FAILED, "Insert/Update"
                                " operation failed");
                }
        }

        return ret;
}




/*Libgfdb API Function: Used to delete record from the database
 *                      NOTE: In the current gfdb_sqlite3 plugin
 *                      implementation this function is dummy.
 *                      Use the insert_record function.
 *                      Refer CTR Xlator features/changetimerecorder for usage
 * Arguments:
 *      _conn_node     :  GFDB Connection node
 *      gfdb_db_record :  Record to be deleted
 * Returns : if successful return 0 or
 *          -ve value in case of failure*/
int
delete_record (gfdb_conn_node_t *_conn_node,
                        gfdb_db_record_t *gfdb_db_record)
{
        int ret = 0;
        gfdb_db_operations_t *db_operations_t   = NULL;
        void *gf_db_connection                  = NULL;

        CHECK_CONN_NODE(_conn_node);

        db_operations_t = &_conn_node->gfdb_connection.gfdb_db_operations;
        gf_db_connection = _conn_node->gfdb_connection.gf_db_connection;

        if (db_operations_t->delete_record_op) {

                ret = db_operations_t->delete_record_op (gf_db_connection,
                                                        gfdb_db_record);
                if (ret) {
                        gf_msg (GFDB_DATA_STORE, GF_LOG_ERROR, 0,
                                LG_MSG_DELETE_FAILED, "Delete operation "
                                "failed");
                }

        }

        return ret;
}





/*Libgfdb API Function: Query all the records from the database
 * Arguments:
 *      _conn_node      : GFDB Connection node
 *      query_callback  : Call back function that will be called
 *                        for every record found
 *      _query_cbk_args : Custom argument passed for the call back
 *                        function query_callback
 * Returns : if successful return 0 or
 *          -ve value in case of failure*/
int
find_all(gfdb_conn_node_t *_conn_node, gf_query_callback_t query_callback,
                void *_query_cbk_args) {
        int ret = 0;
        gfdb_db_operations_t *db_operations_t   = NULL;
        void *gf_db_connection                  = NULL;

        CHECK_CONN_NODE(_conn_node);

        db_operations_t = &_conn_node->gfdb_connection.gfdb_db_operations;
        gf_db_connection = _conn_node->gfdb_connection.gf_db_connection;

        if (db_operations_t->find_all_op) {
                ret = db_operations_t->find_all_op (gf_db_connection,
                                                query_callback,
                                                _query_cbk_args);
                if (ret) {
                        gf_msg (GFDB_DATA_STORE, GF_LOG_ERROR, 0,
                                LG_MSG_FIND_OP_FAILED, "Find all operation "
                                "failed");
                }

        }

        return ret;
}



/*Libgfdb API Function: Query records/files that have not changed/accessed
 *                      from a time in past to current time
 * Arguments:
 *      _conn_node              : GFDB Connection node
 *      query_callback          : Call back function that will be called
 *                                for every record found
 *      _query_cbk_args         : Custom argument passed for the call back
 *                                function query_callback
 *      for_time                : Time from where the file/s are not
 *                                changed/accessed
 * Returns : if successful return 0 or
 *          -ve value in case of failure*/
int
find_unchanged_for_time(gfdb_conn_node_t *_conn_node,
                                        gf_query_callback_t query_callback,
                                        void *_query_cbk_args,
                                        gfdb_time_t *for_time) {

        int ret = 0;
        gfdb_db_operations_t *db_operations_t   = NULL;
        void *gf_db_connection                  = NULL;

        CHECK_CONN_NODE(_conn_node);

        db_operations_t = &_conn_node->gfdb_connection.gfdb_db_operations;
        gf_db_connection = _conn_node->gfdb_connection.gf_db_connection;

        if (db_operations_t->find_unchanged_for_time_op) {

                ret = db_operations_t->find_unchanged_for_time_op
                                                        (gf_db_connection,
                                                        query_callback,
                                                        _query_cbk_args,
                                                        for_time);
                if (ret) {
                        gf_msg (GFDB_DATA_STORE, GF_LOG_ERROR, 0,
                                LG_MSG_FIND_OP_FAILED, "Find unchanged "
                                "operation failed");
                }

        }

        return ret;
}

/*Libgfdb API Function: Query records/files that have changed/accessed from a
 *                      time in past to current time
 * Arguments:
 *      _conn_node              : GFDB Connection node
 *      query_callback          : Call back function that will be called
 *                                for every record found
 *      _query_cbk_args         : Custom argument passed for the call back
 *                                function query_callback
 *      for_time                : Time from where the file/s are
 *                                changed/accessed
 * Returns : if successful return 0 or
 *          -ve value in case of failure*/
int
find_recently_changed_files(gfdb_conn_node_t *_conn_node,
                                gf_query_callback_t query_callback,
                                void *_query_cbk_args,
                                gfdb_time_t *from_time) {

        int ret = 0;
        gfdb_db_operations_t *db_operations_t   = NULL;
        void *gf_db_connection                  = NULL;

        CHECK_CONN_NODE(_conn_node);

        db_operations_t = &_conn_node->gfdb_connection.gfdb_db_operations;
        gf_db_connection = _conn_node->gfdb_connection.gf_db_connection;

        if (db_operations_t->find_recently_changed_files_op) {

                ret =  db_operations_t->find_recently_changed_files_op (
                                                        gf_db_connection,
                                                        query_callback,
                                                        _query_cbk_args,
                                                        from_time);
                if (ret) {
                        gf_msg (GFDB_DATA_STORE, GF_LOG_ERROR, 0,
                                LG_MSG_FIND_OP_FAILED,
                                "Find changed operation failed");
                }

        }

        return ret;

}

/*Libgfdb API Function: Query records/files that have not changed/accessed
 *                      from a time in past to current time, with
 *                      a desired frequency
 * Arguments:
 *      _conn_node              : GFDB Connection node
 *      query_callback          : Call back function that will be called
 *                                for every record found
 *      _query_cbk_args         : Custom argument passed for the call back
 *                                function query_callback
 *      for_time                : Time from where the file/s are not
 *                                changed/accessed
 *      write_freq_thresold     : Desired Write Frequency lower limit
 *      read_freq_thresold      : Desired Read Frequency lower limit
 *      _clear_counters         : If true, Clears all the frequency counters of
 *                                all files.
 * Returns : if successful return 0 or
 *          -ve value in case of failure*/
int
find_unchanged_for_time_freq(gfdb_conn_node_t *_conn_node,
                                        gf_query_callback_t query_callback,
                                        void *_query_cbk_args,
                                        gfdb_time_t *for_time,
                                        int write_freq_thresold,
                                        int read_freq_thresold,
                                        gf_boolean_t _clear_counters) {

        int ret = 0;
        gfdb_db_operations_t *db_operations_t   = NULL;
        void *gf_db_connection                  = NULL;

        CHECK_CONN_NODE(_conn_node);

        db_operations_t = &_conn_node->gfdb_connection.gfdb_db_operations;
        gf_db_connection = _conn_node->gfdb_connection.gf_db_connection;

        if (db_operations_t->find_unchanged_for_time_freq_op) {

                ret = db_operations_t->find_unchanged_for_time_freq_op(
                                                        gf_db_connection,
                                                        query_callback,
                                                        _query_cbk_args,
                                                        for_time,
                                                        write_freq_thresold,
                                                        read_freq_thresold,
                                                        _clear_counters);
                if (ret) {
                        gf_msg (GFDB_DATA_STORE, GF_LOG_ERROR, 0,
                                LG_MSG_FIND_OP_FAILED,
                                "Find unchanged with freq operation failed");
                }

        }

        return ret;
}

/*Libgfdb API Function: Query records/files that have changed/accessed from a
 *                      time in past to current time, with
 *                      a desired frequency
 * Arguments:
 *      _conn_node              : GFDB Connection node
 *      query_callback          : Call back function that will be called
 *                                for every record found
 *      _query_cbk_args         : Custom argument passed for the call back
 *                                function query_callback
 *      for_time                : Time from where the file/s are
 *                                changed/accessed
 *      write_freq_thresold     : Desired Write Frequency lower limit
 *      read_freq_thresold      : Desired Read Frequency lower limit
 *      _clear_counters         : If true, Clears all the frequency counters of
 *                                all files.
 * Returns : if successful return 0 or
 *          -ve value in case of failure*/
int
find_recently_changed_files_freq(gfdb_conn_node_t *_conn_node,
                                gf_query_callback_t query_callback,
                                void *_query_cbk_args,
                                gfdb_time_t *from_time,
                                int write_freq_thresold,
                                int read_freq_thresold,
                                gf_boolean_t _clear_counters) {

        int ret = 0;
        gfdb_db_operations_t *db_operations_t   = NULL;
        void *gf_db_connection                  = NULL;

        CHECK_CONN_NODE(_conn_node);

        db_operations_t = &_conn_node->gfdb_connection.gfdb_db_operations;
        gf_db_connection = _conn_node->gfdb_connection.gf_db_connection;

        if (db_operations_t->find_recently_changed_files_freq_op) {

                ret =  db_operations_t->find_recently_changed_files_freq_op(
                                                        gf_db_connection,
                                                        query_callback,
                                                        _query_cbk_args,
                                                        from_time,
                                                        write_freq_thresold,
                                                        read_freq_thresold,
                                                        _clear_counters);
                if (ret) {
                        gf_msg (GFDB_DATA_STORE, GF_LOG_ERROR, 0,
                                LG_MSG_FIND_OP_FAILED,
                                "Find changed with freq operation failed");
                }

        }

        return ret;

}



/*Libgfdb API Function: Clear the heat for all the files
 *
 *  Arguments:
 *    conn_node              : GFDB Connection node
 *
 * Returns : if successful return 0 or
 *           -ve value in case of failure
 **/

int
clear_files_heat (gfdb_conn_node_t *conn_node) {
        int ret = 0;
        gfdb_db_operations_t *db_operations   = NULL;
        void *gf_db_connection                  = NULL;

        CHECK_CONN_NODE(conn_node);

        db_operations = &conn_node->gfdb_connection.gfdb_db_operations;
        gf_db_connection = conn_node->gfdb_connection.gf_db_connection;

        if (db_operations->clear_files_heat_op) {
                ret =  db_operations->clear_files_heat_op (gf_db_connection);
                if (ret) {
                        gf_msg (GFDB_DATA_STORE, GF_LOG_ERROR, 0,
                                LG_MSG_FIND_OP_FAILED,
                                "Clear files heat operation failed");
                }
        }

        return ret;
}


/* Libgfdb API Function: Function to extract version of the db
 * Input:
 * gfdb_conn_node_t *conn_node        : GFDB Connection node
 * char **version  : the version is extracted as a string and will be stored in
 *                   this variable. The freeing of the memory should be done by
 *                   the caller.
 * Return:
 *      On success return the lenght of the version string that is
 *      extracted.
 *      On failure return -1
 * */
int
get_db_version (gfdb_conn_node_t *conn_node, char **version)
{
        int ret = 0;
        gfdb_db_operations_t *db_operations   = NULL;
        void *gf_db_connection                  = NULL;

        CHECK_CONN_NODE(conn_node);

        db_operations = &conn_node->gfdb_connection.gfdb_db_operations;
        gf_db_connection = conn_node->gfdb_connection.gf_db_connection;

        if (db_operations->get_db_version) {
                ret =  db_operations->get_db_version (gf_db_connection,
                                                        version);
                if (ret < 0) {
                        gf_msg (GFDB_DATA_STORE, GF_LOG_ERROR, 0,
                                LG_MSG_FIND_OP_FAILED,
                                "Get version failed");
                }
        }

        return ret;
}

int
get_db_setting (gfdb_conn_node_t *conn_node, char *param_key,
                char **param_value)
{
        int ret = -1;
        gfdb_db_operations_t *db_operations   = NULL;
        void *gf_db_connection                  = NULL;

        CHECK_CONN_NODE(conn_node);

        db_operations = &conn_node->gfdb_connection.gfdb_db_operations;
        gf_db_connection = conn_node->gfdb_connection.gf_db_connection;

        if (db_operations->get_db_setting) {
                ret =  db_operations->get_db_setting (gf_db_connection,
                                                        param_key, param_value);
                if (ret < 0) {
                        gf_msg (GFDB_DATA_STORE, GF_LOG_ERROR, 0,
                                LG_MSG_FIND_OP_FAILED,
                                "Get setting failed");
                }
        }

        return ret;
}



static const
char *get_db_path_key()
{
        return GFDB_SQL_PARAM_DBPATH;
}

void get_gfdb_methods (gfdb_methods_t *methods)
{
        methods->init_db = init_db;
        methods->fini_db = fini_db;
        methods->find_unchanged_for_time = find_unchanged_for_time;
        methods->find_recently_changed_files = find_recently_changed_files;
        methods->find_unchanged_for_time_freq = find_unchanged_for_time_freq;
        methods->find_recently_changed_files_freq =
                                               find_recently_changed_files_freq;
        methods->clear_files_heat = clear_files_heat;
        methods->get_db_version = get_db_version;
        methods->get_db_setting = get_db_setting;
        methods->get_db_path_key = get_db_path_key;

        /* Query Record related functions */
        methods->gfdb_query_record_new = gfdb_query_record_new;
        methods->gfdb_query_record_free = gfdb_query_record_free;
        methods->gfdb_add_link_to_query_record = gfdb_add_link_to_query_record;
        methods->gfdb_write_query_record = gfdb_write_query_record;
        methods->gfdb_read_query_record = gfdb_read_query_record;

        /* Link info related functions */
        methods->gfdb_link_info_new = gfdb_link_info_new;
        methods->gfdb_link_info_free = gfdb_link_info_free;
}