org.apache.hadoop.hbase.master

Class MasterFileSystem

java.lang.Object

org.apache.hadoop.hbase.master.MasterFileSystem

@InterfaceAudience.Private
public class MasterFileSystem
extends Object

This class abstracts a bunch of operations the HMaster needs to interact with the underlying file system like creating the initial layout, checking file system status, etc.

Field Summary

Fields

Modifier and Type	Field and Description
private ClusterId	clusterId
private org.apache.hadoop.conf.Configuration	conf
private org.apache.hadoop.fs.FileSystem	fs
static String	HBASE_DIR_PERMS Parameter name for HBase instance root directory permission
static String	HBASE_WAL_DIR_PERMS Parameter name for HBase WAL directory permission
private org.apache.hadoop.fs.permission.FsPermission	HiddenDirPerms
private boolean	isSecurityEnabled
private static org.slf4j.Logger	LOG
private org.apache.hadoop.fs.Path	rootdir
private org.apache.hadoop.fs.permission.FsPermission	secureRootFilePerms
private org.apache.hadoop.fs.permission.FsPermission	secureRootSubDirPerms
private org.apache.hadoop.fs.Path	tempdir
private org.apache.hadoop.fs.FileSystem	walFs
private org.apache.hadoop.fs.Path	walRootDir

Constructor Summary

Constructors

Constructor and Description
MasterFileSystem(org.apache.hadoop.conf.Configuration conf)

Method Summary

Modifier and Type	Method and Description
private static void	bootstrap(org.apache.hadoop.fs.Path rd, org.apache.hadoop.conf.Configuration c)
private org.apache.hadoop.fs.Path	checkRootDir(org.apache.hadoop.fs.Path rd, org.apache.hadoop.conf.Configuration c, org.apache.hadoop.fs.FileSystem fs) Get the rootdir.
private void	checkStagingDir() Check permissions for bulk load staging directory.
private void	checkSubDir(org.apache.hadoop.fs.Path p, String dirPermsConfName) Make sure the directories under rootDir have good permissions.
private void	checkTempDir(org.apache.hadoop.fs.Path tmpdir, org.apache.hadoop.conf.Configuration c, org.apache.hadoop.fs.FileSystem fs) Make sure the hbase temp directory exists and is empty.
private void	createInitialFileSystemLayout() Create initial layout in filesystem.
void	deleteFamilyFromFS(org.apache.hadoop.fs.Path rootDir, RegionInfo region, byte[] familyName)
void	deleteFamilyFromFS(RegionInfo region, byte[] familyName)
ClusterId	getClusterId()
org.apache.hadoop.conf.Configuration	getConfiguration()
org.apache.hadoop.fs.FileSystem	getFileSystem()
org.apache.hadoop.fs.Path	getRootDir()
org.apache.hadoop.fs.Path	getTempDir()
org.apache.hadoop.fs.FileSystem	getWALFileSystem()
org.apache.hadoop.fs.Path	getWALRootDir()
void	logFileSystemState(org.slf4j.Logger log)
static TableDescriptor	setInfoFamilyCachingForMeta(TableDescriptor metaDescriptor, boolean b) Enable in memory caching for hbase:meta
void	stop()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOG

private static final org.slf4j.Logger LOG

HBASE_DIR_PERMS

public static final String HBASE_DIR_PERMS

Parameter name for HBase instance root directory permission

See Also:

Constant Field Values

HBASE_WAL_DIR_PERMS

public static final String HBASE_WAL_DIR_PERMS

Parameter name for HBase WAL directory permission

See Also:

Constant Field Values

conf

private final org.apache.hadoop.conf.Configuration conf

clusterId

private ClusterId clusterId

fs

private final org.apache.hadoop.fs.FileSystem fs

walFs

private final org.apache.hadoop.fs.FileSystem walFs

rootdir

private final org.apache.hadoop.fs.Path rootdir

tempdir

private final org.apache.hadoop.fs.Path tempdir

walRootDir

