[Linuxptp-devel] [PATCH RFC v3 0/5] Configurable UDS server path

[Richard Cochran]

* Changes in v3:
- update man pages
* Changes in v2:
- update gPTP.cfg with the new option
- allow the maximum possible UDS path

This patch series shows a way how to make the address of the server's
UNIX domain socket configurable at run time. This can be useful when
running multiple ptp4l instances. There are at least two uses cases for
this, namely when testing over a virtual tuntap network, and when
running multiple grand masters on different ports with different
settings.

Warning: compile tested only. Comments and testing are appreciated.

Thanks,
Richard


Richard Cochran (5):
Convert the hard coded UDS server path into a variable.
Introduce a configuration file option for the server's UDS address.
pmc: add a command line option to select the server's UDS address.
Extend the interface name length to allow any UDS address.
pmc: bring the man page more up to date.

clock.c | 2 +-
config.c | 5 +++++
config.h | 3 ++-
default.cfg | 1 +
gPTP.cfg | 1 +
pmc.8 | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++++--
pmc.c | 12 +++++++++++-
ptp4l.8 | 6 +++++-
ptp4l.c | 2 ++
uds.c | 6 ++++--
uds.h | 3 ++-
11 files changed, 87 insertions(+), 9 deletions(-)

[Richard Cochran]

This patch changes the macro for the server socket address into a global
variable so that a subsequent patch can provide a way to set the variable.

Signed-off-by: Richard Cochran <***@gmail.com>
---
clock.c | 2 +-
uds.c | 6 ++++--
uds.h | 3 ++-
3 files changed, 7 insertions(+), 4 deletions(-)

