Files
shairport-sync/ptp-utilities.c
T

211 lines
7.1 KiB
C

/*
* This file is part of Shairport Sync.
* Copyright (c) Mike Brady 2020 -- 2021
* All rights reserved.
*
* Permission is hereby granted, free of charge, to any person
* obtaining a copy of this software and associated documentation
* files (the "Software"), to deal in the Software without
* restriction, including without limitation the rights to use,
* copy, modify, merge, publish, distribute, sublicense, and/or
* sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
* OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
* OTHER DEALINGS IN THE SOFTWARE.
*/
#include "definitions.h"
#include <arpa/inet.h>
#include <errno.h>
#include <fcntl.h>
#include <pthread.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/mman.h>
#ifdef COMPILE_FOR_FREEBSD
#include <netinet/in.h>
#include <sys/socket.h>
#endif
#define __STDC_FORMAT_MACROS
#include "common.h"
#include <inttypes.h>
#include <unistd.h>
#include "nqptp-shm-structures.h"
#include "ptp-utilities.h"
int shm_fd;
void *mapped_addr;
static pthread_mutex_t ptp_access_mutex = PTHREAD_MUTEX_INITIALIZER;
// returns a copy of the shared memory data from the nqptp
// shared memory interface, so long as it's open.
int get_nqptp_data(struct shm_structure *nqptp_data) {
int response = -1; // presume the worst. Fix it on success
// the first part of the shared memory is a mutex lock, so use it to get
// exclusive access while copying
if ((mapped_addr != MAP_FAILED) && (mapped_addr != NULL)) {
pthread_cleanup_debug_mutex_lock((pthread_mutex_t *)mapped_addr, 100000, 1);
memcpy(nqptp_data, (char *)mapped_addr, sizeof(struct shm_structure));
pthread_cleanup_pop(1); // release the mutex
response = 0;
} else {
if (mapped_addr == NULL)
debug(1, "get_nqptp_data because the mapped_addr is NULL");
else if (mapped_addr == MAP_FAILED)
debug(1, "get_nqptp_data because the mapped_addr is MAP_FAILED");
else
debug(1, "get_nqptp_data failed");
}
return response;
}
int ptp_get_clock_info(uint64_t *actual_clock_id, uint64_t *time_of_sample, uint64_t *raw_offset,
uint64_t *mastership_start_time) {
int response = clock_ok;
if (actual_clock_id != NULL)
*actual_clock_id = 0;
if (raw_offset != NULL)
*raw_offset = 0;
if (time_of_sample != NULL)
*time_of_sample = 0;
if (mastership_start_time != NULL)
*mastership_start_time = 0;
// if (ptp_shm_interface_open() == 0) {
struct shm_structure nqptp_data;
if (get_nqptp_data(&nqptp_data) == 0) {
if (nqptp_data.version == NQPTP_SHM_STRUCTURES_VERSION) {
// assuming a clock id can not be zero
if (nqptp_data.master_clock_id != 0) {
if (actual_clock_id != NULL)
*actual_clock_id = nqptp_data.master_clock_id;
if (time_of_sample != NULL)
*time_of_sample = nqptp_data.local_time;
if (raw_offset != NULL)
*raw_offset = nqptp_data.local_to_master_time_offset;
if (mastership_start_time != NULL)
*mastership_start_time = nqptp_data.master_clock_start_time;
} else {
response = clock_no_master;
}
} else {
// the version can not be zero. If zero is returned here, it means that the shared memory is
// not yet initialised, so not availalbe
if (nqptp_data.version == 0)
response = clock_service_unavailable;
else
response = clock_version_mismatch;
}
} else {
response = clock_data_unavailable;
}
return response;
}
void ptp_shm_interface_init() {
mapped_addr = NULL;
}
int ptp_shm_interface_open() {
int response = 0;
if ((mapped_addr == NULL) || (mapped_addr == MAP_FAILED)) {
response = -1;
debug(2, "ptp_shm_interface_open");
if (strcmp(config.nqptp_shared_memory_interface_name, "") != 0) {
response = 0;
int shared_memory_file_descriptor =
shm_open(config.nqptp_shared_memory_interface_name, O_RDWR, 0);
if (shared_memory_file_descriptor >= 0) {
mapped_addr =
// needs to be PROT_READ | PROT_WRITE to allow the mapped memory to be writable for the
// mutex to lock and unlock
mmap(NULL, sizeof(struct shm_structure), PROT_READ | PROT_WRITE, MAP_SHARED,
shared_memory_file_descriptor, 0);
if (mapped_addr == MAP_FAILED) {
response = -1;
}
if (close(shared_memory_file_descriptor) == -1) {
response = -1;
}
} else {
response = -1;
}
if (response == 0)
debug(2, "ptp_shm_interface_open successful");
else
debug(2, "ptp_shm_interface_open failed");
} else {
debug(1, "No config.nqptp_shared_memory_interface_name");
}
} else {
debug(2, "ptp_shm_interface_open -- already open!");
}
return response;
}
int ptp_shm_interface_close() {
int response = -1;
if ((mapped_addr != MAP_FAILED) && (mapped_addr != NULL)) {
debug(1, "ptp_shm_interface_close");
response = munmap(mapped_addr, sizeof(struct shm_structure));
if (response != 0)
debug(1, "error unmapping shared memory.");
}
mapped_addr = NULL;
return response;
}
void ptp_send_control_message_string(const char *msg) {
size_t full_message_size =
strlen(config.nqptp_shared_memory_interface_name) + strlen(" ") + strlen(msg) + 1;
char *full_message = malloc(full_message_size);
if (full_message != NULL) {
*full_message = '\0';
snprintf(full_message, full_message_size, "%s %s", config.nqptp_shared_memory_interface_name,
msg);
debug(2, "Send control message to NQPTP: \"%s\"", full_message);
int s;
unsigned short port = htons(NQPTP_CONTROL_PORT);
struct sockaddr_in server;
/* Create a datagram socket in the internet domain and use the
* default protocol (UDP).
*/
if ((s = socket(AF_INET, SOCK_DGRAM, 0)) < 0) {
die("Can't open a socket to NQPTP");
}
/* Set up the server name */
server.sin_family = AF_INET; /* Internet Domain */
server.sin_port = port; /* Server Port */
server.sin_addr.s_addr = 0; /* Server's Address */
/* Send the message in buf to the server */
if (sendto(s, full_message, full_message_size, 0, (struct sockaddr *)&server, sizeof(server)) <
0) {
die("error sending timing_peer_list to NQPTP");
}
/* Deallocate the socket */
close(s);
/* deallocate the message string */
free(full_message);
} else {
debug(1, "Couldn't allocate memory to prepare a qualified ptp control message string.");
}
}