/*
* Sherlock Library -- Object Buckets
*
- * (c) 2001--2003 Martin Mares <mj@ucw.cz>
+ * (c) 2001--2004 Martin Mares <mj@ucw.cz>
*
* This software may be freely distributed and used according to the terms
* of the GNU Lesser General Public License.
*/
+#ifndef _SHERLOCK_BUCKET_H
+#define _SHERLOCK_BUCKET_H
+
/*
* Format: The object pool is merely a sequence of object buckets.
* Each bucket starts with struct obuck_header and it's padded
*
* Locking: Each operation on the pool is protected by a flock.
*
- * The buckets emulate non-seekable fastbuf streams.
+ * The buckets emulate fastbuf streams. Read streams act as normal files,
+ * but there can be only one write stream which is non-seekable and you
+ * also shouldn't open new read streams when writing.
*
* fork()'ing if you don't have any bucket open is safe.
*/
struct obuck_header {
u32 magic; /* OBUCK_MAGIC should dwell here */
oid_t oid; /* ID of this object or OBUCK_OID_DELETED */
- u32 length; /* Length of compressed data in the bucket */
- u32 orig_length; /* Length of uncompressed data */
+ u32 length; /* Length of data in the bucket */
+ u32 type; /* Data type */
/* Bucket data continue here */
};
+enum bucket_type {
+ BUCKET_TYPE_COMPAT = 0x7fffffff, /* and less -- buckets created by older versions of Sherlock */
+ BUCKET_TYPE_PLAIN = 0x80000000, /* plain textual buckets */
+ BUCKET_TYPE_V30 = 0x80000001, /* v3.0 uncompressed buckets */
+ BUCKET_TYPE_V30C = 0x80000002 /* v3.0 compressed buckets */
+};
+
struct fastbuf;
void obuck_init(int writeable); /* Initialize the bucket module */
/* Reading current bucket */
struct fastbuf *obuck_fetch(void);
-void obuck_fetch_end(struct fastbuf *b);
/* Creating buckets */
-struct fastbuf *obuck_create(void);
+struct fastbuf *obuck_create(u32 type);
void obuck_create_end(struct fastbuf *b, struct obuck_header *hdrp);
/* Deleting buckets */
return ((sh_off_t) oid) << OBUCK_SHIFT;
}
+/* Calculate size of bucket which contains given amount of data */
+
+static inline uns obuck_bucket_size(uns len)
+{
+ return ALIGN(sizeof(struct obuck_header) + len + 4, OBUCK_ALIGN);
+}
+
/* Shaking down bucket file */
void obuck_shakedown(int (*kibitz)(struct obuck_header *old, oid_t new, byte *buck));
+
+#endif