Commit 9b6aa5a5 authored by Zardosht Kasheff's avatar Zardosht Kasheff Committed by Yoni Fogel

[t:4875], add some comments

git-svn-id: file:///svn/toku/tokudb@43429 c7de825b-a66e-492c-adef-691d508d4ae1
parent 445f9283
...@@ -89,6 +89,7 @@ toku_brtheader_release_treelock(struct brt_header* h) { ...@@ -89,6 +89,7 @@ toku_brtheader_release_treelock(struct brt_header* h) {
// Start of Functions that are callbacks to the cachefule // Start of Functions that are callbacks to the cachefule
// //
// maps to cf->log_fassociate_during_checkpoint
static int static int
brtheader_log_fassociate_during_checkpoint (CACHEFILE cf, void *header_v) { brtheader_log_fassociate_during_checkpoint (CACHEFILE cf, void *header_v) {
struct brt_header *h = header_v; struct brt_header *h = header_v;
...@@ -101,6 +102,7 @@ brtheader_log_fassociate_during_checkpoint (CACHEFILE cf, void *header_v) { ...@@ -101,6 +102,7 @@ brtheader_log_fassociate_during_checkpoint (CACHEFILE cf, void *header_v) {
return r; return r;
} }
// maps to cf->log_suppress_rollback_during_checkpoint
static int static int
brtheader_log_suppress_rollback_during_checkpoint (CACHEFILE cf, void *header_v) { brtheader_log_suppress_rollback_during_checkpoint (CACHEFILE cf, void *header_v) {
int r = 0; int r = 0;
...@@ -115,6 +117,7 @@ brtheader_log_suppress_rollback_during_checkpoint (CACHEFILE cf, void *header_v) ...@@ -115,6 +117,7 @@ brtheader_log_suppress_rollback_during_checkpoint (CACHEFILE cf, void *header_v)
return r; return r;
} }
// Maps to cf->begin_checkpoint_userdata
// Create checkpoint-in-progress versions of header and translation (btt) (and fifo for now...). // Create checkpoint-in-progress versions of header and translation (btt) (and fifo for now...).
//Has access to fd (it is protected). //Has access to fd (it is protected).
static int static int
...@@ -137,6 +140,7 @@ brtheader_begin_checkpoint (LSN checkpoint_lsn, void *header_v) { ...@@ -137,6 +140,7 @@ brtheader_begin_checkpoint (LSN checkpoint_lsn, void *header_v) {
return r; return r;
} }
// maps to cf->checkpoint_userdata
// Write checkpoint-in-progress versions of header and translation to disk (really to OS internal buffer). // Write checkpoint-in-progress versions of header and translation to disk (really to OS internal buffer).
// Copy current header's version of checkpoint_staging stat64info to checkpoint header. // Copy current header's version of checkpoint_staging stat64info to checkpoint header.
// Must have access to fd (protected). // Must have access to fd (protected).
...@@ -205,6 +209,7 @@ handle_error: ...@@ -205,6 +209,7 @@ handle_error:
} }
// maps to cf->end_checkpoint_userdata
// free unused disk space // free unused disk space
// (i.e. tell BlockAllocator to liberate blocks used by previous checkpoint). // (i.e. tell BlockAllocator to liberate blocks used by previous checkpoint).
// Must have access to fd (protected) // Must have access to fd (protected)
...@@ -223,7 +228,8 @@ brtheader_end_checkpoint (CACHEFILE UU(cachefile), int fd, void *header_v) { ...@@ -223,7 +228,8 @@ brtheader_end_checkpoint (CACHEFILE UU(cachefile), int fd, void *header_v) {
return r; return r;
} }
//Has access to fd (it is protected). // maps to cf->close_userdata
// Has access to fd (it is protected).
static int static int
brtheader_close (CACHEFILE cachefile, int fd, void *header_v, char **malloced_error_string, BOOL oplsn_valid, LSN oplsn) { brtheader_close (CACHEFILE cachefile, int fd, void *header_v, char **malloced_error_string, BOOL oplsn_valid, LSN oplsn) {
struct brt_header *h = header_v; struct brt_header *h = header_v;
...@@ -281,6 +287,7 @@ brtheader_close (CACHEFILE cachefile, int fd, void *header_v, char **malloced_er ...@@ -281,6 +287,7 @@ brtheader_close (CACHEFILE cachefile, int fd, void *header_v, char **malloced_er
return r; return r;
} }
// maps to cf->note_pin_by_checkpoint
//Must be protected by ydb lock. //Must be protected by ydb lock.
//Is only called by checkpoint begin, which holds it //Is only called by checkpoint begin, which holds it
static int static int
...@@ -294,6 +301,7 @@ brtheader_note_pin_by_checkpoint (CACHEFILE UU(cachefile), void *header_v) ...@@ -294,6 +301,7 @@ brtheader_note_pin_by_checkpoint (CACHEFILE UU(cachefile), void *header_v)
return 0; return 0;
} }
// maps to cf->note_unpin_by_checkpoint
//Must be protected by ydb lock. //Must be protected by ydb lock.
//Called by end_checkpoint, which grabs ydb lock around note_unpin //Called by end_checkpoint, which grabs ydb lock around note_unpin
static int static int
...@@ -335,7 +343,8 @@ static int setup_initial_brtheader_root_node (struct brt_header* h, BLOCKNUM blo ...@@ -335,7 +343,8 @@ static int setup_initial_brtheader_root_node (struct brt_header* h, BLOCKNUM blo
return r; return r;
} }
// TODO: (Zardosht) move this functionality to brt_init_header
// No need in having brt_init_header call this function
static int static int
brt_init_header_partial (BRT t, CACHEFILE cf, TOKUTXN txn) { brt_init_header_partial (BRT t, CACHEFILE cf, TOKUTXN txn) {
int r; int r;
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment