Blame ptp4l.c

Packit Service d8d8ac
/**
Packit Service d8d8ac
 * @file ptp4l.c
Packit Service d8d8ac
 * @brief PTP Boundary Clock or Transparent Clock main program
Packit Service d8d8ac
 * @note Copyright (C) 2011 Richard Cochran <richardcochran@gmail.com>
Packit Service d8d8ac
 *
Packit Service d8d8ac
 * This program is free software; you can redistribute it and/or modify
Packit Service d8d8ac
 * it under the terms of the GNU General Public License as published by
Packit Service d8d8ac
 * the Free Software Foundation; either version 2 of the License, or
Packit Service d8d8ac
 * (at your option) any later version.
Packit Service d8d8ac
 *
Packit Service d8d8ac
 * This program is distributed in the hope that it will be useful,
Packit Service d8d8ac
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Packit Service d8d8ac
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Packit Service d8d8ac
 * GNU General Public License for more details.
Packit Service d8d8ac
 *
Packit Service d8d8ac
 * You should have received a copy of the GNU General Public License along
Packit Service d8d8ac
 * with this program; if not, write to the Free Software Foundation, Inc.,
Packit Service d8d8ac
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
Packit Service d8d8ac
 */
Packit Service d8d8ac
#include <limits.h>
Packit Service d8d8ac
#include <stdio.h>
Packit Service d8d8ac
#include <stdlib.h>
Packit Service d8d8ac
#include <string.h>
Packit Service d8d8ac
#include <unistd.h>
Packit Service d8d8ac
Packit Service d8d8ac
#include "clock.h"
Packit Service d8d8ac
#include "config.h"
Packit Service d8d8ac
#include "ntpshm.h"
Packit Service d8d8ac
#include "pi.h"
Packit Service d8d8ac
#include "print.h"
Packit Service d8d8ac
#include "raw.h"
Packit Service d8d8ac
#include "sk.h"
Packit Service d8d8ac
#include "transport.h"
Packit Service d8d8ac
#include "udp6.h"
Packit Service d8d8ac
#include "uds.h"
Packit Service d8d8ac
#include "util.h"
Packit Service d8d8ac
#include "version.h"
Packit Service d8d8ac
Packit Service d8d8ac
static void usage(char *progname)
Packit Service d8d8ac
{
Packit Service d8d8ac
	fprintf(stderr,
Packit Service d8d8ac
		"\nusage: %s [options]\n\n"
Packit Service d8d8ac
		" Delay Mechanism\n\n"
Packit Service d8d8ac
		" -A        Auto, starting with E2E\n"
Packit Service d8d8ac
		" -E        E2E, delay request-response (default)\n"
Packit Service d8d8ac
		" -P        P2P, peer delay mechanism\n\n"
Packit Service d8d8ac
		" Network Transport\n\n"
Packit Service d8d8ac
		" -2        IEEE 802.3\n"
Packit Service d8d8ac
		" -4        UDP IPV4 (default)\n"
Packit Service d8d8ac
		" -6        UDP IPV6\n\n"
Packit Service d8d8ac
		" Time Stamping\n\n"
Packit Service d8d8ac
		" -H        HARDWARE (default)\n"
Packit Service d8d8ac
		" -S        SOFTWARE\n"
Packit Service d8d8ac
		" -L        LEGACY HW\n\n"
Packit Service d8d8ac
		" Other Options\n\n"
Packit Service d8d8ac
		" -f [file] read configuration from 'file'\n"
Packit Service d8d8ac
		" -i [dev]  interface device to use, for example 'eth0'\n"
Packit Service d8d8ac
		"           (may be specified multiple times)\n"
Packit Service d8d8ac
		" -p [dev]  PTP hardware clock device to use, default auto\n"
Packit Service d8d8ac
		"           (ignored for SOFTWARE/LEGACY HW time stamping)\n"
Packit Service d8d8ac
		" -s        slave only mode (overrides configuration file)\n"
Packit Service d8d8ac
		" -t        transparent clock\n"
Packit Service d8d8ac
		" -l [num]  set the logging level to 'num'\n"
Packit Service d8d8ac
		" -m        print messages to stdout\n"
Packit Service d8d8ac
		" -q        do not print messages to the syslog\n"
Packit Service d8d8ac
		" -v        prints the software version and exits\n"
Packit Service d8d8ac
		" -h        prints this message and exits\n"
Packit Service d8d8ac
		"\n",
Packit Service d8d8ac
		progname);
Packit Service d8d8ac
}
Packit Service d8d8ac
Packit Service d8d8ac
int main(int argc, char *argv[])
Packit Service d8d8ac
{
Packit Service d8d8ac
	char *config = NULL, *req_phc = NULL, *progname;
Packit Service d8d8ac
	enum clock_type type = CLOCK_TYPE_ORDINARY;
Packit Service d8d8ac
	int c, err = -1, index, print_level;
Packit Service d8d8ac
	struct clock *clock = NULL;
Packit Service d8d8ac
	struct option *opts;
Packit Service d8d8ac
	struct config *cfg;
Packit Service d8d8ac
Packit Service d8d8ac
	if (handle_term_signals())
Packit Service d8d8ac
		return -1;
Packit Service d8d8ac
Packit Service d8d8ac
	cfg = config_create();
Packit Service d8d8ac
	if (!cfg) {
Packit Service d8d8ac
		return -1;
Packit Service d8d8ac
	}
Packit Service d8d8ac
	opts = config_long_options(cfg);
Packit Service d8d8ac
Packit Service d8d8ac
	/* Process the command line arguments. */
Packit Service d8d8ac
	progname = strrchr(argv[0], '/');
Packit Service d8d8ac
	progname = progname ? 1+progname : argv[0];
Packit Service d8d8ac
	while (EOF != (c = getopt_long(argc, argv, "AEP246HSLf:i:p:sl:mqvh",
Packit Service d8d8ac
				       opts, &index))) {
Packit Service d8d8ac
		switch (c) {
Packit Service d8d8ac
		case 0:
Packit Service d8d8ac
			if (config_parse_option(cfg, opts[index].name, optarg))
Packit Service d8d8ac
				goto out;
Packit Service d8d8ac
			break;
Packit Service d8d8ac
		case 'A':
Packit Service d8d8ac
			if (config_set_int(cfg, "delay_mechanism", DM_AUTO))
Packit Service d8d8ac
				goto out;
Packit Service d8d8ac
			break;
Packit Service d8d8ac
		case 'E':
Packit Service d8d8ac
			if (config_set_int(cfg, "delay_mechanism", DM_E2E))
Packit Service d8d8ac
				goto out;
Packit Service d8d8ac
			break;
Packit Service d8d8ac
		case 'P':
Packit Service d8d8ac
			if (config_set_int(cfg, "delay_mechanism", DM_P2P))
Packit Service d8d8ac
				goto out;
Packit Service d8d8ac
			break;
Packit Service d8d8ac
		case '2':
Packit Service d8d8ac
			if (config_set_int(cfg, "network_transport",
Packit Service d8d8ac
					    TRANS_IEEE_802_3))
Packit Service d8d8ac
				goto out;
Packit Service d8d8ac
			break;
Packit Service d8d8ac
		case '4':
Packit Service d8d8ac
			if (config_set_int(cfg, "network_transport",
Packit Service d8d8ac
					    TRANS_UDP_IPV4))
Packit Service d8d8ac
				goto out;
Packit Service d8d8ac
			break;
Packit Service d8d8ac
		case '6':
Packit Service d8d8ac
			if (config_set_int(cfg, "network_transport",
Packit Service d8d8ac
					    TRANS_UDP_IPV6))
Packit Service d8d8ac
				goto out;
Packit Service d8d8ac
			break;
Packit Service d8d8ac
		case 'H':
Packit Service d8d8ac
			if (config_set_int(cfg, "time_stamping", TS_HARDWARE))
Packit Service d8d8ac
				goto out;
Packit Service d8d8ac
			break;
Packit Service d8d8ac
		case 'S':
Packit Service d8d8ac
			if (config_set_int(cfg, "time_stamping", TS_SOFTWARE))
Packit Service d8d8ac
				goto out;
Packit Service d8d8ac
			break;
Packit Service d8d8ac
		case 'L':
Packit Service d8d8ac
			if (config_set_int(cfg, "time_stamping", TS_LEGACY_HW))
Packit Service d8d8ac
				goto out;
Packit Service d8d8ac
			break;
Packit Service d8d8ac
		case 'f':
Packit Service d8d8ac
			config = optarg;
Packit Service d8d8ac
			break;
Packit Service d8d8ac
		case 'i':
Packit Service d8d8ac
			if (!config_create_interface(optarg, cfg))
Packit Service d8d8ac
				goto out;
Packit Service d8d8ac
			break;
Packit Service d8d8ac
		case 'p':
Packit Service d8d8ac
			req_phc = optarg;
Packit Service d8d8ac
			break;
Packit Service d8d8ac
		case 's':
Packit Service d8d8ac
			if (config_set_int(cfg, "slaveOnly", 1)) {
Packit Service d8d8ac
				goto out;
Packit Service d8d8ac
			}
Packit Service d8d8ac
			break;
Packit Service d8d8ac
		case 'l':
Packit Service d8d8ac
			if (get_arg_val_i(c, optarg, &print_level,
Packit Service d8d8ac
					  PRINT_LEVEL_MIN, PRINT_LEVEL_MAX))
Packit Service d8d8ac
				goto out;
Packit Service d8d8ac
			config_set_int(cfg, "logging_level", print_level);
Packit Service d8d8ac
			break;
Packit Service d8d8ac
		case 'm':
Packit Service d8d8ac
			config_set_int(cfg, "verbose", 1);
Packit Service d8d8ac
			break;
Packit Service d8d8ac
		case 'q':
Packit Service d8d8ac
			config_set_int(cfg, "use_syslog", 0);
Packit Service d8d8ac
			break;
Packit Service d8d8ac
		case 'v':
Packit Service d8d8ac
			version_show(stdout);
Packit Service d8d8ac
			return 0;
Packit Service d8d8ac
		case 'h':
Packit Service d8d8ac
			usage(progname);
Packit Service d8d8ac
			return 0;
Packit Service d8d8ac
		case '?':
Packit Service d8d8ac
			usage(progname);
Packit Service d8d8ac
			goto out;
Packit Service d8d8ac
		default:
Packit Service d8d8ac
			usage(progname);
Packit Service d8d8ac
			goto out;
Packit Service d8d8ac
		}
Packit Service d8d8ac
	}
Packit Service d8d8ac
Packit Service d8d8ac
	if (config && (c = config_read(config, cfg))) {
Packit Service d8d8ac
		return c;
Packit Service d8d8ac
	}
Packit Service d8d8ac
Packit Service d8d8ac
	print_set_progname(progname);
Packit Service d8d8ac
	print_set_tag(config_get_string(cfg, NULL, "message_tag"));
Packit Service d8d8ac
	print_set_verbose(config_get_int(cfg, NULL, "verbose"));
Packit Service d8d8ac
	print_set_syslog(config_get_int(cfg, NULL, "use_syslog"));
Packit Service d8d8ac
	print_set_level(config_get_int(cfg, NULL, "logging_level"));
Packit Service d8d8ac
Packit Service d8d8ac
	assume_two_step = config_get_int(cfg, NULL, "assume_two_step");
Packit Service d8d8ac
	sk_check_fupsync = config_get_int(cfg, NULL, "check_fup_sync");
Packit Service d8d8ac
	sk_tx_timeout = config_get_int(cfg, NULL, "tx_timestamp_timeout");
Packit Service d8d8ac
Packit Service d8d8ac
	if (config_get_int(cfg, NULL, "clock_servo") == CLOCK_SERVO_NTPSHM) {
Packit Service d8d8ac
		config_set_int(cfg, "kernel_leap", 0);
Packit Service d8d8ac
		config_set_int(cfg, "sanity_freq_limit", 0);
Packit Service d8d8ac
	}
Packit Service d8d8ac
Packit Service d8d8ac
	if (STAILQ_EMPTY(&cfg->interfaces)) {
Packit Service d8d8ac
		fprintf(stderr, "no interface specified\n");
Packit Service d8d8ac
		usage(progname);
Packit Service d8d8ac
		goto out;
Packit Service d8d8ac
	}
Packit Service d8d8ac
Packit Service d8d8ac
	type = config_get_int(cfg, NULL, "clock_type");
Packit Service d8d8ac
	switch (type) {
Packit Service d8d8ac
	case CLOCK_TYPE_ORDINARY:
Packit Service d8d8ac
		if (cfg->n_interfaces > 1) {
Packit Service d8d8ac
			type = CLOCK_TYPE_BOUNDARY;
Packit Service d8d8ac
		}
Packit Service d8d8ac
		break;
Packit Service d8d8ac
	case CLOCK_TYPE_BOUNDARY:
Packit Service d8d8ac
		if (cfg->n_interfaces < 2) {
Packit Service d8d8ac
			fprintf(stderr, "BC needs at least two interfaces\n");
Packit Service d8d8ac
			goto out;
Packit Service d8d8ac
		}
Packit Service d8d8ac
		break;
Packit Service d8d8ac
	case CLOCK_TYPE_P2P:
Packit Service d8d8ac
		if (cfg->n_interfaces < 2) {
Packit Service d8d8ac
			fprintf(stderr, "TC needs at least two interfaces\n");
Packit Service d8d8ac
			goto out;
Packit Service d8d8ac
		}
Packit Service d8d8ac
		if (DM_P2P != config_get_int(cfg, NULL, "delay_mechanism")) {
Packit Service d8d8ac
			fprintf(stderr, "P2P_TC needs P2P delay mechanism\n");
Packit Service d8d8ac
			goto out;
Packit Service d8d8ac
		}
Packit Service d8d8ac
		break;
Packit Service d8d8ac
	case CLOCK_TYPE_E2E:
Packit Service d8d8ac
		if (cfg->n_interfaces < 2) {
Packit Service d8d8ac
			fprintf(stderr, "TC needs at least two interfaces\n");
Packit Service d8d8ac
			goto out;
Packit Service d8d8ac
		}
Packit Service d8d8ac
		if (DM_E2E != config_get_int(cfg, NULL, "delay_mechanism")) {
Packit Service d8d8ac
			fprintf(stderr, "E2E_TC needs E2E delay mechanism\n");
Packit Service d8d8ac
			goto out;
Packit Service d8d8ac
		}
Packit Service d8d8ac
		break;
Packit Service d8d8ac
	case CLOCK_TYPE_MANAGEMENT:
Packit Service d8d8ac
		goto out;
Packit Service d8d8ac
	}
Packit Service d8d8ac
Packit Service d8d8ac
	clock = clock_create(type, cfg, req_phc);
Packit Service d8d8ac
	if (!clock) {
Packit Service d8d8ac
		fprintf(stderr, "failed to create a clock\n");
Packit Service d8d8ac
		goto out;
Packit Service d8d8ac
	}
Packit Service d8d8ac
Packit Service d8d8ac
	err = 0;
Packit Service d8d8ac
Packit Service d8d8ac
	while (is_running()) {
Packit Service d8d8ac
		if (clock_poll(clock))
Packit Service d8d8ac
			break;
Packit Service d8d8ac
	}
Packit Service d8d8ac
out:
Packit Service d8d8ac
	if (clock)
Packit Service d8d8ac
		clock_destroy(clock);
Packit Service d8d8ac
	config_destroy(cfg);
Packit Service d8d8ac
	return err;
Packit Service d8d8ac
}