summaryrefslogtreecommitdiffstats
path: root/src/messages/MDiscoverReply.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/messages/MDiscoverReply.h')
-rw-r--r--src/messages/MDiscoverReply.h212
1 files changed, 212 insertions, 0 deletions
diff --git a/src/messages/MDiscoverReply.h b/src/messages/MDiscoverReply.h
new file mode 100644
index 00000000..bd4f3475
--- /dev/null
+++ b/src/messages/MDiscoverReply.h
@@ -0,0 +1,212 @@
+// -*- 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) 2004-2006 Sage Weil <sage@newdream.net>
+ *
+ * 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_MDISCOVERREPLY_H
+#define CEPH_MDISCOVERREPLY_H
+
+#include "msg/Message.h"
+#include "include/filepath.h"
+
+#include <string>
+
+
+
+/**
+ * MDiscoverReply - return new replicas (of inodes, dirs, dentries)
+ *
+ * we group returned items by (dir, dentry, inode). each
+ * item in each set shares an index (it's "depth").
+ *
+ * we can start and end with any type.
+ * no_base_dir = true if the first group has an inode but no dir
+ * no_base_dentry = true if the first group has an inode but no dentry
+ * they are false if there is no returned data, ie the first group is empty.
+ *
+ * we also return errors:
+ * error_flag_dn(std::string) - the specified dentry dne
+ * error_flag_dir - the last item wasn't a dir, so we couldn't continue.
+ *
+ * and sometimes,
+ * dir_auth_hint - where we think the dir auth is
+ *
+ * depth() gives us the number of depth units/indices for which we have
+ * information. this INCLUDES those for which we have errors but no data.
+ *
+ * see MDCache::handle_discover, handle_discover_reply.
+ *
+ *
+ * so basically, we get
+ *
+ * dir den ino i
+ * x 0
+ * x x x 1
+ * or
+ * x x 0
+ * x x x 1
+ * or
+ * x x x 0
+ * x x x 1
+ * ...and trail off however we want.
+ *
+ *
+ */
+
+class MDiscoverReply : public MessageInstance<MDiscoverReply> {
+public:
+ friend factory;
+private:
+ static constexpr int HEAD_VERSION = 2;
+
+ // info about original request
+ inodeno_t base_ino;
+ frag_t base_dir_frag;
+ bool wanted_base_dir = false;
+ bool wanted_xlocked = false;
+ snapid_t wanted_snapid;
+
+ // and the response
+ bool flag_error_dn = false;
+ bool flag_error_dir = false;
+ std::string error_dentry; // dentry that was not found (to trigger waiters on asker)
+ bool unsolicited = false;
+
+ mds_rank_t dir_auth_hint = 0;
+
+ public:
+ __u8 starts_with = 0;
+ bufferlist trace;
+
+ enum { DIR, DENTRY, INODE };
+
+ // accessors
+ inodeno_t get_base_ino() const { return base_ino; }
+ frag_t get_base_dir_frag() const { return base_dir_frag; }
+ bool get_wanted_base_dir() const { return wanted_base_dir; }
+ bool get_wanted_xlocked() const { return wanted_xlocked; }
+ snapid_t get_wanted_snapid() const { return wanted_snapid; }
+
+ bool is_flag_error_dn() const { return flag_error_dn; }
+ bool is_flag_error_dir() const { return flag_error_dir; }
+ const std::string& get_error_dentry() const { return error_dentry; }
+
+ int get_starts_with() const { return starts_with; }
+
+ mds_rank_t get_dir_auth_hint() const { return dir_auth_hint; }
+
+ bool is_unsolicited() const { return unsolicited; }
+ void mark_unsolicited() { unsolicited = true; }
+
+ void set_base_dir_frag(frag_t df) { base_dir_frag = df; }
+
+protected:
+ MDiscoverReply() : MessageInstance(MSG_MDS_DISCOVERREPLY, HEAD_VERSION) { }
+ MDiscoverReply(const MDiscover &dis) :
+ MessageInstance(MSG_MDS_DISCOVERREPLY, HEAD_VERSION),
+ base_ino(dis.get_base_ino()),
+ base_dir_frag(dis.get_base_dir_frag()),
+ wanted_base_dir(dis.wants_base_dir()),
+ wanted_xlocked(dis.wants_xlocked()),
+ wanted_snapid(dis.get_snapid()),
+ flag_error_dn(false),
+ flag_error_dir(false),
+ unsolicited(false),
+ dir_auth_hint(CDIR_AUTH_UNKNOWN),
+ starts_with(DIR)
+ {
+ header.tid = dis.get_tid();
+ }
+ MDiscoverReply(dirfrag_t df) :
+ MessageInstance(MSG_MDS_DISCOVERREPLY, HEAD_VERSION),
+ base_ino(df.ino),
+ base_dir_frag(df.frag),
+ wanted_base_dir(false),
+ wanted_xlocked(false),
+ wanted_snapid(CEPH_NOSNAP),
+ flag_error_dn(false),
+ flag_error_dir(false),
+ unsolicited(false),
+ dir_auth_hint(CDIR_AUTH_UNKNOWN),
+ starts_with(DIR)
+ {
+ header.tid = 0;
+ }
+ ~MDiscoverReply() override {}
+
+public:
+ std::string_view get_type_name() const override { return "discover_reply"; }
+ void print(ostream& out) const override {
+ out << "discover_reply(" << header.tid << " " << base_ino << ")";
+ }
+
+ // builders
+ bool is_empty() const {
+ return trace.length() == 0 &&
+ !flag_error_dn &&
+ !flag_error_dir &&
+ dir_auth_hint == CDIR_AUTH_UNKNOWN;
+ }
+
+ // void set_flag_forward() { flag_forward = true; }
+ void set_flag_error_dn(std::string_view dn) {
+ flag_error_dn = true;
+ error_dentry = dn;
+ }
+ void set_flag_error_dir() {
+ flag_error_dir = true;
+ }
+ void set_dir_auth_hint(int a) {
+ dir_auth_hint = a;
+ }
+ void set_error_dentry(std::string_view dn) {
+ error_dentry = dn;
+ }
+
+
+ // ...
+ void decode_payload() override {
+ auto p = payload.cbegin();
+ decode(base_ino, p);
+ decode(base_dir_frag, p);
+ decode(wanted_base_dir, p);
+ decode(wanted_xlocked, p);
+ decode(wanted_snapid, p);
+ decode(flag_error_dn, p);
+ decode(flag_error_dir, p);
+ decode(error_dentry, p);
+ decode(dir_auth_hint, p);
+ decode(unsolicited, p);
+
+ decode(starts_with, p);
+ decode(trace, p);
+ }
+ void encode_payload(uint64_t features) override {
+ using ceph::encode;
+ encode(base_ino, payload);
+ encode(base_dir_frag, payload);
+ encode(wanted_base_dir, payload);
+ encode(wanted_xlocked, payload);
+ encode(wanted_snapid, payload);
+ encode(flag_error_dn, payload);
+ encode(flag_error_dir, payload);
+ encode(error_dentry, payload);
+ encode(dir_auth_hint, payload);
+ encode(unsolicited, payload);
+
+ encode(starts_with, payload);
+ encode(trace, payload);
+ }
+};
+
+#endif