[ceph.git] / ceph / src / tools / osdmaptool.cc

// -*- mode:C++; tab-width:8; c-basic-offset:2; indent-tabs-mode:t -*- 
// vim: ts=8 sw=2 smarttab
/*
 * Ceph - scalable distributed file system
 *
 * Copyright (C) 2004-2006 Sage Weil <sage@newdream.net>
 *
 * This is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License version 2.1, as published by the Free Software 
 * Foundation.  See file COPYING.
 * 
 */

#include <string>
#include <sys/stat.h>

#include "common/ceph_argparse.h"
#include "common/errno.h"
#include "common/safe_io.h"

#include "global/global_init.h"
#include "osd/OSDMap.h"

using namespace std;

void usage()
{
  cout << " usage: [--print] [--createsimple <numosd> [--clobber] [--pg_bits <bitsperosd>]] <mapfilename>" << std::endl;
  cout << "   --export-crush <file>   write osdmap's crush map to <file>" << std::endl;
  cout << "   --import-crush <file>   replace osdmap's crush map with <file>" << std::endl;
  cout << "   --test-map-pgs [--pool <poolid>] [--pg_num <pg_num>] map all pgs" << std::endl;
  cout << "   --test-map-pgs-dump [--pool <poolid>] map all pgs" << std::endl;
  cout << "   --test-map-pgs-dump-all [--pool <poolid>] map all pgs to osds" << std::endl;
  cout << "   --mark-up-in            mark osds up and in (but do not persist)" << std::endl;
  cout << "   --clear-temp            clear pg_temp and primary_temp" << std::endl;
  cout << "   --test-random           do random placements" << std::endl;
  cout << "   --test-map-pg <pgid>    map a pgid to osds" << std::endl;
  cout << "   --test-map-object <objectname> [--pool <poolid>] map an object to osds"
       << std::endl;
  cout << "   --upmap-cleanup <file>  clean up pg_upmap[_items] entries, writing" << std::endl;
  cout << "                           commands to <file> [default: - for stdout]" << std::endl;
  cout << "   --upmap <file>          calculate pg upmap entries to balance pg layout" << std::endl;
  cout << "                           writing commands to <file> [default: - for stdout]" << std::endl;
  cout << "   --upmap-max <max-count> set max upmap entries to calculate [default: 100]" << std::endl;
  cout << "   --upmap-deviation <max-deviation>" << std::endl;
  cout << "                           max deviation from target [default: .01]" << std::endl;
  cout << "   --upmap-pool <poolname> restrict upmap balancing to 1 or more pools" << std::endl;
  cout << "   --upmap-save            write modified OSDMap with upmap changes" << std::endl;
  exit(1);
}

void print_inc_upmaps(const OSDMap::Incremental& pending_inc, int fd)
{
  ostringstream ss;
  for (auto& i : pending_inc.old_pg_upmap) {
    ss << "ceph osd rm-pg-upmap " << i << std::endl;
  }
  for (auto& i : pending_inc.new_pg_upmap) {
    ss << "ceph osd pg-upmap " << i.first;
    for (auto osd : i.second) {
      ss << " " << osd;
    }
    ss << std::endl;
  }
  for (auto& i : pending_inc.old_pg_upmap_items) {
    ss << "ceph osd rm-pg-upmap-items " << i << std::endl;
  }
  for (auto& i : pending_inc.new_pg_upmap_items) {
    ss << "ceph osd pg-upmap-items " << i.first;
    for (auto p : i.second) {
      ss << " " << p.first << " " << p.second;
    }
    ss << std::endl;
  }
  string s = ss.str();
  int r = safe_write(fd, s.c_str(), s.size());
  if (r < 0) {
    cerr << "error writing output: " << cpp_strerror(r) << std::endl;
    exit(1);
  }
}

