pmc_common.c

/**
 * @file pmc_common.c
 * @note Copyright (C) 2012 Richard Cochran <richardcochran@gmail.com>
 * @note Copyright (C) 2013 Miroslav Lichvar <mlichvar@redhat.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
#include <errno.h>
#include <stdlib.h>
#include <string.h>
#include <sys/types.h>
#include <unistd.h>

#include "notification.h"
#include "print.h"
#include "sad.h"
#include "tlv.h"
#include "transport.h"
#include "pmc_common.h"
#include "power_profile.h"

#define BAD_ACTION   -1
#define BAD_ID       -1
#define AMBIGUOUS_ID -2
#define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))

/*
   Field                  Len  Type
  --------------------------------------------------------
   clockType                2
   physicalLayerProtocol    1  PTPText
   physicalAddressLength    2  UInteger16
   physicalAddress          0
   protocolAddress          4  Enumeration16 + UInteger16
   manufacturerIdentity     3
   reserved                 1
   productDescription       1  PTPText
   revisionData             1  PTPText
   userDescription          1  PTPText
   profileIdentity          6
  --------------------------------------------------------
   TOTAL                   22
*/
#define EMPTY_CLOCK_DESCRIPTION 22
/* Includes one extra byte to make length even. */
#define EMPTY_PTP_TEXT 2
/* Field                  Len  Type
 * -------------------------------------------------------
 * portIdentity          10    UInteger16 + 8 * Octets
 * port_state             1    uint8_t
 * timestamping           1    uint8_t
 * interface              1    PTPText
 * extra                  1    make length even
 * -------------------------------------------------------
 * TOTAL                 14
 */
#define EMPTY_PORT_PROPERTIES_NP 14
/* Field                  Len  Type
 * -------------------------------------------------------
 * actualTableSize        2    UInteger16
 * unicast_masters        0    Zero length array
 * -------------------------------------------------------
 * TOTAL                  2
 */
#define EMPTY_UNICAST_MASTER_TABLE_NP 2

static void do_get_action(struct pmc *pmc, int action, int index, char *str);
static void do_set_action(struct pmc *pmc, int action, int index, char *str);
static void not_supported(struct pmc *pmc, int action, int index, char *str);
static void null_management(struct pmc *pmc, int action, int index, char *str);

static const char *action_string[] = {
	"GET",
	"SET",
	"RESPONSE",
	"COMMAND",
	"ACKNOWLEDGE",
};

struct management_id {
	char name[64];
	int code;
	void (*func)(struct pmc *pmc, int action, int index, char *str);
};

