1 // -*- mode:C++; tab-width:8; c-basic-offset:2; indent-tabs-mode:t -*-
2 // vim: ts=8 sw=2 smarttab
12 #include "include/types.h"
14 #include "global/global_context.h"
18 #include "messages/MPGStats.h"
20 #include "messages/MGenericMessage.h"
22 #include "messages/MPGStatsAck.h"
24 #include "messages/MStatfs.h"
25 #include "messages/MStatfsReply.h"
27 #include "messages/MGetPoolStats.h"
28 #include "messages/MGetPoolStatsReply.h"
31 #include "messages/MPoolOp.h"
32 #include "messages/MPoolOpReply.h"
34 #include "messages/PaxosServiceMessage.h"
35 #include "messages/MMonCommand.h"
36 #include "messages/MMonCommandAck.h"
37 #include "messages/MMonPaxos.h"
39 #include "messages/MMonProbe.h"
40 #include "messages/MMonJoin.h"
41 #include "messages/MMonElection.h"
42 #include "messages/MMonSync.h"
43 #include "messages/MMonScrub.h"
45 #include "messages/MLog.h"
46 #include "messages/MLogAck.h"
48 #include "messages/MPing.h"
50 #include "messages/MCommand.h"
51 #include "messages/MCommandReply.h"
52 #include "messages/MBackfillReserve.h"
53 #include "messages/MRecoveryReserve.h"
55 #include "messages/MRoute.h"
56 #include "messages/MForward.h"
58 #include "messages/MOSDBoot.h"
59 #include "messages/MOSDAlive.h"
60 #include "messages/MOSDBeacon.h"
61 #include "messages/MOSDPGTemp.h"
62 #include "messages/MOSDFailure.h"
63 #include "messages/MOSDMarkMeDown.h"
64 #include "messages/MOSDFull.h"
65 #include "messages/MOSDPing.h"
66 #include "messages/MOSDOp.h"
67 #include "messages/MOSDOpReply.h"
68 #include "messages/MOSDSubOp.h"
69 #include "messages/MOSDSubOpReply.h"
70 #include "messages/MOSDRepOp.h"
71 #include "messages/MOSDRepOpReply.h"
72 #include "messages/MOSDMap.h"
73 #include "messages/MMonGetOSDMap.h"
75 #include "messages/MOSDPGCreated.h"
76 #include "messages/MOSDPGNotify.h"
77 #include "messages/MOSDPGQuery.h"
78 #include "messages/MOSDPGLog.h"
79 #include "messages/MOSDPGRemove.h"
80 #include "messages/MOSDPGInfo.h"
81 #include "messages/MOSDPGCreate.h"
82 #include "messages/MOSDPGTrim.h"
83 #include "messages/MOSDScrub.h"
84 #include "messages/MOSDScrubReserve.h"
85 #include "messages/MOSDRepScrub.h"
86 #include "messages/MOSDRepScrubMap.h"
87 #include "messages/MOSDPGScan.h"
88 #include "messages/MOSDPGBackfill.h"
89 #include "messages/MOSDBackoff.h"
90 #include "messages/MOSDPGBackfillRemove.h"
92 #include "messages/MRemoveSnaps.h"
94 #include "messages/MMonMap.h"
95 #include "messages/MMonGetMap.h"
96 #include "messages/MMonGetVersion.h"
97 #include "messages/MMonGetVersionReply.h"
98 #include "messages/MMonHealth.h"
99 #include "messages/MMonMetadata.h"
100 #include "messages/MDataPing.h"
101 #include "messages/MAuth.h"
102 #include "messages/MAuthReply.h"
103 #include "messages/MMonSubscribe.h"
104 #include "messages/MMonSubscribeAck.h"
105 #include "messages/MMonGlobalID.h"
106 #include "messages/MClientSession.h"
107 #include "messages/MClientReconnect.h"
108 #include "messages/MClientRequest.h"
109 #include "messages/MClientRequestForward.h"
110 #include "messages/MClientReply.h"
111 #include "messages/MClientCaps.h"
112 #include "messages/MClientCapRelease.h"
113 #include "messages/MClientLease.h"
114 #include "messages/MClientSnap.h"
115 #include "messages/MClientQuota.h"
117 #include "messages/MMDSSlaveRequest.h"
119 #include "messages/MMDSMap.h"
120 #include "messages/MFSMap.h"
121 #include "messages/MFSMapUser.h"
122 #include "messages/MMDSBeacon.h"
123 #include "messages/MMDSLoadTargets.h"
124 #include "messages/MMDSResolve.h"
125 #include "messages/MMDSResolveAck.h"
126 #include "messages/MMDSCacheRejoin.h"
127 #include "messages/MMDSFindIno.h"
128 #include "messages/MMDSFindInoReply.h"
129 #include "messages/MMDSOpenIno.h"
130 #include "messages/MMDSOpenInoReply.h"
132 #include "messages/MDirUpdate.h"
133 #include "messages/MDiscover.h"
134 #include "messages/MDiscoverReply.h"
136 #include "messages/MMDSFragmentNotify.h"
138 #include "messages/MExportDirDiscover.h"
139 #include "messages/MExportDirDiscoverAck.h"
140 #include "messages/MExportDirCancel.h"
141 #include "messages/MExportDirPrep.h"
142 #include "messages/MExportDirPrepAck.h"
143 #include "messages/MExportDir.h"
144 #include "messages/MExportDirAck.h"
145 #include "messages/MExportDirNotify.h"
146 #include "messages/MExportDirNotifyAck.h"
147 #include "messages/MExportDirFinish.h"
149 #include "messages/MExportCaps.h"
150 #include "messages/MExportCapsAck.h"
151 #include "messages/MGatherCaps.h"
154 #include "messages/MDentryUnlink.h"
155 #include "messages/MDentryLink.h"
157 #include "messages/MHeartbeat.h"
159 #include "messages/MMDSTableRequest.h"
161 //#include "messages/MInodeUpdate.h"
162 #include "messages/MCacheExpire.h"
163 #include "messages/MInodeFileCaps.h"
165 #include "messages/MMgrBeacon.h"
166 #include "messages/MMgrMap.h"
167 #include "messages/MMgrDigest.h"
168 #include "messages/MMgrReport.h"
169 #include "messages/MMgrOpen.h"
170 #include "messages/MMgrConfigure.h"
171 #include "messages/MMonMgrReport.h"
173 #include "messages/MLock.h"
175 #include "messages/MWatchNotify.h"
176 #include "messages/MTimeCheck.h"
178 #include "common/config.h"
180 #include "messages/MOSDPGPush.h"
181 #include "messages/MOSDPGPushReply.h"
182 #include "messages/MOSDPGPull.h"
184 #include "messages/MOSDECSubOpWrite.h"
185 #include "messages/MOSDECSubOpWriteReply.h"
186 #include "messages/MOSDECSubOpRead.h"
187 #include "messages/MOSDECSubOpReadReply.h"
189 #include "messages/MOSDPGUpdateLogMissing.h"
190 #include "messages/MOSDPGUpdateLogMissingReply.h"
192 #define DEBUGLVL 10 // debug level of output
194 #define dout_subsys ceph_subsys_ms
196 void Message::encode(uint64_t features
, int crcflags
)
198 // encode and copy out of *m
199 if (empty_payload()) {
200 assert(middle
.length() == 0);
201 encode_payload(features
);
203 if (byte_throttler
) {
204 byte_throttler
->take(payload
.length() + middle
.length());
207 // if the encoder didn't specify past compatibility, we assume it
209 if (header
.compat_version
== 0)
210 header
.compat_version
= header
.version
;
212 if (crcflags
& MSG_CRC_HEADER
)
216 header
.front_len
= get_payload().length();
217 header
.middle_len
= get_middle().length();
218 header
.data_len
= get_data().length();
219 if (crcflags
& MSG_CRC_HEADER
)
222 footer
.flags
= CEPH_MSG_FOOTER_COMPLETE
;
224 if (crcflags
& MSG_CRC_DATA
) {
229 ::encode(get_header(), bl
);
231 // dump the old footer format
232 ceph_msg_footer_old old_footer
;
233 old_footer
.front_crc
= footer
.front_crc
;
234 old_footer
.middle_crc
= footer
.middle_crc
;
235 old_footer
.data_crc
= footer
.data_crc
;
236 old_footer
.flags
= footer
.flags
;
237 ::encode(old_footer
, bl
);
239 ::encode(get_payload(), bl
);
240 ::encode(get_middle(), bl
);
241 ::encode(get_data(), bl
);
243 // this is almost an exponential backoff, except because we count
244 // bits we tend to sample things we encode later, which should be
245 // more representative.
249 for (unsigned t
= i
; t
; bits
++)
254 snprintf(fn
, sizeof(fn
), ENCODE_STRINGIFY(ENCODE_DUMP
) "/%s__%d.%x",
255 abi::__cxa_demangle(typeid(*this).name(), 0, 0, &status
),
257 int fd
= ::open(fn
, O_WRONLY
|O_TRUNC
|O_CREAT
, 0644);
265 footer
.flags
= (unsigned)footer
.flags
| CEPH_MSG_FOOTER_NOCRC
;
269 void Message::dump(Formatter
*f
) const
273 f
->dump_string("summary", ss
.str());
276 Message
*decode_message(CephContext
*cct
, int crcflags
,
277 ceph_msg_header
& header
,
278 ceph_msg_footer
& footer
,
279 bufferlist
& front
, bufferlist
& middle
,
280 bufferlist
& data
, Connection
* conn
)
283 if (crcflags
& MSG_CRC_HEADER
) {
284 __u32 front_crc
= front
.crc32c(0);
285 __u32 middle_crc
= middle
.crc32c(0);
287 if (front_crc
!= footer
.front_crc
) {
289 ldout(cct
, 0) << "bad crc in front " << front_crc
<< " != exp " << footer
.front_crc
<< dendl
;
290 ldout(cct
, 20) << " ";
291 front
.hexdump(*_dout
);
296 if (middle_crc
!= footer
.middle_crc
) {
298 ldout(cct
, 0) << "bad crc in middle " << middle_crc
<< " != exp " << footer
.middle_crc
<< dendl
;
299 ldout(cct
, 20) << " ";
300 middle
.hexdump(*_dout
);
306 if (crcflags
& MSG_CRC_DATA
) {
307 if ((footer
.flags
& CEPH_MSG_FOOTER_NOCRC
) == 0) {
308 __u32 data_crc
= data
.crc32c(0);
309 if (data_crc
!= footer
.data_crc
) {
311 ldout(cct
, 0) << "bad crc in data " << data_crc
<< " != exp " << footer
.data_crc
<< dendl
;
312 ldout(cct
, 20) << " ";
313 data
.hexdump(*_dout
);
323 int type
= header
.type
;
326 // -- with payload --
335 case CEPH_MSG_STATFS
:
338 case CEPH_MSG_STATFS_REPLY
:
339 m
= new MStatfsReply
;
341 case MSG_GETPOOLSTATS
:
342 m
= new MGetPoolStats
;
344 case MSG_GETPOOLSTATSREPLY
:
345 m
= new MGetPoolStatsReply
;
347 case CEPH_MSG_POOLOP
:
350 case CEPH_MSG_POOLOP_REPLY
:
351 m
= new MPoolOpReply
;
353 case MSG_MON_COMMAND
:
356 case MSG_MON_COMMAND_ACK
:
357 m
= new MMonCommandAck
;
369 case MSG_MON_ELECTION
:
370 m
= new MMonElection
;
392 case MSG_COMMAND_REPLY
:
393 m
= new MCommandReply
;
395 case MSG_OSD_BACKFILL_RESERVE
:
396 m
= new MBackfillReserve
;
398 case MSG_OSD_RECOVERY_RESERVE
:
399 m
= new MRecoveryReserve
;
409 case CEPH_MSG_MON_MAP
:
412 case CEPH_MSG_MON_GET_MAP
:
415 case CEPH_MSG_MON_GET_OSDMAP
:
416 m
= new MMonGetOSDMap
;
418 case CEPH_MSG_MON_GET_VERSION
:
419 m
= new MMonGetVersion();
421 case CEPH_MSG_MON_GET_VERSION_REPLY
:
422 m
= new MMonGetVersionReply();
424 case CEPH_MSG_MON_METADATA
:
425 m
= new MMonMetadata();
435 m
= new MOSDBeacon();
440 case MSG_OSD_FAILURE
:
441 m
= new MOSDFailure();
443 case MSG_OSD_MARK_ME_DOWN
:
444 m
= new MOSDMarkMeDown();
452 case CEPH_MSG_OSD_OP
:
455 case CEPH_MSG_OSD_OPREPLY
:
456 m
= new MOSDOpReply();
461 case MSG_OSD_SUBOPREPLY
:
462 m
= new MOSDSubOpReply();
467 case MSG_OSD_REPOPREPLY
:
468 m
= new MOSDRepOpReply();
470 case MSG_OSD_PG_CREATED
:
471 m
= new MOSDPGCreated();
473 case MSG_OSD_PG_UPDATE_LOG_MISSING
:
474 m
= new MOSDPGUpdateLogMissing();
476 case MSG_OSD_PG_UPDATE_LOG_MISSING_REPLY
:
477 m
= new MOSDPGUpdateLogMissingReply();
479 case CEPH_MSG_OSD_BACKOFF
:
483 case CEPH_MSG_OSD_MAP
:
487 case CEPH_MSG_WATCH_NOTIFY
:
488 m
= new MWatchNotify
;
491 case MSG_OSD_PG_NOTIFY
:
492 m
= new MOSDPGNotify
;
494 case MSG_OSD_PG_QUERY
:
500 case MSG_OSD_PG_REMOVE
:
501 m
= new MOSDPGRemove
;
503 case MSG_OSD_PG_INFO
:
506 case MSG_OSD_PG_CREATE
:
507 m
= new MOSDPGCreate
;
509 case MSG_OSD_PG_TRIM
:
516 case MSG_OSD_SCRUB_RESERVE
:
517 m
= new MOSDScrubReserve
;
519 case MSG_REMOVE_SNAPS
:
520 m
= new MRemoveSnaps
;
522 case MSG_OSD_REP_SCRUB
:
523 m
= new MOSDRepScrub
;
525 case MSG_OSD_REP_SCRUBMAP
:
526 m
= new MOSDRepScrubMap
;
528 case MSG_OSD_PG_SCAN
:
531 case MSG_OSD_PG_BACKFILL
:
532 m
= new MOSDPGBackfill
;
534 case MSG_OSD_PG_BACKFILL_REMOVE
:
535 m
= new MOSDPGBackfillRemove
;
537 case MSG_OSD_PG_PUSH
:
540 case MSG_OSD_PG_PULL
:
543 case MSG_OSD_PG_PUSH_REPLY
:
544 m
= new MOSDPGPushReply
;
546 case MSG_OSD_EC_WRITE
:
547 m
= new MOSDECSubOpWrite
;
549 case MSG_OSD_EC_WRITE_REPLY
:
550 m
= new MOSDECSubOpWriteReply
;
552 case MSG_OSD_EC_READ
:
553 m
= new MOSDECSubOpRead
;
555 case MSG_OSD_EC_READ_REPLY
:
556 m
= new MOSDECSubOpReadReply
;
562 case CEPH_MSG_AUTH_REPLY
:
566 case MSG_MON_GLOBAL_ID
:
567 m
= new MMonGlobalID
;
571 case CEPH_MSG_MON_SUBSCRIBE
:
572 m
= new MMonSubscribe
;
574 case CEPH_MSG_MON_SUBSCRIBE_ACK
:
575 m
= new MMonSubscribeAck
;
577 case CEPH_MSG_CLIENT_SESSION
:
578 m
= new MClientSession
;
580 case CEPH_MSG_CLIENT_RECONNECT
:
581 m
= new MClientReconnect
;
583 case CEPH_MSG_CLIENT_REQUEST
:
584 m
= new MClientRequest
;
586 case CEPH_MSG_CLIENT_REQUEST_FORWARD
:
587 m
= new MClientRequestForward
;
589 case CEPH_MSG_CLIENT_REPLY
:
590 m
= new MClientReply
;
592 case CEPH_MSG_CLIENT_CAPS
:
595 case CEPH_MSG_CLIENT_CAPRELEASE
:
596 m
= new MClientCapRelease
;
598 case CEPH_MSG_CLIENT_LEASE
:
599 m
= new MClientLease
;
601 case CEPH_MSG_CLIENT_SNAP
:
604 case CEPH_MSG_CLIENT_QUOTA
:
605 m
= new MClientQuota
;
609 case MSG_MDS_SLAVE_REQUEST
:
610 m
= new MMDSSlaveRequest
;
613 case CEPH_MSG_MDS_MAP
:
616 case CEPH_MSG_FS_MAP
:
619 case CEPH_MSG_FS_MAP_USER
:
625 case MSG_MDS_OFFLOAD_TARGETS
:
626 m
= new MMDSLoadTargets
;
628 case MSG_MDS_RESOLVE
:
631 case MSG_MDS_RESOLVEACK
:
632 m
= new MMDSResolveAck
;
634 case MSG_MDS_CACHEREJOIN
:
635 m
= new MMDSCacheRejoin
;
638 case MSG_MDS_DIRUPDATE
:
639 m
= new MDirUpdate();
642 case MSG_MDS_DISCOVER
:
645 case MSG_MDS_DISCOVERREPLY
:
646 m
= new MDiscoverReply();
649 case MSG_MDS_FINDINO
:
652 case MSG_MDS_FINDINOREPLY
:
653 m
= new MMDSFindInoReply
;
656 case MSG_MDS_OPENINO
:
659 case MSG_MDS_OPENINOREPLY
:
660 m
= new MMDSOpenInoReply
;
663 case MSG_MDS_FRAGMENTNOTIFY
:
664 m
= new MMDSFragmentNotify
;
667 case MSG_MDS_EXPORTDIRDISCOVER
:
668 m
= new MExportDirDiscover();
670 case MSG_MDS_EXPORTDIRDISCOVERACK
:
671 m
= new MExportDirDiscoverAck();
673 case MSG_MDS_EXPORTDIRCANCEL
:
674 m
= new MExportDirCancel();
677 case MSG_MDS_EXPORTDIR
:
680 case MSG_MDS_EXPORTDIRACK
:
681 m
= new MExportDirAck
;
683 case MSG_MDS_EXPORTDIRFINISH
:
684 m
= new MExportDirFinish
;
687 case MSG_MDS_EXPORTDIRNOTIFY
:
688 m
= new MExportDirNotify();
691 case MSG_MDS_EXPORTDIRNOTIFYACK
:
692 m
= new MExportDirNotifyAck();
695 case MSG_MDS_EXPORTDIRPREP
:
696 m
= new MExportDirPrep();
699 case MSG_MDS_EXPORTDIRPREPACK
:
700 m
= new MExportDirPrepAck();
703 case MSG_MDS_EXPORTCAPS
:
706 case MSG_MDS_EXPORTCAPSACK
:
707 m
= new MExportCapsAck
;
709 case MSG_MDS_GATHERCAPS
:
714 case MSG_MDS_DENTRYUNLINK
:
715 m
= new MDentryUnlink
;
717 case MSG_MDS_DENTRYLINK
:
721 case MSG_MDS_HEARTBEAT
:
722 m
= new MHeartbeat();
725 case MSG_MDS_CACHEEXPIRE
:
726 m
= new MCacheExpire();
729 case MSG_MDS_TABLE_REQUEST
:
730 m
= new MMDSTableRequest
;
733 /* case MSG_MDS_INODEUPDATE:
734 m = new MInodeUpdate();
738 case MSG_MDS_INODEFILECAPS
:
739 m
= new MInodeFileCaps();
747 m
= new MMgrBeacon();
750 case MSG_MON_MGR_REPORT
:
751 m
= new MMonMgrReport();
759 m
= new MMgrDigest();
767 m
= new MMgrReport();
770 case MSG_MGR_CONFIGURE
:
771 m
= new MMgrConfigure();
775 m
= new MTimeCheck();
779 m
= new MMonHealth();
781 #if defined(HAVE_XIO)
786 // -- simple messages without payload --
788 case CEPH_MSG_SHUTDOWN
:
789 m
= new MGenericMessage(type
);
794 ldout(cct
, 0) << "can't decode unknown message type " << type
<< " MSG_AUTH=" << CEPH_MSG_AUTH
<< dendl
;
795 if (cct
->_conf
->ms_die_on_bad_msg
)
803 // m->header.version, if non-zero, should be populated with the
804 // newest version of the encoding the code supports. If set, check
805 // it against compat_version.
806 if (m
->get_header().version
&&
807 m
->get_header().version
< header
.compat_version
) {
809 ldout(cct
, 0) << "will not decode message of type " << type
810 << " version " << header
.version
811 << " because compat_version " << header
.compat_version
812 << " > supported version " << m
->get_header().version
<< dendl
;
813 if (cct
->_conf
->ms_die_on_bad_msg
)
820 m
->set_connection(conn
);
821 m
->set_header(header
);
822 m
->set_footer(footer
);
823 m
->set_payload(front
);
824 m
->set_middle(middle
);
830 catch (const buffer::error
&e
) {
832 lderr(cct
) << "failed to decode message of type " << type
833 << " v" << header
.version
834 << ": " << e
.what() << dendl
;
835 ldout(cct
, cct
->_conf
->ms_dump_corrupt_message_level
) << "dump: \n";
836 m
->get_payload().hexdump(*_dout
);
838 if (cct
->_conf
->ms_die_on_bad_msg
)
849 void Message::encode_trace(bufferlist
&bl
, uint64_t features
) const
851 auto p
= trace
.get_info();
852 static const blkin_trace_info empty
= { 0, 0, 0 };
859 void Message::decode_trace(bufferlist::iterator
&p
, bool create
)
861 blkin_trace_info info
= {};
868 const auto msgr
= connection
->get_messenger();
869 const auto endpoint
= msgr
->get_trace_endpoint();
871 trace
.init(get_type_name(), endpoint
, &info
, true);
872 trace
.event("decoded trace");
873 } else if (create
|| (msgr
->get_myname().is_osd() &&
874 msgr
->cct
->_conf
->osd_blkin_trace_all
)) {
875 // create a trace even if we didn't get one on the wire
876 trace
.init(get_type_name(), endpoint
);
877 trace
.event("created trace");
879 trace
.keyval("tid", get_tid());
880 trace
.keyval("entity type", get_source().type_str());
881 trace
.keyval("entity num", get_source().num());
886 // This routine is not used for ordinary messages, but only when encapsulating a message
887 // for forwarding and routing. It's also used in a backward compatibility test, which only
888 // effectively tests backward compability for those functions. To avoid backward compatibility
889 // problems, we currently always encode and decode using the old footer format that doesn't
890 // allow for message authentication. Eventually we should fix that. PLR
892 void encode_message(Message
*msg
, uint64_t features
, bufferlist
& payload
)
894 bufferlist front
, middle
, data
;
895 ceph_msg_footer_old old_footer
;
896 ceph_msg_footer footer
;
897 msg
->encode(features
, MSG_CRC_ALL
);
898 ::encode(msg
->get_header(), payload
);
900 // Here's where we switch to the old footer format. PLR
902 footer
= msg
->get_footer();
903 old_footer
.front_crc
= footer
.front_crc
;
904 old_footer
.middle_crc
= footer
.middle_crc
;
905 old_footer
.data_crc
= footer
.data_crc
;
906 old_footer
.flags
= footer
.flags
;
907 ::encode(old_footer
, payload
);
909 ::encode(msg
->get_payload(), payload
);
910 ::encode(msg
->get_middle(), payload
);
911 ::encode(msg
->get_data(), payload
);
914 // See above for somewhat bogus use of the old message footer. We switch to the current footer
915 // after decoding the old one so the other form of decode_message() doesn't have to change.
916 // We've slipped in a 0 signature at this point, so any signature checking after this will
919 Message
*decode_message(CephContext
*cct
, int crcflags
, bufferlist::iterator
& p
)
922 ceph_msg_footer_old fo
;
924 bufferlist fr
, mi
, da
;
927 f
.front_crc
= fo
.front_crc
;
928 f
.middle_crc
= fo
.middle_crc
;
929 f
.data_crc
= fo
.data_crc
;
935 return decode_message(cct
, crcflags
, h
, f
, fr
, mi
, da
, nullptr);