lib/fsm.h

Go to the documentation of this file.

#ifndef H_FSM
#define H_FSM

#include "cpio.h"

/*@-exportlocal@*/
/*@unchecked@*/
extern int _fsm_debug;
/*@=exportlocal@*/

#define FSM_VERBOSE     0x8000
#define FSM_INTERNAL    0x4000
#define FSM_SYSCALL     0x2000
#define FSM_DEAD        0x1000

#define _fv(_a)         ((_a) | FSM_VERBOSE)
#define _fi(_a)         ((_a) | FSM_INTERNAL)
#define _fs(_a)         ((_a) | (FSM_INTERNAL | FSM_SYSCALL))
#define _fd(_a)         ((_a) | (FSM_INTERNAL | FSM_DEAD))

typedef enum fileStage_e {
    FSM_UNKNOWN =   0,
    FSM_INIT    =  _fd(1),
    FSM_PRE     =  _fd(2),
    FSM_PROCESS =  _fv(3),
    FSM_POST    =  _fd(4),
    FSM_UNDO    =  5,
    FSM_FINI    =  6,

    FSM_PKGINSTALL      = _fd(7),
    FSM_PKGERASE        = _fd(8),
    FSM_PKGBUILD        = _fd(9),
    FSM_PKGCOMMIT       = _fd(10),
    FSM_PKGUNDO         = _fd(11),

    FSM_CREATE  =  _fd(17),
    FSM_MAP     =  _fd(18),
    FSM_MKDIRS  =  _fi(19),
    FSM_RMDIRS  =  _fi(20),
    FSM_MKLINKS =  _fi(21),
    FSM_NOTIFY  =  _fd(22),
    FSM_DESTROY =  _fd(23),
    FSM_VERIFY  =  _fd(24),
    FSM_COMMIT  =  _fd(25),

    FSM_UNLINK  =  _fs(33),
    FSM_RENAME  =  _fs(34),
    FSM_MKDIR   =  _fs(35),
    FSM_RMDIR   =  _fs(36),
    FSM_LSETFCON=  _fs(39),
    FSM_CHOWN   =  _fs(40),
    FSM_LCHOWN  =  _fs(41),
    FSM_CHMOD   =  _fs(42),
    FSM_UTIME   =  _fs(43),
    FSM_SYMLINK =  _fs(44),
    FSM_LINK    =  _fs(45),
    FSM_MKFIFO  =  _fs(46),
    FSM_MKNOD   =  _fs(47),
    FSM_LSTAT   =  _fs(48),
    FSM_STAT    =  _fs(49),
    FSM_READLINK=  _fs(50),
    FSM_CHROOT  =  _fs(51),

    FSM_NEXT    =  _fd(65),
    FSM_EAT     =  _fd(66),
    FSM_POS     =  _fd(67),
    FSM_PAD     =  _fd(68),
    FSM_TRAILER =  _fd(69),
    FSM_HREAD   =  _fd(70),
    FSM_HWRITE  =  _fd(71),
    FSM_DREAD   =  _fs(72),
    FSM_DWRITE  =  _fs(73),

    FSM_ROPEN   =  _fs(129),
    FSM_READ    =  _fs(130),
    FSM_RCLOSE  =  _fs(131),
    FSM_WOPEN   =  _fs(132),
    FSM_WRITE   =  _fs(133),
    FSM_WCLOSE  =  _fs(134)
} fileStage;
#undef  _fv
#undef  _fi
#undef  _fs
#undef  _fd

struct hardLink_s {
/*@owned@*/ /*@relnull@*/
    struct hardLink_s * next;
/*@owned@*/
    const char ** nsuffix;
/*@owned@*/
    int * filex;
    struct stat sb;
    int nlink;
    int linksLeft;
    int linkIndex;
    int createdPath;
};

struct fsmIterator_s {
    rpmts ts;                   
    rpmfi fi;                   
    int reverse;                
    int isave;                  
    int i;                      
};

