PostgreSQL Source Code  git master
filemap.h File Reference
#include "datapagemap.h"
#include "storage/block.h"
#include "storage/relfilenode.h"
Include dependency graph for filemap.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  file_entry_t
 
struct  filemap_t
 

Typedefs

typedef struct file_entry_t file_entry_t
 
typedef struct filemap_t filemap_t
 

Enumerations

enum  file_action_t {
  FILE_ACTION_UNDECIDED = 0 , FILE_ACTION_CREATE , FILE_ACTION_COPY , FILE_ACTION_COPY_TAIL ,
  FILE_ACTION_NONE , FILE_ACTION_TRUNCATE , FILE_ACTION_REMOVE
}
 
enum  file_type_t { FILE_TYPE_UNDEFINED = 0 , FILE_TYPE_REGULAR , FILE_TYPE_DIRECTORY , FILE_TYPE_SYMLINK }
 

Functions

void filehash_init (void)
 
void process_source_file (const char *path, file_type_t type, size_t size, const char *link_target)
 
void process_target_file (const char *path, file_type_t type, size_t size, const char *link_target)
 
void process_target_wal_block_change (ForkNumber forknum, RelFileNode rnode, BlockNumber blkno)
 
filemap_tdecide_file_actions (void)
 
void calculate_totals (filemap_t *filemap)
 
void print_filemap (filemap_t *filemap)
 

Typedef Documentation

◆ file_entry_t

typedef struct file_entry_t file_entry_t

◆ filemap_t

typedef struct filemap_t filemap_t

Enumeration Type Documentation

◆ file_action_t

Enumerator
FILE_ACTION_UNDECIDED 
FILE_ACTION_CREATE 
FILE_ACTION_COPY 
FILE_ACTION_COPY_TAIL 
FILE_ACTION_NONE 
FILE_ACTION_TRUNCATE 
FILE_ACTION_REMOVE 

Definition at line 16 of file filemap.h.

