hermes.h

Go to the documentation of this file.

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 * Distributed under BSD 3-Clause license.                                   *
 * Copyright by The HDF Group.                                               *
 * Copyright by the Illinois Institute of Technology.                        *
 * All rights reserved.                                                      *
 *                                                                           *
 * This file is part of Hermes. The full Hermes copyright notice, including  *
 * terms governing use, modification, and redistribution, is contained in    *
 * the COPYING file, which can be found at the top directory. If you do not  *
 * have access to the file, you may request a copy from help@hdfgroup.org.   *
 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 
#ifndef HERMES_H_
#define HERMES_H_
 
#include <glog/logging.h>
 
#include <cstdint>
#include <string>
 
#include "buffer_pool.h"
#include "hermes_types.h"
#include "metadata_management.h"
#include "rpc.h"
 
namespace hermes {
namespace api {
 
std::string GetVersion();
 
class Hermes {
 public:
  bool is_initialized;
 
  // TODO(chogan): Temporarily public to facilitate iterative development.
  hermes::SharedMemoryContext context_; 
  hermes::CommunicationContext comm_;   
  hermes::RpcContext rpc_;              
  hermes::Arena trans_arena_; 
  std::string shmem_name_;
  std::string rpc_server_name_;
 
  Hermes() {}
 
  explicit Hermes(SharedMemoryContext context) : context_(context) {}
 
  bool IsApplicationCore();
 
  bool IsFirstRankOnNode();
 
  void AppBarrier();
 
  int GetProcessRank();
 
  int GetNodeId();
 
  int GetNumProcesses();
 
  void *GetAppCommunicator();
 
  void Finalize(bool force_rpc_shutdown = false);
 
  void FinalizeClient(bool stop_daemon = true);
 
  void RemoteFinalize();
 
  void RunDaemon();
 
  bool BucketContainsBlob(const std::string &bucket_name,
                          const std::string &blob_name);
 
  bool BucketExists(const std::string &bucket_name);
};
 
class Bucket;
 
Status RenameBucket(const std::string &old_name, const std::string &new_name,
                    Context &ctx);
 
Status TransferBlob(const Bucket &src_bkt, const std::string &src_blob_name,
                    Bucket &dst_bkt, const std::string &dst_blob_name,
                    Context &ctx);
 
std::shared_ptr<api::Hermes> InitHermes(const char *config_file = NULL,
                                        bool is_daemon = false,
                                        bool is_adapter = false);
 
}  // namespace api
 
std::shared_ptr<api::Hermes> InitHermes(Config *config, bool is_daemon = false,
                                        bool is_adapter = false);
 
std::shared_ptr<api::Hermes> InitHermesDaemon(char *config_file = NULL);
 
std::shared_ptr<api::Hermes> InitHermesDaemon(Config *config);
 
std::shared_ptr<api::Hermes> InitHermesClient(const char *config_file = NULL);
 
}  // namespace hermes
 
#endif  // HERMES_H_