From 8c70b4b9c73c30dfe8f966d26b2375a8c4f98e83 Mon Sep 17 00:00:00 2001 From: Ted Ross Date: Wed, 10 Jul 2013 19:59:05 +0000 Subject: QPID-4984 - Added a utilities library for linearstore and its tools. git-svn-id: https://svn.apache.org/repos/asf/qpid/branches/linearstore@1501945 13f79535-47bb-0310-9956-ffa450edef68 --- qpid/cpp/src/linearstore.cmake | 14 ++- .../cpp/src/qpid/linearstore/jrnl/utils/file_hdr.c | 43 +++++++++ .../cpp/src/qpid/linearstore/jrnl/utils/file_hdr.h | 106 +++++++++++++++++++++ qpid/cpp/src/qpid/linearstore/jrnl/utils/rec_hdr.h | 75 +++++++++++++++ 4 files changed, 237 insertions(+), 1 deletion(-) create mode 100644 qpid/cpp/src/qpid/linearstore/jrnl/utils/file_hdr.c create mode 100644 qpid/cpp/src/qpid/linearstore/jrnl/utils/file_hdr.h create mode 100644 qpid/cpp/src/qpid/linearstore/jrnl/utils/rec_hdr.h (limited to 'qpid/cpp/src') diff --git a/qpid/cpp/src/linearstore.cmake b/qpid/cpp/src/linearstore.cmake index 3d8c7af5d0..ea6c0d1f4d 100644 --- a/qpid/cpp/src/linearstore.cmake +++ b/qpid/cpp/src/linearstore.cmake @@ -118,6 +118,10 @@ if (BUILD_LINEARSTORE) qpid/linearstore/TxnCtxt.cpp ) + set (util_SOURCES + qpid/linearstore/jrnl/utils/file_hdr.c + ) + # linearstore include directories get_property(dirs DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} PROPERTY INCLUDE_DIRECTORIES) set (legacy_include_DIRECTORIES @@ -132,6 +136,14 @@ if (BUILD_LINEARSTORE) "#include <${DB_INCLUDE_DIR}/db_cxx.h>\n") endif() + add_library (linearstoreutils SHARED + ${util_SOURCES} + ) + + target_link_libraries (linearstoreutils + rt + ) + add_library (linearstore MODULE ${legacy_jrnl_SOURCES} ${legacy_store_SOURCES} @@ -148,7 +160,7 @@ if (BUILD_LINEARSTORE) target_link_libraries (linearstore aio uuid - qpidcommon qpidtypes qpidbroker + qpidcommon qpidtypes qpidbroker linearstoreutils ${DB_LIBRARY} ) diff --git a/qpid/cpp/src/qpid/linearstore/jrnl/utils/file_hdr.c b/qpid/cpp/src/qpid/linearstore/jrnl/utils/file_hdr.c new file mode 100644 index 0000000000..af546c034d --- /dev/null +++ b/qpid/cpp/src/qpid/linearstore/jrnl/utils/file_hdr.c @@ -0,0 +1,43 @@ +/* + * + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + * + */ + +#include "file_hdr.h" +#include + +int set_time_now(file_hdr_t *fh) +{ + struct timespec ts; + int err; + + if (err = clock_gettime(CLOCK_REALTIME, &ts)) + return err; + fh->_ts_sec = ts.tv_sec; + fh->_ts_nsec = ts.tv_nsec; +} + + +void set_time(file_hdr_t *fh, struct timespec *ts) +{ + fh->_ts_sec = ts->tv_sec; + fh->_ts_nsec = ts->tv_nsec; +} + + diff --git a/qpid/cpp/src/qpid/linearstore/jrnl/utils/file_hdr.h b/qpid/cpp/src/qpid/linearstore/jrnl/utils/file_hdr.h new file mode 100644 index 0000000000..af7e888ad3 --- /dev/null +++ b/qpid/cpp/src/qpid/linearstore/jrnl/utils/file_hdr.h @@ -0,0 +1,106 @@ +#ifndef QPID_LEGACYSTORE_JRNL_FILE_HDR_H +#define QPID_LEGACYSTORE_JRNL_FILE_HDR_H +/* + * + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + * + */ + +/** + * \file file_hdr.h + * + * Qpid asynchronous store plugin library + * + * File containing code for class mrg::journal::file_hdr (file + * record header), used to start a journal file. It contains some + * file metadata and information to aid journal recovery. + * + * \author Kim van der Riet + */ + +#include +#include "rec_hdr.h" + +#pragma pack(1) + +/** + * \brief Struct for data common to the head of all journal files. In addition to + * the common data, this includes the record ID and offset of the first record in + * the file. + * + * This header precedes all data in journal files and occupies the first complete + * block in the file. The record ID and offset are updated on each overwrite of the + * file. + * + * File header info in binary format (48 bytes): + * 
+ *   0                           7
+ * +---+---+---+---+---+---+---+---+  -+
+ * |     magic     | v | 0 | flags |   |
+ * +---+---+---+---+---+---+---+---+   | struct hdr
+ * |       first rid in file       |   |
+ * +---+---+---+---+---+---+---+---+  -+
+ * |              fro              |
+ * +---+---+---+---+---+---+---+---+
+ * |           timestamp (sec)     |
+ * +---+---+---+---+---+---+---+---+
+ * |           timestamp (ns)      |
+ * +---+---+---+---+---+---+---+---+
+ * |  file-count   |    reserved   |
+ * +---+---+---+---+---+---+---+---+
+ * |           file-size           |
+ * +---+---+---+---+---+---+---+---+
+ * |          file-number          |
+ * +---+---+---+---+---+---+---+---+
+ * | n-len |  File Name...         |
+ * +-------+                       |
+ * |                               |
+ * +---+---+---+---+---+---+---+---+
+ *
+ * v = file version (If the format or encoding of this file changes, then this
+ *     number should be incremented)
+ * fro = First record offset, offset from start of file to first record header
+ * file-count  = Number of files in use for the journal at the time this header is written
+ * file-size   = Size of the file in octets
+ * file-number = Incrementing serial number indicating file order within a journal
+ * n-len = Length of the queue name in octets.
+ *
+ * + * Note that journal files should be transferable between 32- and 64-bit + * hardware of the same endianness, but not between hardware of opposite + * entianness without some sort of binary conversion utility. Thus buffering + * will be needed for types that change size between 32- and 64-bit compiles. + */ +typedef struct file_hdr_t { + rec_hdr_t _rhdr; + uint64_t _fro; + uint64_t _ts_sec; + uint64_t _ts_nsec; + uint32_t _file_count; + uint32_t _reserved; + uint64_t _file_size; + uint64_t _file_number; + uint16_t _name_length; +} file_hdr_t; + +int set_time_now(file_hdr_t *fh); +void set_time(file_hdr_t *fh, struct timespec *ts); + +#pragma pack() + +#endif // ifndef QPID_LEGACYSTORE_JRNL_FILE_HDR_H diff --git a/qpid/cpp/src/qpid/linearstore/jrnl/utils/rec_hdr.h b/qpid/cpp/src/qpid/linearstore/jrnl/utils/rec_hdr.h new file mode 100644 index 0000000000..c8f8c8f9d1 --- /dev/null +++ b/qpid/cpp/src/qpid/linearstore/jrnl/utils/rec_hdr.h @@ -0,0 +1,75 @@ +#ifndef QPID_LEGACYSTORE_JRNL_REC_HDR_H +#define QPID_LEGACYSTORE_JRNL_REC_HDR_H +/* + * + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + * + */ + +/** + * \file rec_hdr.h + * + * Qpid asynchronous store plugin library + * + * File containing code for class mrg::journal::rec_hdr (record header), + * which is a common initial header used for all journal record structures + * except the record tail (rec_tail). + * + * \author Kim van der Riet + */ + +#include +#include "qpid/legacystore/jrnl/jcfg.h" +#include + +#pragma pack(1) + +/** + * \brief Struct for data common to the head of all journal files and records. + * This includes identification for the file type, the encoding version, endian + * indicator and a record ID. + * + * File header info in binary format (16 bytes): + * 
+ *   0                           7
+ * +---+---+---+---+---+---+---+---+
+ * |     magic     | v | 0 | flags |
+ * +---+---+---+---+---+---+---+---+
+ * |              rid              |
+ * +---+---+---+---+---+---+---+---+
+ * v = file version (If the format or encoding of this file changes, then this
+ *     number should be incremented)
+ * 0 = reserved
+ *
+ * + * Note that journal files should be transferable between 32- and 64-bit + * hardware of the same endianness, but not between hardware of opposite + * entianness without some sort of binary conversion utility. Thus buffering + * will be needed for types that change size between 32- and 64-bit compiles. + */ +typedef struct rec_hdr_t { + uint32_t _magic; ///< File type identifier (magic number) + uint8_t _version; ///< File encoding version + uint8_t _zero; ///< Flag for determining endianness + uint16_t _uflag; ///< User-defined flags + uint64_t _rid; ///< Record ID (rotating 64-bit counter) +} rec_hdr_t; + +#pragma pack() + +#endif // ifndef QPID_LEGACYSTORE_JRNL_REC_HDR_H -- cgit v1.2.1