rpm/lib/fsm.h

#ifndef H_FSM
#define H_FSM

/** \ingroup payload
 * \file fsm.h
 * File state machine to handle a payload within an rpm package.
 */

#include <rpm/rpmfi.h>

#ifdef __cplusplus
extern "C" {
#endif

typedef struct rpmpsm_s * rpmpsm;

/**
 * Execute a file actions for package
 * @param ts		transaction set
 * @param te		transaction set element
 * @param files		transaction element file info
 * @param psm		owner psm (or NULL)
 * @param[out] failedFile	pointer to first file name that failed (malloced)
 * @return		0 on success
 */

int rpmPackageFilesInstall(rpmts ts, rpmte te, rpmfiles files,
              rpmpsm psm, char ** failedFile);

int rpmPackageFilesRemove(rpmts ts, rpmte te, rpmfiles files,
              rpmpsm psm, char ** failedFile);

RPM_GNUC_INTERNAL
int rpmfiArchiveReadToFilePsm(rpmfi fi, FD_t fd, int nodigest, rpmpsm psm);

RPM_GNUC_INTERNAL
void rpmpsmNotify(rpmpsm psm, int what, rpm_loff_t amount);
#ifdef __cplusplus
}
#endif

#endif	/* H_FSM */
Reorganize sources before implementing --repackage. CVS patchset: 4543 CVS date: 2001/02/10 16:47:40 2001-02-11 00:47:40 +08:00			`#ifndef H_FSM`
			`#define H_FSM`

Doxygen annotations for config files. Doxygen annotations for rpmdep section. Add manifests for install modes. CVS patchset: 4675 CVS date: 2001/04/10 12:36:45 2001-04-10 20:36:45 +08:00			`/** \ingroup payload`
Remove leading directories from doxygen notation These don't represent the exported include structure so they're probably more harmful than anything else. 2022-03-09 20:07:36 +08:00			`* \file fsm.h`
Doxygen annotations for config files. Doxygen annotations for rpmdep section. Add manifests for install modes. CVS patchset: 4675 CVS date: 2001/04/10 12:36:45 2001-04-10 20:36:45 +08:00			`* File state machine to handle a payload within an rpm package.`
Reorganize sources before implementing --repackage. CVS patchset: 4543 CVS date: 2001/02/10 16:47:40 2001-02-11 00:47:40 +08:00			`*/`

Switch to <rpm/foo.h> style for public headers - adjust include paths accordingly 2007-12-08 20:02:32 +08:00			`#include <rpm/rpmfi.h>`
Reorganize sources before implementing --repackage. CVS patchset: 4543 CVS date: 2001/02/10 16:47:40 2001-02-11 00:47:40 +08:00
			`#ifdef __cplusplus`
			`extern "C" {`
			`#endif`

Move internal stuff from fsm.h to fsm.c Reduce fileStage to the three "goal" stages 2012-03-30 20:56:33 +08:00			`typedef struct rpmpsm_s * rpmpsm;`

Reorganize sources before implementing --repackage. CVS patchset: 4543 CVS date: 2001/02/10 16:47:40 2001-02-11 00:47:40 +08:00			`/**`
Kill FSM: Remove remains 2012-03-29 21:49:51 +08:00			`* Execute a file actions for package`
Reorganize sources before implementing --repackage. CVS patchset: 4543 CVS date: 2001/02/10 16:47:40 2001-02-11 00:47:40 +08:00			`* @param ts transaction set`
Fix doxygen warnings Make shure parameter descriptions in doc strings match the functions 2015-02-17 22:29:59 +08:00			`* @param te transaction set element`
			`* @param files transaction element file info`
Pass and remember the controlling psm (if any) in fsm 2012-01-05 20:24:33 +08:00			`* @param psm owner psm (or NULL)`
Shut up bogus Doxygen warnings about undocumented parameters As of Doxygen >= 1.8.20 it started complaining about anything marked as @retval being undocumented. As this is widely used in rpm... Mass-replace all @retval uses with @param[out] to silence. Some of these are actually in/out parameters but combing through all of them is a bit too much... Also escape <CR><LF> in rpmpgp.h to shut up yet another new warning. 2020-10-28 15:50:45 +08:00			`* @param[out] failedFile pointer to first file name that failed (malloced)`
Reorganize sources before implementing --repackage. CVS patchset: 4543 CVS date: 2001/02/10 16:47:40 2001-02-11 00:47:40 +08:00			`* @return 0 on success`
			`*/`

Move rpmte payload open out of psm - Perhaps not such a big deal, but this makes rpmPackageFilesInstall() and rpmPackageFilesRemove() interfaces identical, which could be useful. In any case there's no particular reason this code should be in psm either.. 2014-03-21 15:00:27 +08:00			`int rpmPackageFilesInstall(rpmts ts, rpmte te, rpmfiles files,`
Kill FSM: Make FSM_PKGINSTALL a function 2012-03-29 21:44:40 +08:00			`rpmpsm psm, char ** failedFile);`

Let install and erase create their own file iterators - Package install and erase ultimately need different types of file iterators, grab and pass the actual file set handle instead of an iterator from psm and use a local iterator in fsm. Passing the rpmfiles handle isn't strictly needed, fsm could grab it from the element by itself... This also eliminates the last use of rpmteFI() in librpm. - No functional changes here, both install and erase still use a plain old forward rpmfi iterator which is plain wrong for both of them. 2013-11-14 15:55:59 +08:00			`int rpmPackageFilesRemove(rpmts ts, rpmte te, rpmfiles files,`
Kill FSM: Make FSM_PKGERASE a function 2012-03-29 21:47:41 +08:00			`rpmpsm psm, char ** failedFile);`

Minimally resurrect fine-grained progress callbacks on install - Add an internal version where we can pass the psm for notifications for now, the callbacks will need a major rework but now is not the time... 2014-04-03 16:14:17 +08:00			`RPM_GNUC_INTERNAL`
			`int rpmfiArchiveReadToFilePsm(rpmfi fi, FD_t fd, int nodigest, rpmpsm psm);`

Clean up progress callbacks in fsm/psm machinery - Move notifications from fsm to psm side for sanity and symmetry, psm already has members to hold the callback state. - Replace PSM_NOTIFY "state" with a helper function that both fsm and psm itself use (except for error callbacks which are a bit different) - Init psm->total early, this doesn't change and can now be used to refer to "all done" value whatever it happens to be, instead of magic "100" values etc. - Packages with no files are now handled through the same path as everything else from progress reporting pov, we just skip calls to fsm if there are no files. - Issue stop callbacks for install as well. While INST_CLOSE_FILE can be (and is currently) used to detect this condition, its conceptually an entirely different thing. - Fix erasure callback parameters, they were reversed (starting from total and ending with 0, ehh...) 2012-01-05 20:48:22 +08:00			`RPM_GNUC_INTERNAL`
			`void rpmpsmNotify(rpmpsm psm, int what, rpm_loff_t amount);`
Reorganize sources before implementing --repackage. CVS patchset: 4543 CVS date: 2001/02/10 16:47:40 2001-02-11 00:47:40 +08:00			`#ifdef __cplusplus`
			`}`
			`#endif`

			`#endif /* H_FSM */`