17 {
18  FILE_ACTION_UNDECIDED = 0, /* not decided yet */
19 
20  FILE_ACTION_CREATE, /* create local directory or symbolic link */
21  FILE_ACTION_COPY, /* copy whole file, overwriting if exists */
22  FILE_ACTION_COPY_TAIL, /* copy tail from 'source_size' to
23  * 'target_size' */
24  FILE_ACTION_NONE, /* no action (we might still copy modified
25  * blocks based on the parsed WAL) */
26  FILE_ACTION_TRUNCATE, /* truncate local file to 'newsize' bytes */
27  FILE_ACTION_REMOVE /* remove local file / directory / symlink */
file_action_t
Definition: filemap.h:17
@ FILE_ACTION_REMOVE
Definition: filemap.h:27
@ FILE_ACTION_COPY
Definition: filemap.h:21
@ FILE_ACTION_NONE
Definition: filemap.h:24
@ FILE_ACTION_COPY_TAIL
Definition: filemap.h:22
@ FILE_ACTION_UNDECIDED
Definition: filemap.h:18
@ FILE_ACTION_TRUNCATE
Definition: filemap.h:26
@ FILE_ACTION_CREATE
Definition: filemap.h:20

◆ file_type_t

Enumerator
FILE_TYPE_UNDEFINED 
FILE_TYPE_REGULAR 
FILE_TYPE_DIRECTORY 
FILE_TYPE_SYMLINK 

Definition at line 30 of file filemap.h.

31 {
33 
37 } file_type_t;
file_type_t
Definition: filemap.h:31
@ FILE_TYPE_UNDEFINED
Definition: filemap.h:32
@ FILE_TYPE_REGULAR
Definition: filemap.h:34
@ FILE_TYPE_SYMLINK
Definition: filemap.h:36
@ FILE_TYPE_DIRECTORY
Definition: filemap.h:35

Function Documentation

◆ calculate_totals()

void calculate_totals ( filemap_t filemap)

Definition at line 438 of file filemap.c.

439 {
440  file_entry_t *entry;
441  int i;
442 
443  filemap->total_size = 0;
444  filemap->fetch_size = 0;
445 
446  for (i = 0; i < filemap->nentries; i++)
447  {
448  entry = filemap->entries[i];
449 
450  if (entry->source_type != FILE_TYPE_REGULAR)
451  continue;
452 
453  filemap->total_size += entry->source_size;
454 
455  if (entry->action == FILE_ACTION_COPY)
456  {
457  filemap->fetch_size += entry->source_size;
458  continue;
459  }
460 
461  if (entry->action == FILE_ACTION_COPY_TAIL)
462  filemap->fetch_size += (entry->source_size - entry->target_size);
463 
464  if (entry->target_pages_to_overwrite.bitmapsize > 0)
465  {
467  BlockNumber blk;
468 
470  while (datapagemap_next(iter, &blk))
471  filemap->fetch_size += BLCKSZ;
472 
473  pg_free(iter);
474  }
475  }
476 }
uint32 BlockNumber
Definition: block.h:31
bool datapagemap_next(datapagemap_iterator_t *iter, BlockNumber *blkno)
Definition: datapagemap.c:87
datapagemap_iterator_t * datapagemap_iterate(datapagemap_t *map)
Definition: datapagemap.c:75
void pg_free(void *ptr)
Definition: fe_memutils.c:105
int i
Definition: isn.c:73
int bitmapsize
Definition: datapagemap.h:18
Definition: filemap.h:50
datapagemap_t target_pages_to_overwrite
Definition: filemap.h:68
size_t source_size
Definition: filemap.h:75
file_type_t source_type
Definition: filemap.h:74
size_t target_size
Definition: filemap.h:61
file_action_t action
Definition: filemap.h:81
file_entry_t * entries[FLEXIBLE_ARRAY_MEMBER]
Definition: filemap.h:96
int nentries
Definition: filemap.h:95
uint64 total_size
Definition: filemap.h:92
uint64 fetch_size
Definition: filemap.h:93

References file_entry_t::action, datapagemap::bitmapsize, datapagemap_iterate(), datapagemap_next(), filemap_t::entries, filemap_t::fetch_size, FILE_ACTION_COPY, FILE_ACTION_COPY_TAIL, FILE_TYPE_REGULAR, i, filemap_t::nentries, pg_free(), file_entry_t::source_size, file_entry_t::source_type, file_entry_t::target_pages_to_overwrite, file_entry_t::target_size, and filemap_t::total_size.

Referenced by main().

◆ decide_file_actions()

filemap_t* decide_file_actions ( void  )

Definition at line 788 of file filemap.c.

789 {
790  int i;
791  filehash_iterator it;
792  file_entry_t *entry;
793  filemap_t *filemap;
794 
795  filehash_start_iterate(filehash, &it);
796  while ((entry = filehash_iterate(filehash, &it)) != NULL)
797  {
798  entry->action = decide_file_action(entry);
799  }
800 
801  /*
802  * Turn the hash table into an array, and sort in the order that the
803  * actions should be performed.
804  */
805  filemap = pg_malloc(offsetof(filemap_t, entries) +
806  filehash->members * sizeof(file_entry_t *));
807  filemap->nentries = filehash->members;
808  filehash_start_iterate(filehash, &it);
809  i = 0;
810  while ((entry = filehash_iterate(filehash, &it)) != NULL)
811  {
812  filemap->entries[i++] = entry;
813  }
814 
815  qsort(&filemap->entries, filemap->nentries, sizeof(file_entry_t *),
817 
818  return filemap;
819 }
#define offsetof(type, field)
Definition: c.h:727
void * pg_malloc(size_t size)
Definition: fe_memutils.c:47
static filehash_hash * filehash
Definition: filemap.c:56
static file_action_t decide_file_action(file_entry_t *entry)
Definition: filemap.c:639
static int final_filemap_cmp(const void *a, const void *b)
Definition: filemap.c:619
#define qsort(a, b, c, d)
Definition: port.h:495

References file_entry_t::action, decide_file_action(), filemap_t::entries, filehash, final_filemap_cmp(), i, filemap_t::nentries, offsetof, pg_malloc(), and qsort.

Referenced by main().

◆ filehash_init()

void filehash_init ( void  )

Definition at line 168 of file filemap.c.

169 {
170  filehash = filehash_create(FILEHASH_INITIAL_SIZE, NULL);
171 }
#define FILEHASH_INITIAL_SIZE
Definition: filemap.c:54

References filehash, and FILEHASH_INITIAL_SIZE.

Referenced by main().

◆ print_filemap()

void print_filemap ( filemap_t filemap)

Definition at line 479 of file filemap.c.

480 {
481  file_entry_t *entry;
482  int i;
483 
484  for (i = 0; i < filemap->nentries; i++)
485  {
486  entry = filemap->entries[i];
487  if (entry->action != FILE_ACTION_NONE ||
489  {
490  pg_log_debug("%s (%s)", entry->path,
491  action_to_str(entry->action));
492 
493  if (entry->target_pages_to_overwrite.bitmapsize > 0)
495  }
496  }
497  fflush(stdout);
498 }
void datapagemap_print(datapagemap_t *map)
Definition: datapagemap.c:117
static const char * action_to_str(file_action_t action)
Definition: filemap.c:412
static void const char fflush(stdout)
#define pg_log_debug(...)
Definition: logging.h:133
const char * path
Definition: filemap.h:53

References file_entry_t::action, action_to_str(), datapagemap::bitmapsize, datapagemap_print(), filemap_t::entries, fflush(), FILE_ACTION_NONE, i, filemap_t::nentries, file_entry_t::path, pg_log_debug, generate_unaccent_rules::stdout, and file_entry_t::target_pages_to_overwrite.

Referenced by main().

◆ process_source_file()

void process_source_file ( const char *  path,
file_type_t  type,
size_t  size,
const char *  link_target 
)

Definition at line 218 of file filemap.c.

220 {
221  file_entry_t *entry;
222 
223  /*
224  * Pretend that pg_wal is a directory, even if it's really a symlink. We
225  * don't want to mess with the symlink itself, nor complain if it's a
226  * symlink in source but not in target or vice versa.
227  */
228  if (strcmp(path, "pg_wal") == 0 && type == FILE_TYPE_SYMLINK)
230 
231  /*
232  * sanity check: a filename that looks like a data file better be a
233  * regular file
234  */
235  if (type != FILE_TYPE_REGULAR && isRelDataFile(path))
236  pg_fatal("data file \"%s\" in source is not a regular file", path);
237 
238  /* Remember this source file */
239  entry = insert_filehash_entry(path);
240  if (entry->source_exists)
241  pg_fatal("duplicate source file \"%s\"", path);
242  entry->source_exists = true;
243  entry->source_type = type;
244  entry->source_size = size;
245  entry->source_link_target = link_target ? pg_strdup(link_target) : NULL;
246 }
char * pg_strdup(const char *in)
Definition: fe_memutils.c:85
static bool isRelDataFile(const char *path)
Definition: filemap.c:509
static file_entry_t * insert_filehash_entry(const char *path)
Definition: filemap.c:175
#define pg_fatal(...)
bool source_exists
Definition: filemap.h:73
char * source_link_target
Definition: filemap.h:76

References FILE_TYPE_DIRECTORY, FILE_TYPE_REGULAR, FILE_TYPE_SYMLINK, insert_filehash_entry(), isRelDataFile(), pg_fatal, pg_strdup(), file_entry_t::source_exists, file_entry_t::source_link_target, file_entry_t::source_size, file_entry_t::source_type, and generate_unaccent_rules::type.

Referenced by libpq_traverse_files(), local_traverse_files(), and main().

◆ process_target_file()

void process_target_file ( const char *  path,
file_type_t  type,
size_t  size,
const char *  link_target 
)

Definition at line 254 of file filemap.c.

256 {
257  file_entry_t *entry;
258 
259  /*
260  * Do not apply any exclusion filters here. This has advantage to remove
261  * from the target data folder all paths which have been filtered out from
262  * the source data folder when processing the source files.
263  */
264 
265  /*
266  * Like in process_source_file, pretend that pg_wal is always a directory.
267  */
268  if (strcmp(path, "pg_wal") == 0 && type == FILE_TYPE_SYMLINK)
270 
271  /* Remember this target file */
272  entry = insert_filehash_entry(path);
273  if (entry->target_exists)
274  pg_fatal("duplicate source file \"%s\"", path);
275  entry->target_exists = true;
276  entry->target_type = type;
277  entry->target_size = size;
278  entry->target_link_target = link_target ? pg_strdup(link_target) : NULL;
279 }
bool target_exists
Definition: filemap.h:59
char * target_link_target
Definition: filemap.h:62
file_type_t target_type
Definition: filemap.h:60

References FILE_TYPE_DIRECTORY, FILE_TYPE_SYMLINK, insert_filehash_entry(), pg_fatal, pg_strdup(), file_entry_t::target_exists, file_entry_t::target_link_target, file_entry_t::target_size, file_entry_t::target_type, and generate_unaccent_rules::type.

Referenced by main().

◆ process_target_wal_block_change()

void process_target_wal_block_change ( ForkNumber  forknum,
RelFileNode  rnode,
BlockNumber  blkno 
)

Definition at line 291 of file filemap.c.

293 {
294  char *path;
295  file_entry_t *entry;
296  BlockNumber blkno_inseg;
297  int segno;
298 
299  segno = blkno / RELSEG_SIZE;
300  blkno_inseg = blkno % RELSEG_SIZE;
301 
302  path = datasegpath(rnode, forknum, segno);
303  entry = lookup_filehash_entry(path);
304  pfree(path);
305 
306  /*
307  * If the block still exists in both systems, remember it. Otherwise we
308  * can safely ignore it.
309  *
310  * If the block is beyond the EOF in the source system, or the file
311  * doesn't exist in the source at all, we're going to truncate/remove it
312  * away from the target anyway. Likewise, if it doesn't exist in the
313  * target anymore, we will copy it over with the "tail" from the source
314  * system, anyway.
315  *
316  * It is possible to find WAL for a file that doesn't exist on either
317  * system anymore. It means that the relation was dropped later in the
318  * target system, and independently on the source system too, or that it
319  * was created and dropped in the target system and it never existed in
320  * the source. Either way, we can safely ignore it.
321  */
322  if (entry)
323  {
324  Assert(entry->isrelfile);
325 
326  if (entry->target_exists)
327  {
328  if (entry->target_type != FILE_TYPE_REGULAR)
329  pg_fatal("unexpected page modification for non-regular file \"%s\"",
330  entry->path);
331 
332  if (entry->source_exists)
333  {
334  off_t end_offset;
335 
336  end_offset = (blkno_inseg + 1) * BLCKSZ;
337  if (end_offset <= entry->source_size && end_offset <= entry->target_size)
338  datapagemap_add(&entry->target_pages_to_overwrite, blkno_inseg);
339  }
340  }
341  }
342 }
void datapagemap_add(datapagemap_t *map, BlockNumber blkno)
Definition: datapagemap.c:32
static char * datasegpath(RelFileNode rnode, ForkNumber forknum, BlockNumber segno)
Definition: filemap.c:592
static file_entry_t * lookup_filehash_entry(const char *path)
Definition: filemap.c:205
Assert(fmt[strlen(fmt) - 1] !='\n')
void pfree(void *pointer)
Definition: mcxt.c:1175
bool isrelfile
Definition: filemap.h:54

References Assert(), datapagemap_add(), datasegpath(), FILE_TYPE_REGULAR, file_entry_t::isrelfile, lookup_filehash_entry(), file_entry_t::path, pfree(), pg_fatal, file_entry_t::source_exists, file_entry_t::target_exists, file_entry_t::target_pages_to_overwrite, and file_entry_t::target_type.

Referenced by extractPageInfo().