struct management_id idtab[] = {
/* Clock management ID values */
	{ "USER_DESCRIPTION", MID_USER_DESCRIPTION, do_get_action },
	{ "SAVE_IN_NON_VOLATILE_STORAGE", MID_SAVE_IN_NON_VOLATILE_STORAGE, not_supported },
	{ "RESET_NON_VOLATILE_STORAGE", MID_RESET_NON_VOLATILE_STORAGE, not_supported },
	{ "INITIALIZE", MID_INITIALIZE, not_supported },
	{ "FAULT_LOG", MID_FAULT_LOG, not_supported },
	{ "FAULT_LOG_RESET", MID_FAULT_LOG_RESET, not_supported },
	{ "DEFAULT_DATA_SET", MID_DEFAULT_DATA_SET, do_get_action },
	{ "CURRENT_DATA_SET", MID_CURRENT_DATA_SET, do_get_action },
	{ "PARENT_DATA_SET", MID_PARENT_DATA_SET, do_get_action },
	{ "TIME_PROPERTIES_DATA_SET", MID_TIME_PROPERTIES_DATA_SET, do_get_action },
	{ "PRIORITY1", MID_PRIORITY1, do_set_action },
	{ "PRIORITY2", MID_PRIORITY2, do_set_action },
	{ "DOMAIN", MID_DOMAIN, do_get_action },
	{ "SLAVE_ONLY", MID_SLAVE_ONLY, do_get_action },
	{ "TIME", MID_TIME, not_supported },
	{ "CLOCK_ACCURACY", MID_CLOCK_ACCURACY, do_get_action },
	{ "UTC_PROPERTIES", MID_UTC_PROPERTIES, not_supported },
	{ "TRACEABILITY_PROPERTIES", MID_TRACEABILITY_PROPERTIES, do_get_action },
	{ "TIMESCALE_PROPERTIES", MID_TIMESCALE_PROPERTIES, do_get_action },
	{ "PATH_TRACE_LIST", MID_PATH_TRACE_LIST, not_supported },
	{ "PATH_TRACE_ENABLE", MID_PATH_TRACE_ENABLE, not_supported },
	{ "GRANDMASTER_CLUSTER_TABLE", MID_GRANDMASTER_CLUSTER_TABLE, not_supported },
	{ "ACCEPTABLE_MASTER_TABLE", MID_ACCEPTABLE_MASTER_TABLE, not_supported },
	{ "ACCEPTABLE_MASTER_MAX_TABLE_SIZE", MID_ACCEPTABLE_MASTER_MAX_TABLE_SIZE, not_supported },
	{ "ALTERNATE_TIME_OFFSET_ENABLE", MID_ALTERNATE_TIME_OFFSET_ENABLE, do_set_action },
	{ "ALTERNATE_TIME_OFFSET_NAME", MID_ALTERNATE_TIME_OFFSET_NAME, do_set_action },
	{ "ALTERNATE_TIME_OFFSET_MAX_KEY", MID_ALTERNATE_TIME_OFFSET_MAX_KEY, not_supported },
	{ "ALTERNATE_TIME_OFFSET_PROPERTIES", MID_ALTERNATE_TIME_OFFSET_PROPERTIES, do_set_action },
	{ "MASTER_ONLY", MID_MASTER_ONLY, do_get_action },
	{ "TRANSPARENT_CLOCK_DEFAULT_DATA_SET", MID_TRANSPARENT_CLOCK_DEFAULT_DATA_SET, not_supported },
	{ "PRIMARY_DOMAIN", MID_PRIMARY_DOMAIN, not_supported },
	{ "TIME_STATUS_NP", MID_TIME_STATUS_NP, do_get_action },
	{ "GRANDMASTER_SETTINGS_NP", MID_GRANDMASTER_SETTINGS_NP, do_set_action },
	{ "SUBSCRIBE_EVENTS_NP", MID_SUBSCRIBE_EVENTS_NP, do_set_action },
	{ "SYNCHRONIZATION_UNCERTAIN_NP", MID_SYNCHRONIZATION_UNCERTAIN_NP, do_set_action },
	{ "EXTERNAL_GRANDMASTER_PROPERTIES_NP", MID_EXTERNAL_GRANDMASTER_PROPERTIES_NP, do_set_action },
/* Port management ID values */
	{ "NULL_MANAGEMENT", MID_NULL_MANAGEMENT, null_management },
	{ "CLOCK_DESCRIPTION", MID_CLOCK_DESCRIPTION, do_get_action },
	{ "PORT_DATA_SET", MID_PORT_DATA_SET, do_get_action },
	{ "LOG_ANNOUNCE_INTERVAL", MID_LOG_ANNOUNCE_INTERVAL, do_get_action },
	{ "ANNOUNCE_RECEIPT_TIMEOUT", MID_ANNOUNCE_RECEIPT_TIMEOUT, do_get_action },
	{ "LOG_SYNC_INTERVAL", MID_LOG_SYNC_INTERVAL, do_get_action },
	{ "VERSION_NUMBER", MID_VERSION_NUMBER, do_get_action },
	{ "ENABLE_PORT", MID_ENABLE_PORT, not_supported },
	{ "DISABLE_PORT", MID_DISABLE_PORT, not_supported },
	{ "UNICAST_NEGOTIATION_ENABLE", MID_UNICAST_NEGOTIATION_ENABLE, not_supported },
	{ "UNICAST_MASTER_TABLE", MID_UNICAST_MASTER_TABLE, not_supported },
	{ "UNICAST_MASTER_MAX_TABLE_SIZE", MID_UNICAST_MASTER_MAX_TABLE_SIZE, not_supported },
	{ "ACCEPTABLE_MASTER_TABLE_ENABLED", MID_ACCEPTABLE_MASTER_TABLE_ENABLED, not_supported },
	{ "ALTERNATE_MASTER", MID_ALTERNATE_MASTER, not_supported },
	{ "TRANSPARENT_CLOCK_PORT_DATA_SET", MID_TRANSPARENT_CLOCK_PORT_DATA_SET, not_supported },
	{ "DELAY_MECHANISM", MID_DELAY_MECHANISM, do_get_action },
	{ "LOG_MIN_PDELAY_REQ_INTERVAL", MID_LOG_MIN_PDELAY_REQ_INTERVAL, do_get_action },
	{ "PORT_DATA_SET_NP", MID_PORT_DATA_SET_NP, do_set_action },
	{ "PORT_PROPERTIES_NP", MID_PORT_PROPERTIES_NP, do_get_action },
	{ "PORT_STATS_NP", MID_PORT_STATS_NP, do_get_action },
	{ "PORT_SERVICE_STATS_NP", MID_PORT_SERVICE_STATS_NP, do_get_action },
	{ "UNICAST_MASTER_TABLE_NP", MID_UNICAST_MASTER_TABLE_NP, do_get_action },
	{ "PORT_HWCLOCK_NP", MID_PORT_HWCLOCK_NP, do_get_action },
	{ "POWER_PROFILE_SETTINGS_NP", MID_POWER_PROFILE_SETTINGS_NP, do_set_action },
	{ "CMLDS_INFO_NP", MID_CMLDS_INFO_NP, do_get_action },
	{ "PORT_CORRECTIONS_NP", MID_PORT_CORRECTIONS_NP, do_set_action },
};

