[ceph.git] / ceph / src / rgw / services / svc_user_rados.h

// -*- mode:C++; tab-width:8; c-basic-offset:2; indent-tabs-mode:t -*-
// vim: ts=8 sw=2 smarttab ft=cpp

/*
 * Ceph - scalable distributed file system
 *
 * Copyright (C) 2019 Red Hat, Inc.
 *
 * 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.
 *
 */


#pragma once

#include "rgw/rgw_service.h"

#include "svc_meta_be.h"
#include "svc_user.h"

class RGWSI_RADOS;
class RGWSI_Zone;
class RGWSI_SysObj;
class RGWSI_SysObj_Cache;
class RGWSI_Meta;
class RGWSI_SyncModules;
class RGWSI_MetaBackend_Handler;

struct rgw_cache_entry_info;

class RGWUserBuckets;

class RGWGetUserHeader_CB;
class RGWGetUserStats_CB;

template <class T>
class RGWChainedCacheImpl;

class RGWSI_User_RADOS : public RGWSI_User
{
  friend class PutOperation;

  std::unique_ptr<RGWSI_MetaBackend::Module> be_module;
  RGWSI_MetaBackend_Handler *be_handler;

  struct user_info_cache_entry {
    RGWUserInfo info;
    RGWObjVersionTracker objv_tracker;
    real_time mtime;
  };

  using RGWChainedCacheImpl_user_info_cache_entry = RGWChainedCacheImpl<user_info_cache_entry>;
  unique_ptr<RGWChainedCacheImpl_user_info_cache_entry> uinfo_cache;

  rgw_raw_obj get_buckets_obj(const rgw_user& user_id) const;

  int get_user_info_from_index(RGWSI_MetaBackend::Context *ctx,
                               const string& key,
                               const rgw_pool& pool,
                               RGWUserInfo *info,
                               RGWObjVersionTracker * const objv_tracker,
                               real_time * const pmtime,
                               optional_yield y,
                               const DoutPrefixProvider *dpp);

  int remove_uid_index(RGWSI_MetaBackend::Context *ctx, const RGWUserInfo& user_info, RGWObjVersionTracker *objv_tracker,
                       optional_yield y, const DoutPrefixProvider *dpp);

  int remove_key_index(const DoutPrefixProvider *dpp, RGWSI_MetaBackend::Context *ctx, const RGWAccessKey& access_key, optional_yield y);
  int remove_email_index(const DoutPrefixProvider *dpp, RGWSI_MetaBackend::Context *ctx, const string& email, optional_yield y);
  int remove_swift_name_index(const DoutPrefixProvider *dpp, RGWSI_MetaBackend::Context *ctx, const string& swift_name, optional_yield y);

  /* admin management */
  int cls_user_update_buckets(const DoutPrefixProvider *dpp, rgw_raw_obj& obj, list<cls_user_bucket_entry>& entries, bool add, optional_yield y);
  int cls_user_add_bucket(const DoutPrefixProvider *dpp, rgw_raw_obj& obj, const cls_user_bucket_entry& entry, optional_yield y);
  int cls_user_remove_bucket(const DoutPrefixProvider *dpp, rgw_raw_obj& obj, const cls_user_bucket& bucket, optional_yield y);

  /* quota stats */
  int cls_user_flush_bucket_stats(const DoutPrefixProvider *dpp, rgw_raw_obj& user_obj,
                                  const RGWBucketEnt& ent, optional_yield y);
  int cls_user_list_buckets(const DoutPrefixProvider *dpp, 
                            rgw_raw_obj& obj,
                            const string& in_marker,
                            const string& end_marker,
                            const int max_entries,
                            list<cls_user_bucket_entry>& entries,
                            string * const out_marker,
                            bool * const truncated,
                            optional_yield y);

  int cls_user_reset_stats(const DoutPrefixProvider *dpp, const rgw_user& user, optional_yield y);
  int cls_user_get_header(const DoutPrefixProvider *dpp, const rgw_user& user, cls_user_header *header, optional_yield y);
  int cls_user_get_header_async(const DoutPrefixProvider *dpp, const string& user, RGWGetUserHeader_CB *cb);

