Main Page | Modules | Data Structures | Directories | File List | Data Fields | Globals | Related Pages

fsm.c File Reference

File state machine to handle a payload from a package. More...

#include "system.h"
#include <rpmio_internal.h>
#include <rpmlib.h>
#include "cpio.h"
#include "fsm.h"
#include "rpmerr.h"
#include "rpmfi.h"
#include "rpmte.h"
#include "rpmts.h"
#include "rpmsq.h"
#include "ugid.h"
#include "debug.h"

Go to the source code of this file.

Data Structures

struct  dnli_s

Defines

#define fsmUNSAFE   fsmStage
#define _RPMFI_INTERNAL
#define alloca_strdup(_s)   strcpy(alloca(strlen(_s)+1), (_s))
#define _FSM_DEBUG   0
#define SUFFIX_RPMORIG   ".rpmorig"
#define SUFFIX_RPMSAVE   ".rpmsave"
#define SUFFIX_RPMNEW   ".rpmnew"
#define IS_DEV_LOG(_x)
#define _fafilter(_a)
#define _tsmask   (RPMTRANS_FLAG_PKGCOMMIT | RPMTRANS_FLAG_COMMIT)

Typedefs

typedef dnli_sDNLI_t

Functions

rpmts fsmGetTs (const FSM_t fsm)
 Retrieve transaction set from file state machine iterator.
rpmfi fsmGetFi (const FSM_t fsm)
 Retrieve transaction element file info from file state machine iterator.
const char * fsmFsPath (const FSM_t fsm, const struct stat *st, const char *subdir, const char *suffix)
void * mapFreeIterator (void *p)
void * mapInitIterator (rpmts ts, rpmfi fi)
int mapNextIterator (void *a)
int cpioStrCmp (const void *a, const void *b)
int mapFind (FSMI_t iter, const char *fsmPath)
void * dnlFreeIterator (const void *a)
int dnlCount (const DNLI_t dnli)
int dnlIndex (const DNLI_t dnli)
void * dnlInitIterator (const FSM_t fsm, int reverse)
const char * dnlNextIterator (DNLI_t dnli)
void * fsmThread (void *arg)
int fsmNext (FSM_t fsm, fileStage nstage)
 File state machine driver.
int saveHardLink (FSM_t fsm)
void * freeHardLink (struct hardLink_s *li)
FSM_t newFSM (void)
 Create file state machine instance.
FSM_t freeFSM (FSM_t fsm)
 Destroy file state machine instance.
int fsmSetup (FSM_t fsm, fileStage goal, const rpmts ts, const rpmfi fi, FD_t cfd, unsigned int *archiveSize, const char **failedFile)
 Load external data into file state machine.
int fsmTeardown (FSM_t fsm)
 Clean file state machine.
int fsmMapFContext (FSM_t fsm)
int fsmMapPath (FSM_t fsm)
 Map next file path and action.
int fsmMapAttrs (FSM_t fsm)
 Map file stat(2) info.
int expandRegular (FSM_t fsm)
int writeFile (FSM_t fsm, int writeData)
int writeLinkedFile (FSM_t fsm)
int fsmMakeLinks (FSM_t fsm)
int fsmCommitLinks (FSM_t fsm)
int fsmRmdirs (FSM_t fsm)
 Remove (if created) directories not explicitly included in package.
int fsmMkdirs (FSM_t fsm)
 Create (if necessary) directories not explicitly included in package.
void removeSBITS (const char *path)
int fsmStage (FSM_t fsm, fileStage stage)
 File state machine driver.
const char *const fileActionString (fileAction a)
 Return formatted string representation of file disposition.
const char *const fileStageString (fileStage a)
 Return formatted string representation of file stages.

Variables

int _fsm_debug = 0
int _fsm_threads = 0
int strict_erasures = 0


Detailed Description

File state machine to handle a payload from a package.

Definition in file fsm.c.


Define Documentation

#define _fafilter _a   ) 
 

Value:

(!((_a) == FA_CREATE || (_a) == FA_ERASE || (_a) == FA_COPYIN || (_a) == FA_COPYOUT) \
        ? fileActionString(_a) : "")