static void do_get_action(struct pmc *pmc, int action, int index, char *str)
{
	if (action == GET)
		pmc_send_get_action(pmc, idtab[index].code);
	else
		fprintf(stderr, "%s only allows GET\n", idtab[index].name);
}

static void do_set_action(struct pmc *pmc, int action, int index, char *str)
{
	int cnt, code = idtab[index].code, freq_traceable, leap_59, leap_61,
		ptp_timescale, time_traceable, utc_off_valid;
	struct external_grandmaster_properties_np egpn;
	struct alternate_time_offset_properties atop;
	struct ieee_c37_238_settings_np pwr;
	struct grandmaster_settings_np gsn;
	struct management_tlv_datum mtd;
	struct subscribe_events_np sen;
	struct port_corrections_np pcn;
	struct port_ds_np pnp;
	char onoff_port_state[4] = "off";
	char onoff_time_status[4] = "off";
	char onoff_parent_data_set[4] = "off";
	char onoff_cmlds[4] = "off";
	char display_name[11] = {0};
	char identity[19];
	uint64_t jump;
	uint8_t key;
	int enable;

	mtd.reserved = 0;

	switch (action) {
	case GET:
		pmc_send_get_action(pmc, code);
		return;
	case SET:
		break;
	case RESPONSE:
	case COMMAND:
	case ACKNOWLEDGE:
	default:
		fprintf(stderr, "%s only allows GET or SET\n",
			idtab[index].name);
		return;
	}
	switch (code) {
	case MID_PRIORITY1:
	case MID_PRIORITY2:
		cnt = sscanf(str,  " %*s %*s %hhu", &mtd.val);
		if (cnt != 1) {
			fprintf(stderr, "%s SET needs 1 value\n",
				idtab[index].name);
			break;
		}
		pmc_send_set_action(pmc, code, &mtd, sizeof(mtd));
		break;
	case MID_ALTERNATE_TIME_OFFSET_ENABLE:
		cnt = sscanf(str,  " %*s %*s keyField %hhu enable %d",
			     &mtd.val, &enable);
		if (cnt != 2) {
			fprintf(stderr, "%s SET needs 2 values\n",
				idtab[index].name);
			break;
		}
		mtd.reserved = enable ? 1 : 0;
		pmc_send_set_action(pmc, code, &mtd, sizeof(mtd));
		break;
	case MID_ALTERNATE_TIME_OFFSET_NAME:
		cnt = sscanf(str, " %*s %*s "
			     "keyField       %hhu "
			     "displayName    %10s ",
			     &key,
			     display_name);
		if (cnt != 2) {
			fprintf(stderr, "%s SET needs 2 values\n",
				idtab[index].name);
			break;
		}
		pmc_send_set_aton(pmc, code, key, display_name);
		break;
	case MID_ALTERNATE_TIME_OFFSET_PROPERTIES:
		memset(&atop, 0, sizeof(atop));
		cnt = sscanf(str, " %*s %*s "
			     "keyField       %hhu "
			     "currentOffset  %d "
			     "jumpSeconds    %d "
			     "timeOfNextJump %" SCNu64,
			     &atop.keyField,
			     &atop.currentOffset,
			     &atop.jumpSeconds,
			     &jump);
		if (cnt != 4) {
			fprintf(stderr, "%s SET needs 4 values\n",
				idtab[index].name);
			break;
		}
		atop.timeOfNextJump.seconds_lsb = jump & 0xffffffff;
		atop.timeOfNextJump.seconds_msb = jump >> 32;
		pmc_send_set_action(pmc, code, &atop, sizeof(atop));
		break;
	case MID_GRANDMASTER_SETTINGS_NP:
		cnt = sscanf(str, " %*s %*s "
			     "clockClass              %hhu "
			     "clockAccuracy           %hhx "
			     "offsetScaledLogVariance %hx "
			     "currentUtcOffset        %hd "
			     "leap61                  %d "
			     "leap59                  %d "
			     "currentUtcOffsetValid   %d "
			     "ptpTimescale            %d "
			     "timeTraceable           %d "
			     "frequencyTraceable      %d "
			     "timeSource              %hhx ",
			     &gsn.clockQuality.clockClass,
			     &gsn.clockQuality.clockAccuracy,
			     &gsn.clockQuality.offsetScaledLogVariance,
			     &gsn.utc_offset,
			     &leap_61,
			     &leap_59,
			     &utc_off_valid,
			     &ptp_timescale,
			     &time_traceable,
			     &freq_traceable,
			     &gsn.time_source);
		if (cnt != 11) {
			fprintf(stderr, "%s SET needs 11 values\n",
				idtab[index].name);
			break;
		}
		gsn.time_flags = 0;
		if (leap_61)
			gsn.time_flags |= LEAP_61;
		if (leap_59)
			gsn.time_flags |= LEAP_59;
		if (utc_off_valid)
			gsn.time_flags |= UTC_OFF_VALID;
		if (ptp_timescale)
			gsn.time_flags |= PTP_TIMESCALE;
		if (time_traceable)
			gsn.time_flags |= TIME_TRACEABLE;
		if (freq_traceable)
			gsn.time_flags |= FREQ_TRACEABLE;
		pmc_send_set_action(pmc, code, &gsn, sizeof(gsn));
		break;
	case MID_SUBSCRIBE_EVENTS_NP:
		memset(&sen, 0, sizeof(sen));
		cnt = sscanf(str, " %*s %*s "
			     "duration          %hu "
			     "NOTIFY_PORT_STATE %3s "
			     "NOTIFY_TIME_SYNC  %3s "
			     "NOTIFY_PARENT_DATA_SET %3s "
			     "NOTIFY_CMLDS %3s ",
			     &sen.duration,
			     onoff_port_state,
			     onoff_time_status,
			     onoff_parent_data_set,
			     onoff_cmlds);
		if (cnt < 1) {
			fprintf(stderr, "%s SET needs at least one value\n",
				idtab[index].name);
			break;
		}
		if (!strcasecmp(onoff_port_state, "on")) {
			event_bitmask_set(sen.bitmask, NOTIFY_PORT_STATE, TRUE);
		}
		if (!strcasecmp(onoff_time_status, "on")) {
			event_bitmask_set(sen.bitmask, NOTIFY_TIME_SYNC, TRUE);
		}
		if (!strcasecmp(onoff_parent_data_set, "on")) {
			event_bitmask_set(sen.bitmask, NOTIFY_PARENT_DATA_SET,
					  TRUE);
		}
		if (!strcasecmp(onoff_cmlds, "on")) {
			event_bitmask_set(sen.bitmask, NOTIFY_CMLDS, TRUE);
		}
		pmc_send_set_action(pmc, code, &sen, sizeof(sen));
		break;
	case MID_SYNCHRONIZATION_UNCERTAIN_NP:
		cnt = sscanf(str,  " %*s %*s %hhu", &mtd.val);
		if (cnt != 1) {
			fprintf(stderr, "%s SET needs 1 value\n",
				idtab[index].name);
			break;
		}
		switch (mtd.val) {
		case SYNC_UNCERTAIN_DONTCARE:
		case SYNC_UNCERTAIN_FALSE:
		case SYNC_UNCERTAIN_TRUE:
			pmc_send_set_action(pmc, code, &mtd, sizeof(mtd));
			break;
		default:
			fprintf(stderr, "\nusage: set SYNCHRONIZATION_UNCERTAIN_NP "
				"%hhu (false), %hhu (true), or %hhu (don't care)\n\n",
				SYNC_UNCERTAIN_FALSE,
				SYNC_UNCERTAIN_TRUE,
				SYNC_UNCERTAIN_DONTCARE);
		}
		break;
	case MID_PORT_DATA_SET_NP:
		cnt = sscanf(str, " %*s %*s "
			     "neighborPropDelayThresh %u "
			     "asCapable               %d ",
			     &pnp.neighborPropDelayThresh,
			     &pnp.asCapable);
		if (cnt != 2) {
			fprintf(stderr, "%s SET needs 2 values\n",
				idtab[index].name);
			break;
		}
		pmc_send_set_action(pmc, code, &pnp, sizeof(pnp));
		break;
	case MID_POWER_PROFILE_SETTINGS_NP:
		cnt = sscanf(str, " %*s %*s "
			     "version                   %hu "
			     "grandmasterID             %hx "
			     "grandmasterTimeInaccuracy %u "
			     "networkTimeInaccuracy     %u "
			     "totalTimeInaccuracy       %u ",
			     &pwr.version,
			     &pwr.grandmasterID,
			     &pwr.grandmasterTimeInaccuracy,
			     &pwr.networkTimeInaccuracy,
			     &pwr.totalTimeInaccuracy);
		if (cnt != 5) {
			fprintf(stderr, "%s SET needs 5 values\n",
				idtab[index].name);
			break;
		}
		switch (pwr.version) {
		case IEEE_C37_238_VERSION_NONE:
		case IEEE_C37_238_VERSION_2011:
		case IEEE_C37_238_VERSION_2017:
			pmc_send_set_action(pmc, code, &pwr, sizeof(pwr));
			break;
		default:
			fprintf(stderr, "\nusage: set PROFILE_SETTINGS_NP version "
				"%hu (none), %hu (2011), or %hu (2017)\n\n",
				IEEE_C37_238_VERSION_NONE,
				IEEE_C37_238_VERSION_2011,
				IEEE_C37_238_VERSION_2017);
		}
		break;
	case MID_EXTERNAL_GRANDMASTER_PROPERTIES_NP:
		cnt = sscanf(str, " %*s %*s "
			     "gmIdentity   %18s "
			     "stepsRemoved %hu ",
			     identity,
			     &egpn.stepsRemoved);
		if (cnt != 2 || str2cid(identity, &egpn.gmIdentity)) {
			fprintf(stderr, "%s SET needs 2 values\n",
				idtab[index].name);
			break;
		}
		pmc_send_set_action(pmc, code, &egpn, sizeof(egpn));
		break;
	case MID_PORT_CORRECTIONS_NP:
		cnt = sscanf(str, " %*s %*s "
			     "egressLatency  %"SCNd64" "
			     "ingressLatency %"SCNd64" "
			     "delayAsymmetry %"SCNd64" ",
			     &pcn.egressLatency,
			     &pcn.ingressLatency,
			     &pcn.delayAsymmetry);
		if (cnt != 3) {
			fprintf(stderr, "%s SET needs 3 values\n",
				idtab[index].name);
			break;
		}
		pcn.egressLatency <<= 16;
		pcn.ingressLatency <<= 16;
		pcn.delayAsymmetry <<= 16;
		pmc_send_set_action(pmc, code, &pcn, sizeof(pcn));
		break;
	}
}

