initial code repo
[stor4nfv.git] / src / ceph / src / global / global_init.h
diff --git a/src/ceph/src/global/global_init.h b/src/ceph/src/global/global_init.h
new file mode 100644 (file)
index 0000000..ba74deb
--- /dev/null
@@ -0,0 +1,107 @@
+// -*- 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) 2011 New Dream Network
+ *
+ * This is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License version 2.1, as published by the Free Software
+ * Foundation.  See file COPYING.
+ *
+ */
+
+#ifndef CEPH_COMMON_GLOBAL_INIT_H
+#define CEPH_COMMON_GLOBAL_INIT_H
+
+#include <stdint.h>
+#include <vector>
+#include <boost/intrusive_ptr.hpp>
+#include "include/assert.h"
+#include "common/code_environment.h"
+#include "common/common_init.h"
+
+class CephContext;
+
+/*
+ * global_init is the first initialization function that
+ * daemons and utility programs need to call. It takes care of a lot of
+ * initialization, including setting up g_ceph_context.
+ */
+boost::intrusive_ptr<CephContext>
+     global_init(std::vector < const char * > *alt_def_args,
+                std::vector < const char* >& args,
+                uint32_t module_type,
+                code_environment_t code_env,
+                int flags,
+                const char *data_dir_option = 0,
+                bool run_pre_init = true);
+
+void intrusive_ptr_add_ref(CephContext* cct);
+void intrusive_ptr_release(CephContext* cct);
+
+// just the first half; enough to get config parsed but doesn't start up the
+// cct or log.
+void global_pre_init(std::vector < const char * > *alt_def_args,
+                    std::vector < const char* >& args,
+                    uint32_t module_type, code_environment_t code_env,
+                    int flags,
+                    const char *data_dir_option = 0);
+
+/*
+ * perform all of the steps that global_init_daemonize performs just prior
+ * to actually forking (via daemon(3)).  return 0 if we are going to proceed
+ * with the fork, or -1 otherwise.
+ */
+int global_init_prefork(CephContext *cct);
+
+/*
+ * perform all the steps that global_init_daemonize performs just after
+ * the fork, except closing stderr, which we'll do later on.
+ */
+void global_init_postfork_start(CephContext *cct);
+
+/*
+ * close stderr, thus completing the postfork.
+ */
+void global_init_postfork_finish(CephContext *cct);
+
+
+/*
+ * global_init_daemonize handles daemonizing a process. 
+ *
+ * If this is called, it *must* be called before common_init_finish.
+ * Note that this is equivalent to calling _prefork(), daemon(), and
+ * _postfork.
+ */
+void global_init_daemonize(CephContext *cct);
+
+/*
+ * global_init_chdir changes the process directory.
+ *
+ * If this is called, it *must* be called before common_init_finish
+ */
+void global_init_chdir(const CephContext *cct);
+
+/*
+ * Explicitly shut down stderr. Usually, you don't need to do
+ * this, because global_init_daemonize will do it for you. However, in some
+ * rare cases you need to call this explicitly.
+ *
+ * If this is called, it *must* be called before common_init_finish
+ */
+int global_init_shutdown_stderr(CephContext *cct);
+
+/*
+ * Preload the erasure coding libraries to detect early issues with
+ * configuration.
+ */
+int global_init_preload_erasure_code(const CephContext *cct);
+
+/**
+ * print daemon startup banner/warning
+ */
+void global_print_banner(void);
+
+#endif