Referenced by fsmStage().

#define _FSM_DEBUG   0
 

Definition at line 36 of file fsm.c.

#define _RPMFI_INTERNAL
 

Definition at line 18 of file fsm.c.

#define _tsmask   (RPMTRANS_FLAG_PKGCOMMIT | RPMTRANS_FLAG_COMMIT)
 

#define alloca_strdup _s   )     strcpy(alloca(strlen(_s)+1), (_s))
 

Definition at line 34 of file fsm.c.

Referenced by ftpNLST(), legacyRetrofit(), relocateFileList(), and writeFile().

#define fsmUNSAFE   fsmStage
 

Definition at line 14 of file fsm.c.

Referenced by fsmMakeLinks(), fsmMkdirs(), fsmSetup(), fsmStage(), fsmTeardown(), and writeFile().

#define IS_DEV_LOG _x   ) 
 

Value:

((_x) != NULL && strlen(_x) >= (sizeof("/dev/log")-1) && \
        !strncmp((_x), "/dev/log", sizeof("/dev/log")-1) && \
        ((_x)[sizeof("/dev/log")-1] == '\0' || \
         (_x)[sizeof("/dev/log")-1] == ';'))

Definition at line 1429 of file fsm.c.

Referenced by fsmStage().

#define SUFFIX_RPMNEW   ".rpmnew"
 

Definition at line 68 of file fsm.c.

#define SUFFIX_RPMORIG   ".rpmorig"
 

Definition at line 66 of file fsm.c.

#define SUFFIX_RPMSAVE   ".rpmsave"
 

Definition at line 67 of file fsm.c.


Function Documentation

const char* const fileActionString fileAction  a  ) 
 

Return formatted string representation of file disposition.

Parameters:
a file dispostion
Returns:
formatted string

Definition at line 2457 of file fsm.c.

References FA_ALTNAME, FA_BACKUP, FA_COPYIN, FA_COPYOUT, FA_CREATE, FA_ERASE, FA_SAVE, FA_SKIP, FA_SKIPCOLOR, FA_SKIPNETSHARED, FA_SKIPNSTATE, and FA_UNKNOWN.

const char* const fileStageString fileStage  a  ) 
 

Return formatted string representation of file stages.

Parameters:
a file stage
Returns:
formatted string

Definition at line 2477 of file fsm.c.

References FSM_CHMOD, FSM_CHOWN, FSM_CHROOT, FSM_COMMIT, FSM_CREATE, FSM_DESTROY, FSM_DREAD, FSM_DWRITE, FSM_EAT, FSM_FINI, FSM_HREAD, FSM_HWRITE, FSM_INIT, FSM_LCHOWN, FSM_LINK, FSM_LSETFCON, FSM_LSTAT, FSM_MAP, FSM_MKDIR, FSM_MKDIRS, FSM_MKFIFO, FSM_MKLINKS, FSM_MKNOD, FSM_NEXT, FSM_NOTIFY, FSM_PAD, FSM_PKGBUILD, FSM_PKGCOMMIT, FSM_PKGERASE, FSM_PKGINSTALL, FSM_PKGUNDO, FSM_POS, FSM_POST, FSM_PRE, FSM_PROCESS, FSM_RCLOSE, FSM_READ, FSM_READLINK, FSM_RENAME, FSM_RMDIR, FSM_RMDIRS, FSM_ROPEN, FSM_STAT, FSM_SYMLINK, FSM_TRAILER, FSM_UNDO, FSM_UNKNOWN, FSM_UNLINK, FSM_UTIME, FSM_VERIFY, FSM_WCLOSE, FSM_WOPEN, and FSM_WRITE.

Referenced by fsmStage().

FSM_t freeFSM FSM_t  fsm  ) 
 

Destroy file state machine instance.

Parameters:
fsm file state machine
Returns:
always NULL

Definition at line 533 of file fsm.c.

References _free(), fsm_s::dnlx, freeHardLink(), FSM_t, fsm_s::iter, fsm_s::ldn, fsm_s::li, fsm_s::links, mapFreeIterator(), hardLink_s::next, and fsm_s::path.

