src/cp-hash.c

   1 /* cp-hash.c  -- file copying (hash search routines)
   2    Copyright (C) 89, 90, 91, 1995-2002 Free Software Foundation.
   3
   4    This program is free software; you can redistribute it and/or modify
   5    it under the terms of the GNU General Public License as published by
   6    the Free Software Foundation; either version 2, or (at your option)
   7    any later version.
   8
   9    This program is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12    GNU General Public License for more details.
  13
  14    You should have received a copy of the GNU General Public License
  15    along with this program; if not, write to the Free Software Foundation,
  16    Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  17
  18    Written by Torbjorn Granlund, Sweden (tege@sics.se).
  19    Rewritten to use lib/hash.c by Jim Meyering.  */
  20
  21 #include <config.h>
  22
  23 #if HAVE_INTTYPES_H
  24 # include <inttypes.h>
  25 #endif
  26 #include <stdio.h>
  27 #include <sys/types.h>
  28 #include "system.h"
  29
  30 #include "same.h"
  31 #include "quote.h"
  32 #include "hash.h"
  33 #include "error.h"
  34 #include "cp-hash.h"
  35
  36 /* Use ST_DEV and ST_INO as the key, FILENAME as the value.
  37    These are used e.g., in copy.c to associate the destination path with
  38    the source device/inode pair so that if we encounter a matching dev/ino
  39    pair in the source tree we can arrange to create a hard link between
  40    the corresponding names in the destination tree.  */
  41 struct Src_to_dest
  42 {
  43   ino_t st_ino;
  44   dev_t st_dev;
  45   /* Destination path name (of non-directory or pre-existing directory)
  46      corresponding to the dev/ino of a copied file, or the destination path
  47      name corresponding to a dev/ino pair for a newly-created directory. */
  48   char const* name;
  49 };
  50
  51 /* This table maps source dev/ino to destination file name.
  52    We use it to preserve hard links when copying.  */
  53 static Hash_table *src_to_dest;
  54
  55 /* Initial size of the above hash table.  */
  56 #define INITIAL_TABLE_SIZE 103
  57
  58 static unsigned int
  59 src_to_dest_hash (void const *x, unsigned int table_size)
  60 {
  61   struct Src_to_dest const *p = x;
  62
  63   /* Ignoring the device number here should be fine.  */
  64   /* The cast to uintmax_t prevents negative remainders
  65      if st_ino is negative.  */
  66   return (uintmax_t) p->st_ino % table_size;
  67 }
  68
  69 /* Compare two Src_to_dest entries.
  70    Return true if their keys are judged `equal'.  */
  71 static bool
  72 src_to_dest_compare (void const *x, void const *y)
  73 {
  74   struct Src_to_dest const *a = x;
  75   struct Src_to_dest const *b = y;
  76   return SAME_INODE (*a, *b) ? true : false;
  77 }
  78
  79 static void
  80 src_to_dest_free (void *x)
  81 {
  82   struct Src_to_dest *a = x;
  83   free ((char *) (a->name));
  84   free (x);
  85 }
  86
  87 /* Remove the entry matching INO/DEV from the table
  88    that maps source ino/dev to destination file name.  */
  89 void
  90 forget_created (ino_t ino, dev_t dev)
  91 {
  92   struct Src_to_dest probe;
  93   struct Src_to_dest *ent;
  94
  95   probe.st_ino = ino;
  96   probe.st_dev = dev;
  97   probe.name = NULL;
  98
  99   ent = hash_delete (src_to_dest, &probe);
 100   if (ent)
 101     src_to_dest_free (ent);
 102 }
 103
 104 /* Add PATH to the list of files that we have created.
 105    Return 1 if we can't stat PATH, otherwise 0.  */
 106
 107 int
 108 remember_created (const char *path)
 109 {
 110   struct stat sb;
 111
 112   if (stat (path, &sb) < 0)
 113     {
 114       error (0, errno, "%s", quote (path));
 115       return 1;
 116     }
 117
 118   remember_copied (path, sb.st_ino, sb.st_dev);
 119   return 0;
 120 }
 121
 122 /* Add path NAME, copied from inode number INO and device number DEV,
 123    to the list of files we have copied.
 124    Return NULL if inserted, otherwise non-NULL. */
 125
 126 char *
 127 remember_copied (const char *name, ino_t ino, dev_t dev)
 128 {
 129   struct Src_to_dest *ent;
 130   struct Src_to_dest *ent_from_table;
 131
 132   ent = (struct Src_to_dest *) xmalloc (sizeof *ent);
 133   ent->name = xstrdup (name);
 134   ent->st_ino = ino;
 135   ent->st_dev = dev;
 136
 137   ent_from_table = hash_insert (src_to_dest, ent);
 138   if (ent_from_table == NULL)
 139     {
 140       /* Insertion failed due to lack of memory.  */
 141       xalloc_die ();
 142     }
 143
 144   /* Determine whether there was already an entry in the table
 145      with a matching key.  If so, free ENT (it wasn't inserted) and
 146      return the `name' from the table entry.  */
 147   if (ent_from_table != ent)
 148     {
 149       src_to_dest_free (ent);
 150       return (char *) ent_from_table->name;
 151     }
 152
 153   /* New key;  insertion succeeded.  */
 154   return NULL;
 155 }
 156
 157 /* Initialize the hash table.  */
 158 void
 159 hash_init (void)
 160 {
 161   src_to_dest = hash_initialize (INITIAL_TABLE_SIZE, NULL,
 162                                  src_to_dest_hash,
 163                                  src_to_dest_compare,
 164                                  src_to_dest_free);
 165   if (src_to_dest == NULL)
 166     xalloc_die ();
 167 }
 168
 169 /* Reset the hash structure in the global variable `htab' to
 170    contain no entries.  */
 171
 172 void
 173 forget_all (void)
 174 {
 175   hash_free (src_to_dest);
 176 }