  int do_start(optional_yield, const DoutPrefixProvider *dpp) override;
public:
  struct Svc {
    RGWSI_User_RADOS *user{nullptr};
    RGWSI_RADOS *rados{nullptr};
    RGWSI_Zone *zone{nullptr};
    RGWSI_SysObj *sysobj{nullptr};
    RGWSI_SysObj_Cache *cache{nullptr};
    RGWSI_Meta *meta{nullptr};
    RGWSI_MetaBackend *meta_be{nullptr};
    RGWSI_SyncModules *sync_modules{nullptr};
  } svc;

  RGWSI_User_RADOS(CephContext *cct);
  ~RGWSI_User_RADOS();

  void init(RGWSI_RADOS *_rados_svc,
            RGWSI_Zone *_zone_svc, RGWSI_SysObj *_sysobj_svc,
	    RGWSI_SysObj_Cache *_cache_svc, RGWSI_Meta *_meta_svc,
            RGWSI_MetaBackend *_meta_be_svc,
	    RGWSI_SyncModules *_sync_modules);

  RGWSI_MetaBackend_Handler *get_be_handler() override {
    return be_handler;
  }

  int read_user_info(RGWSI_MetaBackend::Context *ctx,
                     const rgw_user& user,
                     RGWUserInfo *info,
                     RGWObjVersionTracker * const objv_tracker,
                     real_time * const pmtime,
                     rgw_cache_entry_info * const cache_info,
                     map<string, bufferlist> * const pattrs,
                     optional_yield y,
                     const DoutPrefixProvider *dpp) override;

  int store_user_info(RGWSI_MetaBackend::Context *ctx,
                      const RGWUserInfo& info,
                      RGWUserInfo *old_info,
                      RGWObjVersionTracker *objv_tracker,
                      const real_time& mtime,
                      bool exclusive,
                      map<string, bufferlist> *attrs,
                      optional_yield y,
                      const DoutPrefixProvider *dpp) override;

  int remove_user_info(RGWSI_MetaBackend::Context *ctx,
                       const RGWUserInfo& info,
                       RGWObjVersionTracker *objv_tracker,
                       optional_yield y,
                       const DoutPrefixProvider *dpp) override;

  int get_user_info_by_email(RGWSI_MetaBackend::Context *ctx,
                             const string& email, RGWUserInfo *info,
                             RGWObjVersionTracker *objv_tracker,
                             real_time *pmtime,
                             optional_yield y,
                             const DoutPrefixProvider *dpp) override;
  int get_user_info_by_swift(RGWSI_MetaBackend::Context *ctx,
                             const string& swift_name,
                             RGWUserInfo *info,        /* out */
                             RGWObjVersionTracker * const objv_tracker,
                             real_time * const pmtime,
                             optional_yield y,
                             const DoutPrefixProvider *dpp) override;
  int get_user_info_by_access_key(RGWSI_MetaBackend::Context *ctx,
                                  const std::string& access_key,
                                  RGWUserInfo *info,
                                  RGWObjVersionTracker* objv_tracker,
                                  real_time *pmtime,
                                  optional_yield y,
                                  const DoutPrefixProvider *dpp) override;

  /* user buckets directory */

  int add_bucket(const DoutPrefixProvider *dpp, 
                 RGWSI_MetaBackend::Context *ctx,
                 const rgw_user& user,
                 const rgw_bucket& bucket,
                 ceph::real_time creation_time,
                 optional_yield y) override;
  int remove_bucket(const DoutPrefixProvider *dpp, 
                    RGWSI_MetaBackend::Context *ctx,
                    const rgw_user& user,
                    const rgw_bucket& _bucket,
                    optional_yield y) override;
  int list_buckets(const DoutPrefixProvider *dpp, 
                   RGWSI_MetaBackend::Context *ctx,
                   const rgw_user& user,
                   const string& marker,
                   const string& end_marker,
                   uint64_t max,
                   RGWUserBuckets *buckets,
                   bool *is_truncated,
                   optional_yield y) override;

  /* quota related */
  int flush_bucket_stats(const DoutPrefixProvider *dpp, 
                         RGWSI_MetaBackend::Context *ctx,
                         const rgw_user& user,
                         const RGWBucketEnt& ent, optional_yield y) override;

  int complete_flush_stats(const DoutPrefixProvider *dpp, 
                           RGWSI_MetaBackend::Context *ctx,
			   const rgw_user& user, optional_yield y) override;

