rpm 5.3.12
Data Structures | Defines | Typedefs | Functions | Variables
lib/fsm.c File Reference

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

#include "system.h"
#include <rpmio_internal.h>
#include <rpmcb.h>
#include "rpmsq.h"
#include <rpmsx.h>
#include "cpio.h"
#include "tar.h"
#include "ugid.h"
#include <rpmtag.h>
#include <rpmtypes.h>
#include <rpmdb.h>
#include "rpmfi.h"
#include <fsm.h>
#include "rpmte.h"
#include "rpmts.h"
#include "debug.h"
Include dependency graph for fsm.c:

Go to the source code of this file.

Data Structures

struct  dnli_s
 Directory name iterator. More...

Defines

#define _RPMDB_INTERNAL
#define _RPMFI_INTERNAL
#define _IOSM_INTERNAL
#define fsmUNSAFE   fsmStage
#define _USE_RPMTE
#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 _tsmask   (RPMTRANS_FLAG_PKGCOMMIT | RPMTRANS_FLAG_COMMIT)
#define IS_DEV_LOG(_x)
#define _fafilter(_a)

Typedefs

typedef struct dnli_sDNLI_t
 Directory name iterator.

Functions

static rpmts fsmGetTs (const IOSM_t fsm)
 Retrieve transaction set from file state machine iterator.
static rpmfi fsmGetFi (const IOSM_t fsm)
 Retrieve transaction element file info from file state machine iterator.
static const char * fsmFsPath (const IOSM_t fsm, const struct stat *st, const char *subdir, const char *suffix)
 Build path to file from file info, ornamented with subdir and suffix.
static void * mapFreeIterator (void *p)
 Destroy file info iterator.
static void * mapInitIterator (rpmfi fi, int reverse)
 Create file info iterator.
static int mapNextIterator (void *a)
 Return next index into file info.
static int cpioStrCmp (const void *a, const void *b)
static int mapFind (FSMI_t iter, const char *fsmPath)
 Locate archive path in file info.
static void * dnlFreeIterator (const void *a)
 Destroy directory name iterator.
static int dnlCount (const DNLI_t dnli)
static int dnlIndex (const DNLI_t dnli)
static void * dnlInitIterator (const IOSM_t fsm, int reverse)
 Create directory name iterator.
static const char * dnlNextIterator (DNLI_t dnli)
 Return next directory name (from file info).
int fsmNext (IOSM_t fsm, iosmFileStage nstage)
 File state machine driver.
static int saveHardLink (IOSM_t fsm)
 Save hard link in chain.
static void * freeHardLink (struct hardLink_s *li)
 Destroy set of hard links.
IOSM_t newFSM (void)
 Create file state machine instance.
IOSM_t freeFSM (IOSM_t fsm)
 Destroy file state machine instance.
int fsmSetup (void *_fsm, iosmFileStage goal, const char *afmt, const void *_ts, const void *_fi, FD_t cfd, unsigned int *archiveSize, const char **failedFile)
 Load external data into file state machine.
int fsmTeardown (void *_fsm)
 Clean file state machine.
static int fsmMapFContext (IOSM_t fsm)
int fsmMapPath (IOSM_t fsm)
 Map next file path and action.
int fsmMapAttrs (IOSM_t fsm)
 Map file stat(2) info.
static int extractRegular (IOSM_t fsm)
 Create file from payload stream.
static int writeFile (IOSM_t fsm, int writeData)
 Write next item to payload stream.
static int writeLinkedFile (IOSM_t fsm)
 Write set of linked files to payload stream.
static int fsmMakeLinks (IOSM_t fsm)
 Create pending hard links to existing file.
static int fsmCommitLinks (IOSM_t fsm)
 Commit hard linked file set atomically.
static int fsmRmdirs (IOSM_t fsm)
 Remove (if created) directories not explicitly included in package.
static int fsmMkdirs (IOSM_t fsm)
 Create (if necessary) directories not explicitly included in package.
int fsmStage (IOSM_t fsm, iosmFileStage stage)
 File state machine driver.

Variables

int _fsm_debug = 0
int _fsm_threads = 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) \
        ? iosmFileActionString(_a) : "")

Referenced by fsmStage(), and iosmStage().

#define _FSM_DEBUG   0

Definition at line 52 of file fsm.c.

#define _IOSM_INTERNAL

Definition at line 27 of file fsm.c.

#define _RPMDB_INTERNAL

Definition at line 21 of file fsm.c.

#define _RPMFI_INTERNAL

Definition at line 24 of file fsm.c.

#define _tsmask   (RPMTRANS_FLAG_PKGCOMMIT | RPMTRANS_FLAG_COMMIT)

Referenced by fsmSetup(), and iosmSetup().

#define _USE_RPMTE

Definition at line 31 of file fsm.c.

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

Definition at line 50 of file fsm.c.

#define fsmUNSAFE   fsmStage

Definition at line 29 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 1589 of file fsm.c.

