/usr/include/rados/buffer.h is in librados-dev 0.80.7-2+deb8u2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 | // -*- mode:C++; tab-width:8; c-basic-offset:2; indent-tabs-mode:t -*-
// vim: ts=8 sw=2 smarttab
/*
* Ceph - scalable distributed file system
*
* Copyright (C) 2004-2006 Sage Weil <sage@newdream.net>
*
* This is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software
* Foundation. See file COPYING.
*
*/
#ifndef CEPH_BUFFER_H
#define CEPH_BUFFER_H
#if defined(__linux__)
#include <stdlib.h>
#include <linux/types.h>
#elif defined(__FreeBSD__)
#include <sys/types.h>
#include <stdlib.h>
#endif
#ifndef _XOPEN_SOURCE
# define _XOPEN_SOURCE 600
#endif
#include <stdio.h>
#if defined(__linux__) // For malloc(2).
#include <malloc.h>
#endif
#include <inttypes.h>
#include <stdint.h>
#include <string.h>
#ifndef __CYGWIN__
# include <sys/mman.h>
#endif
#include <iostream>
#include <istream>
#include <iomanip>
#include <list>
#include <string>
#include <exception>
#include "page.h"
#include "crc32c.h"
#ifdef __CEPH__
# include "include/assert.h"
#else
# include <assert.h>
#endif
namespace ceph {
class buffer {
/*
* exceptions
*/
public:
struct error : public std::exception{
const char *what() const throw () {
return "buffer::exception";
}
};
struct bad_alloc : public error {
const char *what() const throw () {
return "buffer::bad_alloc";
}
};
struct end_of_buffer : public error {
const char *what() const throw () {
return "buffer::end_of_buffer";
}
};
struct malformed_input : public error {
explicit malformed_input(const char *w) {
snprintf(buf, sizeof(buf), "buffer::malformed_input: %s", w);
}
const char *what() const throw () {
return buf;
}
private:
char buf[256];
};
struct error_code : public malformed_input {
explicit error_code(int error);
int code;
};
/// total bytes allocated
static int get_total_alloc();
/// enable/disable alloc tracking
static void track_alloc(bool b);
/// count of cached crc hits (matching input)
static int get_cached_crc();
/// count of cached crc hits (mismatching input, required adjustment)
static int get_cached_crc_adjusted();
/// enable/disable tracking of cached crcs
static void track_cached_crc(bool b);
/// count of calls to buffer::ptr::c_str()
static int get_c_str_accesses();
/// enable/disable tracking of buffer::ptr::c_str() calls
static void track_c_str(bool b);
private:
/* hack for memory utilization debugging. */
static void inc_total_alloc(unsigned len);
static void dec_total_alloc(unsigned len);
/*
* an abstract raw buffer. with a reference count.
*/
class raw;
class raw_malloc;
class raw_static;
class raw_mmap_pages;
class raw_posix_aligned;
class raw_hack_aligned;
class raw_char;
class raw_pipe;
friend std::ostream& operator<<(std::ostream& out, const raw &r);
public:
/*
* named constructors
*/
static raw* copy(const char *c, unsigned len);
static raw* create(unsigned len);
static raw* claim_char(unsigned len, char *buf);
static raw* create_malloc(unsigned len);
static raw* claim_malloc(unsigned len, char *buf);
static raw* create_static(unsigned len, char *buf);
static raw* create_page_aligned(unsigned len);
static raw* create_zero_copy(unsigned len, int fd, int64_t *offset);
/*
* a buffer pointer. references (a subsequence of) a raw buffer.
*/
class ptr {
raw *_raw;
unsigned _off, _len;
void release();
public:
ptr() : _raw(0), _off(0), _len(0) {}
ptr(raw *r);
ptr(unsigned l);
ptr(const char *d, unsigned l);
ptr(const ptr& p);
ptr(const ptr& p, unsigned o, unsigned l);
ptr& operator= (const ptr& p);
~ptr() {
release();
}
bool have_raw() const { return _raw ? true:false; }
raw *clone();
void swap(ptr& other);
// misc
bool at_buffer_head() const { return _off == 0; }
bool at_buffer_tail() const;
bool is_page_aligned() const { return ((long)c_str() & ~CEPH_PAGE_MASK) == 0; }
bool is_n_page_sized() const { return (length() & ~CEPH_PAGE_MASK) == 0; }
// accessors
raw *get_raw() const { return _raw; }
const char *c_str() const;
char *c_str();
unsigned length() const { return _len; }
unsigned offset() const { return _off; }
unsigned start() const { return _off; }
unsigned end() const { return _off + _len; }
unsigned unused_tail_length() const;
const char& operator[](unsigned n) const;
char& operator[](unsigned n);
const char *raw_c_str() const;
unsigned raw_length() const;
int raw_nref() const;
void copy_out(unsigned o, unsigned l, char *dest) const {
assert(_raw);
if (!((o <= _len) && (o+l <= _len)))
throw end_of_buffer();
memcpy(dest, c_str()+o, l);
}
bool can_zero_copy() const;
int zero_copy_to_fd(int fd, int64_t *offset) const;
unsigned wasted();
int cmp(const ptr& o) const;
bool is_zero() const;
// modifiers
void set_offset(unsigned o) { _off = o; }
void set_length(unsigned l) { _len = l; }
void append(char c);
void append(const char *p, unsigned l);
void copy_in(unsigned o, unsigned l, const char *src);
void zero();
void zero(unsigned o, unsigned l);
};
friend std::ostream& operator<<(std::ostream& out, const buffer::ptr& bp);
/*
* list - the useful bit!
*/
class list {
// my private bits
std::list<ptr> _buffers;
unsigned _len;
ptr append_buffer; // where i put small appends.
public:
class iterator {
list *bl;
std::list<ptr> *ls; // meh.. just here to avoid an extra pointer dereference..
unsigned off; // in bl
std::list<ptr>::iterator p;
unsigned p_off; // in *p
public:
// constructor. position.
iterator() :
bl(0), ls(0), off(0), p_off(0) {}
iterator(list *l, unsigned o=0) :
bl(l), ls(&bl->_buffers), off(0), p(ls->begin()), p_off(0) {
advance(o);
}
iterator(list *l, unsigned o, std::list<ptr>::iterator ip, unsigned po) :
bl(l), ls(&bl->_buffers), off(o), p(ip), p_off(po) { }
iterator(const iterator& other) : bl(other.bl),
ls(other.ls),
off(other.off),
p(other.p),
p_off(other.p_off) {}
iterator& operator=(const iterator& other) {
if (this != &other) {
bl = other.bl;
ls = other.ls;
off = other.off;
p = other.p;
p_off = other.p_off;
}
return *this;
}
/// get current iterator offset in buffer::list
unsigned get_off() { return off; }
/// get number of bytes remaining from iterator position to the end of the buffer::list
unsigned get_remaining() { return bl->length() - off; }
/// true if iterator is at the end of the buffer::list
bool end() {
return p == ls->end();
//return off == bl->length();
}
void advance(int o);
void seek(unsigned o);
char operator*();
iterator& operator++();
ptr get_current_ptr();
// copy data out.
// note that these all _append_ to dest!
void copy(unsigned len, char *dest);
void copy(unsigned len, ptr &dest);
void copy(unsigned len, list &dest);
void copy(unsigned len, std::string &dest);
void copy_all(list &dest);
// copy data in
void copy_in(unsigned len, const char *src);
void copy_in(unsigned len, const list& otherl);
};
private:
mutable iterator last_p;
int zero_copy_to_fd(int fd) const;
public:
// cons/des
list() : _len(0), last_p(this) {}
list(unsigned prealloc) : _len(0), last_p(this) {
append_buffer = buffer::create(prealloc);
append_buffer.set_length(0); // unused, so far.
}
~list() {}
list(const list& other) : _buffers(other._buffers), _len(other._len), last_p(this) { }
list& operator= (const list& other) {
if (this != &other) {
_buffers = other._buffers;
_len = other._len;
}
return *this;
}
const std::list<ptr>& buffers() const { return _buffers; }
void swap(list& other);
unsigned length() const {
#if 0
// DEBUG: verify _len
unsigned len = 0;
for (std::list<ptr>::const_iterator it = _buffers.begin();
it != _buffers.end();
it++) {
len += (*it).length();
}
assert(len == _len);
#endif
return _len;
}
bool contents_equal(buffer::list& other);
bool can_zero_copy() const;
bool is_page_aligned() const;
bool is_n_page_sized() const;
bool is_zero() const;
// modifiers
void clear() {
_buffers.clear();
_len = 0;
last_p = begin();
}
void push_front(ptr& bp) {
if (bp.length() == 0)
return;
_buffers.push_front(bp);
_len += bp.length();
}
void push_front(raw *r) {
ptr bp(r);
push_front(bp);
}
void push_back(const ptr& bp) {
if (bp.length() == 0)
return;
_buffers.push_back(bp);
_len += bp.length();
}
void push_back(raw *r) {
ptr bp(r);
push_back(bp);
}
void zero();
void zero(unsigned o, unsigned l);
bool is_contiguous();
void rebuild();
void rebuild(ptr& nb);
void rebuild_page_aligned();
// sort-of-like-assignment-op
void claim(list& bl);
void claim_append(list& bl);
void claim_prepend(list& bl);
iterator begin() {
return iterator(this, 0);
}
iterator end() {
return iterator(this, _len, _buffers.end(), 0);
}
// crope lookalikes.
// **** WARNING: this are horribly inefficient for large bufferlists. ****
void copy(unsigned off, unsigned len, char *dest) const;
void copy(unsigned off, unsigned len, list &dest) const;
void copy(unsigned off, unsigned len, std::string& dest) const;
void copy_in(unsigned off, unsigned len, const char *src);
void copy_in(unsigned off, unsigned len, const list& src);
void append(char c);
void append(const char *data, unsigned len);
void append(const std::string& s) {
append(s.data(), s.length());
}
void append(const ptr& bp);
void append(const ptr& bp, unsigned off, unsigned len);
void append(const list& bl);
void append(std::istream& in);
void append_zero(unsigned len);
/*
* get a char
*/
const char& operator[](unsigned n) const;
char *c_str();
void substr_of(const list& other, unsigned off, unsigned len);
// funky modifer
void splice(unsigned off, unsigned len, list *claim_by=0 /*, bufferlist& replace_with */);
void write(int off, int len, std::ostream& out) const;
void encode_base64(list& o);
void decode_base64(list& o);
void hexdump(std::ostream &out) const;
int read_file(const char *fn, std::string *error);
ssize_t read_fd(int fd, size_t len);
int read_fd_zero_copy(int fd, size_t len);
int write_file(const char *fn, int mode=0644);
int write_fd(int fd) const;
int write_fd_zero_copy(int fd) const;
uint32_t crc32c(uint32_t crc) const;
};
/*
* efficient hash of one or more bufferlists
*/
class hash {
uint32_t crc;
public:
hash() : crc(0) { }
hash(uint32_t init) : crc(init) { }
void update(buffer::list& bl) {
crc = bl.crc32c(crc);
}
uint32_t digest() {
return crc;
}
};
};
typedef buffer::ptr bufferptr;
typedef buffer::list bufferlist;
typedef buffer::hash bufferhash;
inline bool operator>(bufferlist& l, bufferlist& r) {
for (unsigned p = 0; ; p++) {
if (l.length() > p && r.length() == p) return true;
if (l.length() == p) return false;
if (l[p] > r[p]) return true;
if (l[p] < r[p]) return false;
}
}
inline bool operator>=(bufferlist& l, bufferlist& r) {
for (unsigned p = 0; ; p++) {
if (l.length() > p && r.length() == p) return true;
if (r.length() == p && l.length() == p) return true;
if (l.length() == p && r.length() > p) return false;
if (l[p] > r[p]) return true;
if (l[p] < r[p]) return false;
}
}
inline bool operator==(bufferlist &l, bufferlist &r) {
if (l.length() != r.length())
return false;
for (unsigned p = 0; p < l.length(); p++) {
if (l[p] != r[p])
return false;
}
return true;
}
inline bool operator<(bufferlist& l, bufferlist& r) {
return r > l;
}
inline bool operator<=(bufferlist& l, bufferlist& r) {
return r >= l;
}
inline std::ostream& operator<<(std::ostream& out, const buffer::ptr& bp) {
if (bp.have_raw())
out << "buffer::ptr(" << bp.offset() << "~" << bp.length()
<< " " << (void*)bp.c_str()
<< " in raw " << (void*)bp.raw_c_str()
<< " len " << bp.raw_length()
<< " nref " << bp.raw_nref() << ")";
else
out << "buffer:ptr(" << bp.offset() << "~" << bp.length() << " no raw)";
return out;
}
inline std::ostream& operator<<(std::ostream& out, const buffer::list& bl) {
out << "buffer::list(len=" << bl.length() << "," << std::endl;
std::list<buffer::ptr>::const_iterator it = bl.buffers().begin();
while (it != bl.buffers().end()) {
out << "\t" << *it;
if (++it == bl.buffers().end()) break;
out << "," << std::endl;
}
out << std::endl << ")";
return out;
}
inline std::ostream& operator<<(std::ostream& out, buffer::error& e)
{
return out << e.what();
}
inline bufferhash& operator<<(bufferhash& l, bufferlist &r) {
l.update(r);
return l;
}
}
#endif
|