  int reset_bucket_stats(const DoutPrefixProvider *dpp, 
                         RGWSI_MetaBackend::Context *ctx,
			 const rgw_user& user,
                         optional_yield y) override;
  int read_stats(const DoutPrefixProvider *dpp, 
                 RGWSI_MetaBackend::Context *ctx,
		 const rgw_user& user, RGWStorageStats *stats,
		 ceph::real_time *last_stats_sync,              /* last time a full stats sync completed */
		 ceph::real_time *last_stats_update,
                 optional_yield y) override;  /* last time a stats update was done */

  int read_stats_async(const DoutPrefixProvider *dpp, RGWSI_MetaBackend::Context *ctx,
		       const rgw_user& user, RGWGetUserStats_CB *cb) override;
};
Commit	Line	Data
9f95a23c TL	1	// -- mode:C++; tab-width:8; c-basic-offset:2; indent-tabs-mode:t --
	2	// vim: ts=8 sw=2 smarttab ft=cpp
	3
	4	/*
	5	* Ceph - scalable distributed file system
	6	*
	7	* Copyright (C) 2019 Red Hat, Inc.
	8	*
	9	* This is free software; you can redistribute it and/or
	10	* modify it under the terms of the GNU Lesser General Public
	11	* License version 2.1, as published by the Free Software
	12	* Foundation. See file COPYING.
	13	*
	14	*/
	15
	16
	17	#pragma once
	18
	19	#include "rgw/rgw_service.h"
	20
	21	#include "svc_meta_be.h"
	22	#include "svc_user.h"
	23
	24	class RGWSI_RADOS;
	25	class RGWSI_Zone;
	26	class RGWSI_SysObj;
	27	class RGWSI_SysObj_Cache;
	28	class RGWSI_Meta;
	29	class RGWSI_SyncModules;
	30	class RGWSI_MetaBackend_Handler;
	31
	32	struct rgw_cache_entry_info;
	33
	34	class RGWUserBuckets;
	35
	36	class RGWGetUserHeader_CB;
	37	class RGWGetUserStats_CB;
	38
	39	template <class T>
	40	class RGWChainedCacheImpl;
	41
	42	class RGWSI_User_RADOS : public RGWSI_User
	43	{
	44	friend class PutOperation;
	45
	46	std::unique_ptr<RGWSI_MetaBackend::Module> be_module;
	47	RGWSI_MetaBackend_Handler *be_handler;
	48
	49	struct user_info_cache_entry {
	50	RGWUserInfo info;
	51	RGWObjVersionTracker objv_tracker;
	52	real_time mtime;
	53	};
	54
	55	using RGWChainedCacheImpl_user_info_cache_entry = RGWChainedCacheImpl<user_info_cache_entry>;
	56	unique_ptr<RGWChainedCacheImpl_user_info_cache_entry> uinfo_cache;
	57
	58	rgw_raw_obj get_buckets_obj(const rgw_user& user_id) const;
	59
	60	int get_user_info_from_index(RGWSI_MetaBackend::Context *ctx,
	61	const string& key,
	62	const rgw_pool& pool,
	63	RGWUserInfo *info,
	64	RGWObjVersionTracker * const objv_tracker,
65	real_time * const pmtime,
b3b6e05e TL	66	optional_yield y,
b3b6e05e TL	67	const DoutPrefixProvider *dpp);
9f95a23c TL	68
9f95a23c TL	69	int remove_uid_index(RGWSI_MetaBackend::Context ctx, const RGWUserInfo& user_info, RGWObjVersionTracker objv_tracker,
b3b6e05e	70	optional_yield y, const DoutPrefixProvider *dpp);
9f95a23c	71
b3b6e05e TL	72	int remove_key_index(const DoutPrefixProvider dpp, RGWSI_MetaBackend::Context ctx, const RGWAccessKey& access_key, optional_yield y);
	73	int remove_email_index(const DoutPrefixProvider dpp, RGWSI_MetaBackend::Context ctx, const string& email, optional_yield y);
	74	int remove_swift_name_index(const DoutPrefixProvider dpp, RGWSI_MetaBackend::Context ctx, const string& swift_name, optional_yield y);
9f95a23c TL	75
9f95a23c TL	76	/* admin management */
b3b6e05e TL	77	int cls_user_update_buckets(const DoutPrefixProvider *dpp, rgw_raw_obj& obj, list<cls_user_bucket_entry>& entries, bool add, optional_yield y);
	78	int cls_user_add_bucket(const DoutPrefixProvider *dpp, rgw_raw_obj& obj, const cls_user_bucket_entry& entry, optional_yield y);
	79	int cls_user_remove_bucket(const DoutPrefixProvider *dpp, rgw_raw_obj& obj, const cls_user_bucket& bucket, optional_yield y);
9f95a23c TL	80
9f95a23c TL	81	/* quota stats */
b3b6e05e	82	int cls_user_flush_bucket_stats(const DoutPrefixProvider *dpp, rgw_raw_obj& user_obj,
f67539c2	83	const RGWBucketEnt& ent, optional_yield y);
b3b6e05e TL	84	int cls_user_list_buckets(const DoutPrefixProvider *dpp,
b3b6e05e TL	85	rgw_raw_obj& obj,
9f95a23c TL	86	const string& in_marker,
	87	const string& end_marker,
	88	const int max_entries,
	89	list<cls_user_bucket_entry>& entries,
	90	string * const out_marker,
f67539c2 TL	91	bool * const truncated,
f67539c2 TL	92	optional_yield y);
9f95a23c	93
b3b6e05e TL	94	int cls_user_reset_stats(const DoutPrefixProvider *dpp, const rgw_user& user, optional_yield y);
	95	int cls_user_get_header(const DoutPrefixProvider dpp, const rgw_user& user, cls_user_header header, optional_yield y);
	96	int cls_user_get_header_async(const DoutPrefixProvider dpp, const string& user, RGWGetUserHeader_CB cb);
9f95a23c	97
b3b6e05e	98	int do_start(optional_yield, const DoutPrefixProvider *dpp) override;
9f95a23c TL	99	public:
	100	struct Svc {
	101	RGWSI_User_RADOS *user{nullptr};
	102	RGWSI_RADOS *rados{nullptr};
	103	RGWSI_Zone *zone{nullptr};
	104	RGWSI_SysObj *sysobj{nullptr};
	105	RGWSI_SysObj_Cache *cache{nullptr};
	106	RGWSI_Meta *meta{nullptr};
	107	RGWSI_MetaBackend *meta_be{nullptr};
	108	RGWSI_SyncModules *sync_modules{nullptr};
	109	} svc;
	110
	111	RGWSI_User_RADOS(CephContext *cct);
	112	~RGWSI_User_RADOS();
	113
	114	void init(RGWSI_RADOS *_rados_svc,
	115	RGWSI_Zone _zone_svc, RGWSI_SysObj _sysobj_svc,
	116	RGWSI_SysObj_Cache _cache_svc, RGWSI_Meta _meta_svc,
	117	RGWSI_MetaBackend *_meta_be_svc,
	118	RGWSI_SyncModules *_sync_modules);
	119
	120	RGWSI_MetaBackend_Handler *get_be_handler() override {
	121	return be_handler;
	122	}
	123
	124	int read_user_info(RGWSI_MetaBackend::Context *ctx,
	125	const rgw_user& user,
	126	RGWUserInfo *info,
	127	RGWObjVersionTracker * const objv_tracker,
	128	real_time * const pmtime,
	129	rgw_cache_entry_info * const cache_info,
	130	map<string, bufferlist> * const pattrs,
b3b6e05e TL	131	optional_yield y,
b3b6e05e TL	132	const DoutPrefixProvider *dpp) override;
9f95a23c TL	133
	134	int store_user_info(RGWSI_MetaBackend::Context *ctx,
	135	const RGWUserInfo& info,
	136	RGWUserInfo *old_info,
	137	RGWObjVersionTracker *objv_tracker,
	138	const real_time& mtime,
	139	bool exclusive,
	140	map<string, bufferlist> *attrs,
b3b6e05e TL	141	optional_yield y,
b3b6e05e TL	142	const DoutPrefixProvider *dpp) override;
9f95a23c TL	143
	144	int remove_user_info(RGWSI_MetaBackend::Context *ctx,
	145	const RGWUserInfo& info,
	146	RGWObjVersionTracker *objv_tracker,
b3b6e05e TL	147	optional_yield y,
b3b6e05e TL	148	const DoutPrefixProvider *dpp) override;
9f95a23c TL	149
	150	int get_user_info_by_email(RGWSI_MetaBackend::Context *ctx,
	151	const string& email, RGWUserInfo *info,
	152	RGWObjVersionTracker *objv_tracker,
	153	real_time *pmtime,
b3b6e05e TL	154	optional_yield y,
b3b6e05e TL	155	const DoutPrefixProvider *dpp) override;
9f95a23c TL	156	int get_user_info_by_swift(RGWSI_MetaBackend::Context *ctx,
	157	const string& swift_name,
	158	RGWUserInfo info, / out */
	159	RGWObjVersionTracker * const objv_tracker,
	160	real_time * const pmtime,
b3b6e05e TL	161	optional_yield y,
b3b6e05e TL	162	const DoutPrefixProvider *dpp) override;
9f95a23c TL	163	int get_user_info_by_access_key(RGWSI_MetaBackend::Context *ctx,
	164	const std::string& access_key,
	165	RGWUserInfo *info,
	166	RGWObjVersionTracker* objv_tracker,
	167	real_time *pmtime,
b3b6e05e TL	168	optional_yield y,
b3b6e05e TL	169	const DoutPrefixProvider *dpp) override;
9f95a23c TL	170
	171	/* user buckets directory */
	172
b3b6e05e TL	173	int add_bucket(const DoutPrefixProvider *dpp,
b3b6e05e TL	174	RGWSI_MetaBackend::Context *ctx,
9f95a23c TL	175	const rgw_user& user,
9f95a23c TL	176	const rgw_bucket& bucket,
f67539c2 TL	177	ceph::real_time creation_time,
f67539c2 TL	178	optional_yield y) override;
b3b6e05e TL	179	int remove_bucket(const DoutPrefixProvider *dpp,
b3b6e05e TL	180	RGWSI_MetaBackend::Context *ctx,
9f95a23c	181	const rgw_user& user,
f67539c2 TL	182	const rgw_bucket& _bucket,
f67539c2 TL	183	optional_yield y) override;
b3b6e05e TL	184	int list_buckets(const DoutPrefixProvider *dpp,
b3b6e05e TL	185	RGWSI_MetaBackend::Context *ctx,
9f95a23c TL	186	const rgw_user& user,
	187	const string& marker,
	188	const string& end_marker,
	189	uint64_t max,
	190	RGWUserBuckets *buckets,
f67539c2 TL	191	bool *is_truncated,
f67539c2 TL	192	optional_yield y) override;
9f95a23c TL	193
9f95a23c TL	194	/* quota related */
b3b6e05e TL	195	int flush_bucket_stats(const DoutPrefixProvider *dpp,
b3b6e05e TL	196	RGWSI_MetaBackend::Context *ctx,
9f95a23c	197	const rgw_user& user,
f67539c2	198	const RGWBucketEnt& ent, optional_yield y) override;
9f95a23c	199
b3b6e05e TL	200	int complete_flush_stats(const DoutPrefixProvider *dpp,
b3b6e05e TL	201	RGWSI_MetaBackend::Context *ctx,
f67539c2	202	const rgw_user& user, optional_yield y) override;
9f95a23c	203
b3b6e05e TL	204	int reset_bucket_stats(const DoutPrefixProvider *dpp,
b3b6e05e TL	205	RGWSI_MetaBackend::Context *ctx,
f67539c2 TL	206	const rgw_user& user,
f67539c2 TL	207	optional_yield y) override;
b3b6e05e TL	208	int read_stats(const DoutPrefixProvider *dpp,
b3b6e05e TL	209	RGWSI_MetaBackend::Context *ctx,
9f95a23c TL	210	const rgw_user& user, RGWStorageStats *stats,
9f95a23c TL	211	ceph::real_time last_stats_sync, / last time a full stats sync completed */
f67539c2 TL	212	ceph::real_time *last_stats_update,
f67539c2 TL	213	optional_yield y) override; /* last time a stats update was done */
9f95a23c	214
b3b6e05e	215	int read_stats_async(const DoutPrefixProvider dpp, RGWSI_MetaBackend::Context ctx,
9f95a23c TL	216	const rgw_user& user, RGWGetUserStats_CB *cb) override;
	217	};
	218