static void not_supported(struct pmc *pmc, int action, int index, char *str)
{
	fprintf(stdout, "sorry, %s not supported yet\n", idtab[index].name);
}

static void null_management(struct pmc *pmc, int action, int index, char *str)
{
	if (action == GET)
		pmc_send_get_action(pmc, idtab[index].code);
	else
		puts("non-get actions still todo");
}

static int parse_action(char *s)
{
	int len = strlen(s);
	if (0 == strncasecmp(s, "GET", len))
		return GET;
	else if (0 == strncasecmp(s, "SET", len))
		return SET;
	else if (0 == strncasecmp(s, "CMD", len))
		return COMMAND;
	else if (0 == strncasecmp(s, "COMMAND", len))
		return COMMAND;
	return BAD_ACTION;
}

static int parse_id(char *s)
{
	int i, index = BAD_ID, len = strlen(s);
	/* check for exact match */
	for (i = 0; i < ARRAY_SIZE(idtab); i++) {
		if (strcasecmp(s, idtab[i].name) == 0) {
			return i;
		}
	}
	/* look for a unique prefix match */
	for (i = 0; i < ARRAY_SIZE(idtab); i++) {
		if (0 == strncasecmp(s, idtab[i].name, len)) {
			if (index == BAD_ID)
				index = i;
			else
				return AMBIGUOUS_ID;
		}
	}
	return index;
}

