ext2read.h

/**
 * Ext2read
 * File: ext2read.h
 **/
/**
 * Copyright (C) 2005 2010 by Manish Regmi   (regmi dot manish at gmail.com)
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the
 * Free Software Foundation, Inc.,
 * 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 **/

#ifndef __EXT2READ_H
#define __EXT2READ_H

#ifdef __GNUC__
 #include <stdint.h>
#endif

#include <list>
#include <string>
#include <QCache>

#include "platform.h"
#include "ext2fs.h"
//#include "lvm.h"

#define MAX_CACHE_SIZE          500
#define INVALID_TABLE                   3
#define FILE_TYPE_PARTITON		0x7E
#define FILE_TYPE_DIR			2

/* Identifies the type of file by using i_mode of inode */
/* structure as input.									*/
#define EXT2_S_ISDIR(mode)	((mode & 0x0f000) == 0x04000)
#define EXT2_S_ISLINK(mode)	((mode & 0x0f000) == 0x0a000)
#define EXT2_S_ISBLK(mode)	((mode & 0x0f000) == 0x06000)
#define EXT2_S_ISSOCK(mode)	((mode & 0x0f000) == 0x0c000)
#define EXT2_S_ISREG(mode)	((mode & 0x0f000) == 0x08000)
#define EXT2_S_ISCHAR(mode)	((mode & 0x0f000) == 0x02000)
#define EXT2_S_ISFIFO(mode)	((mode & 0x0f000) == 0x01000)

/* Identifies the type of file by using file_type of 	*/
/* directory structure as input.						*/
#define EXT2_FT_ISDIR(mode)		(mode  == 0x2)
#define EXT2_FT_ISLINK(mode)	(mode  == 0x7)
#define EXT2_FT_ISBLK(mode)		(mode  == 0x4)
#define EXT2_FT_ISSOCK(mode)	(mode  == 0x6)
#define EXT2_FT_ISREG(mode)		(mode  == 0x1)
#define EXT2_FT_ISCHAR(mode)	(mode  == 0x3)
#define EXT2_FT_ISFIFO(mode)	(mode  == 0x5)
#define IS_PART(mode)			(mode == FILE_TYPE_PARTITION)

/* Mask values for the access rights. */
/* User */
#define EXT2_S_IRUSR			0x0100
#define EXT2_S_IWUSR			0x0080
#define EXT2_S_IXUSR			0x0040
/* Group */
#define EXT2_S_IRGRP			0x0020
#define EXT2_S_IWGRP			0x0010
#define EXT2_S_IXGRP			0x0008
/* Others */
#define EXT2_S_IROTH			0x0004
#define EXT2_S_IWOTH			0x0002
#define EXT2_S_IXOTH			0x0001

#define IS_BUFFER_END(p, q, bsize)	(((char *)(p)) >= ((char *)(q) + bsize))

using namespace std;

static INLINE const char *get_type_string(int type)
{
	switch(type)
	{
		case 0x1:	return "Regular File";
		case 0x2:	return "Directory";
		case 0x3:	return "Character Device";
		case 0x4:	return "Block Device";
		case 0x5:	return "Fifo File";
		case 0x6:	return "Socket File";
		case 0x7:	return "Symbolic Link";
	}

	return "Unknown Type";
}

static INLINE char *get_access(unsigned long mode)
{
	static char acc[9];
	acc[0] = (mode & EXT2_S_IRUSR)? 'r':'-';
	acc[1] = (mode & EXT2_S_IWUSR)? 'w':'-';
	acc[2] = (mode & EXT2_S_IXUSR)? 'x':'-';

	acc[3] = (mode & EXT2_S_IRGRP)? 'r':'-';
	acc[4] = (mode & EXT2_S_IWGRP)? 'w':'-';
	acc[5] = (mode & EXT2_S_IXGRP)? 'x':'-';

	acc[6] = (mode & EXT2_S_IROTH)? 'r':'-';
	acc[7] = (mode & EXT2_S_IWOTH)? 'w':'-';
	acc[8] = (mode & EXT2_S_IXOTH)? 'x':'-';

	acc[9] = '\0';
	return acc;
}

// forward declaration
class Ext2Partition;
class VolumeGroup;
class LogicalVolume;

class Ext2File {
public:
    uint32_t    inode_num;
    uint8_t     file_type;
    string      file_name;
    lloff_t     file_size;

    EXT2_INODE  inode;
    Ext2Partition *partition;
    bool onview;
};

typedef struct ext2dirent {
    EXT2_DIR_ENTRY *next;
    EXT2_DIR_ENTRY *dirbuf;
    Ext2File *parent;
    lloff_t read_bytes;     // Bytes already read
    lloff_t next_block;
} EXT2DIRENT;

class Ext2Partition {
    FileHandle  handle;
    int         sect_size;
    lloff_t	total_sectors;
    lloff_t 	relative_sect;
    string      linux_name;

    int inodes_per_group;
    int inode_size;
    int blocksize;
    uint32_t totalGroups;
    EXT2_GROUP_DESC *desc;
    char *inode_buffer;         // buffer to cache last used block of inodes
    lloff_t last_block;          // block number of the last inode block read
    Ext2File *root;
    QCache <lloff_t , char > buffercache; //LRU based cache for blocks
    LogicalVolume *lvol;
    
    int ext2_readblock(lloff_t blocknum, void *buffer);
    uint32_t fileblock_to_logical(EXT2_INODE *ino, uint32_t lbn);
    lloff_t extent_to_logical(EXT2_INODE *ino, lloff_t lbn);
    lloff_t extent_binarysearch(EXT4_EXTENT_HEADER *header, lloff_t lbn, bool isallocated);
    int mount();

public:
    bool onview;        // flag to determine if it is already added to view.
    bool is_valid;      // is this valid Ext2/3/4 partition

public:
    Ext2Partition(lloff_t, lloff_t, int ssise, FileHandle , LogicalVolume *vol);
    ~Ext2Partition();

    void set_linux_name(const char *, int , int);
    void set_image_name(const char *name) { linux_name.assign(name); }
    string &get_linux_name();
    Ext2File *get_root() { return root; }
    int get_blocksize() { return blocksize; }
    Ext2File *read_inode(uint32_t inum);
    int read_data_block(EXT2_INODE *ino, lloff_t lbn, void *buf);
    EXT2DIRENT *open_dir(Ext2File *parent);
    Ext2File *read_dir(EXT2DIRENT *);
    void close_dir(EXT2DIRENT *);

};

class Ext2Read {
private:
    int ndisks;

    list <Ext2Partition *> nparts;

    int scan_ebr(FileHandle , lloff_t , int , int);
    int scan_gpt(FileHandle , lloff_t , int , int);
    int scan_partitions(char *path, int);
    void clear_partitions();


public:
    Ext2Read();
    ~Ext2Read();

    list <VolumeGroup *> groups;

    void scan_system();
    int add_loopback(const char *file);
    list<Ext2Partition *> get_partitions();
    list<VolumeGroup *> &get_volgroups() { return groups; }
    void add_partition(Ext2Partition *part) { nparts.push_back(part); }
    int get_detected_disks() { return ndisks; }
};

#ifdef __cplusplus
extern "C"{
#endif

int log_init();
void log_exit();
int ext2explore_log(const char *msg, ...);
int ext2explore_log_err(char *file, char *line, const char *buf, ...);

#ifdef __cplusplus
}
#endif

#define LOG_INFO	ext2explore_log
#define LOG		LOG_INFO
#define LOG_ERROR	LOG_INFO

#endif  // __EXT2READ_H