1 // -*- mode:C++; tab-width:8; c-basic-offset:2; indent-tabs-mode:t -*-
2 // vim: ts=8 sw=2 smarttab
4 #include "common/ceph_argparse.h"
5 #include "global/global_init.h"
6 #include "global/signal_handler.h"
7 #include "common/config.h"
8 #include "common/errno.h"
9 #include "common/Timer.h"
10 #include "common/safe_io.h"
11 #include "common/TracepointProvider.h"
12 #include "include/compat.h"
13 #include "include/str_list.h"
14 #include "include/stringify.h"
15 #include "rgw_common.h"
16 #include "rgw_rados.h"
18 #include "rgw_period_pusher.h"
19 #include "rgw_realm_reloader.h"
21 #include "rgw_rest_s3.h"
22 #include "rgw_rest_swift.h"
23 #include "rgw_rest_admin.h"
24 #include "rgw_rest_usage.h"
25 #include "rgw_rest_user.h"
26 #include "rgw_rest_bucket.h"
27 #include "rgw_rest_metadata.h"
28 #include "rgw_rest_log.h"
29 #include "rgw_rest_config.h"
30 #include "rgw_rest_realm.h"
31 #include "rgw_rest_sts.h"
32 #include "rgw_swift_auth.h"
34 #include "rgw_tools.h"
35 #include "rgw_resolve.h"
36 #include "rgw_request.h"
37 #include "rgw_process.h"
38 #include "rgw_frontend.h"
39 #include "rgw_http_client_curl.h"
40 #include "rgw_perf_counters.h"
41 #ifdef WITH_RADOSGW_AMQP_ENDPOINT
44 #if defined(WITH_RADOSGW_BEAST_FRONTEND)
45 #include "rgw_asio_frontend.h"
46 #endif /* WITH_RADOSGW_BEAST_FRONTEND */
48 #include "rgw_dmclock_scheduler_ctx.h"
50 #include "services/svc_zone.h"
52 #ifdef HAVE_SYS_PRCTL_H
53 #include <sys/prctl.h>
56 #define dout_subsys ceph_subsys_rgw
59 TracepointProvider::Traits
rgw_op_tracepoint_traits("librgw_op_tp.so",
61 TracepointProvider::Traits
rgw_rados_tracepoint_traits("librgw_rados_tp.so",
65 static sig_t sighandler_alrm
;
69 static int signal_fd
[2] = {0, 0};
71 void signal_shutdown()
74 int ret
= write(signal_fd
[0], (char *)&val
, sizeof(val
));
76 derr
<< "ERROR: " << __func__
<< ": write() returned "
77 << cpp_strerror(errno
) << dendl
;
81 static void wait_shutdown()
84 int r
= safe_read_exact(signal_fd
[1], &val
, sizeof(val
));
86 derr
<< "safe_read_exact returned with error" << dendl
;
90 static int signal_fd_init()
92 return socketpair(AF_UNIX
, SOCK_STREAM
, 0, signal_fd
);
95 static void signal_fd_finalize()
101 static void handle_sigterm(int signum
)
103 dout(1) << __func__
<< dendl
;
104 #if defined(WITH_RADOSGW_FCGI_FRONTEND)
105 FCGX_ShutdownPending();
108 // send a signal to make fcgi's accept(2) wake up. unfortunately the
109 // initial signal often isn't sufficient because we race with accept's
110 // check of the flag wet by ShutdownPending() above.
111 if (signum
!= SIGUSR1
) {
114 // safety net in case we get stuck doing an orderly shutdown.
115 uint64_t secs
= g_ceph_context
->_conf
->rgw_exit_timeout_secs
;
118 dout(1) << __func__
<< " set alarm for " << secs
<< dendl
;
123 static void godown_alarm(int signum
)
129 class C_InitTimeout
: public Context
{
132 void finish(int r
) override
{
133 derr
<< "Initialization timeout, failed to initialize" << dendl
;
140 cout
<< "usage: radosgw [options...]" << std::endl
;
141 cout
<< "options:\n";
142 cout
<< " --rgw-region=<region> region in which radosgw runs\n";
143 cout
<< " --rgw-zone=<zone> zone in which radosgw runs\n";
144 cout
<< " --rgw-socket-path=<path> specify a unix domain socket path\n";
145 cout
<< " -m monaddress[:port] connect to specified monitor\n";
146 cout
<< " --keyring=<path> path to radosgw keyring\n";
147 cout
<< " --logfile=<logfile> file to log debug output\n";
148 cout
<< " --debug-rgw=<log-level>/<memory-level> set radosgw debug level\n";
149 generic_server_usage();
154 static RGWRESTMgr
*set_logging(RGWRESTMgr
*mgr
)
156 mgr
->set_logging(true);
160 static RGWRESTMgr
*rest_filter(RGWRados
*store
, int dialect
, RGWRESTMgr
*orig
)
162 RGWSyncModuleInstanceRef sync_module
= store
->get_sync_module();
164 return sync_module
->get_rest_filter(dialect
, orig
);
171 * start up the RADOS connection and then handle HTTP messages as they come in
173 int main(int argc
, const char **argv
)
175 // dout() messages will be sent to stderr, but FCGX wants messages on stdout
176 // Redirect stderr to stdout.
177 TEMP_FAILURE_RETRY(close(STDERR_FILENO
));
178 if (TEMP_FAILURE_RETRY(dup2(STDOUT_FILENO
, STDERR_FILENO
)) < 0) {
180 cout
<< "failed to redirect stderr to stdout: " << cpp_strerror(err
)
185 /* alternative default for module */
186 map
<string
,string
> defaults
= {
187 { "debug_rgw", "1/5" },
188 { "keyring", "$rgw_data/keyring" },
189 { "objecter_inflight_ops", "24576" }
192 vector
<const char*> args
;
193 argv_to_vec(argc
, argv
, args
);
195 cerr
<< argv
[0] << ": -h or --help for usage" << std::endl
;
198 if (ceph_argparse_need_usage(args
)) {
203 // First, let's determine which frontends are configured.
204 int flags
= CINIT_FLAG_UNPRIVILEGED_DAEMON_DEFAULTS
;
206 &defaults
, args
, CEPH_ENTITY_TYPE_CLIENT
, CODE_ENVIRONMENT_DAEMON
,
209 list
<string
> frontends
;
210 g_conf().early_expand_meta(g_conf()->rgw_frontends
, &cerr
);
211 get_str_list(g_conf()->rgw_frontends
, ",", frontends
);
212 multimap
<string
, RGWFrontendConfig
*> fe_map
;
213 list
<RGWFrontendConfig
*> configs
;
214 if (frontends
.empty()) {
215 frontends
.push_back("civetweb");
217 for (list
<string
>::iterator iter
= frontends
.begin(); iter
!= frontends
.end(); ++iter
) {
220 if (f
.find("civetweb") != string::npos
|| f
.find("beast") != string::npos
) {
221 // If civetweb or beast is configured as a frontend, prevent global_init() from
222 // dropping permissions by setting the appropriate flag.
223 flags
|= CINIT_FLAG_DEFER_DROP_PRIVILEGES
;
224 if (f
.find("port") != string::npos
) {
225 // check for the most common ws problems
226 if ((f
.find("port=") == string::npos
) ||
227 (f
.find("port= ") != string::npos
)) {
228 derr
<< "WARNING: radosgw frontend config found unexpected spacing around 'port' "
229 << "(ensure frontend port parameter has the form 'port=80' with no spaces "
230 << "before or after '=')" << dendl
;
235 RGWFrontendConfig
*config
= new RGWFrontendConfig(f
);
236 int r
= config
->init();
239 cerr
<< "ERROR: failed to init config: " << f
<< std::endl
;
243 configs
.push_back(config
);
245 string framework
= config
->get_framework();
246 fe_map
.insert(pair
<string
, RGWFrontendConfig
*>(framework
, config
));
249 // Now that we've determined which frontend(s) to use, continue with global
250 // initialization. Passing false as the final argument ensures that
251 // global_pre_init() is not invoked twice.
252 // claim the reference and release it after subsequent destructors have fired
253 auto cct
= global_init(&defaults
, args
, CEPH_ENTITY_TYPE_CLIENT
,
254 CODE_ENVIRONMENT_DAEMON
,
255 flags
, "rgw_data", false);
257 // maintain existing region root pool for new multisite objects
258 if (!g_conf()->rgw_region_root_pool
.empty()) {
259 const char *root_pool
= g_conf()->rgw_region_root_pool
.c_str();
260 if (g_conf()->rgw_zonegroup_root_pool
.empty()) {
261 g_conf().set_val_or_die("rgw_zonegroup_root_pool", root_pool
);
263 if (g_conf()->rgw_period_root_pool
.empty()) {
264 g_conf().set_val_or_die("rgw_period_root_pool", root_pool
);
266 if (g_conf()->rgw_realm_root_pool
.empty()) {
267 g_conf().set_val_or_die("rgw_realm_root_pool", root_pool
);
271 // for region -> zonegroup conversion (must happen before common_init_finish())
272 if (!g_conf()->rgw_region
.empty() && g_conf()->rgw_zonegroup
.empty()) {
273 g_conf().set_val_or_die("rgw_zonegroup", g_conf()->rgw_region
.c_str());
276 if (g_conf()->daemonize
) {
277 global_init_daemonize(g_ceph_context
);
280 SafeTimer
init_timer(g_ceph_context
, mutex
);
283 init_timer
.add_event_after(g_conf()->rgw_init_timeout
, new C_InitTimeout
);
286 common_init_finish(g_ceph_context
);
288 init_async_signal_handler();
289 register_async_signal_handler(SIGHUP
, sighup_handler
);
291 TracepointProvider::initialize
<rgw_rados_tracepoint_traits
>(g_ceph_context
);
292 TracepointProvider::initialize
<rgw_op_tracepoint_traits
>(g_ceph_context
);
294 int r
= rgw_tools_init(g_ceph_context
);
296 derr
<< "ERROR: unable to initialize rgw tools" << dendl
;
301 rgw::curl::setup_curl(fe_map
);
302 rgw_http_client_init(g_ceph_context
);
304 #if defined(WITH_RADOSGW_FCGI_FRONTEND)
309 RGWStoreManager::get_storage(g_ceph_context
,
310 g_conf()->rgw_enable_gc_threads
,
311 g_conf()->rgw_enable_lc_threads
,
312 g_conf()->rgw_enable_quota_threads
,
313 g_conf()->rgw_run_sync_thread
,
314 g_conf().get_val
<bool>("rgw_dynamic_resharding"),
315 g_conf()->rgw_cache_enabled
);
318 init_timer
.cancel_all_events();
319 init_timer
.shutdown();
322 derr
<< "Couldn't init storage provider (RADOS)" << dendl
;
325 r
= rgw_perf_start(g_ceph_context
);
327 derr
<< "ERROR: failed starting rgw perf" << dendl
;
331 rgw_rest_init(g_ceph_context
, store
, store
->svc
.zone
->get_zonegroup());
334 init_timer
.cancel_all_events();
335 init_timer
.shutdown();
338 rgw_user_init(store
);
339 rgw_bucket_init(store
->meta_mgr
);
341 rgw_log_usage_init(g_ceph_context
, store
);
347 get_str_list(g_conf()->rgw_enable_apis
, apis
);
349 map
<string
, bool> apis_map
;
350 for (list
<string
>::iterator li
= apis
.begin(); li
!= apis
.end(); ++li
) {
351 apis_map
[*li
] = true;
354 /* warn about insecure keystone secret config options */
355 if (!(g_ceph_context
->_conf
->rgw_keystone_admin_token
.empty() ||
356 g_ceph_context
->_conf
->rgw_keystone_admin_password
.empty())) {
357 dout(0) << "WARNING: rgw_keystone_admin_token and rgw_keystone_admin_password should be avoided as they can expose secrets. Prefer the new rgw_keystone_admin_token_path and rgw_keystone_admin_password_path options, which read their secrets from files." << dendl
;
360 // S3 website mode is a specialization of S3
361 const bool s3website_enabled
= apis_map
.count("s3website") > 0;
362 const bool sts_enabled
= apis_map
.count("sts") > 0;
363 const bool iam_enabled
= apis_map
.count("iam") > 0;
364 const bool pubsub_enabled
= apis_map
.count("pubsub") > 0;
365 // Swift API entrypoint could placed in the root instead of S3
366 const bool swift_at_root
= g_conf()->rgw_swift_url_prefix
== "/";
367 if (apis_map
.count("s3") > 0 || s3website_enabled
) {
368 if (! swift_at_root
) {
369 rest
.register_default_mgr(set_logging(rest_filter(store
, RGW_REST_S3
,
370 new RGWRESTMgr_S3(s3website_enabled
, sts_enabled
, iam_enabled
, pubsub_enabled
))));
372 derr
<< "Cannot have the S3 or S3 Website enabled together with "
373 << "Swift API placed in the root of hierarchy" << dendl
;
378 if (pubsub_enabled
) {
379 #ifdef WITH_RADOSGW_AMQP_ENDPOINT
380 if (!rgw::amqp::init(cct
.get())) {
381 dout(1) << "ERROR: failed to initialize AMQP manager" << dendl
;
386 if (apis_map
.count("swift") > 0) {
387 RGWRESTMgr_SWIFT
* const swift_resource
= new RGWRESTMgr_SWIFT
;
389 if (! g_conf()->rgw_cross_domain_policy
.empty()) {
390 swift_resource
->register_resource("crossdomain.xml",
391 set_logging(new RGWRESTMgr_SWIFT_CrossDomain
));
394 swift_resource
->register_resource("healthcheck",
395 set_logging(new RGWRESTMgr_SWIFT_HealthCheck
));
397 swift_resource
->register_resource("info",
398 set_logging(new RGWRESTMgr_SWIFT_Info
));
400 if (! swift_at_root
) {
401 rest
.register_resource(g_conf()->rgw_swift_url_prefix
,
402 set_logging(rest_filter(store
, RGW_REST_SWIFT
,
405 if (store
->svc
.zone
->get_zonegroup().zones
.size() > 1) {
406 derr
<< "Placing Swift API in the root of URL hierarchy while running"
407 << " multi-site configuration requires another instance of RadosGW"
408 << " with S3 API enabled!" << dendl
;
411 rest
.register_default_mgr(set_logging(swift_resource
));
415 if (apis_map
.count("swift_auth") > 0) {
416 rest
.register_resource(g_conf()->rgw_swift_auth_entry
,
417 set_logging(new RGWRESTMgr_SWIFT_Auth
));
420 if (apis_map
.count("admin") > 0) {
421 RGWRESTMgr_Admin
*admin_resource
= new RGWRESTMgr_Admin
;
422 admin_resource
->register_resource("usage", new RGWRESTMgr_Usage
);
423 admin_resource
->register_resource("user", new RGWRESTMgr_User
);
424 admin_resource
->register_resource("bucket", new RGWRESTMgr_Bucket
);
426 /*Registering resource for /admin/metadata */
427 admin_resource
->register_resource("metadata", new RGWRESTMgr_Metadata
);
428 admin_resource
->register_resource("log", new RGWRESTMgr_Log
);
429 admin_resource
->register_resource("config", new RGWRESTMgr_Config
);
430 admin_resource
->register_resource("realm", new RGWRESTMgr_Realm
);
431 rest
.register_resource(g_conf()->rgw_admin_entry
, admin_resource
);
434 /* Initialize the registry of auth strategies which will coordinate
435 * the dynamic reconfiguration. */
436 auto auth_registry
= \
437 rgw::auth::StrategyRegistry::create(g_ceph_context
, store
);
439 /* Header custom behavior */
440 rest
.register_x_headers(g_conf()->rgw_log_http_headers
);
442 if (cct
->_conf
.get_val
<std::string
>("rgw_scheduler_type") == "dmclock" &&
443 !cct
->check_experimental_feature_enabled("dmclock")){
444 derr
<< "dmclock scheduler type is experimental and needs to be"
445 << "set in the option enable experimental data corrupting features"
450 rgw::dmclock::SchedulerCtx sched_ctx
{cct
.get()};
452 OpsLogSocket
*olog
= NULL
;
454 if (!g_conf()->rgw_ops_log_socket_path
.empty()) {
455 olog
= new OpsLogSocket(g_ceph_context
, g_conf()->rgw_ops_log_data_backlog
);
456 olog
->init(g_conf()->rgw_ops_log_socket_path
);
459 r
= signal_fd_init();
461 derr
<< "ERROR: unable to initialize signal fds" << dendl
;
465 register_async_signal_handler(SIGTERM
, handle_sigterm
);
466 register_async_signal_handler(SIGINT
, handle_sigterm
);
467 register_async_signal_handler(SIGUSR1
, handle_sigterm
);
468 sighandler_alrm
= signal(SIGALRM
, godown_alarm
);
470 map
<string
, string
> service_map_meta
;
471 service_map_meta
["pid"] = stringify(getpid());
473 list
<RGWFrontend
*> fes
;
477 for (multimap
<string
, RGWFrontendConfig
*>::iterator fiter
= fe_map
.begin();
478 fiter
!= fe_map
.end(); ++fiter
, ++fe_count
) {
479 RGWFrontendConfig
*config
= fiter
->second
;
480 string framework
= config
->get_framework();
481 RGWFrontend
*fe
= NULL
;
483 if (framework
== "civetweb" || framework
== "mongoose") {
484 framework
= "civetweb";
485 std::string uri_prefix
;
486 config
->get_val("prefix", "", &uri_prefix
);
488 RGWProcessEnv env
= { store
, &rest
, olog
, 0, uri_prefix
, auth_registry
};
489 //TODO: move all of scheduler initializations to frontends?
491 fe
= new RGWCivetWebFrontend(env
, config
, sched_ctx
);
493 else if (framework
== "loadgen") {
495 config
->get_val("port", 80, &port
);
496 std::string uri_prefix
;
497 config
->get_val("prefix", "", &uri_prefix
);
499 RGWProcessEnv env
= { store
, &rest
, olog
, port
, uri_prefix
, auth_registry
};
501 fe
= new RGWLoadGenFrontend(env
, config
);
503 #if defined(WITH_RADOSGW_BEAST_FRONTEND)
504 else if (framework
== "beast") {
506 config
->get_val("port", 80, &port
);
507 std::string uri_prefix
;
508 config
->get_val("prefix", "", &uri_prefix
);
509 RGWProcessEnv env
{ store
, &rest
, olog
, port
, uri_prefix
, auth_registry
};
510 fe
= new RGWAsioFrontend(env
, config
, sched_ctx
);
512 #endif /* WITH_RADOSGW_BEAST_FRONTEND */
513 #if defined(WITH_RADOSGW_FCGI_FRONTEND)
514 else if (framework
== "fastcgi" || framework
== "fcgi") {
515 framework
= "fastcgi";
516 std::string uri_prefix
;
517 config
->get_val("prefix", "", &uri_prefix
);
518 RGWProcessEnv fcgi_pe
= { store
, &rest
, olog
, 0, uri_prefix
, auth_registry
};
520 fe
= new RGWFCGXFrontend(fcgi_pe
, config
);
522 #endif /* WITH_RADOSGW_FCGI_FRONTEND */
524 service_map_meta
["frontend_type#" + stringify(fe_count
)] = framework
;
525 service_map_meta
["frontend_config#" + stringify(fe_count
)] = config
->get_config();
528 dout(0) << "WARNING: skipping unknown framework: " << framework
<< dendl
;
532 dout(0) << "starting handler: " << fiter
->first
<< dendl
;
535 derr
<< "ERROR: failed initializing frontend" << dendl
;
540 derr
<< "ERROR: failed run" << dendl
;
547 r
= store
->register_to_service_map("rgw", service_map_meta
);
549 derr
<< "ERROR: failed to register to service map: " << cpp_strerror(-r
) << dendl
;
555 // add a watcher to respond to realm configuration changes
556 RGWPeriodPusher
pusher(store
);
557 RGWFrontendPauser
pauser(fes
, &pusher
);
558 RGWRealmReloader
reloader(store
, service_map_meta
, &pauser
);
560 RGWRealmWatcher
realm_watcher(g_ceph_context
, store
->svc
.zone
->get_realm());
561 realm_watcher
.add_watcher(RGWRealmNotify::Reload
, reloader
);
562 realm_watcher
.add_watcher(RGWRealmNotify::ZonesNeedPeriod
, pusher
);
564 #if defined(HAVE_SYS_PRCTL_H)
565 if (prctl(PR_SET_DUMPABLE
, 1) == -1) {
566 cerr
<< "warning: unable to set dumpable flag: " << cpp_strerror(errno
) << std::endl
;
572 derr
<< "shutting down" << dendl
;
574 for (list
<RGWFrontend
*>::iterator liter
= fes
.begin(); liter
!= fes
.end();
576 RGWFrontend
*fe
= *liter
;
580 for (list
<RGWFrontend
*>::iterator liter
= fes
.begin(); liter
!= fes
.end();
582 RGWFrontend
*fe
= *liter
;
587 for (list
<RGWFrontendConfig
*>::iterator liter
= configs
.begin();
588 liter
!= configs
.end(); ++liter
) {
589 RGWFrontendConfig
*fec
= *liter
;
593 unregister_async_signal_handler(SIGHUP
, sighup_handler
);
594 unregister_async_signal_handler(SIGTERM
, handle_sigterm
);
595 unregister_async_signal_handler(SIGINT
, handle_sigterm
);
596 unregister_async_signal_handler(SIGUSR1
, handle_sigterm
);
597 shutdown_async_signal_handler();
599 rgw_log_usage_finalize();
603 RGWStoreManager::close_storage(store
);
604 rgw::auth::s3::LDAPEngine::shutdown();
606 rgw_shutdown_resolver();
607 rgw_http_client_cleanup();
608 rgw::curl::cleanup_curl();
609 #ifdef WITH_RADOSGW_AMQP_ENDPOINT
610 rgw::amqp::shutdown();
613 rgw_perf_stop(g_ceph_context
);
615 dout(1) << "final shutdown" << dendl
;
617 signal_fd_finalize();