Referenced by rpmfiFree().

rpmfi fsmGetFi const FSM_t  fsm  ) 
 

Retrieve transaction element file info from file state machine iterator.

Parameters:
fsm file state machine
Returns:
transaction element file info

Definition at line 58 of file fsm.c.

References fsmIterator_s::fi, FSM_t, FSMI_t, fsm_s::iter, and rpmfi.

Referenced by dnlInitIterator(), fsmMapAttrs(), fsmMapFContext(), fsmMapPath(), fsmMkdirs(), fsmStage(), saveHardLink(), and writeFile().

rpmts fsmGetTs const FSM_t  fsm  ) 
 

Retrieve transaction set from file state machine iterator.

Parameters:
fsm file state machine
Returns:
transaction set

Definition at line 51 of file fsm.c.

References FSM_t, FSMI_t, fsm_s::iter, rpmts, and fsmIterator_s::ts.

Referenced by fsmMapAttrs(), fsmMapFContext(), fsmMkdirs(), and fsmStage().

int fsmMapAttrs FSM_t  fsm  ) 
 

Map file stat(2) info.

Parameters:
fsm file state machine

Definition at line 756 of file fsm.c.

References _, fsm_s::fmd5sum, FSM_t, fsmGetFi(), fsmGetTs(), gnameToGid(), fsm_s::goal, int_32, fsm_s::ix, fsm_s::mapFlags, fsm_s::md5sum, rpmfi, RPMMESS_WARNING, rpmMessage, rpmts, rpmtsFlags(), fsm_s::sb, and unameToUid().

Referenced by fsmStage().

int fsmMapFContext FSM_t  fsm  )  [static]
 

Definition at line 623 of file fsm.c.

References fsm_s::fcontext, FSM_t, fsmGetFi(), fsmGetTs(), fsm_s::ix, fsm_s::path, rpmfi, rpmsx, rpmsxFContext(), rpmsxFree(), rpmts, rpmtsFlags(), rpmtsREContext(), rpmtsSELinuxEnabled(), and fsm_s::sb.

Referenced by fsmStage().

int fsmMapPath FSM_t  fsm  ) 
 

Map next file path and action.

Parameters:
fsm file state machine

Definition at line 654 of file fsm.c.

References _free(), fsm_s::action, fsm_s::astriplen, fsm_s::baseName, fsm_s::dirName, FA_ALTNAME, FA_BACKUP, FA_COPYIN, FA_COPYOUT, FA_CREATE, FA_ERASE, FA_SAVE, FA_SKIP, FA_SKIPCOLOR, FA_SKIPNETSHARED, FA_SKIPNSTATE, FA_UNKNOWN, fsm_s::fflags, FSM_t, fsmFsPath(), fsmGetFi(), fsm_s::ix, fsm_s::mapFlags, fsm_s::nsuffix, fsm_s::osuffix, fsm_s::path, rpmfi, rpmteType(), fsm_s::sb, fsm_s::subdir, fsm_s::suffix, TR_ADDED, and TR_REMOVED.

Referenced by fsmStage().

int fsmMkdirs FSM_t  fsm  )  [static]
 

Create (if necessary) directories not explicitly included in package.

Parameters:
fsm file state machine data
Returns:
0 on success

Definition at line 1261 of file fsm.c.

References _, dnlCount(), dnlFreeIterator(), dnlIndex(), dnlInitIterator(), dnlNextIterator(), fsm_s::dnlx, fsm_s::fcontext, FSM_LSETFCON, FSM_LSTAT, FSM_MKDIR, FSM_t, fsmGetFi(), fsmGetTs(), fsmNext(), fsmUNSAFE, fsm_s::ldn, fsm_s::ldnalloc, fsm_s::ldnlen, fsm_s::osb, fsm_s::path, fsm_s::rdbuf, rpmfi, RPMMESS_DEBUG, rpmMessage, rpmsx, rpmsxFContext(), rpmsxFree(), rpmts, rpmtsREContext(), fsm_s::sb, stpcpy(), xcalloc(), and xrealloc().

Referenced by fsmStage().

int fsmNext FSM_t  fsm,
fileStage  nstage
 

