Permalink
Fetching contributors…
Cannot retrieve contributors at this time
342 lines (296 sloc) 17.5 KB
// -*- mode: C; c-basic-offset: 4; tab-width: 4; indent-tabs-mode: nil -*-
// vim: set softtabstop=4 shiftwidth=4 tabstop=4 expandtab:
/*************************************************************************
* Copyright 2008 Regents of the University of California
* Copyright 2009-2012 Ent. Services Development Corporation LP
*
* Redistribution and use of this software in source and binary forms,
* with or without modification, are permitted provided that the
* following conditions are met:
*
* Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer
* in the documentation and/or other materials provided with the
* distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE. USERS OF THIS SOFTWARE ACKNOWLEDGE
* THE POSSIBLE PRESENCE OF OTHER OPEN SOURCE LICENSED MATERIAL,
* COPYRIGHTED MATERIAL OR PATENTED MATERIAL IN THIS SOFTWARE,
* AND IF ANY SUCH MATERIAL IS DISCOVERED THE PARTY DISCOVERING
* IT MAY INFORM DR. RICH WOLSKI AT THE UNIVERSITY OF CALIFORNIA,
* SANTA BARBARA WHO WILL THEN ASCERTAIN THE MOST APPROPRIATE REMEDY,
* WHICH IN THE REGENTS' DISCRETION MAY INCLUDE, WITHOUT LIMITATION,
* REPLACEMENT OF THE CODE SO IDENTIFIED, LICENSING OF THE CODE SO
* IDENTIFIED, OR WITHDRAWAL OF THE CODE CAPABILITY TO THE EXTENT
* NEEDED TO COMPLY WITH ANY SUCH LICENSES OR RIGHTS.
************************************************************************/
#ifndef _INCLUDE_BLOBSTORE_H_
#define _INCLUDE_BLOBSTORE_H_
//!
//! @file storage/blobstore.h
//! Defines the BLOB storage
//!
/*----------------------------------------------------------------------------*\
| |
| INCLUDES |
| |
\*----------------------------------------------------------------------------*/
#define BLOBSTORE_MAX_PATH 1024
#define MAX_BLOCKMAP_SIZE 32
#define MAX_DM_NAME 128 //!< euca-819312998196-i-4336096F-prt-00512swap-ac8d5670
#define MAX_DM_PATH (MAX_DM_NAME + 12) //!< /dev/mapper/euca-819312998196-i-4336096F-prt-00512swap-ac8d5670
#define MAX_DM_LINE (MAX_DM_PATH * 2 + 40) //!< 0 1048576 snapshot $DM1 $DM2 p 16
//! @{
//! @name default permissions for blosbstore content
#define BLOBSTORE_DIRECTORY_PERM 0771 //!< The '1' is there so libvirt/KVM on Maverick do not stumble on permissions
#define BLOBSTORE_FILE_PERM 0660
//! @}
//! @{
//! @name flags for *_open() calls
#define BLOBSTORE_FLAG_RDWR 00001
#define BLOBSTORE_FLAG_RDONLY 00002
#define BLOBSTORE_FLAG_CREAT 00004
#define BLOBSTORE_FLAG_EXCL 00010
#define BLOBSTORE_FLAG_TRUNC 00400
#define BLOBSTORE_FLAG_STRICT 01000
#define BLOBSTORE_FLAG_HOLLOW 02000 //!< means the blob being created should be viewed as not occupying space
//! @}
//! @{
//! @name in-use flags for blockblobs
#define BLOCKBLOB_STATUS_OPENED 00002 //!< currently opened by someone (read or write)
#define BLOCKBLOB_STATUS_LOCKED 00004 //!< locked by a process @TODO remove this UNUSED status?
#define BLOCKBLOB_STATUS_MAPPED 00010 //!< loopback device dm-mapped by one or more other blobs
#define BLOCKBLOB_STATUS_BACKED 00020 //!< loopback device used as a backing by device mapper
#define BLOCKBLOB_STATUS_ABANDONED 00040 //!< non-zero lock file size => blob not closed properly
//! @}
/*----------------------------------------------------------------------------*\
| |
| DEFINES |
| |
\*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*\
| |
| TYPEDEFS |
| |
\*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*\
| |
| ENUMERATIONS |
| |
\*----------------------------------------------------------------------------*/
//! Defines the blobstore error codes
typedef enum {
BLOBSTORE_ERROR_OK = 0,
BLOBSTORE_ERROR_GENERAL, //!< here for compatibility with 'ERROR' elsewhere in Eucalyptus
//! @{
//! @name system errno equivalents
BLOBSTORE_ERROR_NOENT,
BLOBSTORE_ERROR_BADF,
BLOBSTORE_ERROR_NOMEM,
BLOBSTORE_ERROR_ACCES,
BLOBSTORE_ERROR_EXIST,
BLOBSTORE_ERROR_INVAL,
BLOBSTORE_ERROR_NOSPC,
BLOBSTORE_ERROR_AGAIN,
BLOBSTORE_ERROR_MFILE,
//! @}
//! @{
//! @name blobstore-specific errors
BLOBSTORE_ERROR_SIGNATURE,
BLOBSTORE_ERROR_UNKNOWN,
//! @}
} blobstore_error_t;
typedef enum {
BLOBSTORE_REVOCATION_ANY, //!< on create, defaults to NONE; on open, allows for whatever policy is in effect
BLOBSTORE_REVOCATION_NONE, //!< on create, error will be returned when blobstore is full
BLOBSTORE_REVOCATION_LRU, //!< on create, unlocked items are purged in priority+LRU order, when possible
} blobstore_revocation_t;
typedef enum {
BLOBSTORE_SNAPSHOT_ANY, //!< on create, pick DM if possible; on open, allows for whatever policy is in effect
BLOBSTORE_SNAPSHOT_NONE, //!< snapshots are not used, disk copies are used for cloning
BLOBSTORE_SNAPSHOT_DM, //!< device mapper snapshots are used for cloning
} blobstore_snapshot_t;
typedef enum {
BLOBSTORE_FORMAT_ANY, //!< on create, defaults to FILES_VISIBLE; on open, allows for whatever policy is in effect
BLOBSTORE_FORMAT_FILES, //!< blob content/backing and metadata are stored under blobstore path in individual files
BLOBSTORE_FORMAT_DIRECTORY, //!< all blob data are stored in a separate subdirectory under blobstore path
} blobstore_format_t;
typedef enum {
BLOBSTORE_COPY,
BLOBSTORE_MAP,
BLOBSTORE_SNAPSHOT,
} blockmap_relation_t;
typedef enum {
BLOBSTORE_DEVICE,
BLOBSTORE_BLOCKBLOB,
BLOBSTORE_ZERO,
} blockmap_source_t;
/*----------------------------------------------------------------------------*\
| |
| STRUCTURES |
| |
\*----------------------------------------------------------------------------*/
typedef struct _blobstore {
char id[BLOBSTORE_MAX_PATH]; //!< ID of the blobstore, to handle directory moving
char path[BLOBSTORE_MAX_PATH]; //!< full path to blobstore directory
unsigned long long limit_blocks; //!< maximum space, in 512-byte blocks, that all blobs in store may use together
blobstore_revocation_t revocation_policy;
blobstore_snapshot_t snapshot_policy;
blobstore_format_t format;
int fd; //!< file descriptor of the blobstore metadata file
} blobstore;
typedef struct _blockblob {
blobstore *store; //!< pointer to the store for this blob
char id[BLOBSTORE_MAX_PATH]; //!< ID of the blob (used as part of file/directory name)
char blocks_path[BLOBSTORE_MAX_PATH]; //!< full path of the content or snapshot backing file
char device_path[BLOBSTORE_MAX_PATH]; //!< full path of a block device on which blob can be accessed
char dm_name[MAX_DM_NAME]; //!< name of the main device mapper device if this is a clone
unsigned long long size_bytes; //!< size of the blob in bytes
unsigned long long blocks_allocated; //!< actual number of blocks on disk taken by the blob
blobstore_snapshot_t snapshot_type; //!< ANY = not initialized/known, NONE = not a snapshot, DM = DM-based snapshot
unsigned int in_use; //!< flags showing how the blockblob is being used (OPENED, LOCKED, LINKED)
unsigned char is_hollow; //!< blockblob is 'hollow' - its size doesn't count toward the limit
time_t last_accessed; //!< timestamp of last access
time_t last_modified; //!< timestamp of last modification
double priority; //!< priority, for assisting LRU
int fd_lock; //!< file descriptor of the blockblob lock file
int fd_blocks; //!< file descriptor of the blockblob content file
// LL pointers
struct _blockblob *next;
struct _blockblob *prev;
} blockblob;
typedef struct _blockmap {
blockmap_relation_t relation_type;
blockmap_source_t source_type;
union {
char device_path[BLOBSTORE_MAX_PATH];
blockblob *blob;
} source;
unsigned long long first_block_src;
unsigned long long first_block_dst;
unsigned long long len_blocks;
} blockmap;
typedef struct _blockblob_meta {
char id[BLOBSTORE_MAX_PATH]; //!< ID of the blob (used as part of file/directory name)
unsigned long long size_bytes; //!< size of the blob in bytes
unsigned int in_use; //!< flags showing how the blockblob is being used (OPENED, LOCKED, LINKED)
unsigned char is_hollow; //!< blockblob is 'hollow' - its size doesn't count toward the limit
time_t last_accessed; //!< timestamp of last access
time_t last_modified; //!< timestamp of last modification
blobstore *bs; //!< pointer to blobstore, if one is open
struct _blockblob_meta *next;
struct _blockblob_meta *prev;
} blockblob_meta;
typedef struct _blobstore_meta {
char id[BLOBSTORE_MAX_PATH]; //!< ID of the blobstore, to handle directory moving
char path[PATH_MAX]; //!< canonical path of the blobstore directory
unsigned long long blocks_limit; //!< max size of the blobstore, in blocks
unsigned long long blocks_unlocked; //!< number of blocks in blobstore allocated to blobs that are not in use and is not mapped
unsigned long long blocks_locked; //!< number of blocks in blobstore allocated to blobs that are in use or is mapped (a dependency)
unsigned long long blocks_allocated; //!< number of blocks in blobstore that have been allocated on disk
unsigned long long fs_bytes_size; //!< size, in bytes, of the file system that blobstore resides on
unsigned long long fs_bytes_available; //!< bytes available on the file system that blobstore resides on
int fs_id; //!< hash of file system ID, as returned by statfs()
unsigned int num_blobs; //!< count of blobs in the blobstore
blobstore_revocation_t revocation_policy;
blobstore_snapshot_t snapshot_policy;
blobstore_format_t format;
} blobstore_meta;
/*----------------------------------------------------------------------------*\
| |
| EXPORTED VARIABLES |
| |
\*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*\
| |
| STATIC VARIABLES |
| |
\*----------------------------------------------------------------------------*/
//! Blobstore errors matching strings. Make sure these match up with blobstore_error_t enums above
extern const char *_blobstore_error_strings[];
extern const char *blobstore_relation_type_name[];
/*----------------------------------------------------------------------------*\
| |
| EXPORTED PROTOTYPES |
| |
\*----------------------------------------------------------------------------*/
//! @{
//! @name blobstore operations
const char *blobstore_get_error_str(blobstore_error_t error);
const char *blobstore_get_last_msg(void);
const char *blobstore_get_last_trace(void);
void blobstore_set_error_function(void (*fn) (const char *msg));
struct flock *flock_whole_file(struct flock *l, short type);
int blobstore_init(void);
int blobstore_cleanup(void);
blobstore *blobstore_open(const char *path, unsigned long long limit_blocks, unsigned int flags, blobstore_format_t format,
blobstore_revocation_t revocation_policy, blobstore_snapshot_t snapshot_policy);
int blobstore_close(blobstore * bs);
int blobstore_lock(blobstore * bs, long long timeout_usec);
int blobstore_unlock(blobstore * bs);
int blobstore_delete(blobstore * bs);
int blobstore_get_error(void);
ssize_t get_line_desc(char **ppLine, size_t * n, int fd);
int blobstore_delete_nonblobs(blobstore * bs, const char *dir_path);
int blobstore_stat(blobstore * bs, blobstore_meta * meta);
int blobstore_fsck(blobstore * bs, int (*examiner) (const blockblob * bb));
int blobstore_search(blobstore * bs, const char *regex, blockblob_meta ** results);
int blobstore_delete_regex(blobstore * bs, const char *regex);
//! @}
//! @{
//! @name blockblob operations
blockblob *blockblob_open(blobstore * bs, const char *id, unsigned long long size_bytes, unsigned int flags, const char *sig, unsigned long long timeout_usec);
int blockblob_close(blockblob * bb);
int blockblob_delete(blockblob * bb, long long timeout_usec, char do_force);
int blockblob_copy(blockblob * src_bb, unsigned long long src_offset_bytes, blockblob * dst_bb, unsigned long long dst_offset_bytes, unsigned long long len_bytes); //
int blockblob_clone(blockblob * bb, const blockmap * map, unsigned int map_size);
const char *blockblob_get_dev(blockblob * bb);
const char *blockblob_get_file(blockblob * bb);
blobstore *blockblob_get_blobstore(blockblob * bb);
int blockblob_get_dir(blockblob * bb, char *buf, int buflen);
unsigned long long blockblob_get_size_blocks(blockblob * bb);
unsigned long long blockblob_get_size_bytes(blockblob * bb);
int blockblob_sync(const char *dev_path, const blockblob * bb);
//! @}
/*----------------------------------------------------------------------------*\
| |
| STATIC INLINE PROTOTYPES |
| |
\*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*\
| |
| MACROS |
| |
\*----------------------------------------------------------------------------*/
//! Macro to safely close a blobstore (ensure the pointer is set to NULL after)
#define BLOBSTORE_CLOSE(_pStore) \
{ \
blobstore_close((_pStore)); \
(_pStore) = NULL; \
}
//! Macro to safely close a blockblob (ensure the pointer is set to NULL after)
#define BLOCKBLOB_CLOSE(_pBlock) \
{ \
blockblob_close((_pBlock)); \
(_pBlock) = NULL; \
}
/*----------------------------------------------------------------------------*\
| |
| STATIC INLINE IMPLEMENTATION |
| |
\*----------------------------------------------------------------------------*/
#endif /* ! _INCLUDE_BLOBSTORE_H_ */