lfc_controller.cc 13.4 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14
// Copyright (C) 2015  Internet Systems Consortium, Inc. ("ISC")
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
// copyright notice and this permission notice appear in all copies.
//
// THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
// AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.

15
#include <lfc/lfc_controller.h>
16
#include <lfc/lfc_log.h>
17
#include <util/pid_file.h>
18
#include <exceptions/exceptions.h>
19 20 21 22 23
#include <dhcpsrv/csv_lease_file4.h>
#include <dhcpsrv/csv_lease_file6.h>
#include <dhcpsrv/memfile_lease_storage.h>
#include <dhcpsrv/lease_mgr.h>
#include <dhcpsrv/lease_file_loader.h>
24 25
#include <log/logger_manager.h>
#include <log/logger_name.h>
Shawn Routhier's avatar
Shawn Routhier committed
26
#include <config.h>
27

28
#include <iostream>
29 30
#include <sstream>
#include <unistd.h>
31
#include <stdlib.h>
32
#include <cerrno>
33 34

using namespace std;
35
using namespace isc::util;
36
using namespace isc::dhcp;
37
using namespace isc::log;
38

39 40 41 42 43
namespace {
/// @brief Maximum number of errors to allow when reading leases from the file.
const uint32_t MAX_LEASE_ERRORS = 100;
}; // namespace anonymous