File state machine driver.

Parameters:
fsm file state machine
nstage next stage
Returns:
0 on success

Definition at line 406 of file fsm.c.

References FSM_t, fsmStage(), fsmThread(), fsm_s::nstage, rpmsqJoin(), and rpmsqThread().

Referenced by cpioHeaderRead(), cpioHeaderWrite(), cpioTrailerWrite(), expandRegular(), fsmCommitLinks(), fsmMakeLinks(), fsmMkdirs(), fsmRmdirs(), fsmStage(), saveHardLink(), writeFile(), and writeLinkedFile().

int fsmRmdirs FSM_t  fsm  )  [static]
 

Remove (if created) directories not explicitly included in package.

Parameters:
fsm file state machine data
Returns:
0 on success

Definition at line 1204 of file fsm.c.

References dnlCount(), dnlFreeIterator(), dnlIndex(), dnlInitIterator(), dnlNextIterator(), fsm_s::dnlx, FSM_RMDIR, FSM_t, fsmNext(), fsm_s::ldn, fsm_s::path, fsm_s::rdbuf, and stpcpy().

Referenced by fsmStage().

int fsmSetup FSM_t  fsm,
fileStage  goal,
const rpmts  ts,
const rpmfi  fi,
FD_t  cfd,
unsigned int *  archiveSize,
const char **  failedFile
 

Load external data into file state machine.

Parameters:
fsm file state machine
goal 
ts transaction set
fi transaction element file info
cfd 
Return values:
archiveSize pointer to archive size
failedFile pointer to first file name that failed.
Returns:
0 on success

Definition at line 551 of file fsm.c.

References fsm_s::archiveSize, fsm_s::cfd, fsm_s::failedFile, FD_t, fdGetCpioPos(), fdLink, fdSetCpioPos(), FSM_CREATE, FSM_PKGINSTALL, FSM_t, fsmUNSAFE, fsm_s::goal, fsm_s::iter, mapInitIterator(), fsm_s::rc, RPMCALLBACK_INST_START, rpmtsGetTid(), rpmtsNotify(), and fsm_s::sufbuf.

Referenced by cpio_doio(), and rpmpsmStage().

int fsmStage FSM_t  fsm,
fileStage  stage
 

File state machine driver.

Parameters:
fsm file state machine
stage next stage
Returns:
0 on success

Definition at line 1437 of file fsm.c.