private final org.apache.hadoop.fs.Path walRootDir

secureRootSubDirPerms

private final org.apache.hadoop.fs.permission.FsPermission secureRootSubDirPerms

secureRootFilePerms

private final org.apache.hadoop.fs.permission.FsPermission secureRootFilePerms

HiddenDirPerms

private final org.apache.hadoop.fs.permission.FsPermission HiddenDirPerms

isSecurityEnabled

private boolean isSecurityEnabled

Constructor Detail

MasterFileSystem

public MasterFileSystem(org.apache.hadoop.conf.Configuration conf)
                 throws IOException

Throws:

IOException

Method Detail

createInitialFileSystemLayout

private void createInitialFileSystemLayout()
                                    throws IOException

Create initial layout in filesystem.

1. Check if the meta region exists and is readable, if not create it. Create hbase.version and the hbase:meta directory if not one.

Idempotent.

Throws:

IOException

getFileSystem

public org.apache.hadoop.fs.FileSystem getFileSystem()

getWALFileSystem

public org.apache.hadoop.fs.FileSystem getWALFileSystem()

getConfiguration

public org.apache.hadoop.conf.Configuration getConfiguration()

getRootDir

public org.apache.hadoop.fs.Path getRootDir()

Returns:

HBase root directory.

getWALRootDir

public org.apache.hadoop.fs.Path getWALRootDir()

Returns:

HBase WAL root directory, usually the same as getRootDir() but can be different if hfiles on one fs and WALs on another. The 'WALs' dir gets made underneath the root dir returned here; i.e. this is '/hbase', not '/hbase/WALs'.

getTempDir

public org.apache.hadoop.fs.Path getTempDir()

Returns:

HBase temp dir.

getClusterId

public ClusterId getClusterId()

Returns:

The unique identifier generated for this cluster

checkRootDir

private org.apache.hadoop.fs.Path checkRootDir(org.apache.hadoop.fs.Path rd,
                                               org.apache.hadoop.conf.Configuration c,
                                               org.apache.hadoop.fs.FileSystem fs)
                                        throws IOException

Get the rootdir. Make sure its wholesome and exists before returning.

Parameters:

rd -

c -

fs -

Returns:

hbase.rootdir (after checks for existence and bootstrapping if needed populating the directory with necessary bootup files).

Throws:

IOException

checkTempDir

private void checkTempDir(org.apache.hadoop.fs.Path tmpdir,
                          org.apache.hadoop.conf.Configuration c,
                          org.apache.hadoop.fs.FileSystem fs)
                   throws IOException

Make sure the hbase temp directory exists and is empty. NOTE that this method is only executed once just after the master becomes the active one.

Throws:

IOException

checkSubDir

private void checkSubDir(org.apache.hadoop.fs.Path p,
                         String dirPermsConfName)
                  throws IOException

Make sure the directories under rootDir have good permissions. Create if necessary.

Parameters:

p -

Throws:

IOException

checkStagingDir

private void checkStagingDir()
                      throws IOException

Check permissions for bulk load staging directory. This directory has special hidden permissions. Create it if necessary.

Throws:

IOException

bootstrap

private static void bootstrap(org.apache.hadoop.fs.Path rd,
                              org.apache.hadoop.conf.Configuration c)
                       throws IOException

Throws:

IOException

setInfoFamilyCachingForMeta

public static TableDescriptor setInfoFamilyCachingForMeta(TableDescriptor metaDescriptor,
                                                          boolean b)

Enable in memory caching for hbase:meta

deleteFamilyFromFS

public void deleteFamilyFromFS(RegionInfo region,
                               byte[] familyName)
                        throws IOException

Throws:

IOException

deleteFamilyFromFS

public void deleteFamilyFromFS(org.apache.hadoop.fs.Path rootDir,
                               RegionInfo region,
                               byte[] familyName)
                        throws IOException

Throws:

IOException

stop

public void stop()

logFileSystemState

public void logFileSystemState(org.slf4j.Logger log)
                        throws IOException

Throws:

IOException