static int parse_target(struct pmc *pmc, const char *str)
{
	struct PortIdentity pid;

	if (str[0] == '*') {
		memset(&pid, 0xff, sizeof(pid));
	} else if (str2pid(str, &pid)) {
		return -1;
	}

	return pmc_target(pmc, &pid);
}

static void print_help(FILE *fp)
{
	int i;
	fprintf(fp, "\n");
	for (i = 0; i < ARRAY_SIZE(idtab); i++) {
		if (idtab[i].func != not_supported)
			fprintf(fp, "\t[action] %s\n", idtab[i].name);
	}
	fprintf(fp, "\n");
	fprintf(fp, "\tThe [action] can be GET, SET, CMD, or COMMAND\n");
	fprintf(fp, "\tCommands are case insensitive and may be abbreviated.\n");
	fprintf(fp, "\n");
	fprintf(fp, "\tTARGET [portIdentity]\n");
	fprintf(fp, "\tTARGET *\n");
	fprintf(fp, "\n");
}

struct pmc {
	struct config *cfg;
	UInteger16 sequence_id;
	UInteger8 boundary_hops;
	UInteger8 domain_number;
	UInteger8 transport_specific;
	struct PortIdentity port_identity;
	struct PortIdentity target;

	struct transport *transport;
	struct interface *iface;
	struct fdarray fdarray;
	int zero_length_gets;
	int spp;
	UInteger32 active_key_id;
	UInteger8 allow_unauth;
};

