Kea  2.1.7-git
ctrl_dhcp4_srv.cc
Go to the documentation of this file.
1 // Copyright (C) 2014-2022 Internet Systems Consortium, Inc. ("ISC")
2 //
3 // This Source Code Form is subject to the terms of the Mozilla Public
4 // License, v. 2.0. If a copy of the MPL was not distributed with this
5 // file, You can obtain one at http://mozilla.org/MPL/2.0/.
6 
7 #include <config.h>
8 
10 #include <cc/data.h>
11 #include <cfgrpt/config_report.h>
12 #include <config/command_mgr.h>
13 #include <dhcp/libdhcp++.h>
14 #include <dhcp4/ctrl_dhcp4_srv.h>
15 #include <dhcp4/dhcp4_log.h>
16 #include <dhcp4/dhcp4to6_ipc.h>
18 #include <dhcp4/parser_context.h>
19 #include <dhcpsrv/cfg_db_access.h>
21 #include <dhcpsrv/cfgmgr.h>
22 #include <dhcpsrv/db_type.h>
23 #include <dhcpsrv/host_mgr.h>
25 #include <hooks/hooks.h>
26 #include <hooks/hooks_manager.h>
27 #include <stats/stats_mgr.h>
29 
30 #include <signal.h>
31 
32 #include <sstream>
33 
34 using namespace isc::asiolink;
35 using namespace isc::config;
36 using namespace isc::data;
37 using namespace isc::db;
38 using namespace isc::dhcp;
39 using namespace isc::hooks;
40 using namespace isc::stats;
41 using namespace isc::util;
42 using namespace std;
43 namespace ph = std::placeholders;
44 
45 namespace {
46 
48 struct CtrlDhcp4Hooks {
49  int hooks_index_dhcp4_srv_configured_;
50 
52  CtrlDhcp4Hooks() {
53  hooks_index_dhcp4_srv_configured_ = HooksManager::registerHook("dhcp4_srv_configured");
54  }
55 
56 };
57 
58 // Declare a Hooks object. As this is outside any function or method, it
59 // will be instantiated (and the constructor run) when the module is loaded.
60 // As a result, the hook indexes will be defined before any method in this
61 // module is called.
62 CtrlDhcp4Hooks Hooks;
63 
73 void signalHandler(int signo) {
74  // SIGHUP signals a request to reconfigure the server.
75  if (signo == SIGHUP) {
76  ControlledDhcpv4Srv::processCommand("config-reload",
77  ConstElementPtr());
78  } else if ((signo == SIGTERM) || (signo == SIGINT)) {
79  ControlledDhcpv4Srv::processCommand("shutdown",
80  ConstElementPtr());
81  }
82 }
83 
84 }
85 
86 namespace isc {
87 namespace dhcp {
88 
89 ControlledDhcpv4Srv* ControlledDhcpv4Srv::server_ = NULL;
90 
91 void
92 ControlledDhcpv4Srv::init(const std::string& file_name) {
93  // Keep the call timestamp.
94  start_ = boost::posix_time::second_clock::universal_time();
95 
96  // Configure the server using JSON file.
97  ConstElementPtr result = loadConfigFile(file_name);
98 
99  int rcode;
100  ConstElementPtr comment = isc::config::parseAnswer(rcode, result);
101  if (rcode != CONTROL_RESULT_SUCCESS) {
102  string reason = comment ? comment->stringValue() :
103  "no details available";
104  isc_throw(isc::BadValue, reason);
105  }
106 
107  // We don't need to call openActiveSockets() or startD2() as these
108  // methods are called in processConfig() which is called by
109  // processCommand("config-set", ...)
110 
111  // Set signal handlers. When the SIGHUP is received by the process
112  // the server reconfiguration will be triggered. When SIGTERM or
113  // SIGINT will be received, the server will start shutting down.
114  signal_set_.reset(new IOSignalSet(getIOService(), signalHandler));
115 
116  signal_set_->add(SIGINT);
117  signal_set_->add(SIGHUP);
118  signal_set_->add(SIGTERM);
119 }
120 
121 void ControlledDhcpv4Srv::cleanup() {
122  // Nothing to do here. No need to disconnect from anything.
123 }
124 
126 ControlledDhcpv4Srv::loadConfigFile(const std::string& file_name) {
127  // This is a configuration backend implementation that reads the
128  // configuration from a JSON file.
129 
132 
133  // Basic sanity check: file name must not be empty.
134  try {
135  if (file_name.empty()) {
136  // Basic sanity check: file name must not be empty.
137  isc_throw(isc::BadValue, "JSON configuration file not specified."
138  " Please use -c command line option.");
139  }
140 
141  // Read contents of the file and parse it as JSON
142  Parser4Context parser;
143  json = parser.parseFile(file_name, Parser4Context::PARSER_DHCP4);
144  if (!json) {
145  isc_throw(isc::BadValue, "no configuration found");
146  }
147 
148  // Let's do sanity check before we call json->get() which
149  // works only for map.
150  if (json->getType() != isc::data::Element::map) {
151  isc_throw(isc::BadValue, "Configuration file is expected to be "
152  "a map, i.e., start with { and end with } and contain "
153  "at least an entry called 'Dhcp4' that itself is a map. "
154  << file_name
155  << " is a valid JSON, but its top element is not a map."
156  " Did you forget to add { } around your configuration?");
157  }
158 
159  // Use parsed JSON structures to configure the server
160  result = ControlledDhcpv4Srv::processCommand("config-set", json);
161  if (!result) {
162  // Undetermined status of the configuration. This should never
163  // happen, but as the configureDhcp4Server returns a pointer, it is
164  // theoretically possible that it will return NULL.
165  isc_throw(isc::BadValue, "undefined result of "
166  "processCommand(\"config-set\", json)");
167  }
168 
169  // Now check is the returned result is successful (rcode=0) or not
170  // (see @ref isc::config::parseAnswer).
171  int rcode;
172  ConstElementPtr comment = isc::config::parseAnswer(rcode, result);
173  if (rcode != CONTROL_RESULT_SUCCESS) {
174  string reason = comment ? comment->stringValue() :
175  "no details available";
176  isc_throw(isc::BadValue, reason);
177  }
178  } catch (const std::exception& ex) {
179  // If configuration failed at any stage, we drop the staging
180  // configuration and continue to use the previous one.
181  CfgMgr::instance().rollback();
182 
184  .arg(file_name).arg(ex.what());
185  isc_throw(isc::BadValue, "configuration error using file '"
186  << file_name << "': " << ex.what());
187  }
188 
190  .arg(MultiThreadingMgr::instance().getMode() ? "yes" : "no")
191  .arg(MultiThreadingMgr::instance().getThreadPoolSize())
192  .arg(MultiThreadingMgr::instance().getPacketQueueSize());
193 
194  return (result);
195 }
196 
198 ControlledDhcpv4Srv::commandShutdownHandler(const string&, ConstElementPtr args) {
199  if (!ControlledDhcpv4Srv::getInstance()) {
201  return(createAnswer(CONTROL_RESULT_ERROR, "Shutdown failure."));
202  }
203 
204  int exit_value = 0;
205  if (args) {
206  // @todo Should we go ahead and shutdown even if the args are invalid?
207  if (args->getType() != Element::map) {
208  return (createAnswer(CONTROL_RESULT_ERROR, "Argument must be a map"));
209  }
210 
211  ConstElementPtr param = args->get("exit-value");
212  if (param) {
213  if (param->getType() != Element::integer) {
215  "parameter 'exit-value' is not an integer"));
216  }
217 
218  exit_value = param->intValue();
219  }
220  }
221 
222  ControlledDhcpv4Srv::getInstance()->shutdownServer(exit_value);
223  return (createAnswer(CONTROL_RESULT_SUCCESS, "Shutting down."));
224 }
225 
227 ControlledDhcpv4Srv::commandLibReloadHandler(const string&, ConstElementPtr) {
228  // stop thread pool (if running)
230 
231  // Clear the packet queue.
232  MultiThreadingMgr::instance().getThreadPool().reset();
233 
234  try {
236  HookLibsCollection loaded = HooksManager::getLibraryInfo();
237  HooksManager::prepareUnloadLibraries();
238  static_cast<void>(HooksManager::unloadLibraries());
239  bool status = HooksManager::loadLibraries(loaded);
240  if (!status) {
241  isc_throw(Unexpected, "Failed to reload hooks libraries.");
242  }
243  } catch (const std::exception& ex) {
245  ConstElementPtr answer = isc::config::createAnswer(1, ex.what());
246  return (answer);
247  }
249  "Hooks libraries successfully reloaded.");
250  return (answer);
251 }
252 
254 ControlledDhcpv4Srv::commandConfigReloadHandler(const string&,
255  ConstElementPtr /*args*/) {
256  // Get configuration file name.
257  std::string file = ControlledDhcpv4Srv::getInstance()->getConfigFile();
258  try {
260  auto result = loadConfigFile(file);
262  return (result);
263  } catch (const std::exception& ex) {
264  // Log the unsuccessful reconfiguration. The reason for failure
265  // should be already logged. Don't rethrow an exception so as
266  // the server keeps working.
268  .arg(file);
270  "Config reload failed: " + string(ex.what())));
271  }
272 }
273 
275 ControlledDhcpv4Srv::commandConfigGetHandler(const string&,
276  ConstElementPtr /*args*/) {
277  ConstElementPtr config = CfgMgr::instance().getCurrentCfg()->toElement();
278 
279  return (createAnswer(0, config));
280 }
281 
283 ControlledDhcpv4Srv::commandConfigWriteHandler(const string&,
284  ConstElementPtr args) {
285  string filename;
286 
287  if (args) {
288  if (args->getType() != Element::map) {
289  return (createAnswer(CONTROL_RESULT_ERROR, "Argument must be a map"));
290  }
291  ConstElementPtr filename_param = args->get("filename");
292  if (filename_param) {
293  if (filename_param->getType() != Element::string) {
295  "passed parameter 'filename' is not a string"));
296  }
297  filename = filename_param->stringValue();
298  }
299  }
300 
301  if (filename.empty()) {
302  // filename parameter was not specified, so let's use whatever we remember
303  // from the command-line
304  filename = getConfigFile();
305  }
306 
307  if (filename.empty()) {
308  return (createAnswer(CONTROL_RESULT_ERROR, "Unable to determine filename."
309  "Please specify filename explicitly."));
310  }
311 
312  // Ok, it's time to write the file.
313  size_t size = 0;
314  try {
315  ConstElementPtr cfg = CfgMgr::instance().getCurrentCfg()->toElement();
316  size = writeConfigFile(filename, cfg);
317  } catch (const isc::Exception& ex) {
318  return (createAnswer(CONTROL_RESULT_ERROR, string("Error during write-config:")
319  + ex.what()));
320  }
321  if (size == 0) {
322  return (createAnswer(CONTROL_RESULT_ERROR, "Error writing configuration to "
323  + filename));
324  }
325 
326  // Ok, it's time to return the successful response.
327  ElementPtr params = Element::createMap();
328  params->set("size", Element::create(static_cast<long long>(size)));
329  params->set("filename", Element::create(filename));
330 
331  return (createAnswer(CONTROL_RESULT_SUCCESS, "Configuration written to "
332  + filename + " successful", params));
333 }
334 
336 ControlledDhcpv4Srv::commandConfigSetHandler(const string&,
337  ConstElementPtr args) {
338  const int status_code = CONTROL_RESULT_ERROR;
339  ConstElementPtr dhcp4;
340  string message;
341 
342  // Command arguments are expected to be:
343  // { "Dhcp4": { ... } }
344  if (!args) {
345  message = "Missing mandatory 'arguments' parameter.";
346  } else {
347  dhcp4 = args->get("Dhcp4");
348  if (!dhcp4) {
349  message = "Missing mandatory 'Dhcp4' parameter.";
350  } else if (dhcp4->getType() != Element::map) {
351  message = "'Dhcp4' parameter expected to be a map.";
352  }
353  }
354 
355  // Check unsupported objects.
356  if (message.empty()) {
357  for (auto obj : args->mapValue()) {
358  const string& obj_name = obj.first;
359  if (obj_name != "Dhcp4") {
361  .arg(obj_name);
362  if (message.empty()) {
363  message = "Unsupported '" + obj_name + "' parameter";
364  } else {
365  message += " (and '" + obj_name + "')";
366  }
367  }
368  }
369  if (!message.empty()) {
370  message += ".";
371  }
372  }
373 
374  if (!message.empty()) {
375  // Something is amiss with arguments, return a failure response.
376  ConstElementPtr result = isc::config::createAnswer(status_code,
377  message);
378  return (result);
379  }
380 
381  // stop thread pool (if running)
383 
384  // disable multi-threading (it will be applied by new configuration)
385  // this must be done in order to properly handle MT to ST transition
386  // when 'multi-threading' structure is missing from new config
387  MultiThreadingMgr::instance().apply(false, 0, 0);
388 
389  // We are starting the configuration process so we should remove any
390  // staging configuration that has been created during previous
391  // configuration attempts.
392  CfgMgr::instance().rollback();
393 
394  // Parse the logger configuration explicitly into the staging config.
395  // Note this does not alter the current loggers, they remain in
396  // effect until we apply the logging config below. If no logging
397  // is supplied logging will revert to default logging.
398  Daemon::configureLogger(dhcp4, CfgMgr::instance().getStagingCfg());
399 
400  // Let's apply the new logging. We do it early, so we'll be able to print
401  // out what exactly is wrong with the new config in case of problems.
402  CfgMgr::instance().getStagingCfg()->applyLoggingCfg();
403 
404  // Now we configure the server proper.
405  ConstElementPtr result = processConfig(dhcp4);
406 
407  // If the configuration parsed successfully, apply the new logger
408  // configuration and the commit the new configuration. We apply
409  // the logging first in case there's a configuration failure.
410  int rcode = 0;
411  isc::config::parseAnswer(rcode, result);
412  if (rcode == CONTROL_RESULT_SUCCESS) {
413  CfgMgr::instance().getStagingCfg()->applyLoggingCfg();
414 
415  // Use new configuration.
416  CfgMgr::instance().commit();
417  } else {
418  // Ok, we applied the logging from the upcoming configuration, but
419  // there were problems with the config. As such, we need to back off
420  // and revert to the previous logging configuration.
421  CfgMgr::instance().getCurrentCfg()->applyLoggingCfg();
422 
423  if (CfgMgr::instance().getCurrentCfg()->getSequence() != 0) {
424  // Not initial configuration so someone can believe we reverted
425  // to the previous configuration. It is not the case so be clear
426  // about this.
428  }
429  }
430 
431  return (result);
432 }
433 
435 ControlledDhcpv4Srv::commandConfigTestHandler(const string&,
436  ConstElementPtr args) {
437  const int status_code = CONTROL_RESULT_ERROR; // 1 indicates an error
438  ConstElementPtr dhcp4;
439  string message;
440 
441  // Command arguments are expected to be:
442  // { "Dhcp4": { ... } }
443  if (!args) {
444  message = "Missing mandatory 'arguments' parameter.";
445  } else {
446  dhcp4 = args->get("Dhcp4");
447  if (!dhcp4) {
448  message = "Missing mandatory 'Dhcp4' parameter.";
449  } else if (dhcp4->getType() != Element::map) {
450  message = "'Dhcp4' parameter expected to be a map.";
451  }
452  }
453 
454  // Check unsupported objects.
455  if (message.empty()) {
456  for (auto obj : args->mapValue()) {
457  const string& obj_name = obj.first;
458  if (obj_name != "Dhcp4") {
460  .arg(obj_name);
461  if (message.empty()) {
462  message = "Unsupported '" + obj_name + "' parameter";
463  } else {
464  message += " (and '" + obj_name + "')";
465  }
466  }
467  }
468  if (!message.empty()) {
469  message += ".";
470  }
471  }
472 
473  if (!message.empty()) {
474  // Something is amiss with arguments, return a failure response.
475  ConstElementPtr result = isc::config::createAnswer(status_code,
476  message);
477  return (result);
478  }
479 
480  // stop thread pool (if running)
482 
483  // We are starting the configuration process so we should remove any
484  // staging configuration that has been created during previous
485  // configuration attempts.
486  CfgMgr::instance().rollback();
487 
488  // Now we check the server proper.
489  return (checkConfig(dhcp4));
490 }
491 
493 ControlledDhcpv4Srv::commandDhcpDisableHandler(const std::string&,
494  ConstElementPtr args) {
495  std::ostringstream message;
496  int64_t max_period = 0;
497  std::string origin;
498 
499  // If the args map does not contain 'origin' parameter, the default type
500  // will be used (user command).
501  NetworkState::Origin type = NetworkState::Origin::USER_COMMAND;
502 
503  // Parse arguments to see if the 'max-period' or 'origin' parameters have
504  // been specified.
505  if (args) {
506  // Arguments must be a map.
507  if (args->getType() != Element::map) {
508  message << "arguments for the 'dhcp-disable' command must be a map";
509 
510  } else {
511  ConstElementPtr max_period_element = args->get("max-period");
512  // max-period is optional.
513  if (max_period_element) {
514  // It must be an integer, if specified.
515  if (max_period_element->getType() != Element::integer) {
516  message << "'max-period' argument must be a number";
517 
518  } else {
519  // It must be positive integer.
520  max_period = max_period_element->intValue();
521  if (max_period <= 0) {
522  message << "'max-period' must be positive integer";
523  }
524  }
525  }
526  ConstElementPtr origin_element = args->get("origin");
527  // The 'origin' parameter is optional.
528  if (origin_element) {
529  // It must be a string, if specified.
530  if (origin_element->getType() != Element::string) {
531  message << "'origin' argument must be a string";
532 
533  } else {
534  origin = origin_element->stringValue();
535  if (origin == "ha-partner") {
536  type = NetworkState::Origin::HA_COMMAND;
537  } else if (origin != "user") {
538  if (origin.empty()) {
539  origin = "(empty string)";
540  }
541  message << "invalid value used for 'origin' parameter: "
542  << origin;
543  }
544  }
545  }
546  }
547  }
548 
549  // No error occurred, so let's disable the service.
550  if (message.tellp() == 0) {
551  message << "DHCPv4 service disabled";
552  if (max_period > 0) {
553  message << " for " << max_period << " seconds";
554 
555  // The user specified that the DHCP service should resume not
556  // later than in max-period seconds. If the 'dhcp-enable' command
557  // is not sent, the DHCP service will resume automatically.
558  network_state_->delayedEnableAll(static_cast<unsigned>(max_period),
559  type);
560  }
561  network_state_->disableService(type);
562 
563  // Success.
564  return (config::createAnswer(CONTROL_RESULT_SUCCESS, message.str()));
565  }
566 
567  // Failure.
568  return (config::createAnswer(CONTROL_RESULT_ERROR, message.str()));
569 }
570 
572 ControlledDhcpv4Srv::commandDhcpEnableHandler(const std::string&,
573  ConstElementPtr args) {
574  std::ostringstream message;
575  std::string origin;
576 
577  // If the args map does not contain 'origin' parameter, the default type
578  // will be used (user command).
579  NetworkState::Origin type = NetworkState::Origin::USER_COMMAND;
580 
581  // Parse arguments to see if the 'origin' parameter has been specified.
582  if (args) {
583  // Arguments must be a map.
584  if (args->getType() != Element::map) {
585  message << "arguments for the 'dhcp-enable' command must be a map";
586 
587  } else {
588  ConstElementPtr origin_element = args->get("origin");
589  // The 'origin' parameter is optional.
590  if (origin_element) {
591  // It must be a string, if specified.
592  if (origin_element->getType() != Element::string) {
593  message << "'origin' argument must be a string";
594 
595  } else {
596  origin = origin_element->stringValue();
597  if (origin == "ha-partner") {
598  type = NetworkState::Origin::HA_COMMAND;
599  } else if (origin != "user") {
600  if (origin.empty()) {
601  origin = "(empty string)";
602  }
603  message << "invalid value used for 'origin' parameter: "
604  << origin;
605  }
606  }
607  }
608  }
609  }
610 
611  // No error occurred, so let's enable the service.
612  if (message.tellp() == 0) {
613  network_state_->enableService(type);
614 
615  // Success.
617  "DHCP service successfully enabled"));
618  }
619 
620  // Failure.
621  return (config::createAnswer(CONTROL_RESULT_ERROR, message.str()));
622 }
623 
625 ControlledDhcpv4Srv::commandVersionGetHandler(const string&, ConstElementPtr) {
626  ElementPtr extended = Element::create(Dhcpv4Srv::getVersion(true));
627  ElementPtr arguments = Element::createMap();
628  arguments->set("extended", extended);
630  Dhcpv4Srv::getVersion(false),
631  arguments);
632  return (answer);
633 }
634 
636 ControlledDhcpv4Srv::commandBuildReportHandler(const string&,
637  ConstElementPtr) {
638  ConstElementPtr answer =
640  return (answer);
641 }
642 
644 ControlledDhcpv4Srv::commandLeasesReclaimHandler(const string&,
645  ConstElementPtr args) {
646  int status_code = CONTROL_RESULT_ERROR;
647  string message;
648 
649  // args must be { "remove": <bool> }
650  if (!args) {
651  message = "Missing mandatory 'remove' parameter.";
652  } else {
653  ConstElementPtr remove_name = args->get("remove");
654  if (!remove_name) {
655  message = "Missing mandatory 'remove' parameter.";
656  } else if (remove_name->getType() != Element::boolean) {
657  message = "'remove' parameter expected to be a boolean.";
658  } else {
659  bool remove_lease = remove_name->boolValue();
660  server_->alloc_engine_->reclaimExpiredLeases4(0, 0, remove_lease);
661  status_code = 0;
662  message = "Reclamation of expired leases is complete.";
663  }
664  }
665  ConstElementPtr answer = isc::config::createAnswer(status_code, message);
666  return (answer);
667 }
668 
670 ControlledDhcpv4Srv::commandServerTagGetHandler(const std::string&,
671  ConstElementPtr) {
672  const std::string& tag =
673  CfgMgr::instance().getCurrentCfg()->getServerTag();
674  ElementPtr response = Element::createMap();
675  response->set("server-tag", Element::create(tag));
676 
677  return (createAnswer(CONTROL_RESULT_SUCCESS, response));
678 }
679 
681 ControlledDhcpv4Srv::commandConfigBackendPullHandler(const std::string&,
682  ConstElementPtr) {
683  auto ctl_info = CfgMgr::instance().getCurrentCfg()->getConfigControlInfo();
684  if (!ctl_info) {
685  return (createAnswer(CONTROL_RESULT_EMPTY, "No config backend."));
686  }
687 
688  // stop thread pool (if running)
690 
691  // Reschedule the periodic CB fetch.
692  if (TimerMgr::instance()->isTimerRegistered("Dhcp4CBFetchTimer")) {
693  TimerMgr::instance()->cancel("Dhcp4CBFetchTimer");
694  TimerMgr::instance()->setup("Dhcp4CBFetchTimer");
695  }
696 
697  // Code from cbFetchUpdates.
698  // The configuration to use is the current one because this is called
699  // after the configuration manager commit.
700  try {
701  auto srv_cfg = CfgMgr::instance().getCurrentCfg();
702  auto mode = CBControlDHCPv4::FetchMode::FETCH_UPDATE;
703  server_->getCBControl()->databaseConfigFetch(srv_cfg, mode);
704  } catch (const std::exception& ex) {
706  .arg(ex.what());
708  "On demand configuration update failed: " +
709  string(ex.what())));
710  }
712  "On demand configuration update successful."));
713 }
714 
716 ControlledDhcpv4Srv::commandStatusGetHandler(const string&,
717  ConstElementPtr /*args*/) {
718  ElementPtr status = Element::createMap();
719  status->set("pid", Element::create(static_cast<int>(getpid())));
720 
721  auto now = boost::posix_time::second_clock::universal_time();
722  // Sanity check: start_ is always initialized.
723  if (!start_.is_not_a_date_time()) {
724  auto uptime = now - start_;
725  status->set("uptime", Element::create(uptime.total_seconds()));
726  }
727 
728  auto last_commit = CfgMgr::instance().getCurrentCfg()->getLastCommitTime();
729  if (!last_commit.is_not_a_date_time()) {
730  auto reload = now - last_commit;
731  status->set("reload", Element::create(reload.total_seconds()));
732  }
733 
734  auto& mt_mgr = MultiThreadingMgr::instance();
735  if (mt_mgr.getMode()) {
736  status->set("multi-threading-enabled", Element::create(true));
737  status->set("thread-pool-size", Element::create(static_cast<int32_t>(
738  MultiThreadingMgr::instance().getThreadPoolSize())));
739  status->set("packet-queue-size", Element::create(static_cast<int32_t>(
740  MultiThreadingMgr::instance().getPacketQueueSize())));
741  ElementPtr queue_stats = Element::createList();
742  queue_stats->add(Element::create(mt_mgr.getThreadPool().getQueueStat(10)));
743  queue_stats->add(Element::create(mt_mgr.getThreadPool().getQueueStat(100)));
744  queue_stats->add(Element::create(mt_mgr.getThreadPool().getQueueStat(1000)));
745  status->set("packet-queue-statistics", queue_stats);
746 
747  } else {
748  status->set("multi-threading-enabled", Element::create(false));
749  }
750 
751  return (createAnswer(0, status));
752 }
753 
755 ControlledDhcpv4Srv::commandStatisticSetMaxSampleCountAllHandler(const string&,
756  ConstElementPtr args) {
757  StatsMgr& stats_mgr = StatsMgr::instance();
758  ConstElementPtr answer = stats_mgr.statisticSetMaxSampleCountAllHandler(args);
759  // Update the default parameter.
760  long max_samples = stats_mgr.getMaxSampleCountDefault();
761  CfgMgr::instance().getCurrentCfg()->addConfiguredGlobal(
762  "statistic-default-sample-count", Element::create(max_samples));
763  return (answer);
764 }
765 
767 ControlledDhcpv4Srv::commandStatisticSetMaxSampleAgeAllHandler(const string&,
768  ConstElementPtr args) {
769  StatsMgr& stats_mgr = StatsMgr::instance();
770  ConstElementPtr answer = stats_mgr.statisticSetMaxSampleAgeAllHandler(args);
771  // Update the default parameter.
772  auto duration = stats_mgr.getMaxSampleAgeDefault();
773  long max_age = toSeconds(duration);
774  CfgMgr::instance().getCurrentCfg()->addConfiguredGlobal(
775  "statistic-default-sample-age", Element::create(max_age));
776  return (answer);
777 }
778 
780 ControlledDhcpv4Srv::processCommand(const string& command,
781  ConstElementPtr args) {
782  string txt = args ? args->str() : "(none)";
783 
785  .arg(command).arg(txt);
786 
787  ControlledDhcpv4Srv* srv = ControlledDhcpv4Srv::getInstance();
788 
789  if (!srv) {
791  "Server object not initialized, so can't process command '" +
792  command + "', arguments: '" + txt + "'.");
793  return (no_srv);
794  }
795 
796  try {
797  if (command == "shutdown") {
798  return (srv->commandShutdownHandler(command, args));
799 
800  } else if (command == "libreload") {
801  return (srv->commandLibReloadHandler(command, args));
802 
803  } else if (command == "config-reload") {
804  return (srv->commandConfigReloadHandler(command, args));
805 
806  } else if (command == "config-set") {
807  return (srv->commandConfigSetHandler(command, args));
808 
809  } else if (command == "config-get") {
810  return (srv->commandConfigGetHandler(command, args));
811 
812  } else if (command == "config-test") {
813  return (srv->commandConfigTestHandler(command, args));
814 
815  } else if (command == "dhcp-disable") {
816  return (srv->commandDhcpDisableHandler(command, args));
817 
818  } else if (command == "dhcp-enable") {
819  return (srv->commandDhcpEnableHandler(command, args));
820 
821  } else if (command == "version-get") {
822  return (srv->commandVersionGetHandler(command, args));
823 
824  } else if (command == "build-report") {
825  return (srv->commandBuildReportHandler(command, args));
826 
827  } else if (command == "leases-reclaim") {
828  return (srv->commandLeasesReclaimHandler(command, args));
829 
830  } else if (command == "config-write") {
831  return (srv->commandConfigWriteHandler(command, args));
832 
833  } else if (command == "server-tag-get") {
834  return (srv->commandServerTagGetHandler(command, args));
835 
836  } else if (command == "config-backend-pull") {
837  return (srv->commandConfigBackendPullHandler(command, args));
838 
839  } else if (command == "status-get") {
840  return (srv->commandStatusGetHandler(command, args));
841  }
842 
843  return (isc::config::createAnswer(1, "Unrecognized command:"
844  + command));
845 
846  } catch (const isc::Exception& ex) {
847  return (isc::config::createAnswer(1, "Error while processing command '"
848  + command + "':" + ex.what() +
849  ", params: '" + txt + "'"));
850  }
851 }
852 
854 ControlledDhcpv4Srv::processConfig(isc::data::ConstElementPtr config) {
855  ControlledDhcpv4Srv* srv = ControlledDhcpv4Srv::getInstance();
856 
857  // Single stream instance used in all error clauses
858  std::ostringstream err;
859 
860  if (!srv) {
861  err << "Server object not initialized, can't process config.";
862  return (isc::config::createAnswer(1, err.str()));
863  }
864 
866  .arg(srv->redactConfig(config)->str());
867 
868  ConstElementPtr answer = configureDhcp4Server(*srv, config);
869 
870  // Check that configuration was successful. If not, do not reopen sockets
871  // and don't bother with DDNS stuff.
872  try {
873  int rcode = 0;
874  isc::config::parseAnswer(rcode, answer);
875  if (rcode != 0) {
876  return (answer);
877  }
878  } catch (const std::exception& ex) {
879  err << "Failed to process configuration:" << ex.what();
880  return (isc::config::createAnswer(1, err.str()));
881  }
882 
883  // Re-open lease and host database with new parameters.
884  try {
885  DatabaseConnection::db_lost_callback_ =
886  std::bind(&ControlledDhcpv4Srv::dbLostCallback, srv, ph::_1);
887 
888  DatabaseConnection::db_recovered_callback_ =
889  std::bind(&ControlledDhcpv4Srv::dbRecoveredCallback, srv, ph::_1);
890 
891  DatabaseConnection::db_failed_callback_ =
892  std::bind(&ControlledDhcpv4Srv::dbFailedCallback, srv, ph::_1);
893 
894  CfgDbAccessPtr cfg_db = CfgMgr::instance().getStagingCfg()->getCfgDbAccess();
895  cfg_db->setAppendedParameters("universe=4");
896  cfg_db->createManagers();
897  // Reset counters related to connections as all managers have been recreated.
898  srv->getNetworkState()->reset(NetworkState::Origin::DB_CONNECTION);
899  } catch (const std::exception& ex) {
900  err << "Unable to open database: " << ex.what();
901  return (isc::config::createAnswer(1, err.str()));
902  }
903 
904  // Server will start DDNS communications if its enabled.
905  try {
906  srv->startD2();
907  } catch (const std::exception& ex) {
908  err << "Error starting DHCP_DDNS client after server reconfiguration: "
909  << ex.what();
910  return (isc::config::createAnswer(1, err.str()));
911  }
912 
913  // Setup DHCPv4-over-DHCPv6 IPC
914  try {
915  Dhcp4to6Ipc::instance().open();
916  } catch (const std::exception& ex) {
917  std::ostringstream err;
918  err << "error starting DHCPv4-over-DHCPv6 IPC "
919  " after server reconfiguration: " << ex.what();
920  return (isc::config::createAnswer(1, err.str()));
921  }
922 
923  // Configure DHCP packet queueing
924  try {
926  qc = CfgMgr::instance().getStagingCfg()->getDHCPQueueControl();
927  if (IfaceMgr::instance().configureDHCPPacketQueue(AF_INET, qc)) {
929  .arg(IfaceMgr::instance().getPacketQueue4()->getInfoStr());
930  }
931 
932  } catch (const std::exception& ex) {
933  err << "Error setting packet queue controls after server reconfiguration: "
934  << ex.what();
935  return (isc::config::createAnswer(1, err.str()));
936  }
937 
938  // Configure a callback to shut down the server when the bind socket
939  // attempts exceeded.
940  CfgIface::open_sockets_failed_callback_ =
941  std::bind(&ControlledDhcpv4Srv::openSocketsFailedCallback, srv, ph::_1);
942 
943  // Configuration may change active interfaces. Therefore, we have to reopen
944  // sockets according to new configuration. It is possible that this
945  // operation will fail for some interfaces but the openSockets function
946  // guards against exceptions and invokes a callback function to
947  // log warnings. Since we allow that this fails for some interfaces there
948  // is no need to rollback configuration if socket fails to open on any
949  // of the interfaces.
950  CfgMgr::instance().getStagingCfg()->getCfgIface()->
951  openSockets(AF_INET, srv->getServerPort(),
952  getInstance()->useBroadcast());
953 
954  // Install the timers for handling leases reclamation.
955  try {
956  CfgMgr::instance().getStagingCfg()->getCfgExpiration()->
957  setupTimers(&ControlledDhcpv4Srv::reclaimExpiredLeases,
958  &ControlledDhcpv4Srv::deleteExpiredReclaimedLeases,
959  server_);
960 
961  } catch (const std::exception& ex) {
962  err << "unable to setup timers for periodically running the"
963  " reclamation of the expired leases: "
964  << ex.what() << ".";
965  return (isc::config::createAnswer(1, err.str()));
966  }
967 
968  // Setup config backend polling, if configured for it.
969  auto ctl_info = CfgMgr::instance().getStagingCfg()->getConfigControlInfo();
970  if (ctl_info) {
971  long fetch_time = static_cast<long>(ctl_info->getConfigFetchWaitTime());
972  // Only schedule the CB fetch timer if the fetch wait time is greater
973  // than 0.
974  if (fetch_time > 0) {
975  // When we run unit tests, we want to use milliseconds unit for the
976  // specified interval. Otherwise, we use seconds. Note that using
977  // milliseconds as a unit in unit tests prevents us from waiting 1
978  // second on more before the timer goes off. Instead, we wait one
979  // millisecond which significantly reduces the test time.
980  if (!server_->inTestMode()) {
981  fetch_time = 1000 * fetch_time;
982  }
983 
984  boost::shared_ptr<unsigned> failure_count(new unsigned(0));
985  TimerMgr::instance()->
986  registerTimer("Dhcp4CBFetchTimer",
987  std::bind(&ControlledDhcpv4Srv::cbFetchUpdates,
988  server_, CfgMgr::instance().getStagingCfg(),
989  failure_count),
990  fetch_time,
992  TimerMgr::instance()->setup("Dhcp4CBFetchTimer");
993  }
994  }
995 
996  // Finally, we can commit runtime option definitions in libdhcp++. This is
997  // exception free.
998  LibDHCP::commitRuntimeOptionDefs();
999 
1000  // This hook point notifies hooks libraries that the configuration of the
1001  // DHCPv4 server has completed. It provides the hook library with the pointer
1002  // to the common IO service object, new server configuration in the JSON
1003  // format and with the pointer to the configuration storage where the
1004  // parsed configuration is stored.
1005  if (HooksManager::calloutsPresent(Hooks.hooks_index_dhcp4_srv_configured_)) {
1006  CalloutHandlePtr callout_handle = HooksManager::createCalloutHandle();
1007 
1008  callout_handle->setArgument("io_context", srv->getIOService());
1009  callout_handle->setArgument("network_state", srv->getNetworkState());
1010  callout_handle->setArgument("json_config", config);
1011  callout_handle->setArgument("server_config", CfgMgr::instance().getStagingCfg());
1012 
1013  HooksManager::callCallouts(Hooks.hooks_index_dhcp4_srv_configured_,
1014  *callout_handle);
1015 
1016  // Ignore status code as none of them would have an effect on further
1017  // operation.
1018  }
1019 
1020  // Apply multi threading settings.
1021  // @note These settings are applied/updated only if no errors occur while
1022  // applying the new configuration.
1023  // @todo This should be fixed.
1024  try {
1025  CfgMultiThreading::apply(CfgMgr::instance().getStagingCfg()->getDHCPMultiThreading());
1026  } catch (const std::exception& ex) {
1027  err << "Error applying multi threading settings: "
1028  << ex.what();
1029  return (isc::config::createAnswer(CONTROL_RESULT_ERROR, err.str()));
1030  }
1031 
1032  return (answer);
1033 }
1034 
1036 ControlledDhcpv4Srv::checkConfig(isc::data::ConstElementPtr config) {
1037 
1039  .arg(redactConfig(config)->str());
1040 
1041  ControlledDhcpv4Srv* srv = ControlledDhcpv4Srv::getInstance();
1042 
1043  // Single stream instance used in all error clauses
1044  std::ostringstream err;
1045 
1046  if (!srv) {
1047  err << "Server object not initialized, can't process config.";
1048  return (isc::config::createAnswer(1, err.str()));
1049  }
1050 
1051  return (configureDhcp4Server(*srv, config, true));
1052 }
1053 
1054 ControlledDhcpv4Srv::ControlledDhcpv4Srv(uint16_t server_port /*= DHCP4_SERVER_PORT*/,
1055  uint16_t client_port /*= 0*/)
1056  : Dhcpv4Srv(server_port, client_port), timer_mgr_(TimerMgr::instance()) {
1057  if (getInstance()) {
1059  "There is another Dhcpv4Srv instance already.");
1060  }
1061  server_ = this; // remember this instance for later use in handlers
1062 
1063  // TimerMgr uses IO service to run asynchronous timers.
1064  TimerMgr::instance()->setIOService(getIOService());
1065 
1066  // CommandMgr uses IO service to run asynchronous socket operations.
1067  CommandMgr::instance().setIOService(getIOService());
1068 
1069  // LeaseMgr uses IO service to run asynchronous timers.
1071 
1072  // HostMgr uses IO service to run asynchronous timers.
1074 
1075  // These are the commands always supported by the DHCPv4 server.
1076  // Please keep the list in alphabetic order.
1077  CommandMgr::instance().registerCommand("build-report",
1078  std::bind(&ControlledDhcpv4Srv::commandBuildReportHandler, this, ph::_1, ph::_2));
1079 
1080  CommandMgr::instance().registerCommand("config-backend-pull",
1081  std::bind(&ControlledDhcpv4Srv::commandConfigBackendPullHandler, this, ph::_1, ph::_2));
1082 
1083  CommandMgr::instance().registerCommand("config-get",
1084  std::bind(&ControlledDhcpv4Srv::commandConfigGetHandler, this, ph::_1, ph::_2));
1085 
1086  CommandMgr::instance().registerCommand("config-reload",
1087  std::bind(&ControlledDhcpv4Srv::commandConfigReloadHandler, this, ph::_1, ph::_2));
1088 
1089  CommandMgr::instance().registerCommand("config-set",
1090  std::bind(&ControlledDhcpv4Srv::commandConfigSetHandler, this, ph::_1, ph::_2));
1091 
1092  CommandMgr::instance().registerCommand("config-test",
1093  std::bind(&ControlledDhcpv4Srv::commandConfigTestHandler, this, ph::_1, ph::_2));
1094 
1095  CommandMgr::instance().registerCommand("config-write",
1096  std::bind(&ControlledDhcpv4Srv::commandConfigWriteHandler, this, ph::_1, ph::_2));
1097 
1098  CommandMgr::instance().registerCommand("dhcp-enable",
1099  std::bind(&ControlledDhcpv4Srv::commandDhcpEnableHandler, this, ph::_1, ph::_2));
1100 
1101  CommandMgr::instance().registerCommand("dhcp-disable",
1102  std::bind(&ControlledDhcpv4Srv::commandDhcpDisableHandler, this, ph::_1, ph::_2));
1103 
1104  CommandMgr::instance().registerCommand("libreload",
1105  std::bind(&ControlledDhcpv4Srv::commandLibReloadHandler, this, ph::_1, ph::_2));
1106 
1107  CommandMgr::instance().registerCommand("leases-reclaim",
1108  std::bind(&ControlledDhcpv4Srv::commandLeasesReclaimHandler, this, ph::_1, ph::_2));
1109 
1110  CommandMgr::instance().registerCommand("server-tag-get",
1111  std::bind(&ControlledDhcpv4Srv::commandServerTagGetHandler, this, ph::_1, ph::_2));
1112 
1113  CommandMgr::instance().registerCommand("shutdown",
1114  std::bind(&ControlledDhcpv4Srv::commandShutdownHandler, this, ph::_1, ph::_2));
1115 
1116  CommandMgr::instance().registerCommand("status-get",
1117  std::bind(&ControlledDhcpv4Srv::commandStatusGetHandler, this, ph::_1, ph::_2));
1118 
1119  CommandMgr::instance().registerCommand("version-get",
1120  std::bind(&ControlledDhcpv4Srv::commandVersionGetHandler, this, ph::_1, ph::_2));
1121 
1122  // Register statistic related commands
1123  CommandMgr::instance().registerCommand("statistic-get",
1124  std::bind(&StatsMgr::statisticGetHandler, ph::_1, ph::_2));
1125 
1126  CommandMgr::instance().registerCommand("statistic-reset",
1127  std::bind(&StatsMgr::statisticResetHandler, ph::_1, ph::_2));
1128 
1129  CommandMgr::instance().registerCommand("statistic-remove",
1130  std::bind(&StatsMgr::statisticRemoveHandler, ph::_1, ph::_2));
1131 
1132  CommandMgr::instance().registerCommand("statistic-get-all",
1133  std::bind(&StatsMgr::statisticGetAllHandler, ph::_1, ph::_2));
1134 
1135  CommandMgr::instance().registerCommand("statistic-reset-all",
1136  std::bind(&StatsMgr::statisticResetAllHandler, ph::_1, ph::_2));
1137 
1138  CommandMgr::instance().registerCommand("statistic-remove-all",
1139  std::bind(&StatsMgr::statisticRemoveAllHandler, ph::_1, ph::_2));
1140 
1141  CommandMgr::instance().registerCommand("statistic-sample-age-set",
1142  std::bind(&StatsMgr::statisticSetMaxSampleAgeHandler, ph::_1, ph::_2));
1143 
1144  CommandMgr::instance().registerCommand("statistic-sample-age-set-all",
1145  std::bind(&ControlledDhcpv4Srv::commandStatisticSetMaxSampleAgeAllHandler, this, ph::_1, ph::_2));
1146 
1147  CommandMgr::instance().registerCommand("statistic-sample-count-set",
1148  std::bind(&StatsMgr::statisticSetMaxSampleCountHandler, ph::_1, ph::_2));
1149 
1150  CommandMgr::instance().registerCommand("statistic-sample-count-set-all",
1151  std::bind(&ControlledDhcpv4Srv::commandStatisticSetMaxSampleCountAllHandler, this, ph::_1, ph::_2));
1152 }
1153 
1155  setExitValue(exit_value);
1156  getIOService()->stop(); // Stop ASIO transmissions
1157  shutdown(); // Initiate DHCPv4 shutdown procedure.
1158 }
1159 
1161  try {
1163  HostMgr::create();
1164  cleanup();
1165 
1166  // The closure captures either a shared pointer (memory leak)
1167  // or a raw pointer (pointing to a deleted object).
1171 
1172  timer_mgr_->unregisterTimers();
1173 
1174  // Close the command socket (if it exists).
1175  CommandMgr::instance().closeCommandSocket();
1176 
1177  // Deregister any registered commands (please keep in alphabetic order)
1178  CommandMgr::instance().deregisterCommand("build-report");
1179  CommandMgr::instance().deregisterCommand("config-backend-pull");
1180  CommandMgr::instance().deregisterCommand("config-get");
1181  CommandMgr::instance().deregisterCommand("config-reload");
1182  CommandMgr::instance().deregisterCommand("config-set");
1183  CommandMgr::instance().deregisterCommand("config-test");
1184  CommandMgr::instance().deregisterCommand("config-write");
1185  CommandMgr::instance().deregisterCommand("dhcp-disable");
1186  CommandMgr::instance().deregisterCommand("dhcp-enable");
1187  CommandMgr::instance().deregisterCommand("leases-reclaim");
1188  CommandMgr::instance().deregisterCommand("libreload");
1189  CommandMgr::instance().deregisterCommand("server-tag-get");
1190  CommandMgr::instance().deregisterCommand("shutdown");
1191  CommandMgr::instance().deregisterCommand("statistic-get");
1192  CommandMgr::instance().deregisterCommand("statistic-get-all");
1193  CommandMgr::instance().deregisterCommand("statistic-remove");
1194  CommandMgr::instance().deregisterCommand("statistic-remove-all");
1195  CommandMgr::instance().deregisterCommand("statistic-reset");
1196  CommandMgr::instance().deregisterCommand("statistic-reset-all");
1197  CommandMgr::instance().deregisterCommand("statistic-sample-age-set");
1198  CommandMgr::instance().deregisterCommand("statistic-sample-age-set-all");
1199  CommandMgr::instance().deregisterCommand("statistic-sample-count-set");
1200  CommandMgr::instance().deregisterCommand("statistic-sample-count-set-all");
1201  CommandMgr::instance().deregisterCommand("status-get");
1202  CommandMgr::instance().deregisterCommand("version-get");
1203 
1204  // LeaseMgr uses IO service to run asynchronous timers.
1206 
1207  // HostMgr uses IO service to run asynchronous timers.
1209  } catch (...) {
1210  // Don't want to throw exceptions from the destructor. The server
1211  // is shutting down anyway.
1212  ;
1213  }
1214 
1215  server_ = NULL; // forget this instance. There should be no callback anymore
1216  // at this stage anyway.
1217 }
1218 
1219 void
1220 ControlledDhcpv4Srv::reclaimExpiredLeases(const size_t max_leases,
1221  const uint16_t timeout,
1222  const bool remove_lease,
1223  const uint16_t max_unwarned_cycles) {
1224  try {
1225  server_->alloc_engine_->reclaimExpiredLeases4(max_leases, timeout,
1226  remove_lease,
1227  max_unwarned_cycles);
1228  } catch (const std::exception& ex) {
1230  .arg(ex.what());
1231  }
1232  // We're using the ONE_SHOT timer so there is a need to re-schedule it.
1234 }
1235 
1236 void
1237 ControlledDhcpv4Srv::deleteExpiredReclaimedLeases(const uint32_t secs) {
1238  server_->alloc_engine_->deleteExpiredReclaimedLeases4(secs);
1239  // We're using the ONE_SHOT timer so there is a need to re-schedule it.
1241 }
1242 
1243 bool
1244 ControlledDhcpv4Srv::dbLostCallback(ReconnectCtlPtr db_reconnect_ctl) {
1245  if (!db_reconnect_ctl) {
1246  // This should never happen
1248  return (false);
1249  }
1250 
1251  // Disable service until the connection is recovered.
1252  if (db_reconnect_ctl->retriesLeft() == db_reconnect_ctl->maxRetries() &&
1253  db_reconnect_ctl->alterServiceState()) {
1255  }
1256 
1258 
1259  // If reconnect isn't enabled log it, initiate a shutdown if needed and
1260  // return false.
1261  if (!db_reconnect_ctl->retriesLeft() ||
1262  !db_reconnect_ctl->retryInterval()) {
1264  .arg(db_reconnect_ctl->retriesLeft())
1265  .arg(db_reconnect_ctl->retryInterval());
1266  if (db_reconnect_ctl->exitOnFailure()) {
1267  shutdownServer(EXIT_FAILURE);
1268  }
1269  return (false);
1270  }
1271 
1272  return (true);
1273 }
1274 
1275 bool
1276 ControlledDhcpv4Srv::dbRecoveredCallback(ReconnectCtlPtr db_reconnect_ctl) {
1277  if (!db_reconnect_ctl) {
1278  // This should never happen
1280  return (false);
1281  }
1282 
1283  // Enable service after the connection is recovered.
1284  if (db_reconnect_ctl->alterServiceState()) {
1286  }
1287 
1289 
1290  db_reconnect_ctl->resetRetries();
1291 
1292  return (true);
1293 }
1294 
1295 bool
1296 ControlledDhcpv4Srv::dbFailedCallback(ReconnectCtlPtr db_reconnect_ctl) {
1297  if (!db_reconnect_ctl) {
1298  // This should never happen
1300  return (false);
1301  }
1302 
1304  .arg(db_reconnect_ctl->maxRetries());
1305 
1306  if (db_reconnect_ctl->exitOnFailure()) {
1307  shutdownServer(EXIT_FAILURE);
1308  }
1309 
1310  return (true);
1311 }
1312 
1313 void
1314 ControlledDhcpv4Srv::openSocketsFailedCallback(ReconnectCtlPtr reconnect_ctl) {
1315  if (!reconnect_ctl) {
1316  // This should never happen
1318  return;
1319  }
1320 
1322  .arg(reconnect_ctl->maxRetries());
1323 
1324  if (reconnect_ctl->exitOnFailure()) {
1325  shutdownServer(EXIT_FAILURE);
1326  }
1327 }
1328 
1329 void
1330 ControlledDhcpv4Srv::cbFetchUpdates(const SrvConfigPtr& srv_cfg,
1331  boost::shared_ptr<unsigned> failure_count) {
1332  // stop thread pool (if running)
1334 
1335  try {
1336  // Fetch any configuration backend updates since our last fetch.
1337  server_->getCBControl()->databaseConfigFetch(srv_cfg,
1338  CBControlDHCPv4::FetchMode::FETCH_UPDATE);
1339  (*failure_count) = 0;
1340 
1341  } catch (const std::exception& ex) {
1343  .arg(ex.what());
1344 
1345  // We allow at most 10 consecutive failures after which we stop
1346  // making further attempts to fetch the configuration updates.
1347  // Let's return without re-scheduling the timer.
1348  if (++(*failure_count) > 10) {
1351  return;
1352  }
1353  }
1354 
1355  // Reschedule the timer to fetch new updates or re-try if
1356  // the previous attempt resulted in an error.
1357  if (TimerMgr::instance()->isTimerRegistered("Dhcp4CBFetchTimer")) {
1358  TimerMgr::instance()->setup("Dhcp4CBFetchTimer");
1359  }
1360 }
1361 
1362 } // namespace dhcp
1363 } // namespace isc
DHCPv4 server service.
Definition: dhcp4_srv.h:253
RAII class creating a critical section.
const isc::log::MessageID DHCP4_RECLAIM_EXPIRED_LEASES_FAIL
#define LOG_WARN(LOGGER, MESSAGE)
Macro to conveniently test warn output and log it.
Definition: macros.h:26
const isc::log::MessageID DHCP4_DB_RECONNECT_LOST_CONNECTION
const isc::log::MessageID DHCP4_OPEN_SOCKETS_FAILED
const isc::log::MessageID DHCP4_DYNAMIC_RECONFIGURATION_FAIL
static DbCallback db_lost_callback_
Optional callback function to invoke if an opened connection is lost.
isc::data::ElementPtr parseFile(const std::string &filename, ParserType parser_type)
Run the parser on the file specified.
#define LOG_INFO(LOGGER, MESSAGE)
Macro to conveniently test info output and log it.
Definition: macros.h:20
ConstElementPtr createAnswer(const int status_code, const std::string &text, const ConstElementPtr &arg)
const int CONTROL_RESULT_SUCCESS
Status code indicating a successful operation.
static void setIOService(const isc::asiolink::IOServicePtr &io_service)
Sets IO service to be used by the Host Manager.
Definition: host_mgr.h:638
isc::data::ConstElementPtr statisticSetMaxSampleCountAllHandler(const isc::data::ConstElementPtr &params)
Handles statistic-sample-count-set-all command.
Evaluation context, an interface to the expression evaluation.
boost::shared_ptr< ReconnectCtl > ReconnectCtlPtr
Pointer to an instance of ReconnectCtl.
isc::data::ConstElementPtr configureDhcp4Server(Dhcpv4Srv &server, isc::data::ConstElementPtr config_set, bool check_only)
Configure DHCPv4 server (Dhcpv4Srv) with a set of configuration values.
static void destroy()
Destroy lease manager.
const isc::log::MessageID DHCP4_DB_RECONNECT_NO_DB_CTL
const isc::log::MessageID DHCP4_DB_RECONNECT_FAILED
Manages a pool of asynchronous interval timers.
Definition: timer_mgr.h:62
boost::shared_ptr< SrvConfig > SrvConfigPtr
Non-const pointer to the SrvConfig.
Definition: srv_config.h:1165
The network state is being altered by the DB connection recovery mechanics.
const isc::log::MessageID DHCP4_CB_ON_DEMAND_FETCH_UPDATES_FAIL
#define LOG_ERROR(LOGGER, MESSAGE)
Macro to conveniently test error output and log it.
Definition: macros.h:32
const isc::log::MessageID DHCP4_MULTI_THREADING_INFO
const int CONTROL_RESULT_ERROR
Status code indicating a general failure.
boost::shared_ptr< Element > ElementPtr
Definition: data.h:24
STL namespace.
const isc::log::MessageID DHCP4_DYNAMIC_RECONFIGURATION_SUCCESS
const isc::log::MessageID DHCP4_CONFIG_PACKET_QUEUE
const isc::log::MessageID DHCP4_CONFIG_UNSUPPORTED_OBJECT
virtual const char * what() const
Returns a C-style character string of the cause of the exception.
static DbCallback db_failed_callback_
Optional callback function to invoke if an opened connection recovery failed.
Statistics Manager class.
std::vector< HookLibInfo > HookLibsCollection
A storage for information about hook libraries.
Definition: libinfo.h:31
const int CONTROL_RESULT_EMPTY
Status code indicating that the specified command was completed correctly, but failed to produce any ...
isc::log::Logger dhcp4_logger(DHCP4_APP_LOGGER_NAME)
Base logger for DHCPv4 server.
Definition: dhcp4_log.h:90
Origin
Origin of the network state transition.
Definition: network_state.h:84
const isc::log::MessageID DHCP4_DB_RECONNECT_SUCCEEDED
#define isc_throw(type, stream)
A shortcut macro to insert known values into exception arguments.
A generic exception that is thrown if a parameter given to a method is considered invalid in that con...
static const std::string FLUSH_RECLAIMED_TIMER_NAME
Name of the timer for flushing reclaimed leases.
asiolink::IOServicePtr & getIOService()
Returns pointer to the IO service used by the server.
Definition: dhcp4_srv.h:304
Definition: edns.h:19
virtual ~ControlledDhcpv4Srv()
Destructor.
boost::shared_ptr< CfgDbAccess > CfgDbAccessPtr
A pointer to the CfgDbAccess.
static void create()
Creates new instance of the HostMgr.
Definition: host_mgr.cc:43
const isc::log::MessageID DHCP4_CB_PERIODIC_FETCH_UPDATES_FAIL
A generic exception that is thrown when an unexpected error condition occurs.
static DbCallback db_recovered_callback_
Optional callback function to invoke if an opened connection recovery succeeded.
const isc::log::MessageID DHCP4_DYNAMIC_RECONFIGURATION
boost::shared_ptr< const Element > ConstElementPtr
Definition: data.h:27
isc::data::ConstElementPtr redactConfig(isc::data::ConstElementPtr const &config)
Redact a configuration.
Definition: daemon.cc:257
uint32_t getMaxSampleCountDefault() const
Get default count limit.
void cleanup()
Performs cleanup, immediately before termination.
uint16_t getServerPort() const
Get UDP port on which server should listen.
Definition: dhcp4_srv.h:411
const isc::log::MessageID DHCP4_CONFIG_UNRECOVERABLE_ERROR
ConstElementPtr redactConfig(ConstElementPtr const &element, list< string > const &json_path)
Redact a configuration.
boost::shared_ptr< AllocEngine > alloc_engine_
Allocation Engine.
Definition: dhcp4_srv.h:1131
const isc::log::MessageID DHCP4_OPEN_SOCKETS_NO_RECONNECT_CTL
This is a base class for exceptions thrown from the DNS library module.
ConstElementPtr parseAnswer(int &rcode, const ConstElementPtr &msg)
Defines the logger used by the top-level component of kea-lfc.
NetworkStatePtr network_state_
Holds information about disabled DHCP service and/or disabled subnet/network scopes.
Definition: dhcp4_srv.h:1138
void startD2()
Starts DHCP_DDNS client IO if DDNS updates are enabled.
Definition: dhcp4_srv.cc:4148
const isc::log::MessageID DHCP4_CB_PERIODIC_FETCH_UPDATES_RETRIES_EXHAUSTED
void setExitValue(int value)
Sets the exit value.
Definition: daemon.h:227
boost::shared_ptr< CalloutHandle > CalloutHandlePtr
A shared pointer to a CalloutHandle object.
static const std::string RECLAIM_EXPIRED_TIMER_NAME
Name of the timer for reclaiming expired leases.
const isc::log::MessageID DHCP4_CONFIG_RECEIVED
This file contains several functions and constants that are used for handling commands and responses ...
CtrlAgentHooks Hooks
const isc::log::MessageID DHCP4_HOOKS_LIBS_RELOAD_FAIL
const isc::log::MessageID DHCP4_CONFIG_LOAD_FAIL
A generic exception that is thrown if a function is called in a prohibited way.
const isc::log::MessageID DHCP4_NOT_RUNNING
#define LOG_DEBUG(LOGGER, LEVEL, MESSAGE)
Macro to conveniently test debug output and log it.
Definition: macros.h:14
isc::data::ConstElementPtr statisticSetMaxSampleAgeAllHandler(const isc::data::ConstElementPtr &params)
Handles statistic-sample-age-set-all command.
static ControlledDhcpv4Srv * getInstance()
Returns pointer to the sole instance of Dhcpv4Srv.
const isc::log::MessageID DHCP4_DB_RECONNECT_DISABLED
Controlled version of the DHCPv4 server.
std::string getConfigReport()
Definition: cfgrpt.cc:20
Defines the Dhcp4o6Ipc class.
static void setIOService(const isc::asiolink::IOServicePtr &io_service)
Sets IO service to be used by the Lease Manager.
Definition: lease_mgr.h:786
const isc::log::MessageID DHCP4_COMMAND_RECEIVED
#define LOG_FATAL(LOGGER, MESSAGE)
Macro to conveniently test fatal output and log it.
Definition: macros.h:38
void shutdown() override
Instructs the server to shut down.
Definition: dhcp4_srv.cc:728
CBControlDHCPv4Ptr getCBControl() const
Returns an object which controls access to the configuration backends.
Definition: dhcp4_srv.h:318
static const TimerMgrPtr & instance()
Returns pointer to the sole instance of the TimerMgr.
Definition: timer_mgr.cc:449
const int DBG_DHCP4_COMMAND
Debug level used to log receiving commands.
Definition: dhcp4_log.h:30
NetworkStatePtr & getNetworkState()
Returns pointer to the network state used by the server.
Definition: dhcp4_srv.h:309
const StatsDuration & getMaxSampleAgeDefault() const
Get default duration limit.
void shutdownServer(int exit_value)
Initiates shutdown procedure for the whole DHCPv4 server.
Contains declarations for loggers used by the DHCPv4 server component.
long toSeconds(const StatsDuration &dur)
Returns the number of seconds in a duration.
Definition: observation.h:45