Referenced by fsmStage().

#define SUFFIX_RPMNEW   ".rpmnew"

Definition at line 91 of file fsm.c.

Referenced by fsmMapPath().

#define SUFFIX_RPMORIG   ".rpmorig"

Definition at line 89 of file fsm.c.

Referenced by fsmMapPath().

#define SUFFIX_RPMSAVE   ".rpmsave"

Definition at line 90 of file fsm.c.

Referenced by fsmMapPath().


Function Documentation

IOSM_t freeFSM ( IOSM_t  fsm)

Destroy file state machine instance.

Parameters:
fsmfile state machine
Returns:
always NULL

Definition at line 549 of file fsm.c.

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

Referenced by rpmfiFini().

static rpmfi fsmGetFi ( const IOSM_t  fsm) [static]

Retrieve transaction element file info from file state machine iterator.

Parameters:
fsmfile state machine
Returns:
transaction element file info

Definition at line 80 of file fsm.c.

References iosmIterator_s::fi, and iosm_s::iter.

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

static rpmts fsmGetTs ( const IOSM_t  fsm) [static]

Retrieve transaction set from file state machine iterator.

Parameters:
fsmfile state machine
Returns:
transaction set

Definition at line 66 of file fsm.c.

References iosm_s::iter, and iosmIterator_s::ts.

Referenced by extractRegular(), fsmStage(), and fsmTeardown().

int fsmMapAttrs ( IOSM_t  fsm)
static int fsmMapFContext ( IOSM_t  fsm) [static]

Definition at line 775 of file fsm.c.

References iosm_s::fcontext, fsmGetFi(), iosm_s::ix, iosm_s::nofcontexts, iosm_s::path, rpmsxMatch(), and iosm_s::sb.

Referenced by fsmStage().

int fsmMapPath ( IOSM_t  fsm)
static int fsmMkdirs ( IOSM_t  fsm) [static]

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

Parameters:
fsmfile state machine data
Returns:
0 on success

Definition at line 1437 of file fsm.c.

References _free(), D_, dc, dnlCount(), dnlFreeIterator(), dnlIndex(), dnlInitIterator(), dnlNextIterator(), iosm_s::dnlx, iosm_s::fcontext, fsmGetFi(), fsmNext(), fsmUNSAFE, IOSM_LSETFCON, IOSM_LSTAT, IOSM_MKDIR, IOSMERR_ENOENT, iosm_s::ldn, iosm_s::ldnalloc, iosm_s::ldnlen, iosm_s::nofcontexts, iosm_s::osb, iosm_s::path, iosm_s::rdbuf, rpmlog(), RPMLOG_DEBUG, rpmsxMatch(), iosm_s::sb, stpcpy(), urlPath(), xcalloc(), and xrealloc().

Referenced by fsmStage().

int fsmNext ( IOSM_t  fsm,
iosmFileStage  nstage 
)

File state machine driver.

Parameters:
fsmfile state machine
nstagenext stage
Returns:
0 on success

Definition at line 430 of file fsm.c.

References fsmStage(), iosm_s::multithreaded, iosm_s::nstage, rpmsqJoin(), and rpmsqThread().

Referenced by fsmCommitLinks(), fsmMakeLinks(), fsmMkdirs(), fsmRmdirs(), fsmSetup(), fsmStage(), saveHardLink(), writeFile(), and writeLinkedFile().

static int fsmRmdirs ( IOSM_t  fsm) [static]

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

Parameters:
fsmfile state machine data
Returns:
0 on success

Definition at line 1382 of file fsm.c.

References dc, dnlCount(), dnlFreeIterator(), dnlIndex(), dnlInitIterator(), dnlNextIterator(), iosm_s::dnlx, fsmNext(), IOSM_RMDIR, iosm_s::ldn, iosm_s::path, iosm_s::rdbuf, and stpcpy().

Referenced by fsmStage().

int fsmSetup ( void *  _fsm,
iosmFileStage  goal,
const char *  afmt,
const void *  _ts,
const void *  _fi,
FD_t  cfd,
unsigned int *  archiveSize,
const char **  failedFile 
)
int fsmStage ( IOSM_t  fsm,
iosmFileStage  stage 
)

File state machine driver.

Parameters:
fsmfile state machine
stagenext stage
Returns:
0 on success

Definition at line 1596 of file fsm.c.