References _, _fafilter, _free(), _fsm_debug, fsm_s::action, alloca(), fsm_s::astriplen, fsm_s::cfd, fsm_s::commit, CPIO_FOLLOW_SYMLINKS, CPIO_TRAILER, CPIOERR_ENOENT, CPIOERR_ENOTEMPTY, CPIOERR_HDR_TRAILER, cpioHeaderRead(), cpioHeaderWrite(), cpioTrailerWrite(), hardLink_s::createdPath, fsm_s::diskchecked, fsm_s::dnlx, errno, fsm_s::exists, expandRegular(), fsm_s::failedFile, Fclose(), fsm_s::fcontext, fdGetCpioPos(), fdSetCpioPos(), FDSTAT_DIGEST, fdstat_op(), Ferror(), fsm_s::fflags, fileStage, fileStageString(), hardLink_s::filex, Fopen(), Fread(), freeHardLink(), FSM_CHMOD, FSM_CHOWN, FSM_CHROOT, FSM_COMMIT, FSM_CREATE, FSM_DESTROY, FSM_DREAD, FSM_DWRITE, FSM_EAT, FSM_FINI, FSM_HREAD, FSM_HWRITE, FSM_INIT, FSM_LCHOWN, FSM_LINK, FSM_LSETFCON, FSM_LSTAT, FSM_MAP, FSM_MKDIR, FSM_MKDIRS, FSM_MKFIFO, FSM_MKLINKS, FSM_MKNOD, FSM_NEXT, FSM_NOTIFY, FSM_PAD, FSM_PKGBUILD, FSM_PKGCOMMIT, FSM_PKGERASE, FSM_PKGINSTALL, FSM_POS, FSM_POST, FSM_PRE, FSM_PROCESS, FSM_RCLOSE, FSM_READ, FSM_READLINK, FSM_RENAME, FSM_RMDIR, FSM_RMDIRS, FSM_ROPEN, FSM_STAT, FSM_SYMLINK, FSM_t, FSM_TRAILER, FSM_UNDO, FSM_UNKNOWN, FSM_UNLINK, FSM_UTIME, FSM_VERIFY, FSM_WCLOSE, FSM_WOPEN, FSM_WRITE, fsmCommitLinks(), fsmFsPath(), fsmGetFi(), fsmGetTs(), fsmMakeLinks(), fsmMapAttrs(), fsmMapFContext(), fsmMapPath(), fsmMkdirs(), fsmNext(), fsmRmdirs(), fsmUNSAFE, Fwrite(), fsm_s::goal, IS_DEV_LOG, fsm_s::iter, fsm_s::ix, lchown, fsm_s::ldn, fsm_s::ldnalloc, fsm_s::ldnlen, fsm_s::li, Link(), hardLink_s::linkIndex, fsm_s::links, hardLink_s::linksLeft, lsetfilecon, Lstat(), mapFind(), fsm_s::mapFlags, mapNextIterator(), Mkdir(), fsm_s::mkdirsdone, hardLink_s::next, hardLink_s::nlink, fsm_s::nsuffix, fsm_s::opath, fsm_s::osb, fsm_s::osuffix, fsm_s::path, fsm_s::postpone, fsm_s::rc, fsm_s::rdb, fsm_s::rdbuf, fsm_s::rdlen, fsm_s::rdnb, fsm_s::rdsize, Readlink(), removeSBITS(), Rename(), fsm_s::rfd, Rmdir(), RPMCALLBACK_INST_PROGRESS, RPMDEBUG_RMDIR, RPMDEBUG_UNLINK, RPMERR_RMDIR, RPMERR_UNLINK, rpmError, rpmfi, rpmfiTypeString(), RPMMESS_DEBUG, RPMMESS_WARNING, rpmMessage, rpmswAdd(), rpmts, RPMTS_OP_DIGEST, rpmtsFlags(), rpmtsNotify(), rpmtsOp(), S_ISLNK, S_ISSOCK, saveHardLink(), fsm_s::sb, hardLink_s::sb, security_context_t, fsm_s::stage, Stat(), stpcpy(), strict_erasures, fsm_s::subdir, fsm_s::sufbuf, fsm_s::suffix, Unlink(), fsm_s::wfd, fsm_s::wrb, fsm_s::wrbuf, writeFile(), writeLinkedFile(), fsm_s::wrlen, fsm_s::wrnb, fsm_s::wrsize, XFA_SKIPPING, xmalloc(), and xstrdup().

Referenced by fsmNext(), and fsmThread().

int fsmTeardown FSM_t  fsm  ) 
 

Clean file state machine.

Parameters:
fsm file state machine
Returns:
0 on success

Definition at line 607 of file fsm.c.

References fsm_s::cfd, fsm_s::failedFile, fdFree, FSM_DESTROY, FSM_t, fsmUNSAFE, fsm_s::iter, mapFreeIterator(), and fsm_s::rc.

Referenced by cpio_doio(), and rpmpsmStage().

void* fsmThread void *  arg  )  [static]
 

Definition at line 396 of file fsm.c.

References FSM_t, fsmStage(), and fsm_s::nstage.

Referenced by fsmNext().

FSM_t newFSM void   ) 
 

Create file state machine instance.

Returns:
file state machine

Definition at line 527 of file fsm.c.

References FSM_t, and xcalloc().

Referenced by rpmfiNew().

void removeSBITS const char *  path  )  [static]
 

Definition at line 1419 of file fsm.c.

Referenced by fsmStage().


Variable Documentation

int _fsm_debug = 0
 

Definition at line 38 of file fsm.c.

int _fsm_threads = 0
 

Definition at line 42 of file fsm.c.

int strict_erasures = 0
 

Definition at line 48 of file fsm.c.

Referenced by fsmStage().


Generated on Sun Apr 8 21:29:37 2012 for rpm by  doxygen 1.3.9.1