Kea 3.3.4
hooks_manager.h
Go to the documentation of this file.
1// Copyright (C) 2013-2023 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#ifndef HOOKS_MANAGER_H
8#define HOOKS_MANAGER_H
9
10#include <hooks/server_hooks.h>
11#include <hooks/libinfo.h>
12
13#include <boost/noncopyable.hpp>
14#include <boost/shared_ptr.hpp>
15
16#include <string>
17#include <vector>
18
19namespace isc {
20namespace hooks {
21
29public:
30 LibrariesStillOpened(const char* file, size_t line, const char* what) :
31 isc::Exception(file, line, what) {}
32};
33
34// Forward declarations
35class CalloutHandle;
36class CalloutManager;
37class LibraryHandle;
38class LibraryManagerCollection;
39
49
50class HooksManager : boost::noncopyable {
51public:
52
76 static bool loadLibraries(const HookLibsCollection& libraries,
77 bool multi_threading_enabled = false);
78
98 static bool loadLibraries(const HookLibsCollection& libraries,
99 bool multi_threading_enabled,
100 std::string& info);
101
120 static bool unloadLibraries();
121
137 static void prepareUnloadLibraries();
138
148 static bool calloutsPresent(int index);
149
159 static bool commandHandlersPresent(const std::string& command_name);
160
172 static void callCallouts(int index, CalloutHandle& handle);
173
187 static void callCommandHandlers(const std::string& command_name,
188 CalloutHandle& handle);
189
205
221
231 static boost::shared_ptr<CalloutHandle> createCalloutHandle();
232
249 static int registerHook(const std::string& name);
250
256 static std::vector<std::string> getLibraryNames();
257
264
281 static std::vector<std::string> validateLibraries(const std::vector<std::string>& libraries,
282 bool multi_threading_enabled = false);
283
287
318 template<typename T>
319 static void park(const std::string& hook_name, T parked_object,
320 std::function<void()> unpark_callback) {
322 getParkingLotPtr(hook_name)->park(parked_object, unpark_callback);
323 }
324
335 template<typename T>
336 static bool unpark(const std::string& hook_name, T parked_object) {
338 getParkingLotPtr(hook_name)->unpark(parked_object, true));
339 }
340
347 template<typename T>
348 static bool drop(const std::string& hook_name, T parked_object) {
350 getParkingLotPtr(hook_name)->drop(parked_object));
351 }
352
362 template<typename T>
363 static void reference(const std::string& hook_name, T parked_object) {
365 getParkingLotPtr(hook_name)->reference(parked_object);
366 }
367
373 static void clearParkingLots() {
375 }
376
385 static void setTestMode(bool mode);
386
390 static bool getTestMode();
391
392private:
393
398 HooksManager();
399
403 static HooksManager& getHooksManager();
404
406
409
423 bool loadLibrariesInternal(const HookLibsCollection& libraries,
424 bool multi_threading_enabled,
425 std::string& info);
426
431 bool unloadLibrariesInternal();
432
434 void prepareUnloadLibrariesInternal();
435
442 bool calloutsPresentInternal(int index);
443
453 bool commandHandlersPresentInternal(const std::string& command_name);
454
460 void callCalloutsInternal(int index, CalloutHandle& handle);
461
470 void callCommandHandlersInternal(const std::string& command_name,
471 CalloutHandle& handle);
472
476 boost::shared_ptr<CalloutHandle> createCalloutHandleInternal();
477
482 LibraryHandle& preCalloutsLibraryHandleInternal();
483
488 LibraryHandle& postCalloutsLibraryHandleInternal();
489
493 std::vector<std::string> getLibraryNamesInternal() const;
494
496 HookLibsCollection getLibraryInfoInternal() const;
497
499
500 // Members
501
505 boost::shared_ptr<LibraryManagerCollection> lm_collection_;
506
510 boost::shared_ptr<CalloutManager> callout_manager_;
511
516 bool test_mode_;
517};
518
519} // namespace util
520} // namespace hooks
521
522#endif // HOOKS_MANAGER_H
Per-packet callout handle.
Exception(const char *file, size_t line, const char *what)
Constructor for a given type for exceptions with file name and file line number.
virtual const char * what() const
Returns a C-style character string of the cause of the exception.
Per-packet callout handle.
static int registerHook(const std::string &name)
Register Hook.
static LibraryHandle & postCalloutsLibraryHandle()
Return post-callouts library handle.
static bool calloutsPresent(int index)
Are callouts present?
static bool unpark(const std::string &hook_name, T parked_object)
Forces unparking the object (packet).
static void setTestMode(bool mode)
Set test mode.
static std::vector< std::string > getLibraryNames()
Return list of loaded libraries.
static void callCommandHandlers(const std::string &command_name, CalloutHandle &handle)
Calls the callouts/command handlers for a given command name.
static const int CONTEXT_CREATE
Index numbers for pre-defined hooks.
static std::vector< std::string > validateLibraries(const std::vector< std::string > &libraries, bool multi_threading_enabled=false)
Validate library list.
static bool unloadLibraries()
Unload libraries.
static bool loadLibraries(const HookLibsCollection &libraries, bool multi_threading_enabled=false)
Load and reload libraries.
static const int CONTEXT_DESTROY
static void park(const std::string &hook_name, T parked_object, std::function< void()> unpark_callback)
Park an object (packet).
static LibraryHandle & preCalloutsLibraryHandle()
Return pre-callouts library handle.
static bool commandHandlersPresent(const std::string &command_name)
Checks if control command handlers are present for the specified command.
static boost::shared_ptr< CalloutHandle > createCalloutHandle()
Return callout handle.
static void reference(const std::string &hook_name, T parked_object)
Increases reference counter for the parked object.
static void callCallouts(int index, CalloutHandle &handle)
Calls the callouts for a given hook.
static bool getTestMode()
Get test mode.
static HookLibsCollection getLibraryInfo()
Return list of loaded libraries with its parameters.
static void prepareUnloadLibraries()
Prepare the unloading of libraries.
static bool drop(const std::string &hook_name, T parked_object)
Removes parked object without calling a callback.
static void clearParkingLots()
Clears any parking packets.
LibrariesStillOpened(const char *file, size_t line, const char *what)
static ServerHooks & getServerHooks()
Return ServerHooks object.
static const int CONTEXT_DESTROY
ParkingLotsPtr getParkingLotsPtr() const
Returns pointer to all parking lots.
static const int CONTEXT_CREATE
Index numbers for pre-defined hooks.
std::vector< HookLibInfo > HookLibsCollection
A storage for information about hook libraries.
Definition libinfo.h:51
Defines the logger used by the top-level component of kea-lfc.