diff --git a/clock.c b/clock.c
index cf65fff..419a6b7 100644
--- a/clock.c
+++ b/clock.c
@@ -576,7 +576,7 @@ struct clock *clock_create(int phc_index, struct interface *iface, int count,
struct interface udsif;

memset(&udsif, 0, sizeof(udsif));
- snprintf(udsif.name, sizeof(udsif.name), UDS_PATH);
+ snprintf(udsif.name, sizeof(udsif.name), "%s", uds_path);
udsif.transport = TRANS_UDS;

srandom(time(NULL));
diff --git a/uds.c b/uds.c
index 0d114c3..1dbfd6c 100644
--- a/uds.c
+++ b/uds.c
@@ -30,6 +30,8 @@
#include "transport_private.h"
#include "uds.h"

+char uds_path[MAX_IFNAME_SIZE + 1] = "/var/run/ptp4l";
+
#define UDS_FILEMODE (S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP) /*0660*/

struct uds {
@@ -58,7 +60,7 @@ static int uds_open(struct transport *t, char *name, struct fdarray *fda,
}
memset(&sa, 0, sizeof(sa));
sa.sun_family = AF_LOCAL;
- strcpy(sa.sun_path, name);
+ strncpy(sa.sun_path, name, sizeof(sa.sun_path) - 1);

unlink(name);

@@ -72,7 +74,7 @@ static int uds_open(struct transport *t, char *name, struct fdarray *fda,
/* For client use, pre load the server path. */
memset(&sa, 0, sizeof(sa));
sa.sun_family = AF_LOCAL;
- strcpy(sa.sun_path, UDS_PATH);
+ strncpy(sa.sun_path, uds_path, sizeof(sa.sun_path) - 1);
uds->sa = sa;
uds->len = sizeof(sa);

diff --git a/uds.h b/uds.h
index 24effa8..d7f6626 100644
--- a/uds.h
+++ b/uds.h
@@ -20,13 +20,14 @@
#ifndef HAVE_UDS_H
#define HAVE_UDS_H

+#include "config.h"
#include "fd.h"
#include "transport.h"

/**
* Address of the server.
*/
-#define UDS_PATH "/var/run/ptp4l"
+extern char uds_path[MAX_IFNAME_SIZE + 1];

/**
* Allocate an instance of a UDS transport.

[Richard Cochran]

Signed-off-by: Richard Cochran <***@gmail.com>
---
config.c | 5 +++++
config.h | 1 +
default.cfg | 1 +
gPTP.cfg | 1 +
ptp4l.8 | 6 +++++-
ptp4l.c | 2 ++
6 files changed, 15 insertions(+), 1 deletion(-)

diff --git a/config.c b/config.c
index 8cae57f..fe4c0f3 100644
--- a/config.c
+++ b/config.c
@@ -393,6 +393,11 @@ static enum parser_result parse_global_setting(const char *option,
return r;
*cfg->udp6_scope = uval;

+ } else if (!strcmp(option, "uds_address")) {
+ if (strlen(value) > MAX_IFNAME_SIZE)
+ return OUT_OF_RANGE;
+ strncpy(cfg->uds_address, value, MAX_IFNAME_SIZE);
+
} else if (!strcmp(option, "logging_level")) {
r = get_ranged_int(value, &val,
PRINT_LEVEL_MIN, PRINT_LEVEL_MAX);
diff --git a/config.h b/config.h
index 94704a4..4a2cbaa 100644
--- a/config.h
+++ b/config.h
@@ -89,6 +89,7 @@ struct config {
unsigned char *ptp_dst_mac;
unsigned char *p2p_dst_mac;
unsigned char *udp6_scope;
+ char *uds_address;

int print_level;
int use_syslog;
diff --git a/default.cfg b/default.cfg
index 72665a6..0a42a92 100644
--- a/default.cfg
+++ b/default.cfg
@@ -59,6 +59,7 @@ transportSpecific 0x0
ptp_dst_mac 01:1B:19:00:00:00
p2p_dst_mac 01:80:C2:00:00:0E
udp6_scope 0x0E
+uds_address /var/run/ptp4l
#
# Default interface options
#
diff --git a/gPTP.cfg b/gPTP.cfg
index 30719b6..9c26ec5 100644
--- a/gPTP.cfg
+++ b/gPTP.cfg
@@ -57,6 +57,7 @@ clock_servo pi
transportSpecific 0x1
ptp_dst_mac 01:80:C2:00:00:0E
p2p_dst_mac 01:80:C2:00:00:0E
+uds_address /var/run/ptp4l
#
# Default interface options
#
diff --git a/ptp4l.8 b/ptp4l.8
index 493626d..221d7d1 100644
--- a/ptp4l.8
+++ b/ptp4l.8
@@ -1,4 +1,4 @@
-.TH PTP4l 8 "July 2013" "linuxptp"
+.TH PTP4l 8 "October 2013" "linuxptp"
.SH NAME
ptp4l \- PTP Boundary/Ordinary Clock

@@ -354,6 +354,10 @@ will be used as the second byte of the primary address. This option
is only relevant with IPv6 transport. See RFC 4291. The default is
0x0E for the global scope.
.TP
+.B uds_address
+Specifies the address of the UNIX domain socket for receiving local
+management messages. The default is /var/run/ptp4l.
+.TP
.B logging_level
The maximum logging level of messages which should be printed.
The default is 6 (LOG_INFO).
diff --git a/ptp4l.c b/ptp4l.c
index b0d1c9c..dac303a 100644
--- a/ptp4l.c
+++ b/ptp4l.c
@@ -32,6 +32,7 @@
#include "sk.h"
#include "transport.h"
#include "udp6.h"
+#include "uds.h"
#include "util.h"
#include "version.h"

@@ -111,6 +112,7 @@ static struct config cfg_settings = {
.ptp_dst_mac = ptp_dst_mac,
.p2p_dst_mac = p2p_dst_mac,
.udp6_scope = &udp6_scope,
+ .uds_address = uds_path,

.print_level = LOG_INFO,
.use_syslog = 1,

[Richard Cochran]

Signed-off-by: Richard Cochran <***@gmail.com>
---
pmc.8 | 8 +++++++-
pmc.c | 12 +++++++++++-
2 files changed, 18 insertions(+), 2 deletions(-)

diff --git a/pmc.8 b/pmc.8
index d91c657..759ed84 100644
--- a/pmc.8
+++ b/pmc.8
@@ -1,4 +1,4 @@
-.TH PMC 8 "July 2013" "linuxptp"
+.TH PMC 8 "October 2013" "linuxptp"
.SH NAME
pmc \- PTP management client

@@ -19,6 +19,8 @@ pmc \- PTP management client
] [
.BI \-i " interface"
] [
+.BI \-s " uds-address"
+] [
.BI \-t " transport-specific-field"
] [
.B \-v
@@ -69,6 +71,10 @@ Specify the domain number in sent messages. The default is 0.
Specify the network interface. The default is /var/run/pmc for the Unix Domain
Socket transport and eth0 for the other transports.
.TP
+.BI \-s " uds-address"
+Specifies the address of the server's UNIX domain socket.
+The default is /var/run/ptp4l.
+.TP
.BI \-t " transport-specific-field"
Specify the transport specific field in sent messages as a hexadecimal number.
The default is 0x0.
diff --git a/pmc.c b/pmc.c
index 3a6d697..c9851cd 100644
--- a/pmc.c
+++ b/pmc.c
@@ -31,6 +31,7 @@
#include "pmc_common.h"
#include "print.h"
#include "tlv.h"
+#include "uds.h"
#include "util.h"
#include "version.h"

@@ -676,6 +677,7 @@ static void usage(char *progname)
" -h prints this message and exits\n"
" -i [dev] interface device to use, default 'eth0'\n"
" for network and '/var/run/pmc' for UDS.\n"
+ " -s [path] server address for UDS, default '/var/run/ptp4l'.\n"
" -t [hex] transport specific field, default 0x0\n"
" -v prints the software version and exits\n"
" -z send zero length TLV values with the GET actions\n"
@@ -697,7 +699,7 @@ int main(int argc, char *argv[])
/* Process the command line arguments. */
progname = strrchr(argv[0], '/');
progname = progname ? 1+progname : argv[0];
- while (EOF != (c = getopt(argc, argv, "246u""b:d:hi:t:vz"))) {
+ while (EOF != (c = getopt(argc, argv, "246u""b:d:hi:s:t:vz"))) {
switch (c) {
case '2':
transport_type = TRANS_IEEE_802_3;
@@ -720,6 +722,14 @@ int main(int argc, char *argv[])
case 'i':
iface_name = optarg;
break;
+ case 's':
+ if (strlen(optarg) > MAX_IFNAME_SIZE) {
+ fprintf(stderr, "path %s too long, max is %d\n",
+ optarg, MAX_IFNAME_SIZE);
+ return -1;
+ }
+ strncpy(uds_path, optarg, MAX_IFNAME_SIZE);
+ break;
case 't':
if (1 == sscanf(optarg, "%x", &c))
transport_specific = c << 4;

[Richard Cochran]

This patch increases the maximum length of an interface name to
accommodate a UNIX domain socket address of 108 bytes. (This value is
hard coded in the glibc headers, and so we cannot use the Linux kernel
header macro, UNIX_PATH_MAX.)

Signed-off-by: Richard Cochran <***@gmail.com>
---
config.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/config.h b/config.h
index 4a2cbaa..40d8978 100644
--- a/config.h
+++ b/config.h
@@ -27,7 +27,7 @@
#include "sk.h"

#define MAX_PORTS 8
-#define MAX_IFNAME_SIZE 16
+#define MAX_IFNAME_SIZE 108 /* = UNIX_PATH_MAX */

/** Defines a network interface, with PTP options. */
struct interface {

[Richard Cochran]

Signed-off-by: Richard Cochran <***@gmail.com>
---
pmc.8 | 47 ++++++++++++++++++++++++++++++++++++++++++++++-
1 file changed, 46 insertions(+), 1 deletion(-)

diff --git a/pmc.8 b/pmc.8
index 759ed84..988581f 100644
--- a/pmc.8
+++ b/pmc.8
@@ -43,6 +43,11 @@ updates the specified information and
.BR COMMAND )
initiates the specified event.

+By default the management commands are addressed to all ports. The
+.B TARGET
+command can be used to select a particular clock and port for the
+subsequent messages.
+
Command
.B help
can be used to get a list of supported actions and management IDs.
@@ -95,11 +100,51 @@ length TLV values instead.
.SH MANAGEMENT IDS

.TP
+.B ANNOUNCE_RECEIPT_TIMEOUT
+.TP
+.B CLOCK_ACCURACY
+.TP
+.B CLOCK_DESCRIPTION
+.TP
.B CURRENT_DATA_SET
.TP
-.B TIME_STATUS_NP
+.B DEFAULT_DATA_SET
+.TP
+.B DELAY_MECHANISM
+.TP
+.B DOMAIN
+.TP
+.B GRANDMASTER_SETTINGS_NP
+.TP
+.B LOG_ANNOUNCE_INTERVAL
+.TP
+.B LOG_MIN_PDELAY_REQ_INTERVAL
+.TP
+.B LOG_SYNC_INTERVAL
.TP
.B NULL_MANAGEMENT
+.TP
+.B PARENT_DATA_SET
+.TP
+.B PORT_DATA_SET
+.TP
+.B PRIORITY1
+.TP
+.B PRIORITY2
+.TP
+.B SLAVE_ONLY
+.TP
+.B TIMESCALE_PROPERTIES
+.TP
+.B TIME_PROPERTIES_DATA_SET
+.TP
+.B TIME_STATUS_NP
+.TP
+.B TRACEABILITY_PROPERTIES
+.TP
+.B USER_DESCRIPTION
+.TP
+.B VERSION_NUMBER

.SH SEE ALSO
.BR ptp4l (8)

[Miroslav Lichvar]

Post by Richard Cochran
- update man pages
- update gPTP.cfg with the new option
- allow the maximum possible UDS path
This patch series shows a way how to make the address of the server's
UNIX domain socket configurable at run time. This can be useful when
running multiple ptp4l instances. There are at least two uses cases for
this, namely when testing over a virtual tuntap network, and when
running multiple grand masters on different ports with different
settings.
Warning: compile tested only. Comments and testing are appreciated.

The patches look good to me. In a test with a longer non-default
address it seems to be working fine. Thanks for updating the list of
supported actions in the pmc man page.