blob: 3da5f3c216c132d0caaa848fe10808df6da3cf6a [file] [log] [blame]
/*
* 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.
*/
/* $Rev$ $Date$ */
#ifndef tuscany_tinycdb_hpp
#define tuscany_tinycdb_hpp
#include <fcntl.h>
#include <unistd.h>
#include <sys/stat.h>
#include <cdb.h>
#include "string.hpp"
#include "list.hpp"
#include "value.hpp"
#include "monad.hpp"
#include "../../modules/scheme/eval.hpp"
namespace tuscany {
namespace tinycdb {
/**
* A reallocatable buffer.
*/
class buffer {
public:
operator void* const () const throw() {
return buf;
}
operator unsigned char* const () const throw() {
return (unsigned char* const)buf;
}
operator char* const () const throw() {
return (char* const)buf;
}
private:
buffer(const unsigned int size, void* const buf) : size(size), buf(buf) {
}
unsigned int size;
void* buf;
friend const buffer mkbuffer(const unsigned int sz);
friend const buffer mkbuffer(const buffer& b, const unsigned int newsz);
friend const bool free(const buffer& b);
};
/**
* Make a new buffer.
*/
const buffer mkbuffer(const unsigned int sz) {
return buffer(sz, malloc(sz));
}
/**
* Make a new buffer by reallocating an existing one.
*/
const buffer mkbuffer(const buffer& b, const unsigned int sz) {
if (sz <= b.size)
return b;
return buffer(sz, realloc(b.buf, sz));
}
/**
* Free a buffer.
*/
const bool free(const buffer&b) {
::free(b.buf);
return true;
}
/**
* Convert a database name to an absolute path.
*/
const string absdbname(const string& name) {
if (length(name) == 0 || c_str(name)[0] == '/')
return name;
char cwd[512];
if (getcwd(cwd, sizeof(cwd)) == NULL)
return name;
return string(cwd) + "/" + name;
}
/**
* Represents a TinyCDB connection.
*/
class TinyCDB {
public:
TinyCDB() : owner(false), h(*(new (gc_new<handles>()) handles())) {
}
TinyCDB(const string& name) : owner(true), name(absdbname(name)), h(*(new (gc_new<handles>()) handles())) {
debug(name, "tinycdb::tinycdb::name");
}
TinyCDB(const TinyCDB& c) : owner(false), name(c.name), h(c.h) {
debug("tinycdb::tinycdb::copy");
}
TinyCDB& operator=(const TinyCDB& c) = delete;
~TinyCDB() {
if (!owner)
return;
if (h.fd == -1)
return;
close(h.fd);
}
private:
class handles {
public:
handles() : fd(-1) {
st.st_ino = 0;
}
handles(const handles& c) : fd(c.fd), st(c.st) {
}
private:
int fd;
struct stat st;
friend class TinyCDB;
friend const failable<int> cdbopen(const TinyCDB& cdb);
friend const failable<bool> cdbclose(const TinyCDB& cdb);
};
bool owner;
string name;
handles& h;
friend const string dbname(const TinyCDB& cdb);
friend const failable<int> cdbopen(const TinyCDB& cdb);
friend const failable<bool> cdbclose(const TinyCDB& cdb);
};
/**
* Return the name of the database.
*/
const string dbname(const TinyCDB& cdb) {
return cdb.name;
}
/**
* Open a database.
*/
const failable<int> cdbopen(const TinyCDB& cdb) {
// Get database file serial number
struct stat st;
const int s = stat(c_str(cdb.name), &st);
if (s == -1)
return mkfailure<int>(string("Couldn't tinycdb read database stat: ") + cdb.name);
// Open database for the first time
if (cdb.h.fd == -1) {
cdb.h.fd = open(c_str(cdb.name), O_RDONLY);
if (cdb.h.fd == -1)
return mkfailure<int>(string("Couldn't open tinycdb database file: ") + cdb.name);
debug(cdb.h.fd, "tinycdb::open::fd");
cdb.h.st = st;
return cdb.h.fd;
}
// Close and reopen database after a change
if (st.st_ino != cdb.h.st.st_ino) {
// Close current fd
close(cdb.h.fd);
// Reopen database
const int newfd = open(c_str(cdb.name), O_RDONLY);
if (newfd == -1)
return mkfailure<int>(string("Couldn't open tinycdb database file: ") + cdb.name);
if (newfd == cdb.h.fd) {
debug(cdb.h.fd, "tinycdb::open::fd");
cdb.h.st = st;
return cdb.h.fd;
}
// We got a different fd, dup it to the current fd then close it
if (fcntl(newfd, F_DUPFD, cdb.h.fd) == -1)
return mkfailure<int>(string("Couldn't dup tinycdb database file handle: ") + cdb.name);
close(newfd);
debug(cdb.h.fd, "tinycdb::open::fd");
cdb.h.st = st;
return cdb.h.fd;
}
// No change, just return the current fd
return cdb.h.fd;
}
/**
* Close a database.
*/
const failable<bool> cdbclose(const TinyCDB& cdb) {
close(cdb.h.fd);
cdb.h.fd = -1;
return true;
}
/**
* Rewrite a database. The given update function is passed each entry, and
* can return true to let the entry added to the new db, false to skip the
* entry, or a failure.
*/
const failable<bool> rewrite(const lambda<const failable<bool>(buffer& buf, const unsigned int klen, const unsigned int vlen)>& update, const lambda<const failable<bool>(struct cdb_make&)>& finish, buffer& buf, const int tmpfd, const TinyCDB& cdb) {
// Initialize new db structure
struct cdb_make cdbm;
cdb_make_start(&cdbm, tmpfd);
// Open existing db
failable<int> ffd = cdbopen(cdb);
if (!hasContent(ffd))
return mkfailure<bool>(ffd);
const int fd = content(ffd);
// Read the db header
unsigned int pos = 0;
if (lseek(fd, 0, SEEK_SET) != 0)
return mkfailure<bool>("Couldn't seek to tinycdb database start");
if (::read(fd, buf, 2048) != 2048)
return mkfailure<bool>("Couldn't read tinycdb database header");
pos += 2048;
const unsigned int eod = cdb_unpack(buf);
debug(pos, "tinycdb::rewrite::eod");
// Read and add the existing entries
while(pos < eod) {
if (eod - pos < 8)
return mkfailure<bool>("Invalid tinycdb database format, couldn't read entry header");
if (::read(fd, buf, 8) != 8)
return mkfailure<bool>("Couldn't read tinycdb entry header");
pos += 8;
const unsigned int klen = cdb_unpack(buf);
const unsigned int vlen = cdb_unpack(((unsigned char*)buf) + 4);
const unsigned int elen = klen + vlen;
// Read existing entry
buf = mkbuffer(buf, elen);
if (eod - pos < elen)
return mkfailure<bool>("Invalid tinycdb database format, couldn't read entry");
if ((unsigned int)::read(fd, buf, elen) != elen)
return mkfailure<bool>("Couldn't read tinycdb entry");
pos += elen;
// Apply the update function to the entry
debug(string((const char* const)buf, klen), "tinycdb::rewrite::existing key");
debug(string(((const char* const)buf) + klen, vlen), "tinycdb::rewrite::existing value");
const failable<bool> u = update(buf, klen, vlen);
if (!hasContent(u))
return u;
// Skip the entry if the update function returned false
if (u == false)
continue;
// Add the entry to the new db
if (cdb_make_add(&cdbm, buf, klen, ((unsigned char*)buf)+klen, vlen) == -1)
return mkfailure<bool>("Couldn'tt add tinycdb entry");
}
if (pos != eod)
return mkfailure<bool>("Invalid tinycdb database format");
// Call the finish function
const failable<bool> f = finish(cdbm);
if (!hasContent(f))
return f;
// Save the new db
if (cdb_make_finish(&cdbm) == -1)
return mkfailure<bool>("Couldn't save tinycdb database");
return true;
}
const failable<bool> rewrite(const lambda<const failable<bool>(buffer& buf, const unsigned int klen, const unsigned int vlen)>& update, const lambda<const failable<bool>(struct cdb_make&)>& finish, const TinyCDB& cdb) {
// Create a new temporary db file
const string tmpname = dbname(cdb) + ".XXXXXX";
const int tmpfd = mkstemp(const_cast<char*>(c_str(tmpname)));
if (tmpfd == -1)
return mkfailure<bool>("Couldn't create temporary tinycdb database");
// Rewrite the db, apply the update function to each entry
buffer buf = mkbuffer(2048);
const failable<bool> r = rewrite(update, finish, buf, tmpfd, cdb);
if (!hasContent(r)) {
close(tmpfd);
free(buf);
return r;
}
// Atomically replace the db and reopen it in read mode
if (rename(c_str(tmpname), c_str(dbname(cdb))) == -1)
return mkfailure<bool>("Couldn't rename temporary tinycdb database");
cdbclose(cdb);
const failable<int> ffd = cdbopen(cdb);
if (!hasContent(ffd))
return mkfailure<bool>(ffd);
return true;
}
/**
* Post a new item to the database.
*/
const failable<bool> post(const value& key, const value& val, const TinyCDB& cdb) {
debug(key, "tinycdb::post::key");
debug(val, "tinycdb::post::value");
debug(dbname(cdb), "tinycdb::post::dbname");
const string ks(write(content(scheme::writeValue(key))));
const string vs(write(content(scheme::writeValue(val))));
// Process each entry and detect existing key
const lambda<const failable<bool>(buffer&, const unsigned int, const unsigned int)> update = [ks](buffer& buf, const unsigned int klen, unused const unsigned int vlen) -> const failable<bool> {
if (ks == string((char*)buf, klen))
return mkfailure<bool>("Key already exists in tinycdb database");
return true;
};
// Add the new entry to the db
const lambda<const failable<bool>(struct cdb_make&)> finish = [ks, vs](struct cdb_make& cdbm) -> const failable<bool> {
if (cdb_make_add(&cdbm, c_str(ks), (unsigned int)length(ks), c_str(vs), (unsigned int)length(vs)) == -1)
return mkfailure<bool>(string("Couldn't add tinycdb entry: ") + ks);
return true;
};
// Rewrite the db
const failable<bool> r = rewrite(update, finish, cdb);
debug(r, "tinycdb::post::result");
return r;
}
/**
* Update an item in the database. If the item doesn't exist it is added.
*/
const failable<bool> put(const value& key, const value& val, const TinyCDB& cdb) {
debug(key, "tinycdb::put::key");
debug(val, "tinycdb::put::value");
debug(dbname(cdb), "tinycdb::put::dbname");
const string ks(write(content(scheme::writeValue(key))));
const string vs(write(content(scheme::writeValue(val))));
// Process each entry and skip existing key
const lambda<const failable<bool>(buffer&, const unsigned int, const unsigned int)> update = [ks](buffer& buf, const unsigned int klen, unused const unsigned int vlen) -> const failable<bool> {
if (ks == string((char*)buf, klen))
return false;
return true;
};
// Add the new entry to the db
const lambda<const failable<bool>(struct cdb_make&)> finish = [ks, vs](struct cdb_make& cdbm) -> const failable<bool> {
if (cdb_make_add(&cdbm, c_str(ks), (unsigned int)length(ks), c_str(vs), (unsigned int)length(vs)) == -1)
return mkfailure<bool>(string("Couldn't add tinycdb entry: ") + ks);
return true;
};
// Rewrite the db
const failable<bool> r = rewrite(update, finish, cdb);
debug(r, "tinycdb::put::result");
return r;
}
/**
* Patch an item in the database. If the item doesn't exist it is added.
*/
const failable<bool> patch(const value& key, const value& val, const TinyCDB& cdb) {
debug(key, "tinycdb::patch::key");
debug(val, "tinycdb::patch::value");
debug(dbname(cdb), "tinycdb::patch::dbname");
const string ks(write(content(scheme::writeValue(key))));
const string vs(write(content(scheme::writeValue(val))));
// Process each entry and skip existing key
const lambda<const failable<bool>(buffer&, const unsigned int, const unsigned int)> update = [ks](buffer& buf, const unsigned int klen, unused const unsigned int vlen) -> const failable<bool> {
if (ks == string((char*)buf, klen))
return false;
return true;
};
// Add the new entry to the db
const lambda<const failable<bool>(struct cdb_make&)> finish = [ks, vs](struct cdb_make& cdbm) -> const failable<bool> {
if (cdb_make_add(&cdbm, c_str(ks), (unsigned int)length(ks), c_str(vs), (unsigned int)length(vs)) == -1)
return mkfailure<bool>(string("Couldn't add tinycdb entry: ") + ks);
return true;
};
// Rewrite the db
const failable<bool> r = rewrite(update, finish, cdb);
debug(r, "tinycdb::patch::result");
return r;
}
/**
* Get an item from the database.
*/
const failable<value> get(const value& key, const TinyCDB& cdb) {
debug(key, "tinycdb::get::key");
debug(dbname(cdb), "tinycdb::get::dbname");
const failable<int> ffd = cdbopen(cdb);
if (!hasContent(ffd))
return mkfailure<value>(ffd);
const int fd = content(ffd);
const string ks(write(content(scheme::writeValue(key))));
cdbi_t vlen;
if (cdb_seek(fd, c_str(ks), (unsigned int)length(ks), &vlen) <= 0) {
ostringstream os;
os << "Couldn't get tinycdb entry: " << key;
return mkfailure<value>(str(os), 404, false);
}
char* const data = gc_cnew(vlen + 1);
cdb_bread(fd, data, vlen);
data[vlen] = '\0';
const value val(content(scheme::readValue(string(data))));
debug(val, "tinycdb::get::result");
return val;
}
/**
* Delete an item from the database
*/
const failable<bool> del(const value& key, const TinyCDB& cdb) {
debug(key, "tinycdb::delete::key");
debug(dbname(cdb), "tinycdb::delete::dbname");
const string ks(write(content(scheme::writeValue(key))));
bool found = false;
// Process each entry and skip existing key
const lambda<const failable<bool>(buffer&, const unsigned int, const unsigned int)> update = [ks, &found](buffer& buf, const unsigned int klen, unused const unsigned int vlen) -> const failable<bool> {
if (ks == string((char*)buf, klen)) {
found = true;
return false;
}
return true;
};
// Nothing to do to finish
const lambda<const failable<bool>(struct cdb_make&)> finish = [](unused struct cdb_make& cdbm) -> const failable<bool> {
return true;
};
// Rewrite the db
const failable<bool> r = rewrite(update, finish, cdb);
if (!hasContent(r) || !found) {
ostringstream os;
os << "Couldn't delete tinycdb entry: " << key;
return hasContent(r)? mkfailure<bool>(str(os), 404, false) : r;
}
debug(r, "tinycdb::delete::result");
return r;
}
}
}
#endif /* tuscany_tinycdb_hpp */