int main(int argc, const char **argv)
{
  vector<const char*> args;
  argv_to_vec(argc, argv, args);
  env_to_vec(args);

  auto cct = global_init(NULL, args, CEPH_ENTITY_TYPE_CLIENT,
                         CODE_ENVIRONMENT_UTILITY,
                         CINIT_FLAG_NO_DEFAULT_CONFIG_FILE);
  common_init_finish(g_ceph_context);

  const char *me = argv[0];

  std::string fn;
  bool print = false;
  boost::scoped_ptr<Formatter> print_formatter;
  bool tree = false;
  boost::scoped_ptr<Formatter> tree_formatter;
  bool createsimple = false;
  bool create_from_conf = false;
  int num_osd = 0;
  int pg_bits = g_conf->osd_pg_bits;
  int pgp_bits = g_conf->osd_pgp_bits;
  bool clobber = false;
  bool modified = false;
  std::string export_crush, import_crush, test_map_pg, test_map_object;
  bool test_crush = false;
  int range_first = -1;
  int range_last = -1;
  int pool = -1;
  bool mark_up_in = false;
  bool clear_temp = false;
  bool test_map_pgs = false;
  bool test_map_pgs_dump = false;
  bool test_random = false;
  bool upmap_cleanup = false;
  bool upmap = false;
  bool upmap_save = false;
  std::string upmap_file = "-";
  int upmap_max = 100;
  float upmap_deviation = .01;
  std::set<std::string> upmap_pools;
  int64_t pg_num = -1;
  bool test_map_pgs_dump_all = false;

  std::string val;
  std::ostringstream err;
  for (std::vector<const char*>::iterator i = args.begin(); i != args.end(); ) {
    if (ceph_argparse_double_dash(args, i)) {
      break;
    } else if (ceph_argparse_flag(args, i, "-h", "--help", (char*)NULL)) {
      usage();
    } else if (ceph_argparse_flag(args, i, "-p", "--print", (char*)NULL)) {
      print = true;
    } else if (ceph_argparse_witharg(args, i, &val, err, "--dump", (char*)NULL)) {
      print = true;
      if (!val.empty() && val != "plain") {
        print_formatter.reset(Formatter::create(val, "", "json"));
      }
    } else if (ceph_argparse_witharg(args, i, &val, err, "--tree", (char*)NULL)) {
      tree = true;
      if (!val.empty() && val != "plain") {
        tree_formatter.reset(Formatter::create(val, "", "json"));
      }
    } else if (ceph_argparse_witharg(args, i, &upmap_file, "--upmap-cleanup", (char*)NULL)) {
      upmap_cleanup = true;
    } else if (ceph_argparse_witharg(args, i, &upmap_file, "--upmap-save", (char*)NULL)) {
      upmap_save = true;
    } else if (ceph_argparse_witharg(args, i, &upmap_file, "--upmap", (char*)NULL)) {
      upmap_cleanup = true;
      upmap = true;
    } else if (ceph_argparse_witharg(args, i, &upmap_max, err, "--upmap-max", (char*)NULL)) {
    } else if (ceph_argparse_witharg(args, i, &upmap_deviation, err, "--upmap-deviation", (char*)NULL)) {
    } else if (ceph_argparse_witharg(args, i, &val, "--upmap-pool", (char*)NULL)) {
      upmap_pools.insert(val);
    } else if (ceph_argparse_witharg(args, i, &num_osd, err, "--createsimple", (char*)NULL)) {
      if (!err.str().empty()) {
        cerr << err.str() << std::endl;
        exit(EXIT_FAILURE);
      }
      createsimple = true;
    } else if (ceph_argparse_flag(args, i, "--create-from-conf", (char*)NULL)) {
      create_from_conf = true;
    } else if (ceph_argparse_flag(args, i, "--mark-up-in", (char*)NULL)) {
      mark_up_in = true;
    } else if (ceph_argparse_flag(args, i, "--clear-temp", (char*)NULL)) {
      clear_temp = true;
    } else if (ceph_argparse_flag(args, i, "--test-map-pgs", (char*)NULL)) {
      test_map_pgs = true;
    } else if (ceph_argparse_flag(args, i, "--test-map-pgs-dump", (char*)NULL)) {
      test_map_pgs_dump = true;
    } else if (ceph_argparse_flag(args, i, "--test-map-pgs-dump-all", (char*)NULL)) {
      test_map_pgs_dump_all = true;
    } else if (ceph_argparse_flag(args, i, "--test-random", (char*)NULL)) {
      test_random = true;
    } else if (ceph_argparse_flag(args, i, "--clobber", (char*)NULL)) {
      clobber = true;
    } else if (ceph_argparse_witharg(args, i, &pg_bits, err, "--pg_bits", (char*)NULL)) {
      if (!err.str().empty()) {
        cerr << err.str() << std::endl;
        exit(EXIT_FAILURE);
      }
    } else if (ceph_argparse_witharg(args, i, &pgp_bits, err, "--pgp_bits", (char*)NULL)) {
      if (!err.str().empty()) {
        cerr << err.str() << std::endl;
        exit(EXIT_FAILURE);
      }
    } else if (ceph_argparse_witharg(args, i, &val, "--export_crush", (char*)NULL)) {
      export_crush = val;
    } else if (ceph_argparse_witharg(args, i, &val, "--import_crush", (char*)NULL)) {
      import_crush = val;
    } else if (ceph_argparse_witharg(args, i, &val, "--test_map_pg", (char*)NULL)) {
      test_map_pg = val;
    } else if (ceph_argparse_witharg(args, i, &val, "--test_map_object", (char*)NULL)) {
      test_map_object = val;
    } else if (ceph_argparse_flag(args, i, "--test_crush", (char*)NULL)) {
      test_crush = true;
    } else if (ceph_argparse_witharg(args, i, &val, err, "--pg_num", (char*)NULL)) {
      string interr;
      pg_num = strict_strtoll(val.c_str(), 10, &interr);
      if (interr.length() > 0) {
        cerr << "error parsing integer value " << interr << std::endl;
        exit(EXIT_FAILURE);
      }
    } else if (ceph_argparse_witharg(args, i, &range_first, err, "--range_first", (char*)NULL)) {
    } else if (ceph_argparse_witharg(args, i, &range_last, err, "--range_last", (char*)NULL)) {
    } else if (ceph_argparse_witharg(args, i, &pool, err, "--pool", (char*)NULL)) {
      if (!err.str().empty()) {
        cerr << err.str() << std::endl;
        exit(EXIT_FAILURE);
      }
    } else {
      ++i;
    }
  }
  if (args.empty()) {
    cerr << me << ": must specify osdmap filename" << std::endl;
    usage();
  }
  else if (args.size() > 1) {
    cerr << me << ": too many arguments" << std::endl;
    usage();
  }
  fn = args[0];

  if (range_first >= 0 && range_last >= 0) {
    set<OSDMap*> maps;
    OSDMap *prev = NULL;
    for (int i=range_first; i <= range_last; i++) {
      ostringstream f;
      f << fn << "/" << i;
      bufferlist bl;
      string error, s = f.str();
      int r = bl.read_file(s.c_str(), &error);
      if (r < 0) {
        cerr << "unable to read " << s << ": " << cpp_strerror(r) << std::endl;
        exit(1);
      }
      cout << s << " got " << bl.length() << " bytes" << std::endl;
      OSDMap *o = new OSDMap;
      o->decode(bl);
      maps.insert(o);
      if (prev)
        OSDMap::dedup(prev, o);
      prev = o;
    }
    exit(0);
  }
  
  OSDMap osdmap;
  bufferlist bl;

  cerr << me << ": osdmap file '" << fn << "'" << std::endl;
  
  int r = 0;
  struct stat st;
  if (!createsimple && !create_from_conf && !clobber) {
    std::string error;
    r = bl.read_file(fn.c_str(), &error);
    if (r == 0) {
      try {
        osdmap.decode(bl);
      }
      catch (const buffer::error &e) {
        cerr << me << ": error decoding osdmap '" << fn << "'" << std::endl;
        return -1;
      }
    }
    else {
      cerr << me << ": couldn't open " << fn << ": " << error << std::endl;
      return -1;
    }
  }
  else if ((createsimple || create_from_conf) && !clobber && ::stat(fn.c_str(), &st) == 0) {
    cerr << me << ": " << fn << " exists, --clobber to overwrite" << std::endl;
    return -1;
  }

  if (createsimple || create_from_conf) {
    if (createsimple) {
      if (num_osd < 1) {
        cerr << me << ": osd count must be > 0" << std::endl;
        exit(1);
      }
    } else {
      num_osd = -1;
    }
    uuid_d fsid;
    memset(&fsid, 0, sizeof(uuid_d));
    osdmap.build_simple(g_ceph_context, 0, fsid, num_osd, pg_bits, pgp_bits);
    modified = true;
  }

  if (mark_up_in) {
    cout << "marking all OSDs up and in" << std::endl;
    int n = osdmap.get_max_osd();
    for (int i=0; i<n; i++) {
      osdmap.set_state(i, osdmap.get_state(i) | CEPH_OSD_UP);
      osdmap.set_weight(i, CEPH_OSD_IN);
      osdmap.crush->adjust_item_weightf(g_ceph_context, i, 1.0);
    }
  }
  if (clear_temp) {
    cout << "clearing pg/primary temp" << std::endl;
    osdmap.clear_temp();
  }
  int upmap_fd = STDOUT_FILENO;
  if (upmap || upmap_cleanup) {
    if (upmap_file != "-") {
      upmap_fd = ::open(upmap_file.c_str(), O_CREAT|O_WRONLY, 0644);
      if (upmap_fd < 0) {
        cerr << "error opening " << upmap_file << ": " << cpp_strerror(errno)
             << std::endl;
        exit(1);
      }
      cout << "writing upmap command output to: " << upmap_file << std::endl;
    }
  }
  if (upmap_cleanup) {
    cout << "checking for upmap cleanups" << std::endl;
    OSDMap::Incremental pending_inc(osdmap.get_epoch()+1);
    pending_inc.fsid = osdmap.get_fsid();
    int r = osdmap.clean_pg_upmaps(g_ceph_context, &pending_inc);
    if (r > 0) {
      print_inc_upmaps(pending_inc, upmap_fd);
      r = osdmap.apply_incremental(pending_inc);
      assert(r == 0);
    }
  }
  if (upmap) {
    cout << "upmap, max-count " << upmap_max
         << ", max deviation " << upmap_deviation
         << std::endl;
    OSDMap::Incremental pending_inc(osdmap.get_epoch()+1);
    pending_inc.fsid = osdmap.get_fsid();
    set<int64_t> pools;
    for (auto& s : upmap_pools) {
      int64_t p = osdmap.lookup_pg_pool_name(s);
      if (p < 0) {
        cerr << " pool '" << s << "' does not exist" << std::endl;
        exit(1);
      }
      pools.insert(p);
    }
    if (!pools.empty())
      cout << " limiting to pools " << upmap_pools << " (" << pools << ")"
           << std::endl;
    int changed = osdmap.calc_pg_upmaps(
      g_ceph_context, upmap_deviation,
      upmap_max, pools,
      &pending_inc);
    if (changed) {
      print_inc_upmaps(pending_inc, upmap_fd);
      if (upmap_save) {
        int r = osdmap.apply_incremental(pending_inc);
        assert(r == 0);
        modified = true;
      }
    } else {
      cout << "no upmaps proposed" << std::endl;
    }
  }
  if (upmap_file != "-") {
    ::close(upmap_fd);
  }

  if (!import_crush.empty()) {
    bufferlist cbl;
    std::string error;
    r = cbl.read_file(import_crush.c_str(), &error);
    if (r) {
      cerr << me << ": error reading crush map from " << import_crush
           << ": " << error << std::endl;
      exit(1);
    }

    // validate
    CrushWrapper cw;
    bufferlist::iterator p = cbl.begin();
    cw.decode(p);

    if (cw.get_max_devices() > osdmap.get_max_osd()) {
      cerr << me << ": crushmap max_devices " << cw.get_max_devices()
           << " > osdmap max_osd " << osdmap.get_max_osd() << std::endl;
      exit(1);
    }
    
    // apply
    OSDMap::Incremental inc;
    inc.fsid = osdmap.get_fsid();
    inc.epoch = osdmap.get_epoch()+1;
    inc.crush = cbl;
    osdmap.apply_incremental(inc);
    cout << me << ": imported " << cbl.length() << " byte crush map from " << import_crush << std::endl;
    modified = true;
  }

  if (!export_crush.empty()) {
    bufferlist cbl;
    osdmap.crush->encode(cbl, CEPH_FEATURES_SUPPORTED_DEFAULT);
    r = cbl.write_file(export_crush.c_str());
    if (r < 0) {
      cerr << me << ": error writing crush map to " << import_crush << std::endl;
      exit(1);
    }
    cout << me << ": exported crush map to " << export_crush << std::endl;
  }  

  if (!test_map_object.empty()) {
    object_t oid(test_map_object);
    if (pool == -1) {
      cout << me << ": assuming pool 0 (use --pool to override)" << std::endl;
      pool = 0;
    }
    if (!osdmap.have_pg_pool(pool)) {
      cerr << "There is no pool " << pool << std::endl;
      exit(1);
    }
    object_locator_t loc(pool);
    pg_t raw_pgid = osdmap.object_locator_to_pg(oid, loc);
    pg_t pgid = osdmap.raw_pg_to_pg(raw_pgid);
    
    vector<int> acting;
    osdmap.pg_to_acting_osds(pgid, acting);
    cout << " object '" << oid
         << "' -> " << pgid
         << " -> " << acting
         << std::endl;
  }  
  if (!test_map_pg.empty()) {
    pg_t pgid;
    if (!pgid.parse(test_map_pg.c_str())) {
      cerr << me << ": failed to parse pg '" << test_map_pg << std::endl;
      usage();
    }
    cout << " parsed '" << test_map_pg << "' -> " << pgid << std::endl;

    vector<int> raw, up, acting;
    int raw_primary, up_primary, acting_primary;
    osdmap.pg_to_raw_osds(pgid, &raw, &raw_primary);
    osdmap.pg_to_up_acting_osds(pgid, &up, &up_primary,
                                &acting, &acting_primary);
    cout << pgid << " raw (" << raw << ", p" << raw_primary
         << ") up (" << up << ", p" << up_primary
         << ") acting (" << acting << ", p" << acting_primary << ")"
         << std::endl;
  }
  if (test_map_pgs || test_map_pgs_dump || test_map_pgs_dump_all) {
    if (pool != -1 && !osdmap.have_pg_pool(pool)) {
      cerr << "There is no pool " << pool << std::endl;
      exit(1);
    }
    int n = osdmap.get_max_osd();
    vector<int> count(n, 0);
    vector<int> first_count(n, 0);
    vector<int> primary_count(n, 0);
    vector<int> size(30, 0);
    if (test_random)
      srand(getpid());
    auto& pools = osdmap.get_pools();
    for (auto p = pools.begin(); p != pools.end(); ++p) {
      if (pool != -1 && p->first != pool)
        continue;
      if (pg_num > 0) 
        p->second.set_pg_num(pg_num);
      
      cout << "pool " << p->first
           << " pg_num " << p->second.get_pg_num() << std::endl;
      for (unsigned i = 0; i < p->second.get_pg_num(); ++i) {
        pg_t pgid = pg_t(i, p->first);

        vector<int> osds, raw, up, acting;
        int primary, calced_primary, up_primary, acting_primary;
        if (test_random) {
          osds.resize(p->second.size);
          for (unsigned i=0; i<osds.size(); ++i) {
            osds[i] = rand() % osdmap.get_max_osd();
          }
          primary = osds[0];
        } else if (test_map_pgs_dump_all) {
         osdmap.pg_to_raw_osds(pgid, &raw, &calced_primary);
         osdmap.pg_to_up_acting_osds(pgid, &up, &up_primary,
                                &acting, &acting_primary);         
       } else {
          osdmap.pg_to_acting_osds(pgid, &osds, &primary);
        }
        size[osds.size()]++;

        if (test_map_pgs_dump) {
          cout << pgid << "\t" << osds << "\t" << primary << std::endl;
       } else if (test_map_pgs_dump_all) {
         cout << pgid << " raw (" << raw << ", p" << calced_primary
              << ") up (" << up << ", p" << up_primary
              << ") acting (" << acting << ", p" << acting_primary << ")"
              << std::endl;
       }

        for (unsigned i=0; i<osds.size(); i++) {
          //cout << " rep " << i << " on " << osds[i] << std::endl;
          count[osds[i]]++;
        }
        if (osds.size())
          first_count[osds[0]]++;
        if (primary >= 0)
          primary_count[primary]++;
      }
    }

    uint64_t total = 0;
    int in = 0;
    int min_osd = -1;
    int max_osd = -1;
    cout << "#osd\tcount\tfirst\tprimary\tc wt\twt\n";
    for (int i=0; i<n; i++) {
      if (!osdmap.is_in(i))
        continue;
      if (osdmap.crush->get_item_weight(i) <= 0)
        continue;
      in++;
      cout << "osd." << i
           << "\t" << count[i]
           << "\t" << first_count[i]
           << "\t" << primary_count[i]
           << "\t" << osdmap.crush->get_item_weightf(i)
           << "\t" << osdmap.get_weightf(i)
           << std::endl;
      total += count[i];
      if (count[i] &&
          (min_osd < 0 ||
           count[i] < count[min_osd]))
        min_osd = i;
      if (count[i] &&
          (max_osd < 0 ||
           count[i] > count[max_osd]))
        max_osd = i;

    }
    uint64_t avg = in ? (total / in) : 0;
    double dev = 0;
    for (int i=0; i<n; i++) {
      if (!osdmap.is_in(i))
        continue;
      if (osdmap.crush->get_item_weight(i) <= 0)
        continue;
      dev += (avg - count[i]) * (avg - count[i]);
    }
    dev /= in;
    dev = sqrt(dev);

    //double edev = sqrt(pgavg) * (double)avg / pgavg;
    double edev = sqrt((double)total / (double)in * (1.0 - (1.0 / (double)in)));
    cout << " in " << in << std::endl;
    cout << " avg " << avg
         << " stddev " << dev
         << " (" << (dev/avg) << "x)"
         << " (expected " << edev << " " << (edev/avg) << "x))"
         << std::endl;

    if (min_osd >= 0)
      cout << " min osd." << min_osd << " " << count[min_osd] << std::endl;
    if (max_osd >= 0)
      cout << " max osd." << max_osd << " " << count[max_osd] << std::endl;

    for (int i=0; i<4; i++) {
      cout << "size " << i << "\t" << size[i] << std::endl;
    }
  }
  if (test_crush) {
    int pass = 0;
    while (1) {
      cout << "pass " << ++pass << std::endl;

      ceph::unordered_map<pg_t,vector<int> > m;
      for (map<int64_t,pg_pool_t>::const_iterator p = osdmap.get_pools().begin();
           p != osdmap.get_pools().end();
           ++p) {
        const pg_pool_t *pool = osdmap.get_pg_pool(p->first);
        for (ps_t ps = 0; ps < pool->get_pg_num(); ps++) {
          pg_t pgid(ps, p->first, -1);
          for (int i=0; i<100; i++) {
            cout << pgid << " attempt " << i << std::endl;

            vector<int> r;
            osdmap.pg_to_acting_osds(pgid, r);
            //cout << pgid << " " << r << std::endl;
            if (m.count(pgid)) {
              if (m[pgid] != r) {
                cout << pgid << " had " << m[pgid] << " now " << r << std::endl;
                ceph_abort();
              }
            } else
              m[pgid] = r;
          }
        }
      }
    }
  }

  if (!print && !tree && !modified &&
      export_crush.empty() && import_crush.empty() && 
      test_map_pg.empty() && test_map_object.empty() &&
      !test_map_pgs && !test_map_pgs_dump && !test_map_pgs_dump_all &&
      !upmap && !upmap_cleanup) {
    cerr << me << ": no action specified?" << std::endl;
    usage();
  }

  if (modified)
    osdmap.inc_epoch();

  if (print) {
    if (print_formatter) {
      print_formatter->open_object_section("osdmap");
      osdmap.dump(print_formatter.get());
      print_formatter->close_section();
      print_formatter->flush(cout);
    } else {
      osdmap.print(cout);
    }
  }

  if (tree) {
    if (tree_formatter) {
      tree_formatter->open_object_section("tree");
      osdmap.print_tree(tree_formatter.get(), NULL);
      tree_formatter->close_section();
      tree_formatter->flush(cout);
      cout << std::endl;
    } else {
      osdmap.print_tree(NULL, &cout);
    }
  }
  if (modified) {
    bl.clear();
    osdmap.encode(bl, CEPH_FEATURES_SUPPORTED_DEFAULT | CEPH_FEATURE_RESERVED);

    // write it out
    cout << me << ": writing epoch " << osdmap.get_epoch()
         << " to " << fn
         << std::endl;
    int r = bl.write_file(fn.c_str());
    if (r) {
      cerr << "osdmaptool: error writing to '" << fn << "': "
           << cpp_strerror(r) << std::endl;
      return 1;
    }
  }
  

  return 0;
}