struct pmc *pmc_create(struct config *cfg, enum transport_type transport_type,
		       const char *iface_name, const char *remote_address,
		       UInteger8 boundary_hops, UInteger8 domain_number,
		       UInteger8 transport_specific, UInteger8 allow_unauth,
		       int zero_datalen)
{
	struct pmc *pmc;
	UInteger32 proc_id;

	pmc = calloc(1, sizeof *pmc);
	if (!pmc)
		return NULL;

	if (transport_type == TRANS_UDS) {
		proc_id = getpid();
		pmc->port_identity.clockIdentity.id[6] = (proc_id & 0xFF000000) >> 24;
		pmc->port_identity.clockIdentity.id[7] = (proc_id & 0x00FF0000) >> 16;
		pmc->port_identity.portNumber = proc_id & 0xFFFF;
	} else {
		if (generate_clock_identity(&pmc->port_identity.clockIdentity,
					    iface_name)) {
			pr_err("failed to generate a clock identity");
			goto failed;
		}
		pmc->port_identity.portNumber = 1;
	}
	pmc_target_all(pmc);

	pmc->boundary_hops = boundary_hops;
	pmc->domain_number = domain_number;
	pmc->transport_specific = transport_specific;
	pmc->cfg = cfg;
	pmc->spp = config_get_int(cfg, NULL, "spp");
	pmc->active_key_id = config_get_uint(cfg, NULL, "active_key_id");
	pmc->allow_unauth = allow_unauth;

	if (sad_readiness_check(pmc->spp, pmc->active_key_id, pmc->cfg)) {
		goto failed;
	}

	pmc->transport = transport_create(cfg, transport_type);
	if (!pmc->transport) {
		pr_err("failed to create transport");
		goto failed;
	}

	pmc->iface = interface_create(iface_name, remote_address);
	if (!pmc->iface) {
		pr_err("failed to create interface");
		goto failed;
	}

	if (transport_open(pmc->transport, pmc->iface,
			   &pmc->fdarray, TS_SOFTWARE)) {
		pr_err("failed to open transport");
		goto no_trans_open;
	}
	pmc->zero_length_gets = zero_datalen ? 1 : 0;

	return pmc;

no_trans_open:
	interface_destroy(pmc->iface);
failed:
	if (pmc->transport)
		transport_destroy(pmc->transport);
	free(pmc);
	return NULL;
}

void pmc_destroy(struct pmc *pmc)
{
	transport_close(pmc->transport, &pmc->fdarray);
	interface_destroy(pmc->iface);
	transport_destroy(pmc->transport);
	free(pmc);
}

static struct ptp_message *pmc_message(struct pmc *pmc, uint8_t action)
{
	struct ptp_message *msg;
	int pdulen;

	msg = msg_allocate();
	if (!msg)
		return NULL;

	pdulen = sizeof(struct management_msg);
	msg->hwts.type = TS_SOFTWARE;

	msg->header.tsmt               = MANAGEMENT | pmc->transport_specific;
	msg->header.ver                = PTP_VERSION;
	msg->header.messageLength      = pdulen;
	msg->header.domainNumber       = pmc->domain_number;
	msg->header.sourcePortIdentity = pmc->port_identity;
	msg->header.sequenceId         = pmc->sequence_id++;
	msg->header.logMessageInterval = 0x7f;

	msg->management.targetPortIdentity = pmc->target;
	msg->management.startingBoundaryHops = pmc->boundary_hops;
	msg->management.boundaryHops = pmc->boundary_hops;
	msg->management.flags = action;

	return msg;
}

static int pmc_send(struct pmc *pmc, struct ptp_message *msg)
{
	int err;

	if (pmc->spp >= 0) {
		err = sad_append_auth_tlv(pmc->cfg, pmc->spp,
					  pmc->active_key_id, msg);
	} else {
		err = msg_pre_send(msg);
	}
	if (err) {
		pr_err("msg_pre_send failed");
		return -1;
	}
	return transport_send(pmc->transport, &pmc->fdarray,
			      TRANS_GENERAL, msg);
}

