blob: db28b9043c8964fe6c1cf9e4aa83e5bcf9622c3d [file] [log] [blame]
Zhenkai Zhu8d935c82012-03-06 10:44:12 -08001/* -*- Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil -*- */
2/*
3 * Copyright (c) 2012 University of California, Los Angeles
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2 as
7 * published by the Free Software Foundation;
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 *
18 * Author: Zhenkai Zhu <zhenkai@cs.ucla.edu>
Chaoyi Bian3e1eb162012-04-03 16:59:32 -070019 * Chaoyi Bian <bcy@pku.edu.cn>
Alexander Afanasyevc1030192012-03-08 22:21:28 -080020 * Alexander Afanasyev <alexander.afanasyev@ucla.edu>
Zhenkai Zhu8d935c82012-03-06 10:44:12 -080021 */
22
Chaoyi Bian11f294f2012-03-08 14:28:06 -080023#ifndef SYNC_LOGIC_H
24#define SYNC_LOGIC_H
Alexander Afanasyev45fba082012-03-12 18:05:24 -070025
Zhenkai Zhu8d935c82012-03-06 10:44:12 -080026#include <boost/shared_ptr.hpp>
Alexander Afanasyev750d1872012-03-12 15:33:56 -070027#include <boost/thread/recursive_mutex.hpp>
Alexander Afanasyev45fba082012-03-12 18:05:24 -070028#include <boost/random.hpp>
Zhenkai Zhuce66e212012-03-12 22:27:19 -070029#include <memory>
Zhenkai Zhud5aec4b2012-10-09 12:01:19 -070030#include <map>
Alexander Afanasyev387ac952012-03-11 23:49:27 -070031
Yingdi Yu46c9f1a2013-12-18 15:15:46 +080032#include <ndn-cpp/face.hpp>
33#include <ndn-cpp/security/identity/identity-manager.hpp>
34
Zhenkai Zhu8d935c82012-03-06 10:44:12 -080035#include "sync-interest-table.h"
Zhenkai Zhu8d935c82012-03-06 10:44:12 -080036#include "sync-diff-state.h"
37#include "sync-full-state.h"
Chaoyi Bian4194b742012-03-08 17:21:35 -080038#include "sync-std-name-info.h"
Alexander Afanasyev45fba082012-03-12 18:05:24 -070039#include "sync-scheduler.h"
Yingdi Yu43e71612013-10-30 22:19:31 -070040#include "sync-policy-manager.h"
Zhenkai Zhu8d935c82012-03-06 10:44:12 -080041
Alexander Afanasyevc1030192012-03-08 22:21:28 -080042#include "sync-diff-state-container.h"
43
Alexander Afanasyev860e6fe2012-03-15 17:30:31 -070044#ifdef _DEBUG
45#ifdef HAVE_LOG4CXX
46#include <log4cxx/logger.h>
47#endif
48#endif
49
Alexander Afanasyev181d7e52012-04-09 13:54:11 -070050#ifdef NS3_MODULE
51#include <ns3/application.h>
Alexander Afanasyev73f7f9a2012-04-09 15:45:47 -070052#include <ns3/random-variable.h>
Alexander Afanasyev181d7e52012-04-09 13:54:11 -070053#endif
54
Zhenkai Zhu8d935c82012-03-06 10:44:12 -080055namespace Sync {
56
Zhenkai Zhu1cb29292012-05-31 22:54:34 -070057struct MissingDataInfo {
58 std::string prefix;
59 SeqNo low;
60 SeqNo high;
61};
62
Zhenkai Zhu8d935c82012-03-06 10:44:12 -080063/**
64 * \ingroup sync
Zhenkai Zhuaae81522012-03-06 11:05:44 -080065 * @brief A wrapper for SyncApp, which handles ccnx related things (process
66 * interests and data)
Zhenkai Zhu8d935c82012-03-06 10:44:12 -080067 */
Zhenkai Zhub9f19592012-10-16 14:27:38 -070068
Chaoyi Bian11f294f2012-03-08 14:28:06 -080069class SyncLogic
Alexander Afanasyev181d7e52012-04-09 13:54:11 -070070#ifdef NS3_MODULE
71 : public ns3::Application
72#endif
Zhenkai Zhu8d935c82012-03-06 10:44:12 -080073{
74public:
Zhenkai Zhu1cb29292012-05-31 22:54:34 -070075 //typedef boost::function< void ( const std::string &/*prefix*/, const SeqNo &/*newSeq*/, const SeqNo &/*oldSeq*/ ) > LogicUpdateCallback;
76 typedef boost::function< void (const std::vector<MissingDataInfo> & ) > LogicUpdateCallback;
Alexander Afanasyevd95c2312013-11-07 13:45:34 -080077 typedef boost::function< void (const std::string &/*prefix*/ ) > LogicRemoveCallback;
Zhenkai Zhub9f19592012-10-16 14:27:38 -070078 typedef boost::function< void (const std::string &)> LogicPerBranchCallback;
Chaoyi Bian89ee2dc2012-03-09 14:06:01 -080079
Alexander Afanasyevc1030192012-03-08 22:21:28 -080080 /**
Alexander Afanasyev172d2b72012-03-08 23:43:39 -080081 * @brief Constructor
Alexander Afanasyevc1030192012-03-08 22:21:28 -080082 * @param syncPrefix the name prefix to use for the Sync Interest
Alexander Afanasyev03a58b72012-03-12 18:11:56 -070083 * @param onUpdate function that will be called when new state is detected
84 * @param onRemove function that will be called when state is removed
Alexander Afanasyev172d2b72012-03-08 23:43:39 -080085 * @param ccnxHandle ccnx handle
Alexander Afanasyevc1030192012-03-08 22:21:28 -080086 * the app data when new remote names are learned
87 */
Yingdi Yu43e71612013-10-30 22:19:31 -070088 SyncLogic (const ndn::Name& syncPrefix,
Yingdi Yu46c9f1a2013-12-18 15:15:46 +080089 ndn::ptr_lib::shared_ptr<SyncPolicyManager> syncPolicyManager,
Yingdi Yu6e235db2013-12-27 08:40:53 +080090 ndn::ptr_lib::shared_ptr<ndn::Face> face,
91 ndn::ptr_lib::shared_ptr<ndn::Transport> transport,
Alexander Afanasyev750d1872012-03-12 15:33:56 -070092 LogicUpdateCallback onUpdate,
Zhenkai Zhuce66e212012-03-12 22:27:19 -070093 LogicRemoveCallback onRemove);
Zhenkai Zhu46b26a12012-03-06 13:51:16 -080094
Yingdi Yu43e71612013-10-30 22:19:31 -070095 SyncLogic (const ndn::Name& syncPrefix,
Yingdi Yu46c9f1a2013-12-18 15:15:46 +080096 ndn::ptr_lib::shared_ptr<SyncPolicyManager> syncPolicyManager,
Yingdi Yu6e235db2013-12-27 08:40:53 +080097 ndn::ptr_lib::shared_ptr<ndn::Face> face,
98 ndn::ptr_lib::shared_ptr<ndn::Transport> transport,
Zhenkai Zhub9f19592012-10-16 14:27:38 -070099 LogicPerBranchCallback onUpdateBranch);
100
Alexander Afanasyevc1030192012-03-08 22:21:28 -0800101 ~SyncLogic ();
Chaoyi Bian89ee2dc2012-03-09 14:06:01 -0800102
Alexander Afanasyevc1030192012-03-08 22:21:28 -0800103 /**
104 * a wrapper for the same func in SyncApp
105 */
106 void addLocalNames (const std::string &prefix, uint32_t session, uint32_t seq);
Zhenkai Zhu46b26a12012-03-06 13:51:16 -0800107
Alexander Afanasyevc1030192012-03-08 22:21:28 -0800108 /**
109 * @brief respond to the Sync Interest; a lot of logic needs to go in here
110 * @param interest the Sync Interest in string format
111 */
Yingdi Yu46c9f1a2013-12-18 15:15:46 +0800112 void respondSyncInterest (ndn::ptr_lib::shared_ptr<ndn::Interest> interest);
Zhenkai Zhu46b26a12012-03-06 13:51:16 -0800113
Alexander Afanasyevc1030192012-03-08 22:21:28 -0800114 /**
115 * @brief process the fetched sync data
Chaoyi Bian633255f2012-03-09 21:25:38 -0800116 * @param name the data name
Alexander Afanasyevc1030192012-03-08 22:21:28 -0800117 * @param dataBuffer the sync data
118 */
Yingdi Yu46c9f1a2013-12-18 15:15:46 +0800119 void respondSyncData (ndn::ptr_lib::shared_ptr<ndn::Data> data);
Zhenkai Zhu8d935c82012-03-06 10:44:12 -0800120
Zhenkai Zhu0efa37b2012-03-12 13:54:12 -0700121 /**
122 * @brief remove a participant's subtree from the sync tree
Alexander Afanasyev03a58b72012-03-12 18:11:56 -0700123 * @param prefix the name prefix for the participant
Zhenkai Zhu0efa37b2012-03-12 13:54:12 -0700124 */
Alexander Afanasyev03a58b72012-03-12 18:11:56 -0700125 void remove (const std::string &prefix);
Zhenkai Zhu0efa37b2012-03-12 13:54:12 -0700126
Zhenkai Zhue5660932012-06-04 15:25:20 -0700127 std::string
128 getRootDigest();
129
Alexander Afanasyev387ac952012-03-11 23:49:27 -0700130#ifdef _DEBUG
Alexander Afanasyev45fba082012-03-12 18:05:24 -0700131 Scheduler &
Alexander Afanasyevbf2b4362012-03-12 23:55:09 -0700132 getScheduler () { return m_scheduler; }
Alexander Afanasyev387ac952012-03-11 23:49:27 -0700133#endif
Alexander Afanasyev181d7e52012-04-09 13:54:11 -0700134
Alexander Afanasyev181d7e52012-04-09 13:54:11 -0700135#ifdef NS3_MODULE
Alexander Afanasyev40942f42012-04-21 20:53:16 -0700136public:
Alexander Afanasyev181d7e52012-04-09 13:54:11 -0700137 virtual void StartApplication ();
138 virtual void StopApplication ();
139#endif
Alexander Afanasyev387ac952012-03-11 23:49:27 -0700140
Zhenkai Zhueb1d8652012-12-23 15:25:39 -0800141 void stop();
142
Alexander Afanasyev5548c042012-10-04 19:10:09 -0700143 void
144 printState () const;
145
Zhenkai Zhud5aec4b2012-10-09 12:01:19 -0700146 std::map<std::string, bool>
147 getBranchPrefixes() const;
148
Zhenkai Zhu8d935c82012-03-06 10:44:12 -0800149private:
Yingdi Yu6e235db2013-12-27 08:40:53 +0800150 // void
151 // connectToDaemon();
Yingdi Yu46c9f1a2013-12-18 15:15:46 +0800152
Yingdi Yu6e235db2013-12-27 08:40:53 +0800153 // void
154 // onConnectionData(const ndn::ptr_lib::shared_ptr<const ndn::Interest>& interest,
155 // const ndn::ptr_lib::shared_ptr<ndn::Data>& data);
Yingdi Yu46c9f1a2013-12-18 15:15:46 +0800156
Yingdi Yu6e235db2013-12-27 08:40:53 +0800157 // void
158 // onConnectionDataTimeout(const ndn::ptr_lib::shared_ptr<const ndn::Interest>& interest);
Yingdi Yu46c9f1a2013-12-18 15:15:46 +0800159
160 void
Alexander Afanasyev45fba082012-03-12 18:05:24 -0700161 delayedChecksLoop ();
Alexander Afanasyev387ac952012-03-11 23:49:27 -0700162
163 void
Yingdi Yu46c9f1a2013-12-18 15:15:46 +0800164 onSyncInterest (const ndn::ptr_lib::shared_ptr<const ndn::Name>& prefix,
165 const ndn::ptr_lib::shared_ptr<const ndn::Interest>& interest,
166 ndn::Transport& transport,
167 uint64_t registeredPrefixId);
Yingdi Yu43e71612013-10-30 22:19:31 -0700168
169 void
Yingdi Yu46c9f1a2013-12-18 15:15:46 +0800170 onSyncRegisterFailed(const ndn::ptr_lib::shared_ptr<const ndn::Name>& prefix);
171
172 void
173 onSyncData(const ndn::ptr_lib::shared_ptr<const ndn::Interest>& interest,
174 const ndn::ptr_lib::shared_ptr<ndn::Data>& data,
175 int stepCount,
176 const ndn::OnVerified& onVerified,
177 const ndn::OnVerifyFailed& onVerifyFailed);
178
179 void
180 onSyncDataTimeout(const ndn::ptr_lib::shared_ptr<const ndn::Interest>& interest,
181 int retry,
182 int stepCount,
183 const ndn::OnVerified& onVerified,
184 const ndn::OnVerifyFailed& onVerifyFailed);
185
186 void
187 onSyncDataVerifyFailed(const ndn::ptr_lib::shared_ptr<ndn::Data>& data);
188
189 void
190 onSyncDataVerified(const ndn::ptr_lib::shared_ptr<ndn::Data>& data);
191
192 void
193 onSyncCert(const ndn::ptr_lib::shared_ptr<const ndn::Interest>& interest,
194 const ndn::ptr_lib::shared_ptr<ndn::Data>& cert,
195 ndn::ptr_lib::shared_ptr<ndn::ValidationRequest> previousStep);
196
197 void
198 onSyncCertTimeout(const ndn::ptr_lib::shared_ptr<const ndn::Interest>& interest,
199 const ndn::OnVerifyFailed& onVerifyFailed,
200 const ndn::ptr_lib::shared_ptr<ndn::Data>& data,
201 ndn::ptr_lib::shared_ptr<ndn::ValidationRequest> nextStep);
Yingdi Yu43e71612013-10-30 22:19:31 -0700202
203 void
Alexander Afanasyevf3c03a92012-05-09 12:00:37 -0700204 processSyncInterest (const std::string &name,
205 DigestConstPtr digest, bool timedProcessing=false);
206
207 void
208 processSyncData (const std::string &name,
Zhenkai Zhu3cfdcb92012-06-06 15:20:10 -0700209 DigestConstPtr digest, const char *wireData, size_t len);
Alexander Afanasyev387ac952012-03-11 23:49:27 -0700210
Alexander Afanasyev45fba082012-03-12 18:05:24 -0700211 void
Alexander Afanasyevf3c03a92012-05-09 12:00:37 -0700212 processSyncRecoveryInterest (const std::string &name,
213 DigestConstPtr digest);
214
Alexander Afanasyev45fba082012-03-12 18:05:24 -0700215 void
Alexander Afanasyev235c6d72012-03-15 22:28:43 -0700216 insertToDiffLog (DiffStatePtr diff);
Alexander Afanasyev1b449c42012-03-13 20:24:07 -0700217
218 void
Alexander Afanasyevf3c03a92012-05-09 12:00:37 -0700219 satisfyPendingSyncInterests (DiffStateConstPtr diff);
Zhenkai Zhu8d935c82012-03-06 10:44:12 -0800220
Alexander Afanasyevf3c03a92012-05-09 12:00:37 -0700221 boost::tuple<DigestConstPtr, std::string>
222 convertNameToDigestAndType (const std::string &name);
223
224 void
225 sendSyncInterest ();
226
227 void
Alexander Afanasyev46eb5262012-05-10 16:30:35 -0700228 sendSyncRecoveryInterests (DigestConstPtr digest);
229
230 void
Alexander Afanasyevf3c03a92012-05-09 12:00:37 -0700231 sendSyncData (const std::string &name,
232 DigestConstPtr digest, StateConstPtr state);
Alexander Afanasyev80237382012-10-04 10:20:47 -0700233
Zhenkai Zhu2d3e2702012-10-15 14:18:05 -0700234 void
235 sendSyncData (const std::string &name,
236 DigestConstPtr digest, SyncStateMsg &msg);
237
Alexander Afanasyev80237382012-10-04 10:20:47 -0700238 size_t
239 getNumberOfBranches () const;
Alexander Afanasyevf3c03a92012-05-09 12:00:37 -0700240
Zhenkai Zhu8d935c82012-03-06 10:44:12 -0800241private:
Alexander Afanasyevf3c03a92012-05-09 12:00:37 -0700242 FullStatePtr m_state;
Chaoyi Bian89ee2dc2012-03-09 14:06:01 -0800243 DiffStateContainer m_log;
Alexander Afanasyev80237382012-10-04 10:20:47 -0700244 mutable boost::recursive_mutex m_stateMutex;
Alexander Afanasyev750d1872012-03-12 15:33:56 -0700245
Alexander Afanasyevf3c03a92012-05-09 12:00:37 -0700246 std::string m_outstandingInterestName;
Alexander Afanasyevc1030192012-03-08 22:21:28 -0800247 SyncInterestTable m_syncInterestTable;
248
Yingdi Yu43e71612013-10-30 22:19:31 -0700249 ndn::Name m_syncPrefix;
Alexander Afanasyev750d1872012-03-12 15:33:56 -0700250 LogicUpdateCallback m_onUpdate;
251 LogicRemoveCallback m_onRemove;
Zhenkai Zhub9f19592012-10-16 14:27:38 -0700252 LogicPerBranchCallback m_onUpdateBranch;
253 bool m_perBranch;
Yingdi Yu46c9f1a2013-12-18 15:15:46 +0800254 ndn::ptr_lib::shared_ptr<SyncPolicyManager> m_policyManager;
255 ndn::ptr_lib::shared_ptr<ndn::IdentityManager> m_identityManager;
256 ndn::ptr_lib::shared_ptr<ndn::Face> m_face;
257 ndn::ptr_lib::shared_ptr<ndn::Transport> m_transport;
258 uint64_t m_syncRegisteredPrefixId;
Chaoyi Bian89ee2dc2012-03-09 14:06:01 -0800259
Alexander Afanasyevbf2b4362012-03-12 23:55:09 -0700260 Scheduler m_scheduler;
Chaoyi Bian633255f2012-03-09 21:25:38 -0800261
Alexander Afanasyev73f7f9a2012-04-09 15:45:47 -0700262#ifndef NS3_MODULE
Alexander Afanasyev45fba082012-03-12 18:05:24 -0700263 boost::mt19937 m_randomGenerator;
264 boost::variate_generator<boost::mt19937&, boost::uniform_int<> > m_rangeUniformRandom;
Alexander Afanasyev085742a2012-04-26 12:24:57 -0700265 boost::variate_generator<boost::mt19937&, boost::uniform_int<> > m_reexpressionJitter;
Alexander Afanasyev73f7f9a2012-04-09 15:45:47 -0700266#else
267 ns3::UniformVariable m_rangeUniformRandom;
Alexander Afanasyev085742a2012-04-26 12:24:57 -0700268 ns3::UniformVariable m_reexpressionJitter;
Alexander Afanasyev73f7f9a2012-04-09 15:45:47 -0700269#endif
Alexander Afanasyevbf2b4362012-03-12 23:55:09 -0700270
Alexander Afanasyev3a229132012-04-25 15:07:26 -0700271 static const int m_unknownDigestStoreTime = 10; // seconds
Alexander Afanasyev89571f12012-04-23 13:44:57 -0700272#ifdef NS3_MODULE
Alexander Afanasyev3a229132012-04-25 15:07:26 -0700273 static const int m_syncResponseFreshness = 100; // milliseconds
Alexander Afanasyev55608612012-04-30 13:24:50 -0700274 static const int m_syncInterestReexpress = 10; // seconds
Alexander Afanasyev3a229132012-04-25 15:07:26 -0700275 // don't forget to adjust value in SyncCcnxWrapper
Alexander Afanasyev40942f42012-04-21 20:53:16 -0700276#else
Zhenkai Zhu60e8cb32012-06-04 17:29:30 -0700277 static const int m_syncResponseFreshness = 4;
Alexander Afanasyev89571f12012-04-23 13:44:57 -0700278 static const int m_syncInterestReexpress = 4;
Alexander Afanasyev40942f42012-04-21 20:53:16 -0700279#endif
Alexander Afanasyevbf2b4362012-03-12 23:55:09 -0700280
Alexander Afanasyeva76010b2012-05-24 21:31:49 -0700281 static const int m_defaultRecoveryRetransmitInterval = 200; // milliseconds
282 uint32_t m_recoveryRetransmissionInterval; // milliseconds
283
Alexander Afanasyevbf2b4362012-03-12 23:55:09 -0700284 enum EventLabels
285 {
286 DELAYED_INTEREST_PROCESSING = 1,
Alexander Afanasyev46eb5262012-05-10 16:30:35 -0700287 REEXPRESSING_INTEREST = 2,
288 REEXPRESSING_RECOVERY_INTEREST = 3
Alexander Afanasyevbf2b4362012-03-12 23:55:09 -0700289 };
Zhenkai Zhu8d935c82012-03-06 10:44:12 -0800290};
291
292
293} // Sync
294
Zhenkai Zhu1ac6f802012-03-06 17:40:27 -0800295#endif // SYNC_APP_WRAPPER_H