View Javadoc

1   /**
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *     http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing, software
13   * distributed under the License is distributed on an "AS IS" BASIS,
14   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   * See the License for the specific language governing permissions and
16   * limitations under the License.
17   */
18  
19  package org.apache.hadoop.hbase.snapshot;
20  
21  import com.google.protobuf.CodedInputStream;
22  import com.google.protobuf.InvalidProtocolBufferException;
23  
24  import java.io.FileNotFoundException;
25  import java.io.IOException;
26  import java.util.ArrayList;
27  import java.util.Collection;
28  import java.util.HashMap;
29  import java.util.List;
30  import java.util.Map;
31  import java.util.concurrent.ThreadPoolExecutor;
32  import java.util.concurrent.TimeUnit;
33  
34  import org.apache.commons.logging.Log;
35  import org.apache.commons.logging.LogFactory;
36  import org.apache.hadoop.conf.Configuration;
37  import org.apache.hadoop.fs.FSDataInputStream;
38  import org.apache.hadoop.fs.FSDataOutputStream;
39  import org.apache.hadoop.fs.FileStatus;
40  import org.apache.hadoop.fs.FileSystem;
41  import org.apache.hadoop.fs.Path;
42  import org.apache.hadoop.hbase.HColumnDescriptor;
43  import org.apache.hadoop.hbase.HRegionInfo;
44  import org.apache.hadoop.hbase.HTableDescriptor;
45  import org.apache.hadoop.hbase.classification.InterfaceAudience;
46  import org.apache.hadoop.hbase.errorhandling.ForeignExceptionSnare;
47  import org.apache.hadoop.hbase.mob.MobUtils;
48  import org.apache.hadoop.hbase.protobuf.ProtobufUtil;
49  import org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription;
50  import org.apache.hadoop.hbase.protobuf.generated.SnapshotProtos.SnapshotDataManifest;
51  import org.apache.hadoop.hbase.protobuf.generated.SnapshotProtos.SnapshotRegionManifest;
52  import org.apache.hadoop.hbase.regionserver.HRegion;
53  import org.apache.hadoop.hbase.regionserver.HRegionFileSystem;
54  import org.apache.hadoop.hbase.regionserver.Store;
55  import org.apache.hadoop.hbase.regionserver.StoreFile;
56  import org.apache.hadoop.hbase.regionserver.StoreFileInfo;
57  import org.apache.hadoop.hbase.util.Bytes;
58  import org.apache.hadoop.hbase.util.FSTableDescriptors;
59  import org.apache.hadoop.hbase.util.FSUtils;
60  import org.apache.hadoop.hbase.util.Threads;
61  
62  /**
63   * Utility class to help read/write the Snapshot Manifest.
64   *
65   * The snapshot format is transparent for the users of this class,
66   * once the snapshot is written, it will never be modified.
67   * On open() the snapshot will be loaded to the current in-memory format.
68   */
69  @InterfaceAudience.Private
70  public class SnapshotManifest {
71    private static final Log LOG = LogFactory.getLog(SnapshotManifest.class);
72  
73    public static final String SNAPSHOT_MANIFEST_SIZE_LIMIT_CONF_KEY = "snapshot.manifest.size.limit";
74  
75    public static final String DATA_MANIFEST_NAME = "data.manifest";
76  
77    private List<SnapshotRegionManifest> regionManifests;
78    private SnapshotDescription desc;
79    private HTableDescriptor htd;
80  
81    private final ForeignExceptionSnare monitor;
82    private final Configuration conf;
83    private final Path workingDir;
84    private final FileSystem fs;
85    private int manifestSizeLimit;
86  
87    private SnapshotManifest(final Configuration conf, final FileSystem fs,
88        final Path workingDir, final SnapshotDescription desc,
89        final ForeignExceptionSnare monitor) {
90      this.monitor = monitor;
91      this.desc = desc;
92      this.workingDir = workingDir;
93      this.conf = conf;
94      this.fs = fs;
95  
96      this.manifestSizeLimit = conf.getInt(SNAPSHOT_MANIFEST_SIZE_LIMIT_CONF_KEY, 64 * 1024 * 1024);
97    }
98  
99    /**
100    * Return a SnapshotManifest instance, used for writing a snapshot.
101    *
102    * There are two usage pattern:
103    *  - The Master will create a manifest, add the descriptor, offline regions
104    *    and consolidate the snapshot by writing all the pending stuff on-disk.
105    *      manifest = SnapshotManifest.create(...)
106    *      manifest.addRegion(tableDir, hri)
107    *      manifest.consolidate()
108    *  - The RegionServer will create a single region manifest
109    *      manifest = SnapshotManifest.create(...)
110    *      manifest.addRegion(region)
111    */
112   public static SnapshotManifest create(final Configuration conf, final FileSystem fs,
113       final Path workingDir, final SnapshotDescription desc,
114       final ForeignExceptionSnare monitor) {
115     return new SnapshotManifest(conf, fs, workingDir, desc, monitor);
116   }
117 
118   /**
119    * Return a SnapshotManifest instance with the information already loaded in-memory.
120    *    SnapshotManifest manifest = SnapshotManifest.open(...)
121    *    HTableDescriptor htd = manifest.getTableDescriptor()
122    *    for (SnapshotRegionManifest regionManifest: manifest.getRegionManifests())
123    *      hri = regionManifest.getRegionInfo()
124    *      for (regionManifest.getFamilyFiles())
125    *        ...
126    */
127   public static SnapshotManifest open(final Configuration conf, final FileSystem fs,
128       final Path workingDir, final SnapshotDescription desc) throws IOException {
129     SnapshotManifest manifest = new SnapshotManifest(conf, fs, workingDir, desc, null);
130     manifest.load();
131     return manifest;
132   }
133 
134 
135   /**
136    * Add the table descriptor to the snapshot manifest
137    */
138   public void addTableDescriptor(final HTableDescriptor htd) throws IOException {
139     this.htd = htd;
140   }
141 
142   interface RegionVisitor<TRegion, TFamily> {
143     TRegion regionOpen(final HRegionInfo regionInfo) throws IOException;
144     void regionClose(final TRegion region) throws IOException;
145 
146     TFamily familyOpen(final TRegion region, final byte[] familyName) throws IOException;
147     void familyClose(final TRegion region, final TFamily family) throws IOException;
148 
149     void storeFile(final TRegion region, final TFamily family, final StoreFileInfo storeFile)
150       throws IOException;
151   }
152 
153   private RegionVisitor createRegionVisitor(final SnapshotDescription desc) throws IOException {
154     switch (getSnapshotFormat(desc)) {
155       case SnapshotManifestV1.DESCRIPTOR_VERSION:
156         return new SnapshotManifestV1.ManifestBuilder(conf, fs, workingDir);
157       case SnapshotManifestV2.DESCRIPTOR_VERSION:
158         return new SnapshotManifestV2.ManifestBuilder(conf, fs, workingDir);
159       default:
160         throw new CorruptedSnapshotException("Invalid Snapshot version: "+ desc.getVersion(), desc);
161     }
162   }
163 
164   public void addMobRegion(HRegionInfo regionInfo) throws IOException {
165     // 0. Get the ManifestBuilder/RegionVisitor
166     RegionVisitor visitor = createRegionVisitor(desc);
167 
168     // 1. dump region meta info into the snapshot directory
169     LOG.debug("Storing mob region '" + regionInfo + "' region-info for snapshot.");
170     Object regionData = visitor.regionOpen(regionInfo);
171     monitor.rethrowException();
172 
173     // 2. iterate through all the stores in the region
174     LOG.debug("Creating references for mob files");
175 
176     Path mobRegionPath = MobUtils.getMobRegionPath(conf, regionInfo.getTable());
177     for (HColumnDescriptor hcd : htd.getColumnFamilies()) {
178       // 2.1. build the snapshot reference for the store if it's a mob store
179       if (!hcd.isMobEnabled()) {
180         continue;
181       }
182       Object familyData = visitor.familyOpen(regionData, hcd.getName());
183       monitor.rethrowException();
184 
185       Path storePath = MobUtils.getMobFamilyPath(mobRegionPath, hcd.getNameAsString());
186       if (!fs.exists(storePath)) {
187         continue;
188       }
189       FileStatus[] stats = fs.listStatus(storePath);
190       if (stats == null) {
191         continue;
192       }
193       List<StoreFileInfo> storeFiles = new ArrayList<StoreFileInfo>();
194       for (FileStatus stat : stats) {
195         storeFiles.add(new StoreFileInfo(conf, fs, stat));
196       }
197       if (LOG.isDebugEnabled()) {
198         LOG.debug("Adding snapshot references for " + storeFiles + " mob files");
199       }
200 
201       // 2.2. iterate through all the mob files and create "references".
202       for (int i = 0, sz = storeFiles.size(); i < sz; i++) {
203         StoreFileInfo storeFile = storeFiles.get(i);
204         monitor.rethrowException();
205 
206         // create "reference" to this store file.
207         if (LOG.isDebugEnabled()) {
208           LOG.debug("Adding reference for mob file (" + (i + 1) + "/" + sz + "): "
209             + storeFile.getPath());
210         }
211         visitor.storeFile(regionData, familyData, storeFile);
212       }
213       visitor.familyClose(regionData, familyData);
214     }
215     visitor.regionClose(regionData);
216   }
217 
218   /**
219    * Creates a 'manifest' for the specified region, by reading directly from the HRegion object.
220    * This is used by the "online snapshot" when the table is enabled.
221    */
222   public void addRegion(final HRegion region) throws IOException {
223     // 0. Get the ManifestBuilder/RegionVisitor
224     RegionVisitor visitor = createRegionVisitor(desc);
225 
226     // 1. dump region meta info into the snapshot directory
227     LOG.debug("Storing '" + region + "' region-info for snapshot.");
228     Object regionData = visitor.regionOpen(region.getRegionInfo());
229     monitor.rethrowException();
230 
231     // 2. iterate through all the stores in the region
232     LOG.debug("Creating references for hfiles");
233 
234     for (Store store : region.getStores()) {
235       // 2.1. build the snapshot reference for the store
236       Object familyData = visitor.familyOpen(regionData, store.getFamily().getName());
237       monitor.rethrowException();
238 
239       List<StoreFile> storeFiles = new ArrayList<StoreFile>(store.getStorefiles());
240       if (LOG.isDebugEnabled()) {
241         LOG.debug("Adding snapshot references for " + storeFiles  + " hfiles");
242       }
243 
244       // 2.2. iterate through all the store's files and create "references".
245       for (int i = 0, sz = storeFiles.size(); i < sz; i++) {
246         StoreFile storeFile = storeFiles.get(i);
247         monitor.rethrowException();
248 
249         // create "reference" to this store file.
250         LOG.debug("Adding reference for file (" + (i+1) + "/" + sz + "): " + storeFile.getPath());
251         visitor.storeFile(regionData, familyData, storeFile.getFileInfo());
252       }
253       visitor.familyClose(regionData, familyData);
254     }
255     visitor.regionClose(regionData);
256   }
257 
258   /**
259    * Creates a 'manifest' for the specified region, by reading directly from the disk.
260    * This is used by the "offline snapshot" when the table is disabled.
261    */
262   public void addRegion(final Path tableDir, final HRegionInfo regionInfo) throws IOException {
263     // 0. Get the ManifestBuilder/RegionVisitor
264     RegionVisitor visitor = createRegionVisitor(desc);
265 
266     boolean isMobRegion = MobUtils.isMobRegionInfo(regionInfo);
267     try {
268       Path baseDir = tableDir;
269       // Open the RegionFS
270       if (isMobRegion) {
271         baseDir = FSUtils.getTableDir(MobUtils.getMobHome(conf), regionInfo.getTable());
272       }
273       HRegionFileSystem regionFs = HRegionFileSystem.openRegionFromFileSystem(conf, fs,
274         baseDir, regionInfo, true);
275       monitor.rethrowException();
276 
277       // 1. dump region meta info into the snapshot directory
278       LOG.debug("Storing region-info for snapshot.");
279       Object regionData = visitor.regionOpen(regionInfo);
280       monitor.rethrowException();
281 
282       // 2. iterate through all the stores in the region
283       LOG.debug("Creating references for hfiles");
284 
285       // This ensures that we have an atomic view of the directory as long as we have < ls limit
286       // (batch size of the files in a directory) on the namenode. Otherwise, we get back the files
287       // in batches and may miss files being added/deleted. This could be more robust (iteratively
288       // checking to see if we have all the files until we are sure), but the limit is currently
289       // 1000 files/batch, far more than the number of store files under a single column family.
290       Collection<String> familyNames = regionFs.getFamilies();
291       if (familyNames != null) {
292         for (String familyName: familyNames) {
293           Object familyData = visitor.familyOpen(regionData, Bytes.toBytes(familyName));
294           monitor.rethrowException();
295 
296           Collection<StoreFileInfo> storeFiles = regionFs.getStoreFiles(familyName);
297           if (storeFiles == null) {
298             if (LOG.isDebugEnabled()) {
299               LOG.debug("No files under family: " + familyName);
300             }
301             continue;
302           }
303 
304           // 2.1. build the snapshot reference for the store
305           if (LOG.isDebugEnabled()) {
306             LOG.debug("Adding snapshot references for " + storeFiles  + " hfiles");
307           }
308 
309           // 2.2. iterate through all the store's files and create "references".
310           int i = 0;
311           int sz = storeFiles.size();
312           for (StoreFileInfo storeFile: storeFiles) {
313             monitor.rethrowException();
314 
315             // create "reference" to this store file.
316             LOG.debug("Adding reference for file (" + (++i) + "/" + sz + "): "
317                 + storeFile.getPath());
318             visitor.storeFile(regionData, familyData, storeFile);
319           }
320           visitor.familyClose(regionData, familyData);
321         }
322       }
323       visitor.regionClose(regionData);
324     } catch (IOException e) {
325       // the mob directory might not be created yet, so do nothing when it is a mob region
326       if (!isMobRegion) {
327         throw e;
328       }
329     }
330   }
331 
332   /**
333    * Load the information in the SnapshotManifest. Called by SnapshotManifest.open()
334    *
335    * If the format is v2 and there is no data-manifest, means that we are loading an
336    * in-progress snapshot. Since we support rolling-upgrades, we loook for v1 and v2
337    * regions format.
338    */
339   private void load() throws IOException {
340     switch (getSnapshotFormat(desc)) {
341       case SnapshotManifestV1.DESCRIPTOR_VERSION: {
342         this.htd = FSTableDescriptors.getTableDescriptorFromFs(fs, workingDir);
343         ThreadPoolExecutor tpool = createExecutor("SnapshotManifestLoader");
344         try {
345           this.regionManifests =
346             SnapshotManifestV1.loadRegionManifests(conf, tpool, fs, workingDir, desc);
347         } finally {
348           tpool.shutdown();
349         }
350         break;
351       }
352       case SnapshotManifestV2.DESCRIPTOR_VERSION: {
353         SnapshotDataManifest dataManifest = readDataManifest();
354         if (dataManifest != null) {
355           htd = HTableDescriptor.convert(dataManifest.getTableSchema());
356           regionManifests = dataManifest.getRegionManifestsList();
357         } else {
358           // Compatibility, load the v1 regions
359           // This happens only when the snapshot is in-progress and the cache wants to refresh.
360           List<SnapshotRegionManifest> v1Regions, v2Regions;
361           ThreadPoolExecutor tpool = createExecutor("SnapshotManifestLoader");
362           try {
363             v1Regions = SnapshotManifestV1.loadRegionManifests(conf, tpool, fs, workingDir, desc);
364             v2Regions = SnapshotManifestV2.loadRegionManifests(conf, tpool, fs, workingDir, desc);
365           } catch (InvalidProtocolBufferException e) {
366             throw new CorruptedSnapshotException("unable to parse region manifest " +
367                 e.getMessage(), e);
368           } finally {
369             tpool.shutdown();
370           }
371           if (v1Regions != null && v2Regions != null) {
372             regionManifests =
373               new ArrayList<SnapshotRegionManifest>(v1Regions.size() + v2Regions.size());
374             regionManifests.addAll(v1Regions);
375             regionManifests.addAll(v2Regions);
376           } else if (v1Regions != null) {
377             regionManifests = v1Regions;
378           } else /* if (v2Regions != null) */ {
379             regionManifests = v2Regions;
380           }
381         }
382         break;
383       }
384       default:
385         throw new CorruptedSnapshotException("Invalid Snapshot version: "+ desc.getVersion(), desc);
386     }
387   }
388 
389   /**
390    * Get the current snapshot working dir
391    */
392   public Path getSnapshotDir() {
393     return this.workingDir;
394   }
395 
396   /**
397    * Get the SnapshotDescription
398    */
399   public SnapshotDescription getSnapshotDescription() {
400     return this.desc;
401   }
402 
403   /**
404    * Get the table descriptor from the Snapshot
405    */
406   public HTableDescriptor getTableDescriptor() {
407     return this.htd;
408   }
409 
410   /**
411    * Get all the Region Manifest from the snapshot
412    */
413   public List<SnapshotRegionManifest> getRegionManifests() {
414     return this.regionManifests;
415   }
416 
417   /**
418    * Get all the Region Manifest from the snapshot.
419    * This is an helper to get a map with the region encoded name
420    */
421   public Map<String, SnapshotRegionManifest> getRegionManifestsMap() {
422     if (regionManifests == null || regionManifests.size() == 0) return null;
423 
424     HashMap<String, SnapshotRegionManifest> regionsMap =
425         new HashMap<String, SnapshotRegionManifest>(regionManifests.size());
426     for (SnapshotRegionManifest manifest: regionManifests) {
427       String regionName = getRegionNameFromManifest(manifest);
428       regionsMap.put(regionName, manifest);
429     }
430     return regionsMap;
431   }
432 
433   public void consolidate() throws IOException {
434     if (getSnapshotFormat(desc) == SnapshotManifestV1.DESCRIPTOR_VERSION) {
435       Path rootDir = FSUtils.getRootDir(conf);
436       LOG.info("Using old Snapshot Format");
437       // write a copy of descriptor to the snapshot directory
438       new FSTableDescriptors(conf, fs, rootDir)
439         .createTableDescriptorForTableDirectory(workingDir, htd, false);
440     } else {
441       LOG.debug("Convert to Single Snapshot Manifest");
442       convertToV2SingleManifest();
443     }
444   }
445 
446   /*
447    * In case of rolling-upgrade, we try to read all the formats and build
448    * the snapshot with the latest format.
449    */
450   private void convertToV2SingleManifest() throws IOException {
451     // Try to load v1 and v2 regions
452     List<SnapshotRegionManifest> v1Regions, v2Regions;
453     ThreadPoolExecutor tpool = createExecutor("SnapshotManifestLoader");
454     try {
455       v1Regions = SnapshotManifestV1.loadRegionManifests(conf, tpool, fs, workingDir, desc);
456       v2Regions = SnapshotManifestV2.loadRegionManifests(conf, tpool, fs, workingDir, desc);
457     } finally {
458       tpool.shutdown();
459     }
460 
461     SnapshotDataManifest.Builder dataManifestBuilder = SnapshotDataManifest.newBuilder();
462     dataManifestBuilder.setTableSchema(htd.convert());
463 
464     if (v1Regions != null && v1Regions.size() > 0) {
465       dataManifestBuilder.addAllRegionManifests(v1Regions);
466     }
467     if (v2Regions != null && v2Regions.size() > 0) {
468       dataManifestBuilder.addAllRegionManifests(v2Regions);
469     }
470 
471     // Write the v2 Data Manifest.
472     // Once the data-manifest is written, the snapshot can be considered complete.
473     // Currently snapshots are written in a "temporary" directory and later
474     // moved to the "complated" snapshot directory.
475     SnapshotDataManifest dataManifest = dataManifestBuilder.build();
476     writeDataManifest(dataManifest);
477     this.regionManifests = dataManifest.getRegionManifestsList();
478 
479     // Remove the region manifests. Everything is now in the data-manifest.
480     // The delete operation is "relaxed", unless we get an exception we keep going.
481     // The extra files in the snapshot directory will not give any problem,
482     // since they have the same content as the data manifest, and even by re-reading
483     // them we will get the same information.
484     if (v1Regions != null && v1Regions.size() > 0) {
485       for (SnapshotRegionManifest regionManifest: v1Regions) {
486         SnapshotManifestV1.deleteRegionManifest(fs, workingDir, regionManifest);
487       }
488     }
489     if (v2Regions != null && v2Regions.size() > 0) {
490       for (SnapshotRegionManifest regionManifest: v2Regions) {
491         SnapshotManifestV2.deleteRegionManifest(fs, workingDir, regionManifest);
492       }
493     }
494   }
495 
496   /*
497    * Write the SnapshotDataManifest file
498    */
499   private void writeDataManifest(final SnapshotDataManifest manifest)
500       throws IOException {
501     FSDataOutputStream stream = fs.create(new Path(workingDir, DATA_MANIFEST_NAME));
502     try {
503       manifest.writeTo(stream);
504     } finally {
505       stream.close();
506     }
507   }
508 
509   /*
510    * Read the SnapshotDataManifest file
511    */
512   private SnapshotDataManifest readDataManifest() throws IOException {
513     FSDataInputStream in = null;
514     try {
515       in = fs.open(new Path(workingDir, DATA_MANIFEST_NAME));
516       CodedInputStream cin = CodedInputStream.newInstance(in);
517       cin.setSizeLimit(manifestSizeLimit);
518       return SnapshotDataManifest.parseFrom(cin);
519     } catch (FileNotFoundException e) {
520       return null;
521     } catch (InvalidProtocolBufferException e) {
522       throw new CorruptedSnapshotException("unable to parse data manifest " + e.getMessage(), e);
523     } finally {
524       if (in != null) in.close();
525     }
526   }
527 
528   private ThreadPoolExecutor createExecutor(final String name) {
529     return createExecutor(conf, name);
530   }
531 
532   public static ThreadPoolExecutor createExecutor(final Configuration conf, final String name) {
533     int maxThreads = conf.getInt("hbase.snapshot.thread.pool.max", 8);
534     return Threads.getBoundedCachedThreadPool(maxThreads, 30L, TimeUnit.SECONDS,
535               Threads.getNamedThreadFactory(name));
536   }
537 
538   /**
539    * Extract the region encoded name from the region manifest
540    */
541   static String getRegionNameFromManifest(final SnapshotRegionManifest manifest) {
542     byte[] regionName = HRegionInfo.createRegionName(
543             ProtobufUtil.toTableName(manifest.getRegionInfo().getTableName()),
544             manifest.getRegionInfo().getStartKey().toByteArray(),
545             manifest.getRegionInfo().getRegionId(), true);
546     return HRegionInfo.encodeRegionName(regionName);
547   }
548 
549   /*
550    * Return the snapshot format
551    */
552   private static int getSnapshotFormat(final SnapshotDescription desc) {
553     return desc.hasVersion() ? desc.getVersion() : SnapshotManifestV1.DESCRIPTOR_VERSION;
554   }
555 }