blob: b7340a35c1450aff112e7beeae66629e14777e08 [file] [log] [blame]
Alexander Afanasyev2a655f72015-01-26 18:38:33 -08001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
Junxiao Shicb766862017-07-07 22:21:04 +00002/*
Junxiao Shi83be1da2017-06-30 13:37:37 +00003 * Copyright (c) 2014-2017, Regents of the University of California,
Alexander Afanasyev2a655f72015-01-26 18:38:33 -08004 * Arizona Board of Regents,
5 * Colorado State University,
6 * University Pierre & Marie Curie, Sorbonne University,
7 * Washington University in St. Louis,
8 * Beijing Institute of Technology,
9 * The University of Memphis.
10 *
11 * This file is part of NFD (Named Data Networking Forwarding Daemon).
12 * See AUTHORS.md for complete list of NFD authors and contributors.
13 *
14 * NFD is free software: you can redistribute it and/or modify it under the terms
15 * of the GNU General Public License as published by the Free Software Foundation,
16 * either version 3 of the License, or (at your option) any later version.
17 *
18 * NFD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
19 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
20 * PURPOSE. See the GNU General Public License for more details.
21 *
22 * You should have received a copy of the GNU General Public License along with
23 * NFD, e.g., in COPYING.md file. If not, see <http://www.gnu.org/licenses/>.
24 */
25
Junxiao Shicb766862017-07-07 22:21:04 +000026#include "procedure.hpp"
27#include "core/extended-error-message.hpp"
28#include "core/scheduler.hpp"
Junxiao Shi9f5b01d2016-08-05 03:54:28 +000029#include "core/version.hpp"
Alexander Afanasyev2a655f72015-01-26 18:38:33 -080030
Junxiao Shicb766862017-07-07 22:21:04 +000031#include <signal.h>
32#include <string.h>
Alexander Afanasyev5c475972015-12-20 16:16:56 -080033#include <boost/program_options/options_description.hpp>
Alexander Afanasyev5c475972015-12-20 16:16:56 -080034#include <boost/program_options/parsers.hpp>
Junxiao Shi52fa45c2016-11-29 21:18:13 +000035#include <boost/program_options/variables_map.hpp>
Junxiao Shicb766862017-07-07 22:21:04 +000036#include <ndn-cxx/net/network-monitor.hpp>
37#include <ndn-cxx/util/scheduler.hpp>
38#include <ndn-cxx/util/scheduler-scoped-event-id.hpp>
39#include <ndn-cxx/util/time.hpp>
Alexander Afanasyev2a655f72015-01-26 18:38:33 -080040
Davide Pesaventoc0a5a392017-08-19 16:49:30 -040041// suppress warning caused by boost::program_options::parse_config_file
42#ifdef __clang__
43#pragma clang diagnostic ignored "-Wundefined-func-template"
44#endif
45
Alexander Afanasyev2a655f72015-01-26 18:38:33 -080046namespace ndn {
47namespace tools {
Junxiao Shi52fa45c2016-11-29 21:18:13 +000048namespace autoconfig {
49// ndn-autoconfig is an NDN tool not an NFD tool, so it uses ndn::tools::autoconfig namespace.
50// It lives in NFD repository because nfd-start can automatically start ndn-autoconfig in daemon mode.
Alexander Afanasyev2a655f72015-01-26 18:38:33 -080051
Junxiao Shicb766862017-07-07 22:21:04 +000052static const time::nanoseconds DAEMON_INITIAL_DELAY = time::milliseconds(100);
53static const time::nanoseconds DAEMON_UNCONDITIONAL_INTERVAL = time::hours(1);
54static const time::nanoseconds NETMON_DAMPEN_PERIOD = time::seconds(5);
55
56namespace po = boost::program_options;
57
58static void
59usage(std::ostream& os,
60 const po::options_description& optionsDescription,
61 const char* programName)
Alexander Afanasyev2a655f72015-01-26 18:38:33 -080062{
Junxiao Shicb766862017-07-07 22:21:04 +000063 os << "Usage:\n"
64 << " " << programName << " [options]\n"
65 << "\n";
66 os << optionsDescription;
67}
68
69static void
70runDaemon(Procedure& proc)
71{
72 boost::asio::signal_set terminateSignals(proc.getIoService());
73 terminateSignals.add(SIGINT);
74 terminateSignals.add(SIGTERM);
75 terminateSignals.async_wait([&] (const boost::system::error_code& error, int signalNo) {
76 if (error) {
77 return;
Alexander Afanasyev2a655f72015-01-26 18:38:33 -080078 }
Junxiao Shicb766862017-07-07 22:21:04 +000079 const char* signalName = ::strsignal(signalNo);
80 std::cerr << "Exit on signal ";
81 if (signalName == nullptr) {
82 std::cerr << signalNo;
83 }
84 else {
85 std::cerr << signalName;
86 }
87 std::cerr << std::endl;
88 proc.getIoService().stop();
89 });
90
91 util::Scheduler sched(proc.getIoService());
92 util::scheduler::ScopedEventId runEvt(sched);
93 auto scheduleRerun = [&] (time::nanoseconds delay) {
94 runEvt = sched.scheduleEvent(delay, [&] { proc.runOnce(); });
Alexander Afanasyev2a655f72015-01-26 18:38:33 -080095 };
96
Junxiao Shicb766862017-07-07 22:21:04 +000097 proc.onComplete.connect([&] (bool isSuccess) {
98 scheduleRerun(DAEMON_UNCONDITIONAL_INTERVAL);
99 });
Alexander Afanasyeve46279dc2015-01-29 15:39:17 -0800100
Junxiao Shicb766862017-07-07 22:21:04 +0000101 net::NetworkMonitor netmon(proc.getIoService());
102 netmon.onNetworkStateChanged.connect([&] { scheduleRerun(NETMON_DAMPEN_PERIOD); });
Alexander Afanasyev2a655f72015-01-26 18:38:33 -0800103
Junxiao Shicb766862017-07-07 22:21:04 +0000104 scheduleRerun(DAEMON_INITIAL_DELAY);
105 proc.getIoService().run();
106}
Alexander Afanasyev2a655f72015-01-26 18:38:33 -0800107
Junxiao Shi52fa45c2016-11-29 21:18:13 +0000108static int
Alexander Afanasyev2a655f72015-01-26 18:38:33 -0800109main(int argc, char** argv)
110{
Junxiao Shicb766862017-07-07 22:21:04 +0000111 Options options;
112 bool isDaemon = false;
Alexander Afanasyev5c475972015-12-20 16:16:56 -0800113 std::string configFile;
Alexander Afanasyev2a655f72015-01-26 18:38:33 -0800114
Junxiao Shicb766862017-07-07 22:21:04 +0000115 po::options_description optionsDescription("Options");
116 optionsDescription.add_options()
117 ("help,h", "print this message and exit")
118 ("version,V", "display version and exit")
119 ("daemon,d", po::bool_switch(&isDaemon)->default_value(isDaemon),
120 "run in daemon mode, detecting network change events and re-running auto-discovery procedure. "
121 "In addition, the auto-discovery procedure is unconditionally re-run every hour.\n"
Alexander Afanasyev5c475972015-12-20 16:16:56 -0800122 "NOTE: if connection to NFD fails, the daemon will be terminated.")
Junxiao Shicb766862017-07-07 22:21:04 +0000123 ("ndn-fch-url", po::value<std::string>(&options.ndnFchUrl)->default_value(options.ndnFchUrl),
Alexander Afanasyev2a001942016-12-14 18:18:41 -0800124 "URL for NDN-FCH (Find Closest Hub) service")
Junxiao Shicb766862017-07-07 22:21:04 +0000125 ("config,c", po::value<std::string>(&configFile),
126 "configuration file. Exit immediately if `enabled = true` is not specified in config file.")
Alexander Afanasyev5c475972015-12-20 16:16:56 -0800127 ;
128
Junxiao Shicb766862017-07-07 22:21:04 +0000129 po::variables_map vm;
Alexander Afanasyev5c475972015-12-20 16:16:56 -0800130 try {
Junxiao Shicb766862017-07-07 22:21:04 +0000131 po::store(po::parse_command_line(argc, argv, optionsDescription), vm);
132 po::notify(vm);
Alexander Afanasyev5c475972015-12-20 16:16:56 -0800133 }
134 catch (const std::exception& e) {
Junxiao Shicb766862017-07-07 22:21:04 +0000135 std::cerr << "ERROR: " << e.what() << "\n" << "\n\n";
136 usage(std::cerr, optionsDescription, argv[0]);
137 return 2;
Alexander Afanasyev5c475972015-12-20 16:16:56 -0800138 }
139
Junxiao Shicb766862017-07-07 22:21:04 +0000140 if (vm.count("help")) {
141 usage(std::cout, optionsDescription, argv[0]);
Alexander Afanasyev5c475972015-12-20 16:16:56 -0800142 return 0;
143 }
144
Junxiao Shicb766862017-07-07 22:21:04 +0000145 if (vm.count("version")) {
Alexander Afanasyev5c475972015-12-20 16:16:56 -0800146 std::cout << NFD_VERSION_BUILD_STRING << std::endl;
147 return 0;
148 }
149
Junxiao Shicb766862017-07-07 22:21:04 +0000150 if (vm.count("config")) {
151 po::options_description configFileOptions;
152 configFileOptions.add_options()
153 ("enabled", po::value<bool>()->default_value(false))
154 ;
Alexander Afanasyev5c475972015-12-20 16:16:56 -0800155 try {
Junxiao Shicb766862017-07-07 22:21:04 +0000156 po::store(po::parse_config_file<char>(configFile.data(), configFileOptions), vm);
157 po::notify(vm);
Alexander Afanasyev2a655f72015-01-26 18:38:33 -0800158 }
Alexander Afanasyev5c475972015-12-20 16:16:56 -0800159 catch (const std::exception& e) {
Junxiao Shicb766862017-07-07 22:21:04 +0000160 std::cerr << "ERROR in config: " << e.what() << "\n\n";
161 return 2;
162 }
163 if (!vm["enabled"].as<bool>()) {
164 // not enabled in config
165 return 0;
Alexander Afanasyev5c475972015-12-20 16:16:56 -0800166 }
167 }
168
Junxiao Shicb766862017-07-07 22:21:04 +0000169 int exitCode = 0;
Alexander Afanasyev2a655f72015-01-26 18:38:33 -0800170 try {
Junxiao Shicb766862017-07-07 22:21:04 +0000171 Face face;
172 KeyChain keyChain;
173 Procedure proc(face, keyChain);
174 proc.initialize(options);
175
176 if (isDaemon) {
177 runDaemon(proc);
178 }
179 else {
180 proc.onComplete.connect([&exitCode] (bool isSuccess) { exitCode = isSuccess ? 0 : 3; });
181 proc.runOnce();
182 face.processEvents();
183 }
Alexander Afanasyev2a655f72015-01-26 18:38:33 -0800184 }
Junxiao Shicb766862017-07-07 22:21:04 +0000185 catch (const std::exception& e) {
186 std::cerr << ::nfd::getExtendedErrorMessage(e) << std::endl;
Alexander Afanasyev2a655f72015-01-26 18:38:33 -0800187 return 1;
188 }
Junxiao Shicb766862017-07-07 22:21:04 +0000189 return exitCode;
Alexander Afanasyev2a655f72015-01-26 18:38:33 -0800190}
Junxiao Shi52fa45c2016-11-29 21:18:13 +0000191
192} // namespace autoconfig
193} // namespace tools
194} // namespace ndn
195
196int
197main(int argc, char** argv)
198{
199 return ndn::tools::autoconfig::main(argc, argv);
200}