static int pmc_tlv_datalen(struct pmc *pmc, int id)
{
	int len = 0;

	if (pmc->zero_length_gets)
		return len;

	switch (id) {
	case MID_USER_DESCRIPTION:
		len += EMPTY_PTP_TEXT;
		break;
	case MID_DEFAULT_DATA_SET:
		len += sizeof(struct defaultDS);
		break;
	case MID_CURRENT_DATA_SET:
		len += sizeof(struct currentDS);
		break;
	case MID_PARENT_DATA_SET:
		len += sizeof(struct parentDS);
		break;
	case MID_TIME_PROPERTIES_DATA_SET:
		len += sizeof(struct timePropertiesDS);
		break;
	case MID_PRIORITY1:
	case MID_PRIORITY2:
	case MID_DOMAIN:
	case MID_SLAVE_ONLY:
	case MID_CLOCK_ACCURACY:
	case MID_TRACEABILITY_PROPERTIES:
	case MID_TIMESCALE_PROPERTIES:
	case MID_MASTER_ONLY:
	case MID_SYNCHRONIZATION_UNCERTAIN_NP:
		len += sizeof(struct management_tlv_datum);
		break;
	case MID_TIME_STATUS_NP:
		len += sizeof(struct time_status_np);
		break;
	case MID_ALTERNATE_TIME_OFFSET_ENABLE:
		len += sizeof(struct management_tlv_datum);
		break;
	case MID_ALTERNATE_TIME_OFFSET_NAME:
		len += sizeof(struct alternate_time_offset_name);
		break;
	case MID_ALTERNATE_TIME_OFFSET_PROPERTIES:
		len += sizeof(struct alternate_time_offset_properties);
		break;
	case MID_GRANDMASTER_SETTINGS_NP:
		len += sizeof(struct grandmaster_settings_np);
		break;
	case MID_SUBSCRIBE_EVENTS_NP:
		len += sizeof(struct subscribe_events_np);
		break;
	case MID_NULL_MANAGEMENT:
		break;
	case MID_CLOCK_DESCRIPTION:
		len += EMPTY_CLOCK_DESCRIPTION;
		break;
	case MID_PORT_DATA_SET:
		len += sizeof(struct portDS);
		break;
	case MID_PORT_DATA_SET_NP:
		len += sizeof(struct port_ds_np);
		break;
	case MID_PORT_PROPERTIES_NP:
		len += EMPTY_PORT_PROPERTIES_NP;
		break;
	case MID_PORT_STATS_NP:
		len += sizeof(struct port_stats_np);
		break;
	case MID_PORT_SERVICE_STATS_NP:
		len += sizeof(struct port_service_stats_np);
		break;
	case MID_UNICAST_MASTER_TABLE_NP:
		len += EMPTY_UNICAST_MASTER_TABLE_NP;
		break;
	case MID_PORT_HWCLOCK_NP:
		len += sizeof(struct port_hwclock_np);
		break;
	case MID_POWER_PROFILE_SETTINGS_NP:
		len += sizeof(struct ieee_c37_238_settings_np);
		break;
	case MID_EXTERNAL_GRANDMASTER_PROPERTIES_NP:
		len += sizeof(struct external_grandmaster_properties_np);
		break;
	case MID_PORT_CORRECTIONS_NP:
		len += sizeof(struct port_corrections_np);
		break;
	case MID_LOG_ANNOUNCE_INTERVAL:
	case MID_ANNOUNCE_RECEIPT_TIMEOUT:
	case MID_LOG_SYNC_INTERVAL:
	case MID_VERSION_NUMBER:
	case MID_DELAY_MECHANISM:
	case MID_LOG_MIN_PDELAY_REQ_INTERVAL:
		len += sizeof(struct management_tlv_datum);
		break;
	}
	return len + len % 2;
}

int pmc_get_transport_fd(struct pmc *pmc)
{
	return pmc->fdarray.fd[FD_GENERAL];
}

int pmc_send_get_action(struct pmc *pmc, int id)
{
	int datalen, pdulen;
	struct ptp_message *msg;
	struct management_tlv *mgt;
	struct tlv_extra *extra;

	msg = pmc_message(pmc, GET);
	if (!msg) {
		return -1;
	}
	mgt = (struct management_tlv *) msg->management.suffix;
	mgt->type = TLV_MANAGEMENT;
	datalen = pmc_tlv_datalen(pmc, id);
	mgt->length = 2 + datalen;
	mgt->id = id;
	pdulen = msg->header.messageLength + sizeof(*mgt) + datalen;
	msg->header.messageLength = pdulen;

	extra = tlv_extra_alloc();
	if (!extra) {
		pr_err("failed to allocate TLV descriptor");
		msg_put(msg);
		return -ENOMEM;
	}
	extra->tlv = (struct TLV *) msg->management.suffix;
	msg_tlv_attach(msg, extra);

	if (id == MID_CLOCK_DESCRIPTION && !pmc->zero_length_gets) {
		/*
		 * Make sure the tlv_extra pointers dereferenced in
		 * mgt_pre_send() do point to something.
		 */
		struct mgmt_clock_description *cd = &extra->cd;
		uint8_t *buf = mgt->data;
		cd->clockType = (UInteger16 *) buf;
		buf += sizeof(*cd->clockType);
		cd->physicalLayerProtocol = (struct PTPText *) buf;
		buf += sizeof(struct PTPText) + cd->physicalLayerProtocol->length;
		cd->physicalAddress = (struct PhysicalAddress *) buf;
		buf += sizeof(struct PhysicalAddress) + 0;
		cd->protocolAddress = (struct PortAddress *) buf;
	}

	pmc_send(pmc, msg);
	msg_put(msg);

	return 0;
}

int pmc_send_set_action(struct pmc *pmc, int id, void *data, int datasize)
{
	struct management_tlv *mgt;
	struct ptp_message *msg;
	struct tlv_extra *extra;

	msg = pmc_message(pmc, SET);
	if (!msg) {
		return -1;
	}
	extra = msg_tlv_append(msg, sizeof(*mgt) + datasize);
	if (!extra) {
		msg_put(msg);
		return -ENOMEM;
	}
	mgt = (struct management_tlv *) extra->tlv;
	mgt->type = TLV_MANAGEMENT;
	mgt->length = 2 + datasize;
	mgt->id = id;
	memcpy(mgt->data, data, datasize);
	pmc_send(pmc, msg);
	msg_put(msg);

	return 0;
}

