#include <db.h>

int
DB_ENV->log_archive(DB_ENV *env, char *(*listp)[], u_int32_t flags);

Description

The DB_ENV->log_archive function creates a NULL-terminated array of log or database filenames, and copies a pointer to them into the user-specified memory location listp.

By default, DB_ENV->log_archive returns the names of all of the log files that are no longer in use (for example, that are no longer involved in active transactions), and that may safely be archived for catastrophic recovery and then removed from the system. If there are no filenames to return, the memory location to which listp refers will be set to NULL.

Arrays of log filenames are created in allocated memory. If application-specific allocation routines have been declared (see DB_ENV->set_alloc for more information), they are used to allocate the memory; otherwise, the library function malloc(3) is used. The caller is responsible for deallocating the memory. To deallocate the memory, free the memory reference; references inside the returned memory need not be individually freed.

The flags value must be set to 0 or by bitwise inclusively OR'ing together one or more of the following values:

DB_ARCH_ABS

All pathnames are returned as absolute pathnames, instead of relative to the database home directory.

DB_ARCH_DATA

Return the database files that need to be archived in order to recover the database from catastrophic failure. If any of the database files have not been accessed during the lifetime of the current log files, DB_ENV->log_archive will not include them in this list. It is also possible that some of the files referred to by the log have since been deleted from the system.

DB_ARCH_LOG

Return all the log filenames, regardless of whether or not they are in use.

The DB_ARCH_DATA and DB_ARCH_LOG flags are mutually exclusive.

Log cursor handles (returned by the DB_ENV->log_cursor function) may have open file descriptors for log files in the database environment. Also, the Berkeley DB interfaces to the database environment logging subsystem (for example, DB_ENV->log_put and DB_TXN->abort) may allocate log cursors and have open file descriptors for log files as well. On operating systems where filesystem related system calls (for example, rename and unlink on Windows/NT) can fail if a process has an open file descriptor for the affected file, attempting to move or remove the log files listed by DB_ENV->log_archive may fail. All Berkeley DB internal use of log cursors operates on active log files only and furthermore, is short-lived in nature. So, an application seeing such a failure should be restructured to close any open log cursors it may have, and otherwise to retry the operation until it succeeds. (Although the latter is not likely to be necessary; it is hard to imagine a reason to move or rename a log file in which transactions are being logged or aborted.)

See the db_archive manual page for more information on database archival procedures.

The DB_ENV->log_archive function is the underlying function used by the db_archive utility. See the db_archive utility source code for an example of using DB_ENV->log_archive in a IEEE/ANSI Std 1003.1 (POSIX) environment.

The DB_ENV->log_archive function returns a non-zero error value on failure and 0 on success.

Bugs

In a threaded application (that is, one where the environment was created with the DB_THREAD flag specified), calling DB_ENV->log_archive with the DB_ARCH_DATA flag will fail, returning EINVAL. To work around this problem, reopen the log explicitly without specifying DB_THREAD. This restriction is expected to be removed in a future version of Berkeley DB.

Errors

The DB_ENV->log_archive function may fail and return a non-zero error for the following conditions:

EINVAL

An invalid flag value or parameter was specified.

The log was corrupted.

The DB_ENV->log_archive function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. If a catastrophic error has occurred, the DB_ENV->log_archive function may fail and return DB_RUNRECOVERY, in which case all subsequent Berkeley DB calls will fail in the same way.

See Also