/*** Copyright (c), The Regents of the University of California            ***
 *** For more information please refer to structFiles in the COPYRIGHT directory ***/

/* tarSubStructFileDriver.h - header structFile for tarSubStructFileDriver.c
 */



#ifndef TAR_STRUCT_FILE_DRIVER_H_H
#define TAR_STRUCT_FILE_DRIVER_H_H

#include "rods.h"
#include "structFileDriver.h"

typedef struct tarSubFileDesc {
    int inuseFlag;
    int structFileInx;
    int fd;                         /* the fd of the opened cached subFile */
    char cacheFilePath[MAX_NAME_LEN];   /* the phy path name of the cached
                                         * subFile */
} tarSubFileDesc_t;

#define NUM_TAR_SUB_FILE_DESC 20

int
tarSubStructFileCreate (rsComm_t *rsComm, subFile_t *subFile);
int 
tarSubStructFileOpen (rsComm_t *rsComm, subFile_t *subFile); 
int 
tarSubStructFileRead (rsComm_t *rsComm, int fd, void *buf, int len);
int
tarSubStructFileWrite (rsComm_t *rsComm, int fd, void *buf, int len);
int 
tarSubStructFileClose (rsComm_t *rsComm, int fd);
int 
tarSubStructFileUnlink (rsComm_t *rsComm, subFile_t *subFile); 
int
tarSubStructFileStat (rsComm_t *rsComm, subFile_t *subFile,
rodsStat_t **subStructFileStatOut); 
int
tarSubStructFileFstat (rsComm_t *rsComm, int fd, 
rodsStat_t **subStructFileStatOut);
rodsLong_t
tarSubStructFileLseek (rsComm_t *rsComm, int fd, rodsLong_t offset, int whence);
int 
tarSubStructFileRename (rsComm_t *rsComm, subFile_t *subFile, char *newFileName);
int
tarSubStructFileMkdir (rsComm_t *rsComm, subFile_t *subFile);
int
tarSubStructFileRmdir (rsComm_t *rsComm, subFile_t *subFile);
int
tarSubStructFileOpendir (rsComm_t *rsComm, subFile_t *subFile);
int
tarSubStructFileReaddir (rsComm_t *rsComm, int fd, rodsDirent_t **rodsDirent);
int
tarSubStructFileClosedir (rsComm_t *rsComm, int fd);
int
tarSubStructFileTruncate (rsComm_t *rsComm, subFile_t *subFile);
int
rsTarStructFileOpen (rsComm_t *rsComm, specColl_t *specColl);
int
stageTarStructFile (int structFileInx);
int
mkTarCacheDir (int structFileInx);
int
irodsTarOpen (char *pathname, int oflags, int mode);
int
irodsTarClose (int fd);
int
irodsTarRead (int fd, char *buf, int len);
int
irodsTarWrite (int fd, char *buf, int len);
int
verifyStructFileDesc (int structFileInx, char *tarPathname,
specColl_t **specColl);
int
encodeIrodsTarfd (int upperInt, int lowerInt);
int
decodeIrodsTarfd (int inpInt, int *upperInt, int *lowerInt);
int
extractTarFile (int structFileInx);
int
extractTarFileWithExec (int structFileInx);
int
extractTarFileWithLib (int structFileInx);
int
matchStructFileDesc (specColl_t *specColl);
int
getSubStructFilePhyPath (char *phyPath, specColl_t *specColl,
char *subFilePath);
int
tarStructFileSync (rsComm_t *rsComm, structFileOprInp_t *structFileOprInp);
int
tarLogStructFileSync (rsComm_t *rsComm, structFileOprInp_t *structFileOprInp);
int
tarPhyStructFileSync (rsComm_t *rsComm, structFileOprInp_t *structFileOprInp);
int
tarStructFileExtract (rsComm_t *rsComm, structFileOprInp_t *structFileOprInp);
int
syncCacheDirToTarfile (int structFileInx, int oprType);
int
bundleCacheDirWithExec (int structFileInx, int oprType);
int
bundleCacheDirWithLib (int structFileInx);
int
initTarSubFileDesc ();
int
allocTarSubFileDesc ();
int
freeTarSubFileDesc (int tarSubFileInx);
int
bundleCacheDirWithZip (int structFileInx);
int
extractFileWithUnzip (int structFileInx);
#endif	/* TAR_STRUCT_FILE_DRIVER_H_H */