analyzer.h

//
// Created by Juncheng Yang on 4/20/20.
//

#pragma once

#define __STDC_FORMAT_MACROS

#include <inttypes.h>
#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>

#include <iostream>
#include <sstream>
#include <string>
#include <unordered_map>
#include <utility>
#include <vector>

#include "accessPattern.h"
#include "libCacheSim/reader.h"
#include "op.h"
#include "popularity.h"
#include "popularityDecay.h"
#include "reqRate.h"
#include "reuse.h"
#include "size.h"
#include "struct.h"
#include "ttl.h"

/* experimental module */
#include "experimental/createFutureReuseCCDF.hpp"
#include "experimental/lifetime.hpp"
#include "experimental/probAtAge.hpp"
#include "experimental/scanDetector.hpp"
#include "experimental/sizeChange.hpp"

// /* deprecated module */
// #include "dep/writeFutureReuse.hpp"
// #include "dep/writeReuse.hpp"

namespace traceAnalyzer {
typedef struct analysis_option {
  bool req_rate;
  bool access_pattern;
  bool size;
  bool reuse;
  bool popularity;
  bool ttl;

  bool popularity_decay;
  bool lifetime;

  bool create_future_reuse_ccdf;
  bool prob_at_age;

  bool size_change;
} analysis_option_t;

typedef struct analysis_param {
  int track_n_popular;
  /* tracking the number of one-hit, ... X-hit wonders */
  int track_n_hit;
  int time_window;
  int warmup_time;
  double access_pattern_sample_ratio;
  int access_pattern_sample_ratio_inv;
} analysis_param_t;

static analysis_param_t default_param() {
  analysis_param_t param;
  param.track_n_popular = 8;
  param.track_n_hit = 8;
  param.time_window = 300;
  param.warmup_time = 86400;
  param.access_pattern_sample_ratio = 0.01;
  param.access_pattern_sample_ratio_inv = 101;

  return param;
};

static struct analysis_option default_option() {
  struct analysis_option option = {.req_rate = false,
                                   .access_pattern = false,
                                   .size = false,
                                   .reuse = false,
                                   .popularity = false,
                                   .ttl = false,
                                   .popularity_decay = false,
                                   .lifetime = false,
                                   .create_future_reuse_ccdf = false,
                                   .prob_at_age = false,
                                   .size_change = false};

  return option;
};

#define DEFAULT_PREALLOC_N_OBJ 1e8

class TraceAnalyzer {
 public:
  explicit TraceAnalyzer(reader_t *reader, string output_path,
                         struct analysis_option option,
                         struct analysis_param params)
      : access_pattern_sample_ratio_inv_(
            params.access_pattern_sample_ratio_inv),
        track_n_popular_(params.track_n_popular),
        track_n_hit_(params.track_n_hit),
        time_window_(params.time_window),
        warmup_time_(params.warmup_time),
        n_req_(0),
        reader_(reader),
        option_(option),
        output_path_(std::move(output_path)) {
    if (warmup_time_ % time_window_ != 0) {
      /* the popularityDecay computation needs warmup time to be multiple of
       * time_window */
      ERROR("warmup time needs to be multiple of time_window\n");
      exit(1);
    }

    initialize();
  };

  ~TraceAnalyzer() { cleanup(); };

  void run();

  void initialize();

  void cleanup();

  friend ostream &operator<<(ostream &os, const TraceAnalyzer &stat) {
    if (!stat.has_run_) {
      os << "trace stat has not been computed" << endl;
    } else {
      os << stat.stat_ss_.str() << std::endl;
    }
    return os;
  }

  /* params */
  // the sampling ratio used in access pattern analysis
  int access_pattern_sample_ratio_inv_;
  // the number of requests to the most popular object, 2nd most popular ...
  int track_n_popular_;
  // track one-hit wonders, two-hit wonders, etc.
  int track_n_hit_;
  int time_window_;
  // warmup time in seconds
  int warmup_time_;

  /* stat */
  int64_t n_req_ = 0;

  /* number of one-hit, two-hit ... */
  uint64_t *n_hit_cnt_ = nullptr;
  /* the number of requests to the most, 2nd most ... popular object */
  uint64_t *popular_cnt_ = nullptr;

  int64_t start_ts_ = 0, end_ts_ = 0;
  /* request size and object size weighted by request and object */
  uint64_t sum_obj_size_req = 0, sum_obj_size_obj = 0;
  /* request size can be different from object size when only part of
   * an object is requested, we ignore for now */
  //  uint64_t sum_req_size_req = 0, sum_req_size_obj = 0;

  obj_info_map_type obj_map_;

 private:
  reader_t *reader_ = nullptr;
  bool has_run_ = false;
  stringstream stat_ss_;
  struct analysis_option option_;

  OpStat *op_stat_ = nullptr;
  TtlStat *ttl_stat_ = nullptr;
  ReqRate *req_rate_stat_ = nullptr;
  SizeDistribution *size_stat_ = nullptr;
  ReuseDistribution *reuse_stat_ = nullptr;
  AccessPattern *access_stat_ = nullptr;
  Popularity *popularity_stat_ = nullptr;
  PopularityDecay *popularity_decay_stat_ = nullptr;

  ProbAtAge *prob_at_age_ = nullptr;
  LifetimeDistribution *lifetime_stat_ = nullptr;

  // WriteReuseDistribution *write_reuse_stat_ = nullptr;
  CreateFutureReuseDistribution *create_future_reuse_ = nullptr;
  // WriteFutureReuseDistribution *write_future_reuse_stat_ = nullptr;
  SizeChangeDistribution *size_change_distribution_ = nullptr;
  ScanDetector *scan_detector_ = nullptr;

  string output_path_;

  void post_processing();

  string gen_stat_str();

  inline int time_to_window_idx(uint32_t rtime) { return rtime / time_window_; }
};

};  // namespace traceAnalyzer