struct fsm_s {
/*@owned@*/ /*@relnull@*/
    const char * path;          
/*@owned@*/ /*@relnull@*/
    const char * opath;         
/*@relnull@*/
    FD_t cfd;                   
/*@relnull@*/
    FD_t rfd;                   
/*@dependent@*/ /*@relnull@*/
    char * rdbuf;               
/*@owned@*/ /*@relnull@*/
    char * rdb;                 
    size_t rdsize;              
    size_t rdlen;               
    size_t rdnb;                
    FD_t wfd;                   
/*@dependent@*/ /*@relnull@*/
    char * wrbuf;               
/*@owned@*/ /*@relnull@*/
    char * wrb;                 
    size_t wrsize;              
    size_t wrlen;               
    size_t wrnb;                
/*@only@*/ /*@null@*/
    FSMI_t iter;                
    int ix;                     
/*@only@*/ /*@relnull@*/
    struct hardLink_s * links;  
/*@only@*/ /*@relnull@*/
    struct hardLink_s * li;     
/*@kept@*/ /*@null@*/
    unsigned int * archiveSize; 
/*@kept@*/ /*@null@*/
    const char ** failedFile;   
/*@shared@*/ /*@relnull@*/
    const char * subdir;        
/*@unused@*/
    char subbuf[64];    /* XXX eliminate */
/*@observer@*/ /*@relnull@*/
    const char * osuffix;       
/*@observer@*/ /*@relnull@*/
    const char * nsuffix;       
/*@shared@*/ /*@relnull@*/
    const char * suffix;        
    char sufbuf[64];    /* XXX eliminate */
/*@only@*/ /*@null@*/
    short * dnlx;               
/*@only@*/ /*@null@*/
    char * ldn;                 
    int ldnlen;                 
    int ldnalloc;               
    int postpone;               
    int diskchecked;            
    int exists;                 
    int mkdirsdone;             
    int astriplen;              
    int rc;                     
    int commit;                 
    cpioMapFlags mapFlags;      
/*@shared@*/ /*@relnull@*/
    const char * dirName;       
/*@shared@*/ /*@relnull@*/
    const char * baseName;      
/*@shared@*/ /*@relnull@*/
    const char * fmd5sum;       
/*@shared@*/ /*@relnull@*/
    const char * md5sum;        
/*@dependent@*/ /*@observer@*/ /*@null@*/
    const char * fcontext;      
    unsigned fflags;            
    fileAction action;          
    fileStage goal;             
    fileStage stage;            
    fileStage nstage;           
    struct stat sb;             
    struct stat osb;            
};

#ifdef __cplusplus
extern "C" {
#endif

/*@-exportlocal@*/
/*@observer@*/ const char *const fileStageString(fileStage a)   /*@*/;

/*@observer@*/ const char *const fileActionString(fileAction a) /*@*/;
/*@=exportlocal@*/

/*@only@*/ FSM_t newFSM(void)
        /*@*/;

/*@null@*/ FSM_t freeFSM(/*@only@*/ /*@null@*/ FSM_t fsm)
        /*@globals fileSystem @*/
        /*@modifies fsm, fileSystem @*/;

int fsmSetup(FSM_t fsm, fileStage goal,
                const rpmts ts,
                const rpmfi fi,
                FD_t cfd,
                /*@out@*/ unsigned int * archiveSize,
                /*@out@*/ const char ** failedFile)
        /*@globals h_errno, fileSystem, internalState @*/
        /*@modifies fsm, ts, fi, *archiveSize, *failedFile,
                fileSystem, internalState @*/;

int fsmTeardown(FSM_t fsm)
        /*@globals h_errno, fileSystem, internalState @*/
        /*@modifies fsm, fileSystem, internalState @*/;

/*@-exportlocal@*/
rpmts fsmGetTs(const FSM_t fsm)
        /*@*/;

rpmfi fsmGetFi(/*@partial@*/ const FSM_t fsm)
        /*@*/;

int fsmMapPath(FSM_t fsm)
        /*@modifies fsm @*/;

int fsmMapAttrs(FSM_t fsm)
        /*@modifies fsm @*/;
/*@=exportlocal@*/

int fsmNext(FSM_t fsm, fileStage nstage)
        /*@globals errno, h_errno, fileSystem, internalState @*/
        /*@modifies fsm, errno, fileSystem, internalState @*/;

/*@-exportlocal@*/
int fsmStage(/*@partial@*/ FSM_t fsm, fileStage stage)
        /*@globals errno, h_errno, fileSystem, internalState @*/
        /*@modifies fsm, errno, fileSystem, internalState @*/;
/*@=exportlocal@*/

#ifdef __cplusplus
}
#endif

#endif  /* H_FSM */

---