44 45 46 47 48
namespace isc {
namespace lfc {

/// @brief Defines the application name, it may be used to locate
/// configuration data and appears in log statements.
49
const char* LFCController::lfc_app_name_ = "DhcpLFC";
50 51

/// @brief Defines the executable name.
52
const char* LFCController::lfc_bin_name_ = "kea-lfc";
53

54
LFCController::LFCController()
55
    : protocol_version_(0), verbose_(false), config_file_(""), previous_file_(""),
Shawn Routhier's avatar
Shawn Routhier committed
56
      copy_file_(""), output_file_(""), finish_file_(""), pid_file_("") {
57 58
}

59
LFCController::~LFCController() {
60 61 62
}

void
63
LFCController::launch(int argc, char* argv[], const bool test_mode) {
64
    bool do_rotate = true;
65

66 67 68 69 70 71 72 73 74 75 76 77 78 79
    // It would be nice to set up the logger as the first step
    // in the process, but we don't know where to send logging
    // info until after we have parsed our arguments.  As we
    // don't currently log anything when trying to parse the
    // arguments we do the parse before the logging setup.  If
    // we do decide to log something then the code will need
    // to move around a bit.

    try {
        parseArgs(argc, argv);
    } catch (const InvalidUsage& ex) {
        usage(ex.what());
        throw;  // rethrow it
    }
80 81 82 83 84 85 86 87 88
    // If we are running in test mode use the environment variables
    // else use our defaults
    if (test_mode) {
        initLogger();
    }
    else {
        OutputOption option;
        LoggerManager manager;

89
        initLogger(lfc_app_name_, INFO, 0, NULL, false);
90

91 92 93 94 95
        // Prepare the objects to define the logging specification
        LoggerSpecification spec(getRootLoggerName(),
                                 keaLoggerSeverity(INFO),
                                 keaLoggerDbglevel(0));

96 97 98 99 100 101 102 103
	// If we are running in verbose (debugging) mode
	// we send the output to the console, otherwise
	// by default we send it to the SYSLOG
	if (verbose_) {
	    option.destination = OutputOption::DEST_CONSOLE;
	} else {
	    option.destination = OutputOption::DEST_SYSLOG;
	}
104 105 106 107 108 109 110 111

        // ... and set the destination
        spec.addOutputOption(option);

        manager.process(spec);
    }

    LOG_INFO(lfc_logger, LFC_START);
112

113 114
    // verify we are the only instance
    PIDFile pid_file(pid_file_);
115 116

    try {
117
        if (pid_file.check()) {
118
            // Already running instance, bail out
119
            LOG_FATAL(lfc_logger, LFC_RUNNING);
120 121
            return;
        }
122

123
        // create the pid file for this instance
124 125
        pid_file.write();
    } catch (const PIDFileError& pid_ex) {
126
        LOG_FATAL(lfc_logger, LFC_FAIL_PID_CREATE).arg(pid_ex.what());
127 128 129
        return;
    }

130 131 132 133 134
    // If we don't have a finish file do the processing.  We
    // don't know the exact type of the finish file here but
    // all we care about is if it exists so that's okay
    CSVFile lf_finish(getFinishFile());
    if (!lf_finish.exists()) {
135 136 137
        LOG_INFO(lfc_logger, LFC_PROCESSING)
          .arg(previous_file_)
          .arg(copy_file_);
138 139

        try {
140
            if (getProtocolVersion() == 4) {
141 142 143 144 145 146
                processLeases<Lease4, CSVLeaseFile4, Lease4Storage>();
            } else {
                processLeases<Lease6, CSVLeaseFile6, Lease6Storage>();
            }
        } catch (const isc::Exception& proc_ex) {
            // We don't want to do the cleanup but do want to get rid of the pid
147
            do_rotate = false;
148
            LOG_FATAL(lfc_logger, LFC_FAIL_PROCESS).arg(proc_ex.what());
149
        }
150
    }
151

152
    // If do_rotate is true We either already had a finish file or
153 154
    // were able to create one.  We now want to do the file cleanup,
    // we don't want to return after the catch as we
155
    // still need to cleanup the pid file
156
    if (do_rotate) {
157
        LOG_INFO(lfc_logger, LFC_ROTATING);
158

159
        try {
160
            fileRotate();
161
        } catch (const RunTimeFail& run_ex) {
162
          LOG_FATAL(lfc_logger, LFC_FAIL_ROTATE).arg(run_ex.what());
163
        }
164
    }
165 166

    // delete the pid file for this instance
167 168 169
    try {
        pid_file.deleteFile();
    } catch (const PIDFileError& pid_ex) {
170
          LOG_FATAL(lfc_logger, LFC_FAIL_PID_DEL).arg(pid_ex.what());
171
    }
172

173
    LOG_INFO(lfc_logger, LFC_TERMINATE);
174 175 176
}

void
177
LFCController::parseArgs(int argc, char* argv[]) {
178 179
    int ch;

180 181
    opterr = 0;
    optind = 1;
182
    while ((ch = getopt(argc, argv, ":46dvVp:x:i:o:c:f:")) != -1) {
183
        switch (ch) {
Shawn Routhier's avatar
Shawn Routhier committed
184
        case '4':
185
            // Process DHCPv4 lease files.
186
            protocol_version_ = 4;
187 188
            break;

Shawn Routhier's avatar
Shawn Routhier committed
189
        case '6':
190
            // Process DHCPv6 lease files.
191
            protocol_version_ = 6;
192 193
            break;

Shawn Routhier's avatar
Shawn Routhier committed
194
        case 'v':
195
            // Print just Kea vesion and exit.
Shawn Routhier's avatar
Shawn Routhier committed
196
            std::cout << getVersion(false) << std::endl;
197 198
            exit(EXIT_SUCCESS);

Shawn Routhier's avatar
Shawn Routhier committed
199
        case 'V':
200
            // Print extended  Kea vesion and exit.
Shawn Routhier's avatar
Shawn Routhier committed
201
            std::cout << getVersion(true) << std::endl;
202 203
            exit(EXIT_SUCCESS);

Shawn Routhier's avatar
Shawn Routhier committed
204 205 206 207 208 209
        case 'd':
            // Verbose output.
            verbose_ = true;
            break;

        case 'p':
210 211 212 213 214 215 216 217 218
            // PID file name.
            if (optarg == NULL) {
                isc_throw(InvalidUsage, "PID file name missing");
            }
            pid_file_ = optarg;
            break;

        case 'x':
            // Previous (or ex) file name.
Shawn Routhier's avatar
Shawn Routhier committed
219
            if (optarg == NULL) {
220
                isc_throw(InvalidUsage, "Previous (ex) file name missing");
Shawn Routhier's avatar
Shawn Routhier committed
221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241
            }
            previous_file_ = optarg;
            break;

        case 'i':
            // Copy file name.
            if (optarg == NULL) {
                isc_throw(InvalidUsage, "Copy file name missing");
            }
            copy_file_ = optarg;
            break;

        case 'o':
            // Output file name.
            if (optarg == NULL) {
                isc_throw(InvalidUsage, "Output file name missing");
            }
            output_file_ = optarg;
            break;

        case 'f':
242
            // Finish file name.
Shawn Routhier's avatar
Shawn Routhier committed
243 244 245 246 247 248 249
            if (optarg == NULL) {
                isc_throw(InvalidUsage, "Finish file name missing");
            }
            finish_file_ = optarg;
            break;

        case 'c':
250
            // Configuration file name
Shawn Routhier's avatar
Shawn Routhier committed
251 252 253 254 255 256
            if (optarg == NULL) {
                isc_throw(InvalidUsage, "Configuration file name missing");
            }
            config_file_ = optarg;
            break;

257
        case 'h':
Shawn Routhier's avatar
Shawn Routhier committed
258
            usage("");
259 260 261 262 263 264 265 266 267
            exit(EXIT_SUCCESS);

        case '?':
            // Unknown argument
            isc_throw(InvalidUsage, "Unknown argument");

        case ':':
            // Missing option argument
            isc_throw(InvalidUsage, "Missing option argument");
268 269

        default:
270 271 272
            // I don't think we should get here as the unknown arguments
            // and missing options cases should cover everything else
            isc_throw(InvalidUsage, "Invalid command line");
Shawn Routhier's avatar
Shawn Routhier committed
273
        }
274 275 276 277 278 279 280
    }

    // Check for extraneous parameters.
    if (argc > optind) {
        isc_throw(InvalidUsage, "Extraneous parameters.");
    }

281
    if (protocol_version_ == 0) {
282 283 284
        isc_throw(InvalidUsage, "DHCP version required");
    }

285 286 287 288
    if (pid_file_.empty()) {
        isc_throw(InvalidUsage, "PID file not specified");
    }

289
    if (previous_file_.empty()) {
Shawn Routhier's avatar
Shawn Routhier committed
290
        isc_throw(InvalidUsage, "Previous file not specified");
291 292 293
    }

    if (copy_file_.empty()) {
Shawn Routhier's avatar
Shawn Routhier committed
294
        isc_throw(InvalidUsage, "Copy file not specified");
295 296 297
    }

    if (output_file_.empty()) {
Shawn Routhier's avatar
Shawn Routhier committed
298
        isc_throw(InvalidUsage, "Output file not specified");
299 300
    }

301
    if (finish_file_.empty()) {
Shawn Routhier's avatar
Shawn Routhier committed
302
        isc_throw(InvalidUsage, "Finish file not specified");
303 304
    }

305
    if (config_file_.empty()) {
Shawn Routhier's avatar
Shawn Routhier committed
306
        isc_throw(InvalidUsage, "Config file not specified");
307 308 309
    }

    // If verbose is set echo the input information
310
    if (verbose_) {
311
        std::cout << "Protocol version:    DHCPv" << protocol_version_ << std::endl
312 313 314 315 316 317 318
                  << "Previous or ex lease file: " << previous_file_ << std::endl
                  << "Copy lease file:           " << copy_file_ << std::endl
                  << "Output lease file:         " << output_file_ << std::endl
                  << "Finish file:               " << finish_file_ << std::endl
                  << "Config file:               " << config_file_ << std::endl
                  << "PID file:                  " << pid_file_ << std::endl
                  << std::endl;
319 320 321 322
    }
}

void
323
LFCController::usage(const std::string& text) {
324
    if (!text.empty()) {
325 326 327 328
        std::cerr << "Usage error: " << text << std::endl;
    }

    std::cerr << "Usage: " << lfc_bin_name_ << std::endl
329
              << " [-4|-6] -p file -x file -i file -o file -f file -c file" << std::endl
330
              << "   -4 or -6 clean a set of v4 or v6 lease files" << std::endl
331 332
              << "   -p <file>: PID file" << std::endl
              << "   -x <file>: previous or ex lease file" << std::endl
333 334
              << "   -i <file>: copy of lease file" << std::endl
              << "   -o <file>: output lease file" << std::endl
335
              << "   -f <file>: finish file" << std::endl
336 337 338 339
              << "   -c <file>: configuration file" << std::endl
              << "   -v: print version number and exit" << std::endl
              << "   -V: print extended version inforamtion and exit" << std::endl
              << "   -d: optional, verbose output " << std::endl
340
              << "   -h: print this message " << std::endl
341 342 343
              << std::endl;
}

344
std::string
345 346
LFCController::getVersion(const bool extended) const{
    std::stringstream version_stream;
347

348
    version_stream << VERSION;
349
    if (extended) {
350
        version_stream << std::endl << EXTENDED_VERSION;
351 352
    }

353
    return (version_stream.str());
354 355
}

356
template<typename LeaseObjectType, typename LeaseFileType, typename StorageType>
357 358
void
LFCController::processLeases() const {
359 360 361
    StorageType storage;

    // If a previous file exists read the entries into storage
362
    LeaseFileType lf_prev(getPreviousFile());
363 364 365
    if (lf_prev.exists()) {
        LeaseFileLoader::load<LeaseObjectType>(lf_prev, storage,
                                               MAX_LEASE_ERRORS);
366 367
    }

368
    // Follow that with the copy of the current lease file
369
    LeaseFileType lf_copy(getCopyFile());
370 371 372
    if (lf_copy.exists()) {
        LeaseFileLoader::load<LeaseObjectType>(lf_copy, storage,
                                               MAX_LEASE_ERRORS);
373 374 375
    }

    // Write the result out to the output file
376
    LeaseFileType lf_output(getOutputFile());
377
    LeaseFileLoader::write<LeaseObjectType>(lf_output, storage);
378

379
    // If desired log the stats
380
    LOG_INFO(lfc_logger, LFC_READ_STATS)
381 382 383 384
      .arg(lf_prev.getReadLeases() + lf_copy.getReadLeases())
      .arg(lf_prev.getReads() + lf_copy.getReads())
      .arg(lf_prev.getReadErrs() + lf_copy.getReadErrs());

385
    LOG_INFO(lfc_logger, LFC_WRITE_STATS)
386 387 388 389
      .arg(lf_output.getWriteLeases())
      .arg(lf_output.getWrites())
      .arg(lf_output.getWriteErrs());

390
    // Once we've finished the output file move it to the complete file
391
    if (rename(getOutputFile().c_str(), getFinishFile().c_str()) != 0) {
392 393 394
        isc_throw(RunTimeFail, "Unable to move output (" << output_file_
                  << ") to complete (" << finish_file_
                  << ") error: " << strerror(errno));
395
    }
396 397 398
}

void
399
LFCController::fileRotate() const {
400
    // Remove the old previous file
401
    if ((remove(getPreviousFile().c_str()) != 0) &&
402 403 404 405 406 407
        (errno != ENOENT)) {
        isc_throw(RunTimeFail, "Unable to delete previous file '"
                  << previous_file_ << "' error: " << strerror(errno));
    }

    // Remove the copy file
408
    if ((remove(getCopyFile().c_str()) != 0) &&
409 410 411 412 413 414
        (errno != ENOENT)) {
        isc_throw(RunTimeFail, "Unable to delete copy file '"
                  << copy_file_ << "' error: " << strerror(errno));
    }

    // Rename the finish file to be the previous file
415
    if (rename(finish_file_.c_str(), previous_file_.c_str()) != 0) {
416 417 418
        isc_throw(RunTimeFail, "Unable to move finish (" << finish_file_
                  << ") to previous (" << previous_file_
                  << ") error: " << strerror(errno));
419
    }
420
}
421 422
}; // namespace isc::lfc
}; // namespace isc