pegasus_server_impl.cpp 84.8 KB
Newer Older
Q
qinzuoyan 已提交
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
// Copyright (c) 2017, Xiaomi, Inc.  All rights reserved.
// This source code is licensed under the Apache License Version 2.0, which
// can be found in the LICENSE file in the root directory of this source tree.

#include "pegasus_server_impl.h"
#include <pegasus_key_schema.h>
#include <pegasus_value_schema.h>
#include <pegasus_utils.h>
#include <dsn/utility/utils.h>
#include <rocksdb/utilities/checkpoint.h>
#include <rocksdb/table.h>
#include <boost/lexical_cast.hpp>
#include <algorithm>

#ifdef __TITLE__
#undef __TITLE__
#endif
#define __TITLE__ "pegasus.server.impl"

namespace pegasus {
namespace server {

// Although we have removed the INCR operator, but we need reserve the code for compatibility
// reason,
// because there may be some mutation log entries which include the code. Even if these entries need
// not to be applied to rocksdb, they may be deserialized.
DEFINE_TASK_CODE_RPC(RPC_RRDB_RRDB_INCR, TASK_PRIORITY_COMMON, ::dsn::THREAD_POOL_DEFAULT)

static std::string chkpt_get_dir_name(int64_t decree)
{
    char buffer[256];
    sprintf(buffer, "checkpoint.%" PRId64 "", decree);
    return std::string(buffer);
}

static bool chkpt_init_from_dir(const char *name, int64_t &decree)
{
    return 1 == sscanf(name, "checkpoint.%" PRId64 "", &decree) &&
           std::string(name) == chkpt_get_dir_name(decree);
}

pegasus_server_impl::pegasus_server_impl(dsn_gpid gpid)
    : ::dsn::replicated_service_app_type_1(gpid),
      _gpid(gpid),
      _db(nullptr),
      _is_open(false),
      _value_schema_version(0),
C
cailiuyang 已提交
48
      _last_durable_decree(0),
Q
qinzuoyan 已提交
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
      _physical_error(0),
      _is_checkpointing(false)
{
    _primary_address = ::dsn::rpc_address(dsn_primary_address()).to_string();
    char buf[256];
    sprintf(buf, "%d.%d@%s", gpid.u.app_id, gpid.u.partition_index, _primary_address.c_str());
    _replica_name = buf;
    _data_dir = dsn_get_app_data_dir(gpid);

    _verbose_log = dsn_config_get_value_bool("pegasus.server",
                                             "rocksdb_verbose_log",
                                             false,
                                             "print verbose log for debugging, default is false");

    // init db options

    // rocksdb default: 4MB
    _db_opts.write_buffer_size =
        (size_t)dsn_config_get_value_uint64("pegasus.server",
                                            "rocksdb_write_buffer_size",
                                            16777216,
                                            "rocksdb options.write_buffer_size, default 16MB");

    // rocksdb default: 2
    _db_opts.max_write_buffer_number =
        (int)dsn_config_get_value_uint64("pegasus.server",
                                         "rocksdb_max_write_buffer_number",
                                         2,
                                         "rocksdb options.max_write_buffer_number, default 2");

    // rocksdb default: 1
    _db_opts.max_background_compactions =
        (int)dsn_config_get_value_uint64("pegasus.server",
                                         "rocksdb_max_background_compactions",
                                         2,
                                         "rocksdb options.max_background_compactions, default 2");

    // rocksdb default: 7
    _db_opts.num_levels = dsn_config_get_value_uint64(
        "pegasus.server", "rocksdb_num_levels", 6, "rocksdb options.num_levels, default 6");

    // rocksdb default: 2MB
    _db_opts.target_file_size_base =
        dsn_config_get_value_uint64("pegasus.server",
                                    "rocksdb_target_file_size_base",
                                    8388608,
                                    "rocksdb options.target_file_size_base, default 8MB");

    // rocksdb default: 10MB
    _db_opts.max_bytes_for_level_base =
        dsn_config_get_value_uint64("pegasus.server",
                                    "rocksdb_max_bytes_for_level_base",
                                    41943040,
                                    "rocksdb options.max_bytes_for_level_base, default 40MB");

    // rocksdb default: 10
    _db_opts.max_grandparent_overlap_factor = (int)dsn_config_get_value_uint64(
        "pegasus.server",
        "rocksdb_max_grandparent_overlap_factor",
        10,
        "rocksdb options.max_grandparent_overlap_factor, default 10");

    // rocksdb default: 4
    _db_opts.level0_file_num_compaction_trigger =
        (int)dsn_config_get_value_uint64("pegasus.server",
                                         "rocksdb_level0_file_num_compaction_trigger",
                                         4,
                                         "rocksdb options.level0_file_num_compaction_trigger, 4");

    // rocksdb default: 20
    _db_opts.level0_slowdown_writes_trigger = (int)dsn_config_get_value_uint64(
        "pegasus.server",
        "rocksdb_level0_slowdown_writes_trigger",
        20,
        "rocksdb options.level0_slowdown_writes_trigger, default 20");

    // rocksdb default: 24
    _db_opts.level0_stop_writes_trigger =
        (int)dsn_config_get_value_uint64("pegasus.server",
                                         "rocksdb_level0_stop_writes_trigger",
                                         24,
                                         "rocksdb options.level0_stop_writes_trigger, default 24");

    // disable table block cache, default: false
    if ((bool)dsn_config_get_value_bool(
            "pegasus.server",
            "rocksdb_disable_table_block_cache",
            false,
            "rocksdb options.disable_table_block_cache, default false")) {
        rocksdb::BlockBasedTableOptions table_options;
        table_options.no_block_cache = true;
        table_options.block_restart_interval = 4;
        _db_opts.table_factory.reset(NewBlockBasedTableFactory(table_options));
    }

    // disable write ahead logging as replication handles logging instead now
    _wt_opts.disableWAL = true;

    // get the checkpoint reserve options.
    _checkpoint_reserve_min_count = (uint32_t)dsn_config_get_value_uint64(
        "pegasus.server", "checkpoint_reserve_min_count", 3, "checkpoint_reserve_min_count");
    _checkpoint_reserve_time_seconds =
        (uint32_t)dsn_config_get_value_uint64("pegasus.server",
                                              "checkpoint_reserve_time_seconds",
                                              3600,
                                              "checkpoint_reserve_time_seconds");

    // get the _updating_sstsize_inteval_seconds.
    _updating_rocksdb_sstsize_interval_seconds =
        (uint32_t)dsn_config_get_value_uint64("pegasus.server",
                                              "updating_rocksdb_sstsize_interval_seconds",
                                              600,
                                              "updating_rocksdb_sstsize_interval_seconds");

    // register the perf counters
    snprintf(buf, 255, "get_qps@%d.%d", gpid.u.app_id, gpid.u.partition_index);
    _pfc_get_qps.init("app.pegasus", buf, COUNTER_TYPE_RATE, "statistic the qps of GET request");

    snprintf(buf, 255, "multi_get_qps@%d.%d", gpid.u.app_id, gpid.u.partition_index);
    _pfc_multi_get_qps.init(
        "app.pegasus", buf, COUNTER_TYPE_RATE, "statistic the qps of MULTI_GET request");

    snprintf(buf, 255, "scan_qps@%d.%d", gpid.u.app_id, gpid.u.partition_index);
    _pfc_scan_qps.init("app.pegasus", buf, COUNTER_TYPE_RATE, "statistic the qps of SCAN request");

    snprintf(buf, 255, "put_qps@%d.%d", gpid.u.app_id, gpid.u.partition_index);
    _pfc_put_qps.init("app.pegasus", buf, COUNTER_TYPE_RATE, "statistic the qps of PUT request");

    snprintf(buf, 255, "multi_put_qps@%d.%d", gpid.u.app_id, gpid.u.partition_index);
    _pfc_multi_put_qps.init(
        "app.pegasus", buf, COUNTER_TYPE_RATE, "statistic the qps of MULTI_PUT request");

    snprintf(buf, 255, "remove_qps@%d.%d", gpid.u.app_id, gpid.u.partition_index);
    _pfc_remove_qps.init(
        "app.pegasus", buf, COUNTER_TYPE_RATE, "statistic the qps of REMOVE request");

    snprintf(buf, 255, "multi_remove_qps@%d.%d", gpid.u.app_id, gpid.u.partition_index);
    _pfc_multi_remove_qps.init(
        "app.pegasus", buf, COUNTER_TYPE_RATE, "statistic the qps of MULTI_REMOVE request");

    snprintf(buf, 255, "get_latency@%d.%d", gpid.u.app_id, gpid.u.partition_index);
    _pfc_get_latency.init("app.pegasus",
                          buf,
                          COUNTER_TYPE_NUMBER_PERCENTILES,
                          "statistic the latency of GET request");

    snprintf(buf, 255, "multi_get_latency@%d.%d", gpid.u.app_id, gpid.u.partition_index);
    _pfc_multi_get_latency.init("app.pegasus",
                                buf,
                                COUNTER_TYPE_NUMBER_PERCENTILES,
                                "statistic the latency of MULTI_GET request");

    snprintf(buf, 255, "scan_latency@%d.%d", gpid.u.app_id, gpid.u.partition_index);
    _pfc_scan_latency.init("app.pegasus",
                           buf,
                           COUNTER_TYPE_NUMBER_PERCENTILES,
                           "statistic the latency of SCAN request");

    snprintf(buf, 255, "put_latency@%d.%d", gpid.u.app_id, gpid.u.partition_index);
    _pfc_put_latency.init("app.pegasus",
                          buf,
                          COUNTER_TYPE_NUMBER_PERCENTILES,
                          "statistic the latency of PUT request");

    snprintf(buf, 255, "multi_put_latency@%d.%d", gpid.u.app_id, gpid.u.partition_index);
    _pfc_multi_put_latency.init("app.pegasus",
                                buf,
                                COUNTER_TYPE_NUMBER_PERCENTILES,
                                "statistic the latency of MULTI_PUT request");

    snprintf(buf, 255, "remove_latency@%d.%d", gpid.u.app_id, gpid.u.partition_index);
    _pfc_remove_latency.init("app.pegasus",
                             buf,
                             COUNTER_TYPE_NUMBER_PERCENTILES,
                             "statistic the latency of REMOVE request");

    snprintf(buf, 255, "multi_remove_latency@%d.%d", gpid.u.app_id, gpid.u.partition_index);
    _pfc_multi_remove_latency.init("app.pegasus",
                                   buf,
                                   COUNTER_TYPE_NUMBER_PERCENTILES,
                                   "statistic the latency of MULTI_REMOVE request");

231 232 233 234 235 236
    snprintf(buf, 255, "recent.expire.count@%d.%d", gpid.u.app_id, gpid.u.partition_index);
    _pfc_recent_expire_count.init("app.pegasus",
                                  buf,
                                  COUNTER_TYPE_VOLATILE_NUMBER,
                                  "statistic the recent expired value read count");

237 238 239 240 241 242
    snprintf(buf, 255, "recent.filter.count@%d.%d", gpid.u.app_id, gpid.u.partition_index);
    _pfc_recent_filter_count.init("app.pegasus",
                                  buf,
                                  COUNTER_TYPE_VOLATILE_NUMBER,
                                  "statistic the recent filtered value read count");

Q
qinzuoyan 已提交
243 244 245
    snprintf(buf, 255, "disk.storage.sst.count@%d.%d", gpid.u.app_id, gpid.u.partition_index);
    _pfc_sst_count.init(
        "app.pegasus", buf, COUNTER_TYPE_NUMBER, "statistic the count of sstable files");
246

Q
qinzuoyan 已提交
247 248 249
    snprintf(buf, 255, "disk.storage.sst(MB)@%d.%d", gpid.u.app_id, gpid.u.partition_index);
    _pfc_sst_size.init(
        "app.pegasus", buf, COUNTER_TYPE_NUMBER, "statistic the size of sstable files");
250

Q
qinzuoyan 已提交
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 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606
    updating_rocksdb_sstsize();
}

void pegasus_server_impl::parse_checkpoints()
{
    std::vector<std::string> dirs;
    ::dsn::utils::filesystem::get_subdirectories(_data_dir, dirs, false);

    ::dsn::utils::auto_lock<::dsn::utils::ex_lock_nr> l(_checkpoints_lock);

    _checkpoints.clear();
    for (auto &d : dirs) {
        int64_t ci;
        std::string d1 = d.substr(_data_dir.size() + 1);
        if (chkpt_init_from_dir(d1.c_str(), ci)) {
            _checkpoints.push_back(ci);
        } else if (d1.find("checkpoint") != std::string::npos) {
            ddebug(
                "%s: invalid checkpoint directory %s, remove it", _replica_name.c_str(), d.c_str());
            ::dsn::utils::filesystem::remove_path(d);
            if (!::dsn::utils::filesystem::remove_path(d)) {
                derror("%s: remove invalid checkpoint directory %s failed",
                       _replica_name.c_str(),
                       d.c_str());
            }
        }
    }

    if (!_checkpoints.empty()) {
        std::sort(_checkpoints.begin(), _checkpoints.end());
        set_last_durable_decree(_checkpoints.back());
    } else {
        set_last_durable_decree(0);
    }
}

void pegasus_server_impl::gc_checkpoints()
{
    std::deque<int64_t> temp_list;
    {
        ::dsn::utils::auto_lock<::dsn::utils::ex_lock_nr> l(_checkpoints_lock);
        if (_checkpoints.size() <= _checkpoint_reserve_min_count)
            return;
        temp_list = _checkpoints;
    }

    // find the max checkpoint which can be deleted
    int64_t max_del_d = -1;
    uint64_t current_time = dsn_now_ms() / 1000;
    for (int i = 0; i < temp_list.size(); ++i) {
        if (i + _checkpoint_reserve_min_count >= temp_list.size())
            break;
        int64_t d = temp_list[i];
        // we check last write time of "CURRENT" instead of directory, because the directory's
        // last write time may be updated by previous incompleted garbage collection.
        auto cpt_dir = ::dsn::utils::filesystem::path_combine(_data_dir, chkpt_get_dir_name(d));
        auto current_file = ::dsn::utils::filesystem::path_combine(cpt_dir, "CURRENT");
        if (!::dsn::utils::filesystem::file_exists(current_file)) {
            max_del_d = d;
            continue;
        }
        time_t tm;
        if (!dsn::utils::filesystem::last_write_time(current_file, tm)) {
            dwarn("get last write time of file %s failed", current_file.c_str());
            break;
        }
        uint64_t last_write_time = (uint64_t)tm;
        if (last_write_time + _checkpoint_reserve_time_seconds >= current_time) {
            // not expired
            break;
        }
        max_del_d = d;
    }
    if (max_del_d == -1) {
        // no checkpoint to delete
        ddebug("%s: no checkpoint to garbage collection, checkpoints_count = %d",
               _replica_name.c_str(),
               (int)temp_list.size());
        return;
    }
    std::list<int64_t> to_delete_list;
    int64_t min_d = 0;
    int64_t max_d = 0;
    int checkpoints_count = 0;
    {
        ::dsn::utils::auto_lock<::dsn::utils::ex_lock_nr> l(_checkpoints_lock);
        int delete_max_index = -1;
        for (int i = 0; i < _checkpoints.size(); ++i) {
            int64_t del_d = _checkpoints[i];
            if (i + _checkpoint_reserve_min_count >= _checkpoints.size() || del_d > max_del_d)
                break;
            to_delete_list.push_back(del_d);
            delete_max_index = i;
        }
        if (delete_max_index > 0) {
            _checkpoints.erase(_checkpoints.begin(), _checkpoints.begin() + delete_max_index + 1);
        }

        if (!_checkpoints.empty()) {
            min_d = _checkpoints.front();
            max_d = _checkpoints.back();
            checkpoints_count = _checkpoints.size();
        } else {
            min_d = 0;
            max_d = 0;
            checkpoints_count = 0;
        }
    }

    // do delete
    std::list<int64_t> put_back_list;
    for (auto &del_d : to_delete_list) {
        auto cpt_dir = ::dsn::utils::filesystem::path_combine(_data_dir, chkpt_get_dir_name(del_d));
        if (::dsn::utils::filesystem::directory_exists(cpt_dir)) {
            if (::dsn::utils::filesystem::remove_path(cpt_dir)) {
                ddebug("%s: checkpoint directory %s removed by garbage collection",
                       _replica_name.c_str(),
                       cpt_dir.c_str());
            } else {
                derror("%s: checkpoint directory %s remove failed by garbage collection",
                       _replica_name.c_str(),
                       cpt_dir.c_str());
                put_back_list.push_back(del_d);
            }
        } else {
            ddebug("%s: checkpoint directory %s does not exist, ignored by garbage collection",
                   _replica_name.c_str(),
                   cpt_dir.c_str());
        }
    }

    // put back checkpoints which is not deleted
    // ATTENTION: the put back checkpoint may be incomplete, which will cause failure on load.
    if (!put_back_list.empty()) {
        ::dsn::utils::auto_lock<::dsn::utils::ex_lock_nr> l(_checkpoints_lock);
        if (_checkpoints.empty() || put_back_list.back() < _checkpoints.front()) {
            // just insert to front will hold the order
            _checkpoints.insert(_checkpoints.begin(), put_back_list.begin(), put_back_list.end());
        } else {
            // need to re-sort
            _checkpoints.insert(_checkpoints.begin(), put_back_list.begin(), put_back_list.end());
            std::sort(_checkpoints.begin(), _checkpoints.end());
        }

        if (!_checkpoints.empty()) {
            min_d = _checkpoints.front();
            max_d = _checkpoints.back();
            checkpoints_count = _checkpoints.size();
        } else {
            min_d = 0;
            max_d = 0;
            checkpoints_count = 0;
        }
    }

    ddebug("%s: after checkpoint garbage collection, checkpoints_count = %d, "
           "min_checkpoint = %" PRId64 ", max_checkpoint = %" PRId64,
           _replica_name.c_str(),
           checkpoints_count,
           min_d,
           max_d);
}

void pegasus_server_impl::on_batched_write_requests(int64_t decree,
                                                    int64_t timestamp,
                                                    dsn_message_t *requests,
                                                    int count)
{
    dassert(_is_open, "");
    dassert(requests != nullptr, "");
    uint64_t start_time = dsn_now_ns();

    if (count == 1 &&
        ((::dsn::message_ex *)requests[0])->local_rpc_code ==
            ::dsn::apps::RPC_RRDB_RRDB_MULTI_PUT) {
        _pfc_multi_put_qps.increment();
        dsn_message_t request = requests[0];

        ::dsn::apps::update_response resp;
        resp.app_id = _gpid.u.app_id;
        resp.partition_index = _gpid.u.partition_index;
        resp.decree = decree;
        resp.server = _primary_address;

        ::dsn::apps::multi_put_request update;
        ::dsn::unmarshall(request, update);

        if (update.kvs.empty()) {
            // invalid argument
            derror("%s: invalid argument for multi_put: decree = %" PRId64 ", error = empty kvs",
                   _replica_name.c_str(),
                   decree);

            ::dsn::rpc_replier<::dsn::apps::update_response> replier(
                dsn_msg_create_response(request));
            if (!replier.is_empty()) {
                // an invalid operation shoundn't be added to latency calculation
                resp.error = rocksdb::Status::kInvalidArgument;
                replier(resp);
            }
            return;
        }

        for (auto &kv : update.kvs) {
            ::dsn::blob raw_key;
            pegasus_generate_key(raw_key, update.hash_key, kv.key);
            rocksdb::Slice slice_key(raw_key.data(), raw_key.length());
            rocksdb::SliceParts skey(&slice_key, 1);

            pegasus_generate_value(_value_schema_version,
                                   update.expire_ts_seconds,
                                   kv.value,
                                   _write_buf,
                                   _write_slices);
            rocksdb::SliceParts svalue(&_write_slices[0], _write_slices.size());

            _batch.Put(skey, svalue);
        }

        _wt_opts.given_decree = decree;
        rocksdb::Status status = _db->Write(_wt_opts, &_batch);
        if (!status.ok()) {
            derror("%s: rocksdb write failed for multi_put: decree = %" PRId64 ", error = %s",
                   _replica_name.c_str(),
                   decree,
                   status.ToString().c_str());
            _physical_error = status.code();
        }

        ::dsn::rpc_replier<::dsn::apps::update_response> replier(dsn_msg_create_response(request));
        if (!replier.is_empty()) {
            _pfc_multi_put_latency.set(dsn_now_ns() - start_time);
            resp.error = status.code();
            replier(resp);
        }

        _batch.Clear();
        return;
    } else if (count == 1 &&
               ((::dsn::message_ex *)requests[0])->local_rpc_code ==
                   ::dsn::apps::RPC_RRDB_RRDB_MULTI_REMOVE) {
        _pfc_multi_remove_qps.increment();
        dsn_message_t request = requests[0];

        ::dsn::apps::multi_remove_response resp;
        resp.app_id = _gpid.u.app_id;
        resp.partition_index = _gpid.u.partition_index;
        resp.decree = decree;
        resp.server = _primary_address;

        ::dsn::apps::multi_remove_request update;
        ::dsn::unmarshall(request, update);

        if (update.sort_keys.empty()) {
            // invalid argument
            derror("%s: invalid argument for multi_remove: decree = %" PRId64
                   ", error = empty sort keys",
                   _replica_name.c_str(),
                   decree);

            ::dsn::rpc_replier<::dsn::apps::multi_remove_response> replier(
                dsn_msg_create_response(request));
            if (!replier.is_empty()) {
                // an invalid operation shoundn't be added to latency calculation
                resp.error = rocksdb::Status::kInvalidArgument;
                resp.count = 0;
                replier(resp);
            }
            return;
        }

        for (auto &sort_key : update.sort_keys) {
            ::dsn::blob raw_key;
            pegasus_generate_key(raw_key, update.hash_key, sort_key);
            _batch.Delete(rocksdb::Slice(raw_key.data(), raw_key.length()));
        }

        _wt_opts.given_decree = decree;
        rocksdb::Status status = _db->Write(_wt_opts, &_batch);
        if (!status.ok()) {
            derror("%s: rocksdb write failed for multi_remove: decree = %" PRId64 ", error = %s",
                   _replica_name.c_str(),
                   decree,
                   status.ToString().c_str());
            _physical_error = status.code();
            resp.count = 0;
        } else {
            resp.count = update.sort_keys.size();
        }

        ::dsn::rpc_replier<::dsn::apps::multi_remove_response> replier(
            dsn_msg_create_response(request));
        if (!replier.is_empty()) {
            _pfc_multi_remove_latency.set(dsn_now_ns() - start_time);
            resp.error = status.code();
            replier(resp);
        }

        _batch.Clear();
        return;
    } else {
        for (int i = 0; i < count; ++i) {
            dsn_message_t request = requests[i];
            dassert(request != nullptr, "");
            ::dsn::message_ex *msg = (::dsn::message_ex *)request;
            ::dsn::blob key;
            if (msg->local_rpc_code == ::dsn::apps::RPC_RRDB_RRDB_PUT) {
                _pfc_put_qps.increment();
                ::dsn::apps::update_request update;
                ::dsn::unmarshall(request, update);
                key = update.key;

                rocksdb::Slice slice_key(key.data(), key.length());
                rocksdb::SliceParts skey(&slice_key, 1);

                pegasus_generate_value(_value_schema_version,
                                       update.expire_ts_seconds,
                                       update.value,
                                       _write_buf,
                                       _write_slices);
                rocksdb::SliceParts svalue(&_write_slices[0], _write_slices.size());

                _batch.Put(skey, svalue);
                _batch_repliers.emplace_back(dsn_msg_create_response(request));
                _batch_perfcounters.push_back(_pfc_put_latency.get_handle());
            } else if (msg->local_rpc_code == ::dsn::apps::RPC_RRDB_RRDB_REMOVE) {
                _pfc_remove_qps.increment();
                ::dsn::unmarshall(request, key);

                rocksdb::Slice skey(key.data(), key.length());
                _batch.Delete(skey);
                _batch_repliers.emplace_back(dsn_msg_create_response(request));
                _batch_perfcounters.push_back(_pfc_remove_latency.get_handle());
            } else if (msg->local_rpc_code == ::dsn::apps::RPC_RRDB_RRDB_MULTI_PUT ||
                       msg->local_rpc_code == ::dsn::apps::RPC_RRDB_RRDB_MULTI_REMOVE) {
                dassert(false,
                        "rpc code not allow batch: %s",
                        ::dsn::task_code(msg->local_rpc_code).to_string());
            } else {
                dassert(false,
                        "rpc code not handled: %s",
                        ::dsn::task_code(msg->local_rpc_code).to_string());
            }

            if (msg->header->client.partition_hash != 0) {
                uint64_t partition_hash = pegasus_key_hash(key);
                dassert(msg->header->client.partition_hash == partition_hash,
                        "inconsistent partition hash");
                int thread_hash = dsn_gpid_to_thread_hash(_gpid);
                dassert(msg->header->client.thread_hash == thread_hash, "inconsistent thread hash");
            }

            if (_verbose_log) {
                ::dsn::blob hash_key, sort_key;
                pegasus_restore_key(key, hash_key, sort_key);
                ddebug("%s: rocksdb write: decree = %" PRId64
607
                       ", code = %s, hash_key = \"%s\", sort_key = \"%s\"",
Q
qinzuoyan 已提交
608 609 610
                       _replica_name.c_str(),
                       decree,
                       dsn_task_code_to_string(msg->local_rpc_code),
611 612
                       ::pegasus::utils::c_escape_string(hash_key).c_str(),
                       ::pegasus::utils::c_escape_string(sort_key).c_str());
Q
qinzuoyan 已提交
613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707
            }
        }
    }

    if (_batch.Count() == 0) {
        // write fake data
        rocksdb::Slice empty_key;
        rocksdb::SliceParts skey(&empty_key, 1);

        ::dsn::blob empty_value;
        pegasus_generate_value(_value_schema_version, 0, empty_value, _write_buf, _write_slices);
        rocksdb::SliceParts svalue(&_write_slices[0], _write_slices.size());

        _batch.Put(skey, svalue);
    }
    _wt_opts.given_decree = decree;
    auto status = _db->Write(_wt_opts, &_batch);
    if (!status.ok()) {
        derror("%s: rocksdb write failed: decree = %" PRId64 ", error = %s",
               _replica_name.c_str(),
               decree,
               status.ToString().c_str());
        _physical_error = status.code();
    }

    ::dsn::apps::update_response resp;
    resp.error = status.code();
    resp.app_id = _gpid.u.app_id;
    resp.partition_index = _gpid.u.partition_index;
    resp.decree = decree;
    resp.server = _primary_address;

    dassert(_batch_repliers.size() == _batch_perfcounters.size(),
            "%s: repliers's size(%u) vs perfcounters's size(%u) not match",
            _replica_name.c_str(),
            _batch_repliers.size(),
            _batch_perfcounters.size());
    uint64_t latency = dsn_now_ns() - start_time;
    for (unsigned int i = 0; i != _batch_repliers.size(); ++i) {
        if (!_batch_repliers[i].is_empty()) {
            dsn_perf_counter_set(_batch_perfcounters[i], latency);
            _batch_repliers[i](resp);
        }
    }

    _batch.Clear();
    _batch_repliers.clear();
    _batch_perfcounters.clear();
}

void pegasus_server_impl::on_put(const ::dsn::apps::update_request &update,
                                 ::dsn::rpc_replier<::dsn::apps::update_response> &reply)
{
    dassert(false, "not implemented");
}

void pegasus_server_impl::on_multi_put(const ::dsn::apps::multi_put_request &args,
                                       ::dsn::rpc_replier<::dsn::apps::update_response> &reply)
{
    dassert(false, "not implemented");
}

void pegasus_server_impl::on_remove(const ::dsn::blob &key,
                                    ::dsn::rpc_replier<::dsn::apps::update_response> &reply)
{
    dassert(false, "not implemented");
}

void pegasus_server_impl::on_multi_remove(
    const ::dsn::apps::multi_remove_request &args,
    ::dsn::rpc_replier<::dsn::apps::multi_remove_response> &reply)
{
    dassert(false, "not implemented");
}

void pegasus_server_impl::on_get(const ::dsn::blob &key,
                                 ::dsn::rpc_replier<::dsn::apps::read_response> &reply)
{
    dassert(_is_open, "");
    _pfc_get_qps.increment();
    uint64_t start_time = dsn_now_ns();

    ::dsn::apps::read_response resp;
    auto id = get_gpid();
    resp.app_id = id.u.app_id;
    resp.partition_index = id.u.partition_index;
    resp.server = _primary_address;

    rocksdb::Slice skey(key.data(), key.length());
    std::unique_ptr<std::string> value(new std::string());
    rocksdb::Status status = _db->Get(_rd_opts, skey, value.get());

    if (status.ok()) {
        uint32_t expire_ts = pegasus_extract_expire_ts(_value_schema_version, *value);
        if (expire_ts > 0 && expire_ts <= ::pegasus::utils::epoch_now()) {
708
            _pfc_recent_expire_count.increment();
Q
qinzuoyan 已提交
709
            if (_verbose_log) {
710
                derror("%s: rocksdb data expired for get", _replica_name.c_str());
Q
qinzuoyan 已提交
711 712 713 714 715 716 717 718 719
            }
            status = rocksdb::Status::NotFound();
        }
    }

    if (!status.ok()) {
        if (_verbose_log) {
            ::dsn::blob hash_key, sort_key;
            pegasus_restore_key(key, hash_key, sort_key);
720 721
            derror("%s: rocksdb get failed for get: "
                   "hash_key = \"%s\", sort_key = \"%s\", error = %s",
Q
qinzuoyan 已提交
722
                   _replica_name.c_str(),
723 724
                   ::pegasus::utils::c_escape_string(hash_key).c_str(),
                   ::pegasus::utils::c_escape_string(sort_key).c_str(),
Q
qinzuoyan 已提交
725 726
                   status.ToString().c_str());
        } else if (!status.IsNotFound()) {
727
            derror("%s: rocksdb get failed for get: error = %s",
Q
qinzuoyan 已提交
728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754
                   _replica_name.c_str(),
                   status.ToString().c_str());
        }
    }

    resp.error = status.code();
    if (status.ok()) {
        pegasus_extract_user_data(_value_schema_version, std::move(value), resp.value);
    }

    _pfc_get_latency.set(dsn_now_ns() - start_time);
    reply(resp);
}

void pegasus_server_impl::on_multi_get(const ::dsn::apps::multi_get_request &request,
                                       ::dsn::rpc_replier<::dsn::apps::multi_get_response> &reply)
{
    dassert(_is_open, "");
    _pfc_multi_get_qps.increment();
    uint64_t start_time = dsn_now_ns();

    ::dsn::apps::multi_get_response resp;
    auto id = get_gpid();
    resp.app_id = id.u.app_id;
    resp.partition_index = id.u.partition_index;
    resp.server = _primary_address;

755
    if (!is_filter_type_supported(request.sort_key_filter_type)) {
756
        derror("%s: filter type %d not supported for multi_get",
757 758 759 760 761 762 763 764
               _replica_name.c_str(),
               request.sort_key_filter_type);
        resp.error = rocksdb::Status::kInvalidArgument;
        _pfc_multi_get_latency.set(dsn_now_ns() - start_time);
        reply(resp);
        return;
    }

Q
qinzuoyan 已提交
765 766 767
    int32_t max_kv_count = request.max_kv_count > 0 ? request.max_kv_count : INT_MAX;
    int32_t max_kv_size = request.max_kv_size > 0 ? request.max_kv_size : INT_MAX;
    uint32_t epoch_now = ::pegasus::utils::epoch_now();
768
    uint64_t expire_count = 0;
769
    uint64_t filter_count = 0;
Q
qinzuoyan 已提交
770 771

    if (request.sort_keys.empty()) {
772 773 774
        ::dsn::blob range_start_key, range_stop_key;
        pegasus_generate_key(range_start_key, request.hash_key, request.start_sortkey);
        bool start_inclusive = request.start_inclusive;
775 776
        bool stop_inclusive;
        if (request.stop_sortkey.length() == 0) {
777
            pegasus_generate_next_blob(range_stop_key, request.hash_key);
778 779
            stop_inclusive = false;
        } else {
780
            pegasus_generate_key(range_stop_key, request.hash_key, request.stop_sortkey);
781 782 783
            stop_inclusive = request.stop_inclusive;
        }

784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837
        rocksdb::Slice start(range_start_key.data(), range_start_key.length());
        rocksdb::Slice stop(range_stop_key.data(), range_stop_key.length());

        // limit key range by prefix filter
        ::dsn::blob prefix_start_key, prefix_stop_key;
        if (request.sort_key_filter_type == ::dsn::apps::filter_type::FT_MATCH_PREFIX &&
            request.sort_key_filter_pattern.length() > 0) {
            pegasus_generate_key(
                prefix_start_key, request.hash_key, request.sort_key_filter_pattern);
            pegasus_generate_next_blob(
                prefix_stop_key, request.hash_key, request.sort_key_filter_pattern);

            rocksdb::Slice prefix_start(prefix_start_key.data(), prefix_start_key.length());
            if (prefix_start.compare(start) > 0) {
                start = prefix_start;
                start_inclusive = true;
            }

            rocksdb::Slice prefix_stop(prefix_stop_key.data(), prefix_stop_key.length());
            if (prefix_stop.compare(stop) <= 0) {
                stop = prefix_stop;
                stop_inclusive = false;
            }
        }

        // check if range is empty
        int c = start.compare(stop);
        if (c > 0 || (c == 0 && (!start_inclusive || !stop_inclusive))) {
            // empty sort key range
            if (_verbose_log) {
                dwarn("%s: empty sort key range for multi_get: hash_key = \"%s\", "
                      "start_sort_key = \"%s\" (%s), stop_sort_key = \"%s\" (%s), "
                      "sort_key_filter_type = %s, sort_key_filter_pattern = \"%s\", "
                      "final_start = \"%s\" (%s), final_stop = \"%s\" (%s)",
                      _replica_name.c_str(),
                      ::pegasus::utils::c_escape_string(request.hash_key).c_str(),
                      ::pegasus::utils::c_escape_string(request.start_sortkey).c_str(),
                      request.start_inclusive ? "inclusive" : "exclusive",
                      ::pegasus::utils::c_escape_string(request.stop_sortkey).c_str(),
                      request.stop_inclusive ? "inclusive" : "exclusive",
                      ::dsn::apps::_filter_type_VALUES_TO_NAMES.find(request.sort_key_filter_type)
                          ->second,
                      ::pegasus::utils::c_escape_string(request.sort_key_filter_pattern).c_str(),
                      ::pegasus::utils::c_escape_string(start).c_str(),
                      start_inclusive ? "inclusive" : "exclusive",
                      ::pegasus::utils::c_escape_string(stop).c_str(),
                      stop_inclusive ? "inclusive" : "exclusive");
            }
            resp.error = rocksdb::Status::kOk;
            _pfc_multi_get_latency.set(dsn_now_ns() - start_time);
            reply(resp);
            return;
        }

838
        std::unique_ptr<rocksdb::Iterator> it(_db->NewIterator(_rd_opts));
Q
qinzuoyan 已提交
839
        it->Seek(start);
840
        bool complete = false;
841
        bool first_exclusive = !start_inclusive;
Q
qinzuoyan 已提交
842 843 844
        int32_t count = 0;
        int32_t size = 0;
        while (count < max_kv_count && size < max_kv_size && it->Valid()) {
845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871
            // check stop sort key
            int c = it->key().compare(stop);
            if (c > 0 || (c == 0 && !stop_inclusive)) {
                // out of range
                complete = true;
                break;
            }

            // check start sort key
            if (first_exclusive) {
                first_exclusive = false;
                if (it->key().compare(start) == 0) {
                    // discard start_sortkey
                    it->Next();
                    continue;
                }
            }

            // extract value
            int r = append_key_value_for_multi_get(resp.kvs,
                                                   it->key(),
                                                   it->value(),
                                                   request.sort_key_filter_type,
                                                   request.sort_key_filter_pattern,
                                                   epoch_now,
                                                   request.no_value);
            if (r == 1) {
Q
qinzuoyan 已提交
872 873 874
                count++;
                auto &kv = resp.kvs.back();
                size += kv.key.length() + kv.value.length();
875
            } else if (r == 2) {
876
                expire_count++;
877 878
            } else { // r == 3
                filter_count++;
Q
qinzuoyan 已提交
879
            }
880 881 882 883 884 885 886

            if (c == 0) {
                // if arrived to the last position
                complete = true;
                break;
            }

Q
qinzuoyan 已提交
887 888 889 890 891 892 893
            it->Next();
        }

        resp.error = it->status().code();
        if (!it->status().ok()) {
            // error occur
            if (_verbose_log) {
894
                derror("%s: rocksdb scan failed for multi_get: hash_key = \"%s\", error = %s",
Q
qinzuoyan 已提交
895
                       _replica_name.c_str(),
896
                       ::pegasus::utils::c_escape_string(request.hash_key).c_str(),
Q
qinzuoyan 已提交
897 898
                       it->status().ToString().c_str());
            } else {
899
                derror("%s: rocksdb scan failed for multi_get: error = %s",
Q
qinzuoyan 已提交
900 901 902 903
                       _replica_name.c_str(),
                       it->status().ToString().c_str());
            }
            resp.kvs.clear();
904
        } else if (it->Valid() && !complete) {
Q
qinzuoyan 已提交
905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930
            // scan not completed
            resp.error = rocksdb::Status::kIncomplete;
        }
    } else {
        rocksdb::Status status;
        int32_t count = 0;
        int32_t size = 0;
        bool exceed_limit = false;
        bool error_occurred = false;
        for (auto &sort_key : request.sort_keys) {
            // if exceed limit
            if (count >= max_kv_count || size >= max_kv_size) {
                exceed_limit = true;
                break;
            }

            ::dsn::blob raw_key;
            pegasus_generate_key(raw_key, request.hash_key, sort_key);
            rocksdb::Slice skey(raw_key.data(), raw_key.length());
            std::unique_ptr<std::string> value(new std::string());
            status = _db->Get(_rd_opts, skey, value.get());

            // check ttl
            if (status.ok()) {
                uint32_t expire_ts = pegasus_extract_expire_ts(_value_schema_version, *value);
                if (expire_ts > 0 && expire_ts <= epoch_now) {
931
                    expire_count++;
Q
qinzuoyan 已提交
932
                    if (_verbose_log) {
933
                        derror("%s: rocksdb data expired for multi_get", _replica_name.c_str());
Q
qinzuoyan 已提交
934 935 936 937 938 939 940 941
                    }
                    status = rocksdb::Status::NotFound();
                }
            }

            // print log
            if (!status.ok()) {
                if (_verbose_log) {
942 943
                    derror("%s: rocksdb get failed for multi_get: "
                           "hash_key = \"%s\", sort_key = \"%s\", error = %s",
Q
qinzuoyan 已提交
944
                           _replica_name.c_str(),
945 946
                           ::pegasus::utils::c_escape_string(request.hash_key).c_str(),
                           ::pegasus::utils::c_escape_string(sort_key).c_str(),
Q
qinzuoyan 已提交
947 948
                           status.ToString().c_str());
                } else if (!status.IsNotFound()) {
949
                    derror("%s: rocksdb get failed for multi_get: error = %s",
Q
qinzuoyan 已提交
950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983
                           _replica_name.c_str(),
                           status.ToString().c_str());
                }
            }

            // extract value
            if (status.ok()) {
                ::dsn::apps::key_value kv;
                kv.key = sort_key;
                if (!request.no_value) {
                    pegasus_extract_user_data(_value_schema_version, std::move(value), kv.value);
                }
                resp.kvs.emplace_back(kv);
                count++;
                size += kv.key.length() + kv.value.length();
            }

            // if error occurred
            if (!status.ok() && !status.IsNotFound()) {
                error_occurred = true;
                break;
            }
        }

        if (error_occurred) {
            resp.error = status.code();
            resp.kvs.clear();
        } else if (exceed_limit) {
            resp.error = rocksdb::Status::kIncomplete;
        } else {
            resp.error = rocksdb::Status::kOk;
        }
    }

984 985 986
    if (expire_count > 0) {
        _pfc_recent_expire_count.add(expire_count);
    }
987 988 989 990
    if (filter_count > 0) {
        _pfc_recent_filter_count.add(filter_count);
    }

Q
qinzuoyan 已提交
991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016
    _pfc_multi_get_latency.set(dsn_now_ns() - start_time);
    reply(resp);
}

void pegasus_server_impl::on_sortkey_count(const ::dsn::blob &hash_key,
                                           ::dsn::rpc_replier<::dsn::apps::count_response> &reply)
{
    dassert(_is_open, "");

    ::dsn::apps::count_response resp;
    auto id = get_gpid();
    resp.app_id = id.u.app_id;
    resp.partition_index = id.u.partition_index;
    resp.server = _primary_address;

    // scan
    ::dsn::blob start_key, stop_key;
    pegasus_generate_key(start_key, hash_key, ::dsn::blob());
    pegasus_generate_next_blob(stop_key, hash_key);
    rocksdb::Slice start(start_key.data(), start_key.length());
    rocksdb::Slice stop(stop_key.data(), stop_key.length());
    rocksdb::ReadOptions options = _rd_opts;
    options.iterate_upper_bound = &stop;
    std::unique_ptr<rocksdb::Iterator> it(_db->NewIterator(options));
    it->Seek(start);
    resp.count = 0;
1017 1018
    uint32_t epoch_now = ::pegasus::utils::epoch_now();
    uint64_t expire_count = 0;
Q
qinzuoyan 已提交
1019
    while (it->Valid()) {
1020 1021 1022 1023
        uint32_t expire_ts = pegasus_extract_expire_ts(_value_schema_version, it->value());
        if (expire_ts > 0 && expire_ts <= epoch_now) {
            expire_count++;
            if (_verbose_log) {
1024
                derror("%s: rocksdb data expired for sortkey_count", _replica_name.c_str());
1025 1026 1027 1028
            }
        } else {
            resp.count++;
        }
Q
qinzuoyan 已提交
1029 1030
        it->Next();
    }
1031 1032 1033
    if (expire_count > 0) {
        _pfc_recent_expire_count.add(expire_count);
    }
Q
qinzuoyan 已提交
1034 1035 1036 1037 1038

    resp.error = it->status().code();
    if (!it->status().ok()) {
        // error occur
        if (_verbose_log) {
1039
            derror("%s: rocksdb scan failed for sortkey_count: hash_key = \"%s\", error = %s",
Q
qinzuoyan 已提交
1040
                   _replica_name.c_str(),
1041
                   ::pegasus::utils::c_escape_string(hash_key).c_str(),
Q
qinzuoyan 已提交
1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073
                   it->status().ToString().c_str());
        } else {
            derror("%s: rocksdb scan failed for sortkey_count: error = %s",
                   _replica_name.c_str(),
                   it->status().ToString().c_str());
        }
        resp.count = 0;
    }

    reply(resp);
}

void pegasus_server_impl::on_ttl(const ::dsn::blob &key,
                                 ::dsn::rpc_replier<::dsn::apps::ttl_response> &reply)
{
    dassert(_is_open, "");

    ::dsn::apps::ttl_response resp;
    auto id = get_gpid();
    resp.app_id = id.u.app_id;
    resp.partition_index = id.u.partition_index;
    resp.server = _primary_address;

    rocksdb::Slice skey(key.data(), key.length());
    std::string value;
    rocksdb::Status status = _db->Get(_rd_opts, skey, &value);

    uint32_t expire_ts;
    uint32_t now_ts = ::pegasus::utils::epoch_now();
    if (status.ok()) {
        expire_ts = pegasus_extract_expire_ts(_value_schema_version, value);
        if (expire_ts > 0 && expire_ts <= now_ts) {
1074
            _pfc_recent_expire_count.increment();
Q
qinzuoyan 已提交
1075
            if (_verbose_log) {
1076
                derror("%s: rocksdb data expired for ttl", _replica_name.c_str());
Q
qinzuoyan 已提交
1077 1078 1079 1080 1081 1082 1083 1084 1085
            }
            status = rocksdb::Status::NotFound();
        }
    }

    if (!status.ok()) {
        if (_verbose_log) {
            ::dsn::blob hash_key, sort_key;
            pegasus_restore_key(key, hash_key, sort_key);
1086 1087
            derror("%s: rocksdb get failed for ttl: "
                   "hash_key = \"%s\", sort_key = \"%s\", error = %s",
Q
qinzuoyan 已提交
1088
                   _replica_name.c_str(),
1089 1090
                   ::pegasus::utils::c_escape_string(hash_key).c_str(),
                   ::pegasus::utils::c_escape_string(sort_key).c_str(),
Q
qinzuoyan 已提交
1091 1092
                   status.ToString().c_str());
        } else if (!status.IsNotFound()) {
1093
            derror("%s: rocksdb get failed for ttl: error = %s",
Q
qinzuoyan 已提交
1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112
                   _replica_name.c_str(),
                   status.ToString().c_str());
        }
    }

    resp.error = status.code();
    if (status.ok()) {
        if (expire_ts > 0) {
            resp.ttl_seconds = expire_ts - now_ts;
        } else {
            // no ttl
            resp.ttl_seconds = -1;
        }
    }

    reply(resp);
}

DEFINE_TASK_CODE(LOCAL_PEGASUS_SERVER_DELAY, TASK_PRIORITY_COMMON, ::dsn::THREAD_POOL_DEFAULT)
1113
void pegasus_server_impl::on_get_scanner(const ::dsn::apps::get_scanner_request &request,
Q
qinzuoyan 已提交
1114 1115 1116
                                         ::dsn::rpc_replier<::dsn::apps::scan_response> &reply)
{
    dassert(_is_open, "");
1117 1118
    _pfc_scan_qps.increment();
    uint64_t start_time = dsn_now_ns();
Q
qinzuoyan 已提交
1119 1120 1121 1122 1123 1124 1125

    ::dsn::apps::scan_response resp;
    auto id = get_gpid();
    resp.app_id = id.u.app_id;
    resp.partition_index = id.u.partition_index;
    resp.server = _primary_address;

1126
    if (!is_filter_type_supported(request.hash_key_filter_type)) {
1127
        derror("%s: filter type %d not supported for get_scanner",
1128 1129 1130 1131 1132 1133 1134
               _replica_name.c_str(),
               request.hash_key_filter_type);
        resp.error = rocksdb::Status::kInvalidArgument;
        reply(resp);
        return;
    }
    if (!is_filter_type_supported(request.sort_key_filter_type)) {
1135
        derror("%s: filter type %d not supported for get_scanner",
1136 1137 1138 1139 1140 1141 1142
               _replica_name.c_str(),
               request.sort_key_filter_type);
        resp.error = rocksdb::Status::kInvalidArgument;
        reply(resp);
        return;
    }

1143 1144
    bool start_inclusive = request.start_inclusive;
    bool stop_inclusive = request.stop_inclusive;
1145 1146
    rocksdb::Slice start(request.start_key.data(), request.start_key.length());
    rocksdb::Slice stop(request.stop_key.data(), request.stop_key.length());
1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179

    // limit key range by prefix filter
    // because data is not ordered by hash key (hash key "aa" is greater than "b"),
    // so we can only limit the start range by hash key filter.
    ::dsn::blob prefix_start_key;
    if (request.hash_key_filter_type == ::dsn::apps::filter_type::FT_MATCH_PREFIX &&
        request.hash_key_filter_pattern.length() > 0) {
        pegasus_generate_key(prefix_start_key, request.hash_key_filter_pattern, ::dsn::blob());
        rocksdb::Slice prefix_start(prefix_start_key.data(), prefix_start_key.length());
        if (prefix_start.compare(start) > 0) {
            start = prefix_start;
            start_inclusive = true;
        }
    }

    // check if range is empty
    int c = start.compare(stop);
    if (c > 0 || (c == 0 && (!start_inclusive || !stop_inclusive))) {
        // empty key range
        if (_verbose_log) {
            dwarn("%s: empty key range for get_scanner: "
                  "start_key = \"%s\" (%s), stop_key = \"%s\" (%s)",
                  _replica_name.c_str(),
                  ::pegasus::utils::c_escape_string(request.start_key).c_str(),
                  request.start_inclusive ? "inclusive" : "exclusive",
                  ::pegasus::utils::c_escape_string(request.stop_key).c_str(),
                  request.stop_inclusive ? "inclusive" : "exclusive");
        }
        resp.error = rocksdb::Status::kOk;
        _pfc_multi_get_latency.set(dsn_now_ns() - start_time);
        reply(resp);
        return;
    }
Q
qinzuoyan 已提交
1180

1181
    std::unique_ptr<rocksdb::Iterator> it(_db->NewIterator(_rd_opts));
Q
qinzuoyan 已提交
1182 1183
    it->Seek(start);
    bool complete = false;
1184
    bool first_exclusive = !start_inclusive;
Q
qinzuoyan 已提交
1185
    uint32_t epoch_now = ::pegasus::utils::epoch_now();
1186
    uint64_t expire_count = 0;
1187 1188
    uint64_t filter_count = 0;
    int32_t count = 0;
1189
    resp.kvs.reserve(request.batch_size);
1190 1191
    while (count < request.batch_size && it->Valid()) {
        int c = it->key().compare(stop);
1192
        if (c > 0 || (c == 0 && !stop_inclusive)) {
1193
            // out of range
Q
qinzuoyan 已提交
1194 1195
            complete = true;
            break;
1196 1197 1198 1199 1200 1201 1202
        }

        if (first_exclusive) {
            first_exclusive = false;
            if (it->key().compare(start) == 0) {
                // discard start_sortkey
                it->Next();
Q
qinzuoyan 已提交
1203 1204 1205 1206
                continue;
            }
        }

1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218
        int r = append_key_value_for_scan(resp.kvs,
                                          it->key(),
                                          it->value(),
                                          request.hash_key_filter_type,
                                          request.hash_key_filter_pattern,
                                          request.sort_key_filter_type,
                                          request.sort_key_filter_pattern,
                                          epoch_now,
                                          request.no_value);
        if (r == 1) {
            count++;
        } else if (r == 2) {
1219
            expire_count++;
1220 1221
        } else { // r == 3
            filter_count++;
1222
        }
1223 1224 1225 1226 1227 1228 1229 1230

        if (c == 0) {
            // seek to the last position
            complete = true;
            break;
        }

        it->Next();
1231
    }
Q
qinzuoyan 已提交
1232

1233 1234 1235 1236
    resp.error = it->status().code();
    if (!it->status().ok()) {
        // error occur
        if (_verbose_log) {
1237 1238
            derror("%s: rocksdb scan failed for get_scanner: "
                   "start_key = \"%s\" (%s), stop_key = \"%s\" (%s), "
1239 1240
                   "batch_size = %d, read_count = %d, error = %s",
                   _replica_name.c_str(),
1241
                   ::pegasus::utils::c_escape_string(start).c_str(),
1242
                   request.start_inclusive ? "inclusive" : "exclusive",
1243
                   ::pegasus::utils::c_escape_string(stop).c_str(),
1244 1245 1246 1247 1248
                   request.stop_inclusive ? "inclusive" : "exclusive",
                   request.batch_size,
                   count,
                   it->status().ToString().c_str());
        } else {
1249
            derror("%s: rocksdb scan failed for get_scanner: error = %s",
1250 1251 1252 1253 1254 1255
                   _replica_name.c_str(),
                   it->status().ToString().c_str());
        }
        resp.kvs.clear();
    } else if (it->Valid() && !complete) {
        // scan not completed
Q
qinzuoyan 已提交
1256 1257 1258
        std::unique_ptr<pegasus_scan_context> context(
            new pegasus_scan_context(std::move(it),
                                     std::string(stop.data(), stop.size()),
1259 1260 1261 1262 1263 1264 1265 1266 1267
                                     request.stop_inclusive,
                                     request.hash_key_filter_type,
                                     std::string(request.hash_key_filter_pattern.data(),
                                                 request.hash_key_filter_pattern.length()),
                                     request.sort_key_filter_type,
                                     std::string(request.sort_key_filter_pattern.data(),
                                                 request.sort_key_filter_pattern.length()),
                                     request.batch_size,
                                     request.no_value));
Q
qinzuoyan 已提交
1268 1269
        int64_t handle = _context_cache.put(std::move(context));
        resp.context_id = handle;
1270 1271
        // if the context is used, it will be fetched and re-put into cache,
        // which will change the handle,
Q
qinzuoyan 已提交
1272 1273 1274 1275 1276 1277
        // then the delayed task will fetch null context by old handle, and do nothing.
        ::dsn::tasking::enqueue(LOCAL_PEGASUS_SERVER_DELAY,
                                this,
                                [this, handle]() { _context_cache.fetch(handle); },
                                0,
                                std::chrono::minutes(5));
1278 1279 1280
    } else {
        // scan completed
        resp.context_id = pegasus::SCAN_CONTEXT_ID_COMPLETED;
Q
qinzuoyan 已提交
1281 1282
    }

1283 1284 1285 1286 1287 1288 1289 1290
    if (expire_count > 0) {
        _pfc_recent_expire_count.add(expire_count);
    }
    if (filter_count > 0) {
        _pfc_recent_filter_count.add(filter_count);
    }

    _pfc_scan_latency.set(dsn_now_ns() - start_time);
Q
qinzuoyan 已提交
1291 1292 1293
    reply(resp);
}

1294
void pegasus_server_impl::on_scan(const ::dsn::apps::scan_request &request,
Q
qinzuoyan 已提交
1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306
                                  ::dsn::rpc_replier<::dsn::apps::scan_response> &reply)
{
    dassert(_is_open, "");
    _pfc_scan_qps.increment();
    uint64_t start_time = dsn_now_ns();

    ::dsn::apps::scan_response resp;
    auto id = get_gpid();
    resp.app_id = id.u.app_id;
    resp.partition_index = id.u.partition_index;
    resp.server = _primary_address;

1307
    std::unique_ptr<pegasus_scan_context> context = _context_cache.fetch(request.context_id);
Q
qinzuoyan 已提交
1308 1309 1310 1311
    if (context) {
        rocksdb::Iterator *it = context->iterator.get();
        int32_t batch_size = context->batch_size;
        const rocksdb::Slice &stop = context->stop;
1312 1313 1314 1315 1316 1317
        bool stop_inclusive = context->stop_inclusive;
        ::dsn::apps::filter_type::type hash_key_filter_type = context->hash_key_filter_type;
        const ::dsn::blob &hash_key_filter_pattern = context->hash_key_filter_pattern;
        ::dsn::apps::filter_type::type sort_key_filter_type = context->hash_key_filter_type;
        const ::dsn::blob &sort_key_filter_pattern = context->hash_key_filter_pattern;
        bool no_value = context->no_value;
Q
qinzuoyan 已提交
1318 1319
        bool complete = false;
        uint32_t epoch_now = ::pegasus::utils::epoch_now();
1320
        uint64_t expire_count = 0;
1321 1322 1323 1324 1325 1326 1327
        uint64_t filter_count = 0;
        int32_t count = 0;

        while (count < batch_size && it->Valid()) {
            int c = it->key().compare(stop);
            if (c > 0 || (c == 0 && !stop_inclusive)) {
                // out of range
Q
qinzuoyan 已提交
1328 1329 1330
                complete = true;
                break;
            }
1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343

            int r = append_key_value_for_scan(resp.kvs,
                                              it->key(),
                                              it->value(),
                                              hash_key_filter_type,
                                              hash_key_filter_pattern,
                                              sort_key_filter_type,
                                              sort_key_filter_pattern,
                                              epoch_now,
                                              no_value);
            if (r == 1) {
                count++;
            } else if (r == 2) {
1344
                expire_count++;
1345 1346
            } else { // r == 3
                filter_count++;
1347
            }
1348 1349 1350 1351 1352 1353 1354 1355

            if (c == 0) {
                // seek to the last position
                complete = true;
                break;
            }

            it->Next();
1356
        }
1357 1358 1359 1360 1361

        resp.error = it->status().code();
        if (!it->status().ok()) {
            // error occur
            if (_verbose_log) {
1362 1363
                derror("%s: rocksdb scan failed for scan: "
                       "context_id= %" PRId64 ", stop_key = \"%s\" (%s), "
1364 1365 1366
                       "batch_size = %d, read_count = %d, error = %s",
                       _replica_name.c_str(),
                       request.context_id,
1367 1368
                       ::pegasus::utils::c_escape_string(stop).c_str(),
                       stop_inclusive ? "inclusive" : "exclusive",
1369 1370 1371 1372
                       batch_size,
                       count,
                       it->status().ToString().c_str());
            } else {
1373
                derror("%s: rocksdb scan failed for scan: error = %s",
1374 1375 1376 1377 1378 1379
                       _replica_name.c_str(),
                       it->status().ToString().c_str());
            }
            resp.kvs.clear();
        } else if (it->Valid() && !complete) {
            // scan not completed
Q
qinzuoyan 已提交
1380 1381 1382 1383 1384 1385 1386
            int64_t handle = _context_cache.put(std::move(context));
            resp.context_id = handle;
            ::dsn::tasking::enqueue(LOCAL_PEGASUS_SERVER_DELAY,
                                    this,
                                    [this, handle]() { _context_cache.fetch(handle); },
                                    0,
                                    std::chrono::minutes(5));
1387 1388 1389 1390 1391 1392 1393 1394 1395 1396
        } else {
            // scan completed
            resp.context_id = pegasus::SCAN_CONTEXT_ID_COMPLETED;
        }

        if (expire_count > 0) {
            _pfc_recent_expire_count.add(expire_count);
        }
        if (filter_count > 0) {
            _pfc_recent_filter_count.add(filter_count);
Q
qinzuoyan 已提交
1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421
        }
    } else {
        resp.error = rocksdb::Status::Code::kNotFound;
    }

    _pfc_scan_latency.set(dsn_now_ns() - start_time);
    reply(resp);
}

void pegasus_server_impl::on_clear_scanner(const int64_t &args) { _context_cache.fetch(args); }

DEFINE_TASK_CODE(UPDATING_ROCKSDB_SSTSIZE, TASK_PRIORITY_COMMON, THREAD_POOL_REPLICATION_LONG)

::dsn::error_code pegasus_server_impl::start(int argc, char **argv)
{
    dassert(!_is_open, "");
    ddebug("%s: start to open app %s", _replica_name.c_str(), _data_dir.c_str());

    rocksdb::Options opts = _db_opts;
    opts.create_if_missing = true;
    opts.error_if_exists = false;
    opts.compaction_filter = &_key_ttl_compaction_filter;
    opts.default_value_schema_version = PEGASUS_VALUE_SCHEMA_MAX_VERSION;

    auto path = ::dsn::utils::filesystem::path_combine(_data_dir, "rdb");
C
cailiuyang 已提交
1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444

    //
    // here, we must distinguish three cases, such as:
    //  case 1: we open the db that already exist
    //  case 2: we open a new db
    //  case 3: we restore the db base on old data
    //
    // if we want to restore the db base on old data, only all of the restore preconditions are
    // satisfied
    //      restore preconditions:
    //          1, rdb isn't exist
    //          2, we can parse restore info from app env, which is stored in argv
    //          3, restore_dir is exist
    //
    if (::dsn::utils::filesystem::path_exists(path)) {
        // only case 1
        ddebug("%s: rdb is already exist, path = %s", _replica_name.c_str(), path.c_str());
    } else {
        std::pair<std::string, bool> restore_info = get_restore_dir_from_env(argc, argv);
        const std::string &restore_dir = restore_info.first;
        bool force_restore = restore_info.second;
        if (restore_dir.empty()) {
            // case 2
1445 1446 1447 1448 1449 1450 1451
            if (force_restore) {
                derror("%s: try to restore, but we can't combine restore_dir from envs",
                       _replica_name.c_str());
                return ::dsn::ERR_FILE_OPERATION_FAILED;
            } else {
                dinfo("%s: open a new db, path = %s", _replica_name.c_str(), path.c_str());
            }
C
cailiuyang 已提交
1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491
        } else {
            // case 3
            ddebug("%s: try to restore from restore_dir = %s",
                   _replica_name.c_str(),
                   restore_dir.c_str());
            if (::dsn::utils::filesystem::directory_exists(restore_dir)) {
                // here, we just rename restore_dir to rdb, then continue the normal process
                if (::dsn::utils::filesystem::rename_path(restore_dir.c_str(), path.c_str())) {
                    ddebug("%s: rename restore_dir(%s) to rdb(%s) succeed",
                           _replica_name.c_str(),
                           restore_dir.c_str(),
                           path.c_str());
                } else {
                    derror("%s: rename restore_dir(%s) to rdb(%s) failed",
                           _replica_name.c_str(),
                           restore_dir.c_str(),
                           path.c_str());
                    return ::dsn::ERR_FILE_OPERATION_FAILED;
                }
            } else {
                if (force_restore) {
                    derror("%s: try to restore, but restore_dir isn't exist, restore_dir = %s",
                           _replica_name.c_str(),
                           restore_dir.c_str());
                    return ::dsn::ERR_FILE_OPERATION_FAILED;
                } else {
                    dwarn(
                        "%s: try to restore and restore_dir(%s) isn't exist, but we don't force "
                        "it, the role of this replica must not primary, so we open a new db on the "
                        "path(%s)",
                        _replica_name.c_str(),
                        restore_dir.c_str(),
                        path.c_str());
                }
            }
        }
    }

    ddebug("%s: start to open rocksDB's rdb(%s)", _replica_name.c_str(), path.c_str());

Q
qinzuoyan 已提交
1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951
    auto status = rocksdb::DB::Open(opts, path, &_db);
    if (status.ok()) {
        _value_schema_version = _db->GetValueSchemaVersion();
        if (_value_schema_version > PEGASUS_VALUE_SCHEMA_MAX_VERSION) {
            derror("%s: open app failed, unsupported value schema version %" PRIu32,
                   _replica_name.c_str(),
                   _value_schema_version);
            delete _db;
            _db = nullptr;
            return ::dsn::ERR_LOCAL_APP_FAILURE;
        }

        // only enable filter after correct value_schema_version set
        _key_ttl_compaction_filter.SetValueSchemaVersion(_value_schema_version);
        _key_ttl_compaction_filter.EnableFilter();

        parse_checkpoints();

        int64_t ci = _db->GetLastFlushedDecree();
        if (ci != last_durable_decree()) {
            ddebug("%s: start to do async checkpoint, last_durable_decree = %" PRId64
                   ", last_flushed_decree = %" PRId64,
                   _replica_name.c_str(),
                   last_durable_decree(),
                   ci);
            auto err = async_checkpoint(ci, false);
            if (err != ::dsn::ERR_OK) {
                derror("%s: create checkpoint failed, error = %s",
                       _replica_name.c_str(),
                       err.to_string());
                delete _db;
                _db = nullptr;
                return err;
            }
            dassert(ci == last_durable_decree(),
                    "last durable decree mismatch after checkpoint: %" PRId64 " vs %" PRId64,
                    ci,
                    last_durable_decree());
        }

        ddebug("%s: open app succeed, value_schema_version = %" PRIu32
               ", last_durable_decree = %" PRId64 "",
               _replica_name.c_str(),
               _value_schema_version,
               last_durable_decree());

        _is_open = true;

        open_service(get_gpid());

        dinfo("%s: start the updating sstsize timer task", _replica_name.c_str());
        // using ::dsn::timer_task to updating the rocksdb sstsize.
        _updating_task = ::dsn::tasking::enqueue_timer(
            UPDATING_ROCKSDB_SSTSIZE,
            this,
            [this]() { this->updating_rocksdb_sstsize(); },
            std::chrono::seconds(_updating_rocksdb_sstsize_interval_seconds),
            0,
            std::chrono::seconds(30));

        return ::dsn::ERR_OK;
    } else {
        derror("%s: open app failed, error = %s", _replica_name.c_str(), status.ToString().c_str());
        return ::dsn::ERR_LOCAL_APP_FAILURE;
    }
}

::dsn::error_code pegasus_server_impl::stop(bool clear_state)
{
    if (!_is_open) {
        dassert(_db == nullptr, "");
        dassert(!clear_state, "should not be here if do clear");
        return ::dsn::ERR_OK;
    }

    close_service(get_gpid());

    _context_cache.clear();

    // when stop the, should stop the timer_task.
    if (_updating_task != nullptr)
        _updating_task->cancel(true);

    _is_open = false;
    delete _db;
    _db = nullptr;

    {
        ::dsn::utils::auto_lock<::dsn::utils::ex_lock_nr> l(_checkpoints_lock);
        _checkpoints.clear();
        set_last_durable_decree(0);
    }

    if (clear_state) {
        if (!::dsn::utils::filesystem::remove_path(_data_dir)) {
            derror("%s: clear directory %s failed when stop app",
                   _replica_name.c_str(),
                   _data_dir.c_str());
            return ::dsn::ERR_FILE_OPERATION_FAILED;
        }
        _pfc_sst_count.set(0);
        _pfc_sst_size.set(0);
    }

    return ::dsn::ERR_OK;
}

class CheckpointingTokenHelper
{
public:
    CheckpointingTokenHelper(std::atomic_bool &flag) : _flag(flag)
    {
        bool expected = false;
        _token_got = _flag.compare_exchange_strong(expected, true);
    }
    ~CheckpointingTokenHelper()
    {
        if (_token_got)
            _flag.store(false);
    }
    bool token_got() const { return _token_got; }
private:
    std::atomic_bool &_flag;
    bool _token_got;
};

::dsn::error_code pegasus_server_impl::sync_checkpoint(int64_t last_commit)
{
    CheckpointingTokenHelper token_helper(_is_checkpointing);
    if (!token_helper.token_got())
        return ::dsn::ERR_WRONG_TIMING;

    if (last_durable_decree() == last_commit)
        return ::dsn::ERR_NO_NEED_OPERATE;

    rocksdb::Checkpoint *chkpt = nullptr;
    auto status = rocksdb::Checkpoint::Create(_db, &chkpt);
    if (!status.ok()) {
        derror("%s: create Checkpoint object failed, error = %s",
               _replica_name.c_str(),
               status.ToString().c_str());
        return ::dsn::ERR_LOCAL_APP_FAILURE;
    }

    auto dir = chkpt_get_dir_name(last_commit);
    auto chkpt_dir = ::dsn::utils::filesystem::path_combine(_data_dir, dir);
    if (::dsn::utils::filesystem::directory_exists(chkpt_dir)) {
        ddebug("%s: checkpoint directory %s already exist, remove it first",
               _replica_name.c_str(),
               chkpt_dir.c_str());
        if (!::dsn::utils::filesystem::remove_path(chkpt_dir)) {
            derror("%s: remove old checkpoint directory %s failed",
                   _replica_name.c_str(),
                   chkpt_dir.c_str());
            delete chkpt;
            chkpt = nullptr;
            return ::dsn::ERR_FILE_OPERATION_FAILED;
        }
    }

    status = chkpt->CreateCheckpoint(chkpt_dir);
    if (!status.ok()) {
        // sometimes checkpoint may fail, and try again will succeed
        derror("%s: create checkpoint failed, error = %s, try again",
               _replica_name.c_str(),
               status.ToString().c_str());
        status = chkpt->CreateCheckpoint(chkpt_dir);
    }

    // destroy Checkpoint object
    delete chkpt;
    chkpt = nullptr;

    if (!status.ok()) {
        derror("%s: create checkpoint failed, error = %s",
               _replica_name.c_str(),
               status.ToString().c_str());
        ::dsn::utils::filesystem::remove_path(chkpt_dir);
        if (!::dsn::utils::filesystem::remove_path(chkpt_dir)) {
            derror("%s: remove damaged checkpoint directory %s failed",
                   _replica_name.c_str(),
                   chkpt_dir.c_str());
        }
        return ::dsn::ERR_LOCAL_APP_FAILURE;
    }

    {
        ::dsn::utils::auto_lock<::dsn::utils::ex_lock_nr> l(_checkpoints_lock);
        dassert(last_commit > last_durable_decree(),
                "%" PRId64 " VS %" PRId64 "",
                last_commit,
                last_durable_decree());
        if (!_checkpoints.empty()) {
            dassert(last_commit > _checkpoints.back(),
                    "%" PRId64 " VS %" PRId64 "",
                    last_commit,
                    _checkpoints.back());
        }
        _checkpoints.push_back(last_commit);
        set_last_durable_decree(_checkpoints.back());
    }

    ddebug("%s: sync create checkpoint succeed, last_durable_decree = %" PRId64 "",
           _replica_name.c_str(),
           last_durable_decree());

    gc_checkpoints();

    return ::dsn::ERR_OK;
}

// Must be thread safe.
::dsn::error_code pegasus_server_impl::async_checkpoint(int64_t /*last_commit*/, bool is_emergency)
{
    CheckpointingTokenHelper token_helper(_is_checkpointing);
    if (!token_helper.token_got())
        return ::dsn::ERR_WRONG_TIMING;

    if (last_durable_decree() == _db->GetLastFlushedDecree()) {
        if (is_emergency) {
            // trigger flushing memtable, but not wait
            rocksdb::FlushOptions options;
            options.wait = false;
            auto status = _db->Flush(options);
            if (status.ok()) {
                ddebug("%s: trigger flushing memtable succeed", _replica_name.c_str());
                return ::dsn::ERR_TRY_AGAIN;
            } else if (status.IsNoNeedOperate()) {
                dwarn("%s: trigger flushing memtable failed, no memtable to flush",
                      _replica_name.c_str());
                return ::dsn::ERR_NO_NEED_OPERATE;
            } else {
                derror("%s: trigger flushing memtable failed, error = %s",
                       _replica_name.c_str(),
                       status.ToString().c_str());
                return ::dsn::ERR_LOCAL_APP_FAILURE;
            }
        } else {
            return ::dsn::ERR_NO_NEED_OPERATE;
        }
    }

    rocksdb::Checkpoint *chkpt = nullptr;
    auto status = rocksdb::Checkpoint::Create(_db, &chkpt);
    if (!status.ok()) {
        derror("%s: create Checkpoint object failed, error = %s",
               _replica_name.c_str(),
               status.ToString().c_str());
        return ::dsn::ERR_LOCAL_APP_FAILURE;
    }

    char buf[256];
    sprintf(buf, "checkpoint.tmp.%" PRIu64 "", dsn_now_us());
    std::string tmp_dir = ::dsn::utils::filesystem::path_combine(_data_dir, buf);
    if (::dsn::utils::filesystem::directory_exists(tmp_dir)) {
        ddebug("%s: temporary checkpoint directory %s already exist, remove it first",
               _replica_name.c_str(),
               tmp_dir.c_str());
        if (!::dsn::utils::filesystem::remove_path(tmp_dir)) {
            derror("%s: remove temporary checkpoint directory %s failed",
                   _replica_name.c_str(),
                   tmp_dir.c_str());
            return ::dsn::ERR_FILE_OPERATION_FAILED;
        }
    }

    uint64_t ci = last_durable_decree();
    status = chkpt->CreateCheckpointQuick(tmp_dir, &ci);
    delete chkpt;
    chkpt = nullptr;
    if (!status.ok()) {
        derror("%s: async create checkpoint failed, error = %s",
               _replica_name.c_str(),
               status.ToString().c_str());
        if (!::dsn::utils::filesystem::remove_path(tmp_dir)) {
            derror("%s: remove temporary checkpoint directory %s failed",
                   _replica_name.c_str(),
                   tmp_dir.c_str());
        }
        return status.IsNoNeedOperate() ? ::dsn::ERR_NO_NEED_OPERATE : ::dsn::ERR_LOCAL_APP_FAILURE;
    }

    auto chkpt_dir = ::dsn::utils::filesystem::path_combine(_data_dir, chkpt_get_dir_name(ci));
    if (::dsn::utils::filesystem::directory_exists(chkpt_dir)) {
        ddebug("%s: checkpoint directory %s already exist, remove it first",
               _replica_name.c_str(),
               chkpt_dir.c_str());
        if (!::dsn::utils::filesystem::remove_path(chkpt_dir)) {
            derror("%s: remove old checkpoint directory %s failed",
                   _replica_name.c_str(),
                   chkpt_dir.c_str());
            if (!::dsn::utils::filesystem::remove_path(tmp_dir)) {
                derror("%s: remove temporary checkpoint directory %s failed",
                       _replica_name.c_str(),
                       tmp_dir.c_str());
            }
            return ::dsn::ERR_FILE_OPERATION_FAILED;
        }
    }

    if (!::dsn::utils::filesystem::rename_path(tmp_dir, chkpt_dir)) {
        derror("%s: rename checkpoint directory from %s to %s failed",
               _replica_name.c_str(),
               tmp_dir.c_str(),
               chkpt_dir.c_str());
        if (!::dsn::utils::filesystem::remove_path(tmp_dir)) {
            derror("%s: remove temporary checkpoint directory %s failed",
                   _replica_name.c_str(),
                   tmp_dir.c_str());
        }
        return ::dsn::ERR_FILE_OPERATION_FAILED;
    }

    {
        ::dsn::utils::auto_lock<::dsn::utils::ex_lock_nr> l(_checkpoints_lock);
        dassert(
            ci > last_durable_decree(), "%" PRId64 " VS %" PRId64 "", ci, last_durable_decree());
        if (!_checkpoints.empty()) {
            dassert(
                ci > _checkpoints.back(), "%" PRId64 " VS %" PRId64 "", ci, _checkpoints.back());
        }
        _checkpoints.push_back(ci);
        set_last_durable_decree(_checkpoints.back());
    }

    ddebug("%s: async create checkpoint succeed, last_durable_decree = %" PRId64 "",
           _replica_name.c_str(),
           last_durable_decree());

    gc_checkpoints();

    return ::dsn::ERR_OK;
}

::dsn::error_code pegasus_server_impl::get_checkpoint(int64_t learn_start,
                                                      int64_t local_commit,
                                                      void *learn_request,
                                                      int learn_request_size,
                                                      app_learn_state &state)
{
    dassert(_is_open, "");

    int64_t ci = last_durable_decree();
    if (ci == 0) {
        derror("%s: no checkpoint found", _replica_name.c_str());
        return ::dsn::ERR_OBJECT_NOT_FOUND;
    }

    auto chkpt_dir = ::dsn::utils::filesystem::path_combine(_data_dir, chkpt_get_dir_name(ci));
    state.files.clear();
    if (!::dsn::utils::filesystem::get_subfiles(chkpt_dir, state.files, true)) {
        derror(
            "%s: list files in checkpoint dir %s failed", _replica_name.c_str(), chkpt_dir.c_str());
        return ::dsn::ERR_FILE_OPERATION_FAILED;
    }

    state.from_decree_excluded = 0;
    state.to_decree_included = ci;

    ddebug("%s: get checkpoint succeed, from_decree_excluded = 0, to_decree_included = %" PRId64 "",
           _replica_name.c_str(),
           state.to_decree_included);
    return ::dsn::ERR_OK;
}

::dsn::error_code pegasus_server_impl::apply_checkpoint(dsn_chkpt_apply_mode mode,
                                                        int64_t local_commit,
                                                        const dsn_app_learn_state &state)
{
    ::dsn::error_code err;
    int64_t ci = state.to_decree_included;

    if (mode == DSN_CHKPT_COPY) {
        dassert(ci > last_durable_decree(),
                "state.to_decree_included(%" PRId64 ") <= last_durable_decree(%" PRId64 ")",
                ci,
                last_durable_decree());

        auto learn_dir = ::dsn::utils::filesystem::remove_file_name(state.files[0]);
        auto chkpt_dir = ::dsn::utils::filesystem::path_combine(_data_dir, chkpt_get_dir_name(ci));
        if (::dsn::utils::filesystem::rename_path(learn_dir, chkpt_dir)) {
            ::dsn::utils::auto_lock<::dsn::utils::ex_lock_nr> l(_checkpoints_lock);
            dassert(ci > last_durable_decree(),
                    "%" PRId64 " VS %" PRId64 "",
                    ci,
                    last_durable_decree());
            _checkpoints.push_back(ci);
            if (!_checkpoints.empty()) {
                dassert(ci > _checkpoints.back(),
                        "%" PRId64 " VS %" PRId64 "",
                        ci,
                        _checkpoints.back());
            }
            set_last_durable_decree(ci);
            err = ::dsn::ERR_OK;
        } else {
            derror("%s: rename directory %s to %s failed",
                   _replica_name.c_str(),
                   learn_dir.c_str(),
                   chkpt_dir.c_str());
            err = ::dsn::ERR_FILE_OPERATION_FAILED;
        }

        return err;
    }

    if (_is_open) {
        err = stop(true);
        if (err != ::dsn::ERR_OK) {
            derror(
                "%s: close rocksdb %s failed, error = %s", _replica_name.c_str(), err.to_string());
            return err;
        }
    }

    // clear data dir
    if (!::dsn::utils::filesystem::remove_path(_data_dir)) {
        derror("%s: clear data directory %s failed", _replica_name.c_str(), _data_dir.c_str());
        return ::dsn::ERR_FILE_OPERATION_FAILED;
    }

    // reopen the db with the new checkpoint files
    if (state.file_state_count > 0) {
        // create data dir
        if (!::dsn::utils::filesystem::create_directory(_data_dir)) {
            derror("%s: create data directory %s failed", _replica_name.c_str(), _data_dir.c_str());
            return ::dsn::ERR_FILE_OPERATION_FAILED;
        }

        // move learned files from learn_dir to data_dir/rdb
        std::string learn_dir = ::dsn::utils::filesystem::remove_file_name(state.files[0]);
        std::string new_dir = ::dsn::utils::filesystem::path_combine(_data_dir, "rdb");
        if (!::dsn::utils::filesystem::rename_path(learn_dir, new_dir)) {
            derror("%s: rename directory %s to %s failed",
                   _replica_name.c_str(),
                   learn_dir.c_str(),
                   new_dir.c_str());
            return ::dsn::ERR_FILE_OPERATION_FAILED;
        }

        err = start(0, nullptr);
    } else {
        ddebug("%s: apply empty checkpoint, create new rocksdb", _replica_name.c_str());
        err = start(0, nullptr);
    }

    if (err != ::dsn::ERR_OK) {
        derror("%s: open rocksdb failed, error = %s", _replica_name.c_str(), err.to_string());
        return err;
    }

    dassert(_is_open, "");
    dassert(ci == last_durable_decree(), "%" PRId64 " VS %" PRId64 "", ci, last_durable_decree());

    ddebug("%s: apply checkpoint succeed, last_durable_decree = %" PRId64,
           _replica_name.c_str(),
           last_durable_decree());
    return ::dsn::ERR_OK;
}

1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005
bool pegasus_server_impl::is_filter_type_supported(::dsn::apps::filter_type::type filter_type)
{
    return filter_type >= ::dsn::apps::filter_type::FT_NO_FILTER &&
           filter_type <= ::dsn::apps::filter_type::FT_MATCH_POSTFIX;
}

bool pegasus_server_impl::validate_filter(::dsn::apps::filter_type::type filter_type,
                                          const ::dsn::blob &filter_pattern,
                                          const ::dsn::blob &value)
{
    if (filter_type == ::dsn::apps::filter_type::FT_NO_FILTER || filter_pattern.length() == 0)
        return true;
    if (value.length() < filter_pattern.length())
        return false;
    switch (filter_type) {
    case ::dsn::apps::filter_type::FT_MATCH_ANYWHERE: {
        // brute force search
        // TODO: improve it according to
        //   http://old.blog.phusion.nl/2010/12/06/efficient-substring-searching/
        const char *a1 = value.data();
        int l1 = value.length();
        const char *a2 = filter_pattern.data();
        int l2 = filter_pattern.length();
        for (int i = 0; i <= l1 - l2; ++i) {
            int j = 0;
            while (j < l2 && a1[i + j] == a2[j])
                ++j;
            if (j == l2)
                return true;
        }
        return false;
    }
    case ::dsn::apps::filter_type::FT_MATCH_PREFIX:
        return (memcmp(value.data(), filter_pattern.data(), filter_pattern.length()) == 0);
    case ::dsn::apps::filter_type::FT_MATCH_POSTFIX:
        return (memcmp(value.data() + value.length() - filter_pattern.length(),
                       filter_pattern.data(),
                       filter_pattern.length()) == 0);
    default:
        dassert(false, "unsupported filter type: %d", filter_type);
    }
    return false;
}

int pegasus_server_impl::append_key_value_for_scan(
    std::vector<::dsn::apps::key_value> &kvs,
    const rocksdb::Slice &key,
    const rocksdb::Slice &value,
    ::dsn::apps::filter_type::type hash_key_filter_type,
    const ::dsn::blob &hash_key_filter_pattern,
    ::dsn::apps::filter_type::type sort_key_filter_type,
    const ::dsn::blob &sort_key_filter_pattern,
    uint32_t epoch_now,
    bool no_value)
Q
qinzuoyan 已提交
2006 2007 2008 2009 2010 2011
{
    uint32_t expire_ts = pegasus_extract_expire_ts(_value_schema_version, value);
    if (expire_ts > 0 && expire_ts <= epoch_now) {
        if (_verbose_log) {
            derror("%s: rocksdb data expired for scan", _replica_name.c_str());
        }
2012
        return 2;
Q
qinzuoyan 已提交
2013 2014 2015 2016 2017
    }

    ::dsn::apps::key_value kv;

    // extract raw key
2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040
    ::dsn::blob raw_key(key.data(), 0, key.size());
    if (hash_key_filter_type != ::dsn::apps::filter_type::FT_NO_FILTER ||
        sort_key_filter_type != ::dsn::apps::filter_type::FT_NO_FILTER) {
        ::dsn::blob hash_key, sort_key;
        pegasus_restore_key(raw_key, hash_key, sort_key);
        if (hash_key_filter_type != ::dsn::apps::filter_type::FT_NO_FILTER &&
            !validate_filter(hash_key_filter_type, hash_key_filter_pattern, hash_key)) {
            if (_verbose_log) {
                derror("%s: hash key filtered for scan", _replica_name.c_str());
            }
            return 3;
        }
        if (sort_key_filter_type != ::dsn::apps::filter_type::FT_NO_FILTER &&
            !validate_filter(sort_key_filter_type, sort_key_filter_pattern, sort_key)) {
            if (_verbose_log) {
                derror("%s: sort key filtered for scan", _replica_name.c_str());
            }
            return 3;
        }
    }
    std::shared_ptr<char> key_buf(::dsn::make_shared_array<char>(raw_key.length()));
    ::memcpy(key_buf.get(), raw_key.data(), raw_key.length());
    kv.key.assign(std::move(key_buf), 0, raw_key.length());
Q
qinzuoyan 已提交
2041 2042

    // extract value
2043 2044 2045 2046
    if (!no_value) {
        std::unique_ptr<std::string> value_buf(new std::string(value.data(), value.size()));
        pegasus_extract_user_data(_value_schema_version, std::move(value_buf), kv.value);
    }
Q
qinzuoyan 已提交
2047 2048

    kvs.emplace_back(kv);
2049
    return 1;
Q
qinzuoyan 已提交
2050 2051
}

2052 2053 2054 2055 2056 2057 2058 2059
int pegasus_server_impl::append_key_value_for_multi_get(
    std::vector<::dsn::apps::key_value> &kvs,
    const rocksdb::Slice &key,
    const rocksdb::Slice &value,
    ::dsn::apps::filter_type::type sort_key_filter_type,
    const ::dsn::blob &sort_key_filter_pattern,
    uint32_t epoch_now,
    bool no_value)
Q
qinzuoyan 已提交
2060 2061 2062 2063 2064 2065
{
    uint32_t expire_ts = pegasus_extract_expire_ts(_value_schema_version, value);
    if (expire_ts > 0 && expire_ts <= epoch_now) {
        if (_verbose_log) {
            derror("%s: rocksdb data expired for multi get", _replica_name.c_str());
        }
2066
        return 2;
Q
qinzuoyan 已提交
2067 2068 2069 2070 2071 2072 2073 2074
    }

    ::dsn::apps::key_value kv;

    // extract sort_key
    ::dsn::blob raw_key(key.data(), 0, key.size());
    ::dsn::blob hash_key, sort_key;
    pegasus_restore_key(raw_key, hash_key, sort_key);
2075 2076 2077 2078 2079 2080 2081
    if (sort_key_filter_type != ::dsn::apps::filter_type::FT_NO_FILTER &&
        !validate_filter(sort_key_filter_type, sort_key_filter_pattern, sort_key)) {
        if (_verbose_log) {
            derror("%s: sort key filtered for multi get", _replica_name.c_str());
        }
        return 3;
    }
Q
qinzuoyan 已提交
2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092
    std::shared_ptr<char> sort_key_buf(::dsn::make_shared_array<char>(sort_key.length()));
    ::memcpy(sort_key_buf.get(), sort_key.data(), sort_key.length());
    kv.key.assign(std::move(sort_key_buf), 0, sort_key.length());

    // extract value
    if (!no_value) {
        std::unique_ptr<std::string> value_buf(new std::string(value.data(), value.size()));
        pegasus_extract_user_data(_value_schema_version, std::move(value_buf), kv.value);
    }

    kvs.emplace_back(kv);
2093
    return 1;
Q
qinzuoyan 已提交
2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144
}

// statistic the count and size of files of this type. return (-1,-1) if failed.
static std::pair<int64_t, int64_t> get_type_file_size(const std::string &path,
                                                      const std::string &type)
{
    std::vector<std::string> files;
    if (!::dsn::utils::filesystem::get_subfiles(path, files, false)) {
        dwarn("get subfiles of dir %s failed", path.c_str());
        return std::pair<int64_t, int64_t>(-1, -1);
    }
    int64_t res = 0;
    int64_t cnt = 0;
    for (auto &f : files) {
        if (f.length() > type.length() && f.substr(f.length() - type.length()) == type) {
            int64_t tsize = 0;
            if (::dsn::utils::filesystem::file_size(f, tsize)) {
                res += tsize;
                cnt++;
            } else {
                dwarn("get size of file %s failed", f.c_str());
                return std::pair<int64_t, int64_t>(-1, -1);
            }
        }
    }
    return std::pair<int64_t, int64_t>(cnt, res);
}

std::pair<int64_t, int64_t> pegasus_server_impl::statistic_sst_size()
{
    // dir = _data_dir/rdb
    return get_type_file_size(::dsn::utils::filesystem::path_combine(_data_dir, "rdb"), ".sst");
}

void pegasus_server_impl::updating_rocksdb_sstsize()
{
    std::pair<int64_t, int64_t> sst_size = statistic_sst_size();
    if (sst_size.first == -1) {
        dwarn("%s: statistic sst file size failed", _replica_name.c_str());
    } else {
        int64_t sst_size_mb = sst_size.second / 1048576;
        ddebug("%s: statistic sst file size succeed, sst_count = %" PRId64 ", sst_size = %" PRId64
               "(%" PRId64 "MB)",
               _replica_name.c_str(),
               sst_size.first,
               sst_size.second,
               sst_size_mb);
        _pfc_sst_count.set(sst_size.first);
        _pfc_sst_size.set(sst_size_mb);
    }
}
C
cailiuyang 已提交
2145 2146 2147 2148 2149 2150

std::pair<std::string, bool> pegasus_server_impl::get_restore_dir_from_env(int argc, char **argv)
{
    std::pair<std::string, bool> res;
    res.first = std::string();
    res.second = false;
2151 2152 2153 2154
    if (argc <= 0 || ((argc - 1) % 2 != 0) || argv == nullptr) {
        derror("%s: parse restore info from env failed, because invalid argc = %d",
               _replica_name.c_str(),
               argc);
C
cailiuyang 已提交
2155 2156 2157 2158
        return res;
    }
    // env is compounded in replication_app_base::open() function
    std::map<std::string, std::string> env_kvs;
2159 2160 2161 2162 2163
    int idx = 1;
    while (idx < argc) {
        std::string key = std::string(argv[idx++]);
        std::string value = std::string(argv[idx++]);
        env_kvs.insert(std::make_pair(key, value));
C
cailiuyang 已提交
2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197
    }

    auto it = env_kvs.find("force_restore");
    if (it != env_kvs.end()) {
        res.second = true;
    }

    std::stringstream os;
    os << "restore.";
    // TODO: using cold_backup_constant to replace
    // Attention: "policy_name" and "backup_id" must equal to cold_backup_constant::POLICY_NAME
    //             and cold_backup_constant::BACKUP_ID
    it = env_kvs.find("policy_name");
    if (it != env_kvs.end()) {
        ddebug("%s: find policy_name from env, policy_name = %s",
               _replica_name.c_str(),
               it->second.c_str());
        os << it->second << ".";
    } else {
        return res;
    }
    it = env_kvs.find("backup_id");
    if (it != env_kvs.end()) {
        ddebug("%s: find backup_id from env, backup_id = %s",
               _replica_name.c_str(),
               it->second.c_str());
        os << it->second;
    } else {
        return res;
    }
    std::string parent_dir = ::dsn::utils::filesystem::remove_file_name(_data_dir);
    res.first = ::dsn::utils::filesystem::path_combine(parent_dir, os.str());
    return res;
}
Q
qinzuoyan 已提交
2198 2199
}
} // namespace