References _, _fafilter, _free(), iosm_s::action, alloca(), iosm_s::astriplen, iosm_s::cfd, iosm_s::commit, hardLink_s::createdPath, iosm_s::debug, iosm_s::diskchecked, iosm_s::dnlx, errno, iosm_s::exists, extractRegular(), FA_ERASE, FA_UNKNOWN, iosm_s::failedFile, Fclose(), iosm_s::fcontext, fdGetCpioPos(), iosm_s::fflags, Fileno(), hardLink_s::filex, Fopen(), freeHardLink(), fsmCommitLinks(), fsmFsPath(), fsmGetFi(), fsmGetTs(), fsmMakeLinks(), fsmMapAttrs(), fsmMapFContext(), fsmMapPath(), fsmMkdirs(), fsmNext(), fsmRmdirs(), fsmUNSAFE, iosm_s::goal, IOSM_ALL_HARDLINKS, IOSM_CHMOD, IOSM_CHOWN, IOSM_CHROOT, IOSM_COMMIT, IOSM_CREATE, IOSM_DEAD, IOSM_DESTROY, IOSM_DREAD, IOSM_DWRITE, IOSM_EAT, IOSM_FINI, IOSM_FOLLOW_SYMLINKS, IOSM_HREAD, IOSM_HWRITE, IOSM_INIT, IOSM_INTERNAL, IOSM_LCHOWN, IOSM_LINK, IOSM_LSETFCON, IOSM_LSTAT, IOSM_MAP, IOSM_MKDIR, IOSM_MKDIRS, IOSM_MKFIFO, IOSM_MKLINKS, IOSM_MKNOD, IOSM_NEXT, IOSM_NOTIFY, IOSM_PAD, IOSM_PAYLOAD_EXTRACT, IOSM_PAYLOAD_LIST, IOSM_PKGBUILD, IOSM_PKGCOMMIT, IOSM_PKGERASE, IOSM_PKGINSTALL, IOSM_POS, IOSM_POST, IOSM_PRE, IOSM_PROCESS, IOSM_RCLOSE, IOSM_READ, IOSM_READLINK, IOSM_RENAME, IOSM_RMDIR, IOSM_RMDIRS, IOSM_ROPEN, IOSM_STAT, IOSM_SYMLINK, IOSM_SYSCALL, IOSM_TRAILER, IOSM_UNDO, IOSM_UNKNOWN, IOSM_UNLINK, IOSM_UTIME, IOSM_VERBOSE, IOSM_VERIFY, IOSM_WCLOSE, IOSM_WOPEN, IOSM_WRITE, IOSMERR_ENOENT, IOSMERR_ENOTEMPTY, IOSMERR_HDR_TRAILER, IOSMERR_MISSING_HARDLINK, IOSMERR_UNKNOWN_FILETYPE, IOSMERR_UNLINK_FAILED, IOSMERR_UNMAPPED_FILE, iosmFileActionSkipped(), iosmFileStageString(), iosmStage(), IS_DEV_LOG, iosm_s::iter, iosm_s::ix, iosm_s::ldn, iosm_s::ldnalloc, iosm_s::ldnlen, iosm_s::li, hardLink_s::linkIndex, iosm_s::links, hardLink_s::linksLeft, iosm_s::lpath, Lstat(), mapFind(), iosm_s::mapFlags, mapNextIterator(), iosm_s::mkdirsdone, hardLink_s::next, hardLink_s::nlink, iosm_s::nsuffix, iosm_s::opath, iosm_s::osb, iosm_s::osuffix, iosm_s::path, iosm_s::postpone, iosm_s::rc, iosm_s::rdb, iosm_s::rdbuf, iosm_s::rdsize, iosm_s::repackaged, RPMCALLBACK_INST_PROGRESS, RPMFILE_GHOST, RPMFILE_MISSINGOK, rpmfiTypeString(), rpmlog(), RPMLOG_DEBUG, RPMLOG_ERR, RPMLOG_WARNING, rpmtsGetRdb(), rpmtsNotify(), S_ISLNK, S_ISSOCK, saveHardLink(), hardLink_s::sb, iosm_s::sb, iosm_s::stage, stpcpy(), iosm_s::strict_erasures, iosm_s::subdir, iosm_s::sufbuf, iosm_s::suffix, Unlink(), urlPath(), iosm_s::wrb, iosm_s::wrbuf, writeFile(), writeLinkedFile(), iosm_s::wrsize, xmalloc(), and xstrdup().

Referenced by fsmNext().

int fsmTeardown ( void *  _fsm)

Clean file state machine.

Parameters:
_fsmfile state machine
Returns:
0 on success

Definition at line 743 of file fsm.c.

References _free(), iosm_s::cfd, iosm_s::debug, iosm_s::failedFile, fdFree(), fsmGetTs(), fsmUNSAFE, IOSM_DESTROY, iosm_s::iter, iosm_s::lmtab, mapFreeIterator(), iosm_s::op_digest, iosm_s::rc, rpmswAdd(), RPMTS_OP_DIGEST, rpmtsFree(), rpmtsOp(), and iosmIterator_s::ts.

Referenced by cpio_doio(), and rpmpsmStage().

IOSM_t newFSM ( void  )

Create file state machine instance.

Returns:
file state machine

Definition at line 543 of file fsm.c.

References xcalloc().

Referenced by rpmfiNew().


Variable Documentation

int _fsm_debug = 0

Definition at line 54 of file fsm.c.

Referenced by fsmSetup().

int _fsm_threads = 0

Definition at line 58 of file fsm.c.

Referenced by fsmSetup().