View Javadoc

1   /**
2    *
3    * Licensed to the Apache Software Foundation (ASF) under one
4    * or more contributor license agreements.  See the NOTICE file
5    * distributed with this work for additional information
6    * regarding copyright ownership.  The ASF licenses this file
7    * to you under the Apache License, Version 2.0 (the
8    * "License"); you may not use this file except in compliance
9    * with the License.  You may obtain a copy of the License at
10   *
11   *     http://www.apache.org/licenses/LICENSE-2.0
12   *
13   * Unless required by applicable law or agreed to in writing, software
14   * distributed under the License is distributed on an "AS IS" BASIS,
15   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16   * See the License for the specific language governing permissions and
17   * limitations under the License.
18   */
19  package org.apache.hadoop.hbase.io.hfile;
20  
21  import java.io.ByteArrayInputStream;
22  import java.io.Closeable;
23  import java.io.DataInput;
24  import java.io.DataInputStream;
25  import java.io.DataOutputStream;
26  import java.io.IOException;
27  import java.io.SequenceInputStream;
28  import java.net.InetSocketAddress;
29  import java.util.ArrayList;
30  import java.util.Collection;
31  import java.util.Comparator;
32  import java.util.List;
33  import java.util.Map;
34  import java.util.Set;
35  import java.util.SortedMap;
36  import java.util.TreeMap;
37  import java.util.concurrent.atomic.AtomicLong;
38  
39  import org.apache.hadoop.hbase.util.ByteStringer;
40  import org.apache.commons.logging.Log;
41  import org.apache.commons.logging.LogFactory;
42  import org.apache.hadoop.hbase.classification.InterfaceAudience;
43  import org.apache.hadoop.conf.Configuration;
44  import org.apache.hadoop.fs.FSDataInputStream;
45  import org.apache.hadoop.fs.FSDataOutputStream;
46  import org.apache.hadoop.fs.FileStatus;
47  import org.apache.hadoop.fs.FileSystem;
48  import org.apache.hadoop.fs.Path;
49  import org.apache.hadoop.fs.PathFilter;
50  import org.apache.hadoop.hbase.Cell;
51  import org.apache.hadoop.hbase.CellComparator;
52  import org.apache.hadoop.hbase.HConstants;
53  import org.apache.hadoop.hbase.fs.HFileSystem;
54  import org.apache.hadoop.hbase.io.FSDataInputStreamWrapper;
55  import org.apache.hadoop.hbase.io.compress.Compression;
56  import org.apache.hadoop.hbase.io.encoding.DataBlockEncoding;
57  import org.apache.hadoop.hbase.protobuf.ProtobufMagic;
58  import org.apache.hadoop.hbase.protobuf.ProtobufUtil;
59  import org.apache.hadoop.hbase.protobuf.generated.HBaseProtos;
60  import org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.BytesBytesPair;
61  import org.apache.hadoop.hbase.protobuf.generated.HFileProtos;
62  import org.apache.hadoop.hbase.util.BloomFilterWriter;
63  import org.apache.hadoop.hbase.util.Bytes;
64  import org.apache.hadoop.hbase.util.FSUtils;
65  import org.apache.hadoop.io.Writable;
66  
67  import com.google.common.annotations.VisibleForTesting;
68  import com.google.common.base.Preconditions;
69  
70  /**
71   * File format for hbase.
72   * A file of sorted key/value pairs. Both keys and values are byte arrays.
73   * <p>
74   * The memory footprint of a HFile includes the following (below is taken from the
75   * <a
76   * href=https://issues.apache.org/jira/browse/HADOOP-3315>TFile</a> documentation
77   * but applies also to HFile):
78   * <ul>
79   * <li>Some constant overhead of reading or writing a compressed block.
80   * <ul>
81   * <li>Each compressed block requires one compression/decompression codec for
82   * I/O.
83   * <li>Temporary space to buffer the key.
84   * <li>Temporary space to buffer the value.
85   * </ul>
86   * <li>HFile index, which is proportional to the total number of Data Blocks.
87   * The total amount of memory needed to hold the index can be estimated as
88   * (56+AvgKeySize)*NumBlocks.
89   * </ul>
90   * Suggestions on performance optimization.
91   * <ul>
92   * <li>Minimum block size. We recommend a setting of minimum block size between
93   * 8KB to 1MB for general usage. Larger block size is preferred if files are
94   * primarily for sequential access. However, it would lead to inefficient random
95   * access (because there are more data to decompress). Smaller blocks are good
96   * for random access, but require more memory to hold the block index, and may
97   * be slower to create (because we must flush the compressor stream at the
98   * conclusion of each data block, which leads to an FS I/O flush). Further, due
99   * to the internal caching in Compression codec, the smallest possible block
100  * size would be around 20KB-30KB.
101  * <li>The current implementation does not offer true multi-threading for
102  * reading. The implementation uses FSDataInputStream seek()+read(), which is
103  * shown to be much faster than positioned-read call in single thread mode.
104  * However, it also means that if multiple threads attempt to access the same
105  * HFile (using multiple scanners) simultaneously, the actual I/O is carried out
106  * sequentially even if they access different DFS blocks (Reexamine! pread seems
107  * to be 10% faster than seek+read in my testing -- stack).
108  * <li>Compression codec. Use "none" if the data is not very compressable (by
109  * compressable, I mean a compression ratio at least 2:1). Generally, use "lzo"
110  * as the starting point for experimenting. "gz" overs slightly better
111  * compression ratio over "lzo" but requires 4x CPU to compress and 2x CPU to
112  * decompress, comparing to "lzo".
113  * </ul>
114  *
115  * For more on the background behind HFile, see <a
116  * href=https://issues.apache.org/jira/browse/HBASE-61>HBASE-61</a>.
117  * <p>
118  * File is made of data blocks followed by meta data blocks (if any), a fileinfo
119  * block, data block index, meta data block index, and a fixed size trailer
120  * which records the offsets at which file changes content type.
121  * <pre>&lt;data blocks&gt;&lt;meta blocks&gt;&lt;fileinfo&gt;&lt;
122  * data index&gt;&lt;meta index&gt;&lt;trailer&gt;</pre>
123  * Each block has a bit of magic at its start.  Block are comprised of
124  * key/values.  In data blocks, they are both byte arrays.  Metadata blocks are
125  * a String key and a byte array value.  An empty file looks like this:
126  * <pre>&lt;fileinfo&gt;&lt;trailer&gt;</pre>.  That is, there are not data nor meta
127  * blocks present.
128  * <p>
129  * TODO: Do scanners need to be able to take a start and end row?
130  * TODO: Should BlockIndex know the name of its file?  Should it have a Path
131  * that points at its file say for the case where an index lives apart from
132  * an HFile instance?
133  */
134 @InterfaceAudience.Private
135 public class HFile {
136   // LOG is being used in HFileBlock and CheckSumUtil
137   static final Log LOG = LogFactory.getLog(HFile.class);
138 
139   /**
140    * Maximum length of key in HFile.
141    */
142   public final static int MAXIMUM_KEY_LENGTH = Integer.MAX_VALUE;
143 
144   /**
145    * Default compression: none.
146    */
147   public final static Compression.Algorithm DEFAULT_COMPRESSION_ALGORITHM =
148     Compression.Algorithm.NONE;
149 
150   /** Minimum supported HFile format version */
151   public static final int MIN_FORMAT_VERSION = 2;
152 
153   /** Maximum supported HFile format version
154    */
155   public static final int MAX_FORMAT_VERSION = 3;
156 
157   /**
158    * Minimum HFile format version with support for persisting cell tags
159    */
160   public static final int MIN_FORMAT_VERSION_WITH_TAGS = 3;
161 
162   /** Default compression name: none. */
163   public final static String DEFAULT_COMPRESSION =
164     DEFAULT_COMPRESSION_ALGORITHM.getName();
165 
166   /** Meta data block name for bloom filter bits. */
167   public static final String BLOOM_FILTER_DATA_KEY = "BLOOM_FILTER_DATA";
168 
169   /**
170    * We assume that HFile path ends with
171    * ROOT_DIR/TABLE_NAME/REGION_NAME/CF_NAME/HFILE, so it has at least this
172    * many levels of nesting. This is needed for identifying table and CF name
173    * from an HFile path.
174    */
175   public final static int MIN_NUM_HFILE_PATH_LEVELS = 5;
176 
177   /**
178    * The number of bytes per checksum.
179    */
180   public static final int DEFAULT_BYTES_PER_CHECKSUM = 16 * 1024;
181   // For measuring number of checksum failures
182   static final AtomicLong checksumFailures = new AtomicLong();
183 
184   // for test purpose
185   public static final AtomicLong dataBlockReadCnt = new AtomicLong(0);
186 
187   /**
188    * Number of checksum verification failures. It also
189    * clears the counter.
190    */
191   public static final long getChecksumFailuresCount() {
192     return checksumFailures.getAndSet(0);
193   }
194 
195   /** API required to write an {@link HFile} */
196   public interface Writer extends Closeable {
197     /** Max memstore (mvcc) timestamp in FileInfo */
198     public static final byte [] MAX_MEMSTORE_TS_KEY = Bytes.toBytes("MAX_MEMSTORE_TS_KEY");
199 
200     /** Add an element to the file info map. */
201     void appendFileInfo(byte[] key, byte[] value) throws IOException;
202 
203     void append(Cell cell) throws IOException;
204 
205     /** @return the path to this {@link HFile} */
206     Path getPath();
207 
208     /**
209      * Adds an inline block writer such as a multi-level block index writer or
210      * a compound Bloom filter writer.
211      */
212     void addInlineBlockWriter(InlineBlockWriter bloomWriter);
213 
214     // The below three methods take Writables.  We'd like to undo Writables but undoing the below would be pretty
215     // painful.  Could take a byte [] or a Message but we want to be backward compatible around hfiles so would need
216     // to map between Message and Writable or byte [] and current Writable serialization.  This would be a bit of work
217     // to little gain.  Thats my thinking at moment.  St.Ack 20121129
218 
219     void appendMetaBlock(String bloomFilterMetaKey, Writable metaWriter);
220 
221     /**
222      * Store general Bloom filter in the file. This does not deal with Bloom filter
223      * internals but is necessary, since Bloom filters are stored differently
224      * in HFile version 1 and version 2.
225      */
226     void addGeneralBloomFilter(BloomFilterWriter bfw);
227 
228     /**
229      * Store delete family Bloom filter in the file, which is only supported in
230      * HFile V2.
231      */
232     void addDeleteFamilyBloomFilter(BloomFilterWriter bfw) throws IOException;
233 
234     /**
235      * Return the file context for the HFile this writer belongs to
236      */
237     HFileContext getFileContext();
238   }
239 
240   /**
241    * This variety of ways to construct writers is used throughout the code, and
242    * we want to be able to swap writer implementations.
243    */
244   public static abstract class WriterFactory {
245     protected final Configuration conf;
246     protected final CacheConfig cacheConf;
247     protected FileSystem fs;
248     protected Path path;
249     protected FSDataOutputStream ostream;
250     protected CellComparator comparator = 
251         CellComparator.COMPARATOR;
252     protected InetSocketAddress[] favoredNodes;
253     private HFileContext fileContext;
254 
255     WriterFactory(Configuration conf, CacheConfig cacheConf) {
256       this.conf = conf;
257       this.cacheConf = cacheConf;
258     }
259 
260     public WriterFactory withPath(FileSystem fs, Path path) {
261       Preconditions.checkNotNull(fs);
262       Preconditions.checkNotNull(path);
263       this.fs = fs;
264       this.path = path;
265       return this;
266     }
267 
268     public WriterFactory withOutputStream(FSDataOutputStream ostream) {
269       Preconditions.checkNotNull(ostream);
270       this.ostream = ostream;
271       return this;
272     }
273 
274     public WriterFactory withComparator(CellComparator comparator) {
275       Preconditions.checkNotNull(comparator);
276       this.comparator = comparator;
277       return this;
278     }
279 
280     public WriterFactory withFavoredNodes(InetSocketAddress[] favoredNodes) {
281       // Deliberately not checking for null here.
282       this.favoredNodes = favoredNodes;
283       return this;
284     }
285 
286     public WriterFactory withFileContext(HFileContext fileContext) {
287       this.fileContext = fileContext;
288       return this;
289     }
290 
291     public Writer create() throws IOException {
292       if ((path != null ? 1 : 0) + (ostream != null ? 1 : 0) != 1) {
293         throw new AssertionError("Please specify exactly one of " +
294             "filesystem/path or path");
295       }
296       if (path != null) {
297         ostream = HFileWriterImpl.createOutputStream(conf, fs, path, favoredNodes);
298       }
299       return createWriter(fs, path, ostream,
300                    comparator, fileContext);
301     }
302 
303     protected abstract Writer createWriter(FileSystem fs, Path path, FSDataOutputStream ostream,
304         CellComparator comparator, HFileContext fileContext) throws IOException;
305   }
306 
307   /** The configuration key for HFile version to use for new files */
308   public static final String FORMAT_VERSION_KEY = "hfile.format.version";
309 
310   public static int getFormatVersion(Configuration conf) {
311     int version = conf.getInt(FORMAT_VERSION_KEY, MAX_FORMAT_VERSION);
312     checkFormatVersion(version);
313     return version;
314   }
315 
316   /**
317    * Returns the factory to be used to create {@link HFile} writers.
318    * Disables block cache access for all writers created through the
319    * returned factory.
320    */
321   public static final WriterFactory getWriterFactoryNoCache(Configuration
322        conf) {
323     Configuration tempConf = new Configuration(conf);
324     tempConf.setFloat(HConstants.HFILE_BLOCK_CACHE_SIZE_KEY, 0.0f);
325     return HFile.getWriterFactory(conf, new CacheConfig(tempConf));
326   }
327 
328   /**
329    * Returns the factory to be used to create {@link HFile} writers
330    */
331   public static final WriterFactory getWriterFactory(Configuration conf,
332       CacheConfig cacheConf) {
333     int version = getFormatVersion(conf);
334     switch (version) {
335     case 2:
336       throw new IllegalArgumentException("This should never happen. " +
337         "Did you change hfile.format.version to read v2? This version of the software writes v3" +
338         " hfiles only (but it can read v2 files without having to update hfile.format.version " +
339         "in hbase-site.xml)");
340     case 3:
341       return new HFileWriterFactory(conf, cacheConf);
342     default:
343       throw new IllegalArgumentException("Cannot create writer for HFile " +
344           "format version " + version);
345     }
346   }
347 
348   /**
349    * An abstraction used by the block index.
350    * Implementations will check cache for any asked-for block and return cached block if found.
351    * Otherwise, after reading from fs, will try and put block into cache before returning.
352    */
353   public interface CachingBlockReader {
354     /**
355      * Read in a file block.
356      * @param offset offset to read.
357      * @param onDiskBlockSize size of the block
358      * @param cacheBlock
359      * @param pread
360      * @param isCompaction is this block being read as part of a compaction
361      * @param expectedBlockType the block type we are expecting to read with this read operation,
362      *  or null to read whatever block type is available and avoid checking (that might reduce
363      *  caching efficiency of encoded data blocks)
364      * @param expectedDataBlockEncoding the data block encoding the caller is expecting data blocks
365      *  to be in, or null to not perform this check and return the block irrespective of the
366      *  encoding. This check only applies to data blocks and can be set to null when the caller is
367      *  expecting to read a non-data block and has set expectedBlockType accordingly.
368      * @return Block wrapped in a ByteBuffer.
369      * @throws IOException
370      */
371     HFileBlock readBlock(long offset, long onDiskBlockSize,
372         boolean cacheBlock, final boolean pread, final boolean isCompaction,
373         final boolean updateCacheMetrics, BlockType expectedBlockType,
374         DataBlockEncoding expectedDataBlockEncoding)
375         throws IOException;
376 
377     /**
378      * Return the given block back to the cache, if it was obtained from cache.
379      * @param block Block to be returned.
380      */
381     void returnBlock(HFileBlock block);
382   }
383 
384   /** An interface used by clients to open and iterate an {@link HFile}. */
385   public interface Reader extends Closeable, CachingBlockReader {
386     /**
387      * Returns this reader's "name". Usually the last component of the path.
388      * Needs to be constant as the file is being moved to support caching on
389      * write.
390      */
391     String getName();
392 
393     CellComparator getComparator();
394 
395     HFileScanner getScanner(boolean cacheBlocks, final boolean pread, final boolean isCompaction);
396 
397     HFileBlock getMetaBlock(String metaBlockName, boolean cacheBlock) throws IOException;
398 
399     Map<byte[], byte[]> loadFileInfo() throws IOException;
400 
401     Cell getLastKey();
402 
403     Cell midkey() throws IOException;
404 
405     long length();
406 
407     long getEntries();
408 
409     Cell getFirstKey();
410 
411     long indexSize();
412 
413     byte[] getFirstRowKey();
414 
415     byte[] getLastRowKey();
416 
417     FixedFileTrailer getTrailer();
418 
419     HFileBlockIndex.BlockIndexReader getDataBlockIndexReader();
420 
421     HFileScanner getScanner(boolean cacheBlocks, boolean pread);
422 
423     Compression.Algorithm getCompressionAlgorithm();
424 
425     /**
426      * Retrieves general Bloom filter metadata as appropriate for each
427      * {@link HFile} version.
428      * Knows nothing about how that metadata is structured.
429      */
430     DataInput getGeneralBloomFilterMetadata() throws IOException;
431 
432     /**
433      * Retrieves delete family Bloom filter metadata as appropriate for each
434      * {@link HFile}  version.
435      * Knows nothing about how that metadata is structured.
436      */
437     DataInput getDeleteBloomFilterMetadata() throws IOException;
438 
439     Path getPath();
440 
441     /** Close method with optional evictOnClose */
442     void close(boolean evictOnClose) throws IOException;
443 
444     DataBlockEncoding getDataBlockEncoding();
445 
446     boolean hasMVCCInfo();
447 
448     /**
449      * Return the file context of the HFile this reader belongs to
450      */
451     HFileContext getFileContext();
452 
453     boolean shouldIncludeMemstoreTS();
454 
455     boolean isDecodeMemstoreTS();
456 
457     DataBlockEncoding getEffectiveEncodingInCache(boolean isCompaction);
458 
459     @VisibleForTesting
460     HFileBlock.FSReader getUncachedBlockReader();
461 
462     @VisibleForTesting
463     boolean prefetchComplete();
464   }
465 
466   /**
467    * Method returns the reader given the specified arguments.
468    * TODO This is a bad abstraction.  See HBASE-6635.
469    *
470    * @param path hfile's path
471    * @param fsdis stream of path's file
472    * @param size max size of the trailer.
473    * @param cacheConf Cache configuation values, cannot be null.
474    * @param hfs
475    * @return an appropriate instance of HFileReader
476    * @throws IOException If file is invalid, will throw CorruptHFileException flavored IOException
477    */
478   private static Reader pickReaderVersion(Path path, FSDataInputStreamWrapper fsdis,
479       long size, CacheConfig cacheConf, HFileSystem hfs, Configuration conf) throws IOException {
480     FixedFileTrailer trailer = null;
481     try {
482       boolean isHBaseChecksum = fsdis.shouldUseHBaseChecksum();
483       assert !isHBaseChecksum; // Initially we must read with FS checksum.
484       trailer = FixedFileTrailer.readFromStream(fsdis.getStream(isHBaseChecksum), size);
485       switch (trailer.getMajorVersion()) {
486       case 2:
487         LOG.debug("Opening HFile v2 with v3 reader");
488         // Fall through.
489       case 3 :
490         return new HFileReaderImpl(path, trailer, fsdis, size, cacheConf, hfs, conf);
491       default:
492         throw new IllegalArgumentException("Invalid HFile version " + trailer.getMajorVersion());
493       }
494     } catch (Throwable t) {
495       try {
496         fsdis.close();
497       } catch (Throwable t2) {
498         LOG.warn("Error closing fsdis FSDataInputStreamWrapper", t2);
499       }
500       throw new CorruptHFileException("Problem reading HFile Trailer from file " + path, t);
501     }
502   }
503 
504   /**
505    * @param fs A file system
506    * @param path Path to HFile
507    * @param fsdis a stream of path's file
508    * @param size max size of the trailer.
509    * @param cacheConf Cache configuration for hfile's contents
510    * @param conf Configuration
511    * @return A version specific Hfile Reader
512    * @throws IOException If file is invalid, will throw CorruptHFileException flavored IOException
513    */
514   @SuppressWarnings("resource")
515   public static Reader createReader(FileSystem fs, Path path,
516       FSDataInputStreamWrapper fsdis, long size, CacheConfig cacheConf, Configuration conf)
517       throws IOException {
518     HFileSystem hfs = null;
519 
520     // If the fs is not an instance of HFileSystem, then create an
521     // instance of HFileSystem that wraps over the specified fs.
522     // In this case, we will not be able to avoid checksumming inside
523     // the filesystem.
524     if (!(fs instanceof HFileSystem)) {
525       hfs = new HFileSystem(fs);
526     } else {
527       hfs = (HFileSystem)fs;
528     }
529     return pickReaderVersion(path, fsdis, size, cacheConf, hfs, conf);
530   }
531 
532   /**
533    *
534    * @param fs filesystem
535    * @param path Path to file to read
536    * @param cacheConf This must not be null.  @see {@link org.apache.hadoop.hbase.io.hfile.CacheConfig#CacheConfig(Configuration)}
537    * @return an active Reader instance
538    * @throws IOException Will throw a CorruptHFileException (DoNotRetryIOException subtype) if hfile is corrupt/invalid.
539    */
540   public static Reader createReader(
541       FileSystem fs, Path path, CacheConfig cacheConf, Configuration conf) throws IOException {
542     Preconditions.checkNotNull(cacheConf, "Cannot create Reader with null CacheConf");
543     FSDataInputStreamWrapper stream = new FSDataInputStreamWrapper(fs, path);
544     return pickReaderVersion(path, stream, fs.getFileStatus(path).getLen(),
545       cacheConf, stream.getHfs(), conf);
546   }
547 
548   /**
549    * This factory method is used only by unit tests
550    */
551   static Reader createReaderFromStream(Path path,
552       FSDataInputStream fsdis, long size, CacheConfig cacheConf, Configuration conf)
553       throws IOException {
554     FSDataInputStreamWrapper wrapper = new FSDataInputStreamWrapper(fsdis);
555     return pickReaderVersion(path, wrapper, size, cacheConf, null, conf);
556   }
557 
558   /**
559    * Returns true if the specified file has a valid HFile Trailer.
560    * @param fs filesystem
561    * @param path Path to file to verify
562    * @return true if the file has a valid HFile Trailer, otherwise false
563    * @throws IOException if failed to read from the underlying stream
564    */
565   public static boolean isHFileFormat(final FileSystem fs, final Path path) throws IOException {
566     return isHFileFormat(fs, fs.getFileStatus(path));
567   }
568 
569   /**
570    * Returns true if the specified file has a valid HFile Trailer.
571    * @param fs filesystem
572    * @param fileStatus the file to verify
573    * @return true if the file has a valid HFile Trailer, otherwise false
574    * @throws IOException if failed to read from the underlying stream
575    */
576   public static boolean isHFileFormat(final FileSystem fs, final FileStatus fileStatus)
577       throws IOException {
578     final Path path = fileStatus.getPath();
579     final long size = fileStatus.getLen();
580     FSDataInputStreamWrapper fsdis = new FSDataInputStreamWrapper(fs, path);
581     try {
582       boolean isHBaseChecksum = fsdis.shouldUseHBaseChecksum();
583       assert !isHBaseChecksum; // Initially we must read with FS checksum.
584       FixedFileTrailer.readFromStream(fsdis.getStream(isHBaseChecksum), size);
585       return true;
586     } catch (IllegalArgumentException e) {
587       return false;
588     } catch (IOException e) {
589       throw e;
590     } finally {
591       try {
592         fsdis.close();
593       } catch (Throwable t) {
594         LOG.warn("Error closing fsdis FSDataInputStreamWrapper: " + path, t);
595       }
596     }
597   }
598 
599   /**
600    * Metadata for this file. Conjured by the writer. Read in by the reader.
601    */
602   public static class FileInfo implements SortedMap<byte[], byte[]> {
603     static final String RESERVED_PREFIX = "hfile.";
604     static final byte[] RESERVED_PREFIX_BYTES = Bytes.toBytes(RESERVED_PREFIX);
605     static final byte [] LASTKEY = Bytes.toBytes(RESERVED_PREFIX + "LASTKEY");
606     static final byte [] AVG_KEY_LEN = Bytes.toBytes(RESERVED_PREFIX + "AVG_KEY_LEN");
607     static final byte [] AVG_VALUE_LEN = Bytes.toBytes(RESERVED_PREFIX + "AVG_VALUE_LEN");
608     static final byte [] CREATE_TIME_TS = Bytes.toBytes(RESERVED_PREFIX + "CREATE_TIME_TS");
609     static final byte [] COMPARATOR = Bytes.toBytes(RESERVED_PREFIX + "COMPARATOR");
610     static final byte [] TAGS_COMPRESSED = Bytes.toBytes(RESERVED_PREFIX + "TAGS_COMPRESSED");
611     public static final byte [] MAX_TAGS_LEN = Bytes.toBytes(RESERVED_PREFIX + "MAX_TAGS_LEN");
612     private final SortedMap<byte [], byte []> map = new TreeMap<byte [], byte []>(Bytes.BYTES_COMPARATOR);
613 
614     public FileInfo() {
615       super();
616     }
617 
618     /**
619      * Append the given key/value pair to the file info, optionally checking the
620      * key prefix.
621      *
622      * @param k key to add
623      * @param v value to add
624      * @param checkPrefix whether to check that the provided key does not start
625      *          with the reserved prefix
626      * @return this file info object
627      * @throws IOException if the key or value is invalid
628      */
629     public FileInfo append(final byte[] k, final byte[] v,
630         final boolean checkPrefix) throws IOException {
631       if (k == null || v == null) {
632         throw new NullPointerException("Key nor value may be null");
633       }
634       if (checkPrefix && isReservedFileInfoKey(k)) {
635         throw new IOException("Keys with a " + FileInfo.RESERVED_PREFIX
636             + " are reserved");
637       }
638       put(k, v);
639       return this;
640     }
641 
642     public void clear() {
643       this.map.clear();
644     }
645 
646     public Comparator<? super byte[]> comparator() {
647       return map.comparator();
648     }
649 
650     public boolean containsKey(Object key) {
651       return map.containsKey(key);
652     }
653 
654     public boolean containsValue(Object value) {
655       return map.containsValue(value);
656     }
657 
658     public Set<java.util.Map.Entry<byte[], byte[]>> entrySet() {
659       return map.entrySet();
660     }
661 
662     public boolean equals(Object o) {
663       return map.equals(o);
664     }
665 
666     public byte[] firstKey() {
667       return map.firstKey();
668     }
669 
670     public byte[] get(Object key) {
671       return map.get(key);
672     }
673 
674     public int hashCode() {
675       return map.hashCode();
676     }
677 
678     public SortedMap<byte[], byte[]> headMap(byte[] toKey) {
679       return this.map.headMap(toKey);
680     }
681 
682     public boolean isEmpty() {
683       return map.isEmpty();
684     }
685 
686     public Set<byte[]> keySet() {
687       return map.keySet();
688     }
689 
690     public byte[] lastKey() {
691       return map.lastKey();
692     }
693 
694     public byte[] put(byte[] key, byte[] value) {
695       return this.map.put(key, value);
696     }
697 
698     public void putAll(Map<? extends byte[], ? extends byte[]> m) {
699       this.map.putAll(m);
700     }
701 
702     public byte[] remove(Object key) {
703       return this.map.remove(key);
704     }
705 
706     public int size() {
707       return map.size();
708     }
709 
710     public SortedMap<byte[], byte[]> subMap(byte[] fromKey, byte[] toKey) {
711       return this.map.subMap(fromKey, toKey);
712     }
713 
714     public SortedMap<byte[], byte[]> tailMap(byte[] fromKey) {
715       return this.map.tailMap(fromKey);
716     }
717 
718     public Collection<byte[]> values() {
719       return map.values();
720     }
721 
722     /**
723      * Write out this instance on the passed in <code>out</code> stream.
724      * We write it as a protobuf.
725      * @param out
726      * @throws IOException
727      * @see #read(DataInputStream)
728      */
729     void write(final DataOutputStream out) throws IOException {
730       HFileProtos.FileInfoProto.Builder builder = HFileProtos.FileInfoProto.newBuilder();
731       for (Map.Entry<byte [], byte[]> e: this.map.entrySet()) {
732         HBaseProtos.BytesBytesPair.Builder bbpBuilder = HBaseProtos.BytesBytesPair.newBuilder();
733         bbpBuilder.setFirst(ByteStringer.wrap(e.getKey()));
734         bbpBuilder.setSecond(ByteStringer.wrap(e.getValue()));
735         builder.addMapEntry(bbpBuilder.build());
736       }
737       out.write(ProtobufMagic.PB_MAGIC);
738       builder.build().writeDelimitedTo(out);
739     }
740 
741     /**
742      * Populate this instance with what we find on the passed in <code>in</code> stream.
743      * Can deserialize protobuf of old Writables format.
744      * @param in
745      * @throws IOException
746      * @see #write(DataOutputStream)
747      */
748     void read(final DataInputStream in) throws IOException {
749       // This code is tested over in TestHFileReaderV1 where we read an old hfile w/ this new code.
750       int pblen = ProtobufUtil.lengthOfPBMagic();
751       byte [] pbuf = new byte[pblen];
752       if (in.markSupported()) in.mark(pblen);
753       int read = in.read(pbuf);
754       if (read != pblen) throw new IOException("read=" + read + ", wanted=" + pblen);
755       if (ProtobufUtil.isPBMagicPrefix(pbuf)) {
756         parsePB(HFileProtos.FileInfoProto.parseDelimitedFrom(in));
757       } else {
758         if (in.markSupported()) {
759           in.reset();
760           parseWritable(in);
761         } else {
762           // We cannot use BufferedInputStream, it consumes more than we read from the underlying IS
763           ByteArrayInputStream bais = new ByteArrayInputStream(pbuf);
764           SequenceInputStream sis = new SequenceInputStream(bais, in); // Concatenate input streams
765           // TODO: Am I leaking anything here wrapping the passed in stream?  We are not calling close on the wrapped
766           // streams but they should be let go after we leave this context?  I see that we keep a reference to the
767           // passed in inputstream but since we no longer have a reference to this after we leave, we should be ok.
768           parseWritable(new DataInputStream(sis));
769         }
770       }
771     }
772 
773     /** Now parse the old Writable format.  It was a list of Map entries.  Each map entry was a key and a value of
774      * a byte [].  The old map format had a byte before each entry that held a code which was short for the key or
775      * value type.  We know it was a byte [] so in below we just read and dump it.
776      * @throws IOException
777      */
778     void parseWritable(final DataInputStream in) throws IOException {
779       // First clear the map.  Otherwise we will just accumulate entries every time this method is called.
780       this.map.clear();
781       // Read the number of entries in the map
782       int entries = in.readInt();
783       // Then read each key/value pair
784       for (int i = 0; i < entries; i++) {
785         byte [] key = Bytes.readByteArray(in);
786         // We used to read a byte that encoded the class type.  Read and ignore it because it is always byte [] in hfile
787         in.readByte();
788         byte [] value = Bytes.readByteArray(in);
789         this.map.put(key, value);
790       }
791     }
792 
793     /**
794      * Fill our map with content of the pb we read off disk
795      * @param fip protobuf message to read
796      */
797     void parsePB(final HFileProtos.FileInfoProto fip) {
798       this.map.clear();
799       for (BytesBytesPair pair: fip.getMapEntryList()) {
800         this.map.put(pair.getFirst().toByteArray(), pair.getSecond().toByteArray());
801       }
802     }
803   }
804 
805   /** Return true if the given file info key is reserved for internal use. */
806   public static boolean isReservedFileInfoKey(byte[] key) {
807     return Bytes.startsWith(key, FileInfo.RESERVED_PREFIX_BYTES);
808   }
809 
810   /**
811    * Get names of supported compression algorithms. The names are acceptable by
812    * HFile.Writer.
813    *
814    * @return Array of strings, each represents a supported compression
815    *         algorithm. Currently, the following compression algorithms are
816    *         supported.
817    *         <ul>
818    *         <li>"none" - No compression.
819    *         <li>"gz" - GZIP compression.
820    *         </ul>
821    */
822   public static String[] getSupportedCompressionAlgorithms() {
823     return Compression.getSupportedAlgorithms();
824   }
825 
826   // Utility methods.
827   /*
828    * @param l Long to convert to an int.
829    * @return <code>l</code> cast as an int.
830    */
831   static int longToInt(final long l) {
832     // Expecting the size() of a block not exceeding 4GB. Assuming the
833     // size() will wrap to negative integer if it exceeds 2GB (From tfile).
834     return (int)(l & 0x00000000ffffffffL);
835   }
836 
837   /**
838    * Returns all HFiles belonging to the given region directory. Could return an
839    * empty list.
840    *
841    * @param fs  The file system reference.
842    * @param regionDir  The region directory to scan.
843    * @return The list of files found.
844    * @throws IOException When scanning the files fails.
845    */
846   static List<Path> getStoreFiles(FileSystem fs, Path regionDir)
847       throws IOException {
848     List<Path> regionHFiles = new ArrayList<Path>();
849     PathFilter dirFilter = new FSUtils.DirFilter(fs);
850     FileStatus[] familyDirs = fs.listStatus(regionDir, dirFilter);
851     for(FileStatus dir : familyDirs) {
852       FileStatus[] files = fs.listStatus(dir.getPath());
853       for (FileStatus file : files) {
854         if (!file.isDirectory() &&
855             (!file.getPath().toString().contains(HConstants.HREGION_OLDLOGDIR_NAME)) &&
856             (!file.getPath().toString().contains(HConstants.RECOVERED_EDITS_DIR))) {
857           regionHFiles.add(file.getPath());
858         }
859       }
860     }
861     return regionHFiles;
862   }
863 
864   /**
865    * Checks the given {@link HFile} format version, and throws an exception if
866    * invalid. Note that if the version number comes from an input file and has
867    * not been verified, the caller needs to re-throw an {@link IOException} to
868    * indicate that this is not a software error, but corrupted input.
869    *
870    * @param version an HFile version
871    * @throws IllegalArgumentException if the version is invalid
872    */
873   public static void checkFormatVersion(int version)
874       throws IllegalArgumentException {
875     if (version < MIN_FORMAT_VERSION || version > MAX_FORMAT_VERSION) {
876       throw new IllegalArgumentException("Invalid HFile version: " + version
877           + " (expected to be " + "between " + MIN_FORMAT_VERSION + " and "
878           + MAX_FORMAT_VERSION + ")");
879     }
880   }
881 
882 
883   public static void checkHFileVersion(final Configuration c) {
884     int version = c.getInt(FORMAT_VERSION_KEY, MAX_FORMAT_VERSION);
885     if (version < MAX_FORMAT_VERSION || version > MAX_FORMAT_VERSION) {
886       throw new IllegalArgumentException("The setting for " + FORMAT_VERSION_KEY +
887         " (in your hbase-*.xml files) is " + version + " which does not match " +
888         MAX_FORMAT_VERSION +
889         "; are you running with a configuration from an older or newer hbase install (an " +
890         "incompatible hbase-default.xml or hbase-site.xml on your CLASSPATH)?");
891     }
892   }
893 
894   public static void main(String[] args) throws Exception {
895     // delegate to preserve old behavior
896     HFilePrettyPrinter.main(args);
897   }
898 }