int pmc_send_set_aton(struct pmc *pmc, int id, uint8_t key, const char *name)
{
	struct alternate_time_offset_name *aton;
	struct management_tlv *mgt;
	struct ptp_message *msg;
	struct tlv_extra *extra;
	int datasize;

	datasize = sizeof(*aton) + strlen(name);
	if (datasize % 2) {
		datasize++;
	}
	msg = pmc_message(pmc, SET);
	if (!msg) {
		return -1;
	}
	extra = msg_tlv_append(msg, sizeof(*mgt) + datasize);
	if (!extra) {
		msg_put(msg);
		return -ENOMEM;
	}
	mgt = (struct management_tlv *) extra->tlv;
	mgt->type = TLV_MANAGEMENT;
	mgt->length = 2 + datasize;
	mgt->id = id;
	aton = (struct alternate_time_offset_name *) mgt->data;
	aton->keyField = key;
	ptp_text_set(&aton->displayName, name);

	pmc_send(pmc, msg);
	msg_put(msg);

	return 0;
}

struct ptp_message *pmc_recv(struct pmc *pmc)
{
	struct ptp_message *msg, *dup = NULL;
	int cnt, err, spp = pmc->spp;
	struct tlv_extra *extra;

	msg = msg_allocate();
	if (!msg) {
		pr_err("low memory");
		return NULL;
	}
	msg->hwts.type = TS_SOFTWARE;
	cnt = transport_recv(pmc->transport, pmc_get_transport_fd(pmc), msg);
	if (cnt <= 0) {
		pr_err("recv message failed");
		goto failed;
	}
	if (spp >= 0) {
		dup = msg_duplicate(msg, 0);
		if (!dup) {
			goto failed;
		}
	}
	err = msg_post_recv(msg, cnt);
	if (err) {
		switch (err) {
		case -EBADMSG:
			pr_err("bad message");
			break;
		case -EPROTO:
			pr_debug("ignoring message");
			break;
		}
		goto failed;
	}
	if (msg_sots_missing(msg)) {
		pr_err("received %s without timestamp",
		       msg_type_string(msg_type(msg)));
		goto failed;
	}
	if (pmc->allow_unauth && (msg_type(msg) == SIGNALING ||
	    (msg_type(msg) == MANAGEMENT && management_action(msg) == RESPONSE))) {
		spp = -1;
		TAILQ_FOREACH(extra, &msg->tlv_list, list) {
			if (extra->tlv->type == TLV_AUTHENTICATION) {
				spp = pmc->spp;
			}
		}
	}
	err = sad_process_auth(pmc->cfg, spp, msg, dup);
	if (err) {
		if (pmc->allow_unauth == 2) {
			pr_notice("auth failed but allow_unauth set");
		} else {
			switch (err) {
			case -EBADMSG:
				pr_err("auth: bad message");
				break;
			case -EPROTO:
				pr_debug("auth: ignoring message");
				break;
			}
			goto failed;
		}
	}
	if (dup) {
		msg_put(dup);
	}
	return msg;
failed:
	msg_put(msg);
	if (dup) {
		msg_put(dup);
	}
	return NULL;
}

int pmc_target(struct pmc *pmc, struct PortIdentity *pid)
{
	pmc->target = *pid;
	return 0;
}

void pmc_target_port(struct pmc *pmc, UInteger16 portNumber)
{
	pmc->target.portNumber = portNumber;
}

void pmc_target_all(struct pmc *pmc)
{
	memset(&pmc->target, 0xff, sizeof(pmc->target));
}

const char *pmc_action_string(int action)
{
	return action_string[action];
}

int pmc_do_command(struct pmc *pmc, char *str)
{
	int action, id;
	char action_str[10+1] = {0}, id_str[64+1] = {0};

	if (0 == strncasecmp(str, "HELP", strlen(str))) {
		print_help(stdout);
		return 0;
	}

	if (2 != sscanf(str, " %10s %64s", action_str, id_str))
		return -1;

	if (0 == strncasecmp(action_str, "TARGET", strlen(action_str)))
		return parse_target(pmc, id_str);

	action = parse_action(action_str);
	id = parse_id(id_str);

	if (action == BAD_ACTION || id == BAD_ID)
		return -1;

	if (id == AMBIGUOUS_ID) {
		fprintf(stdout, "id %s is too ambiguous\n", id_str);
		return 0;
	}

	fprintf(stdout, "sending: %s %s\n",
		action_string[action], idtab[id].name);

	idtab[id].func(pmc, action, id, str);

	return 0;
}