zmq_port_control.c

/*
 *   BSD LICENSE
 *
 *   Copyright(c) 2016-2017 Netronome.
 *   All rights reserved.
 *
 *   Redistribution and use in source and binary forms, with or without
 *   modification, are permitted provided that the following conditions
 *   are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in
 *       the documentation and/or other materials provided with the
 *       distribution.
 *     * Neither the name of Netronome nor the names of its
 *       contributors may be used to endorse or promote products derived
 *       from this software without specific prior written permission.
 *
 *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#include "zmq_port_control.h"

#include <assert.h>
#include <stdbool.h>
#include <stdio.h>

#include "virtioforwarder.pb-c.h"

#define __MODULE__ "zmq_port_control"
#include "log.h"
#include "sriov.h"
#include "virtio_worker.h"
#include "virtio_vhostuser.h"
#include "zmq_service.h"
#if RTE_VERSION_NUM(21, 00, 0, 0) <= RTE_VERSION
#ifdef RTE_NET_BOND
#define RTE_LIBRTE_PMD_BOND
#endif
#endif
#ifdef RTE_LIBRTE_PMD_BOND
#include <rte_eth_bond.h>
#endif

struct port_control_req_buffer {
	char dbdf_addrs[MAX_NUM_BOND_SLAVES][RTE_ETH_NAME_MAX_LEN];
	unsigned virtio_id;
	char *name;
	uint8_t mode;
	char *vhost_path;
};

/** Converts PortControlRequest.Op to string. */
static char const *
Virtioforwarder__PortControlRequest__Op__to_str(
	Virtioforwarder__PortControlRequest__Op op, char *ans, size_t len)
{
	switch (op)
	{
	case VIRTIOFORWARDER__PORT_CONTROL_REQUEST__OP__ADD:
		return "ADD";

	case VIRTIOFORWARDER__PORT_CONTROL_REQUEST__OP__REMOVE:
		return "REMOVE";

	default:
		snprintf(ans, len, "Virtioforwarder__PortControlRequest__Op(%i)", op);
		return ans;
	}
}
#define Virtioforwarder__PortControlRequest__Op_CCH_MAX 64

/** Converts PortControlRequest.PciAddress to string. */
static void
Virtioforwarder__PortControlRequest__PciAddress__to_str(
	Virtioforwarder__PortControlRequest__PciAddress const *addr, char *ans,
	size_t len)
{
	snprintf(ans, len, "%04X:%02X:%02X.%X", addr->domain, addr->bus,
		addr->slot, addr->function);
}
#define Virtioforwarder__PortControlRequest__PciAddress_CCH_MAX 12

/** Converts PortControlRequest to string. */
static char const *
Virtioforwarder__PortControlRequest__to_str(
	Virtioforwarder__PortControlRequest const *pc, char *ans, size_t len)
{
	char op_str[Virtioforwarder__PortControlRequest__Op_CCH_MAX];
	char pci_addr_str[(1 + Virtioforwarder__PortControlRequest__PciAddress_CCH_MAX) * \
				MAX_NUM_BOND_SLAVES];
	const unsigned sz = Virtioforwarder__PortControlRequest__PciAddress_CCH_MAX;

	for (unsigned i=0; i<pc->n_pci_addrs; ++i) {
		Virtioforwarder__PortControlRequest__PciAddress__to_str(
			pc->pci_addrs[i], &pci_addr_str[i*(sz+1)], sz+1
		);
		strcpy(&pci_addr_str[(i+1)*sz+i], " ");
	}
	snprintf(ans, len, "[op=%s, num_VFs=%zu, pci_addrs=<%s>, virtio_id=%u]",
		Virtioforwarder__PortControlRequest__Op__to_str(
			pc->op, op_str, sizeof op_str
		),
		pc->n_pci_addrs, pci_addr_str, pc->virtio_id
	);

	return ans;
}
#define Virtioforwarder__PortControlRequest__CCH_MAX 128 + \
	(1 + Virtioforwarder__PortControlRequest__PciAddress_CCH_MAX) * \
	MAX_NUM_BOND_SLAVES

/** Range checks PortControlRequest fields. */
static bool
validate_PortControlRequest(Virtioforwarder__PortControlRequest const *pc)
{
	if (pc->name != NULL &&
			(pc->op == VIRTIOFORWARDER__PORT_CONTROL_REQUEST__OP__ADD ||
			pc->op == VIRTIOFORWARDER__PORT_CONTROL_REQUEST__OP__ADD_SOCK) &&
			pc->n_pci_addrs < 2) {
		log_error("Bond add operations require multiple PCI devices.");
		return false;
	}
	if (pc->name == NULL && pc->n_pci_addrs > 1) {
		log_error("Bond port operations require an interface name.");
		return false;
	}
	if ((pc->op == VIRTIOFORWARDER__PORT_CONTROL_REQUEST__OP__REMOVE ||
			pc->op == VIRTIOFORWARDER__PORT_CONTROL_REQUEST__OP__REMOVE_SOCK) &&
			pc->name == NULL && pc->n_pci_addrs > 1) {
		log_error("Cannot specify multiple PCI addresses for VF removal. Provide name to remove a bond.");
		return false;
	}
	if ((pc->op == VIRTIOFORWARDER__PORT_CONTROL_REQUEST__OP__ADD ||
			pc->op == VIRTIOFORWARDER__PORT_CONTROL_REQUEST__OP__REMOVE) &&
			!pc->has_virtio_id) {
		log_error("Add and remove operations require a virtio id.");
		return false;
	}
	if (pc->op == VIRTIOFORWARDER__PORT_CONTROL_REQUEST__OP__ADD_SOCK ||
			pc->op == VIRTIOFORWARDER__PORT_CONTROL_REQUEST__OP__REMOVE_SOCK) {
		if (pc->has_virtio_id)
			log_warning("The virtio id will be ignored for socket pair operations.");
	}

	if (pc->op == VIRTIOFORWARDER__PORT_CONTROL_REQUEST__OP__QUERY_PCI &&
			pc->vhost_path == NULL) {
		log_error("PCI query requires a vhost-user socket path");
		return false;
	}

	return true;
}

/** Sets detailed response status. */
static void
handle_PortControlRequest_set_error_code(
	Virtioforwarder__PortControlResponse *response, char const *error_code_source,
	int32_t error_code)
{
	if (!error_code) {
		response->status = VIRTIOFORWARDER__PORT_CONTROL_RESPONSE__STATUS__OK;
	} else {
		assert(
			response->status ==
			VIRTIOFORWARDER__PORT_CONTROL_RESPONSE__STATUS__ERROR
		);
		/* The double cast is to suppress -Wcast-qual, on the assumption that
		 * the response serializer will not actually attempt to write to this
		 * memory.
		 */
		response->error_code_source = (char *)(intptr_t) error_code_source;
		response->error_code = error_code;
		response->has_error_code = true;
	}
}

static void
port_control_handle_add_socket(Virtioforwarder__PortControlResponse *response,
			struct port_control_req_buffer *cfg,
			unsigned num_devices, bool conditional)
{
	handle_PortControlRequest_set_error_code(
		response, "virtio_add_sock_dev_pair()",
		virtio_add_sock_dev_pair(
			cfg->vhost_path, cfg->dbdf_addrs, num_devices,
			cfg->name, cfg->mode, conditional
		)
	);
}

static void
port_control_handle_remove_socket(Virtioforwarder__PortControlResponse *response,
			struct port_control_req_buffer *cfg, char *name,
			bool conditional)
{
	handle_PortControlRequest_set_error_code(
		response, "virtio_remove_sock_dev_pair()",
		virtio_remove_sock_dev_pair(
			cfg->vhost_path,
			name == NULL ? cfg->dbdf_addrs[0] : name, conditional
		)
	);
}

static void
port_control_handle_query_pci(Virtioforwarder__PortControlResponse *response,
			struct port_control_req_buffer *cfg)
{
	printf("In handle_query_pci");
	handle_PortControlRequest_set_error_code(
		response, "virtio_query_pci()",
		virtio_query_pci(
			response, cfg->vhost_path
		)
	);
}

static void
port_control_handle_add(Virtioforwarder__PortControlResponse *response,
			struct port_control_req_buffer *cfg,
			unsigned num_devices, bool conditional)
{
	if (num_devices == 1) {
		handle_PortControlRequest_set_error_code(
			response, "virtio_forwarder_add_vf2()",
			virtio_forwarder_add_vf2(
				cfg->dbdf_addrs[0],
				cfg->virtio_id, conditional
			)
		);
	} else if (num_devices > 1) {
		handle_PortControlRequest_set_error_code(
			response, "virtio_forwarder_bond_add()",
			virtio_forwarder_bond_add(
				cfg->dbdf_addrs, num_devices, cfg->name,
				cfg->mode, cfg->virtio_id
			)
		);
	} else {
		log_warning("Invalid number of VFs specified in port add request (%u).", num_devices);
	}
}

static void
port_control_handle_remove(Virtioforwarder__PortControlResponse *response,
			struct port_control_req_buffer *cfg, char *name,
			bool conditional)
{
	if (name != NULL) {
		handle_PortControlRequest_set_error_code(
			response, "virtio_forwarder_remove_vf2()",
			virtio_forwarder_remove_vf2(
				name, cfg->virtio_id, conditional
			)
		);
	} else {
		handle_PortControlRequest_set_error_code(
			response, "virtio_forwarder_remove_vf2()",
			virtio_forwarder_remove_vf2(
				cfg->dbdf_addrs[0], cfg->virtio_id, conditional
			)
		);
	}
}

/** Handles a PortControlRequest. */
static size_t
handle_PortControlRequest(
	struct zmq_service *service __attribute__((unused)),
	uint8_t const *request_buffer, size_t cb_request, uint8_t *response_buffer,
	size_t cb_response_buffer)
{
	Virtioforwarder__PortControlResponse response;
	virtioforwarder__port_control_response__init(&response);
	response.status = VIRTIOFORWARDER__PORT_CONTROL_RESPONSE__STATUS__ERROR;

	Virtioforwarder__PortControlRequest *pc =
	virtioforwarder__port_control_request__unpack(
		NULL,
		cb_request,
		request_buffer
	);

	if (!pc) {
		goto pack_response;
	}

	bool valid = validate_PortControlRequest(pc);
	if (valid) {
		char pc_str[Virtioforwarder__PortControlRequest__CCH_MAX];
		log_info("PortControlRequest: %s",
			Virtioforwarder__PortControlRequest__to_str(pc, pc_str, sizeof pc_str)
		);

		struct port_control_req_buffer b;
		memset(&b, 0, sizeof(b));
		for (unsigned i=0; i<pc->n_pci_addrs; ++i)
			Virtioforwarder__PortControlRequest__PciAddress__to_str(
				pc->pci_addrs[i], b.dbdf_addrs[i],
				RTE_ETH_NAME_MAX_LEN
			);
		if (pc->has_virtio_id &&
				pc->op != VIRTIOFORWARDER__PORT_CONTROL_REQUEST__OP__ADD_SOCK &&
				pc->op != VIRTIOFORWARDER__PORT_CONTROL_REQUEST__OP__REMOVE_SOCK)
			b.virtio_id = pc->virtio_id;
		if (pc->name != NULL) {
			b.name = pc->name;
			if (pc->has_mode)
				b.mode = pc->mode;
#ifdef RTE_LIBRTE_PMD_BOND
			else
				b.mode = BONDING_MODE_ACTIVE_BACKUP;
#endif
		}
		if (pc->vhost_path != NULL)
			b.vhost_path = pc->vhost_path;

		bool conditional;
		if (pc->has_conditional) {
			conditional = pc->conditional;
		} else {
			conditional = true;
		}

		switch (pc->op)
		{
		case VIRTIOFORWARDER__PORT_CONTROL_REQUEST__OP__ADD:
			port_control_handle_add(&response, &b, pc->n_pci_addrs,
						conditional);
			break;

		case VIRTIOFORWARDER__PORT_CONTROL_REQUEST__OP__REMOVE:
			port_control_handle_remove(&response, &b,
						pc->n_pci_addrs == 1 ? NULL :
						pc->name, conditional);
			break;

		case VIRTIOFORWARDER__PORT_CONTROL_REQUEST__OP__ADD_SOCK:
			port_control_handle_add_socket(&response, &b,
						pc->n_pci_addrs, conditional);
			break;

		case VIRTIOFORWARDER__PORT_CONTROL_REQUEST__OP__REMOVE_SOCK:
			port_control_handle_remove_socket(&response, &b,
						pc->n_pci_addrs == 1 ? NULL :
						pc->name, conditional);
			break;

		case VIRTIOFORWARDER__PORT_CONTROL_REQUEST__OP__QUERY_PCI:
			port_control_handle_query_pci(&response, &b);
			break;

		default:
			log_critical("unhandled PortControlRequest.Op %i", pc->op);
			break;
		}
	}
	else {
		log_warning("PortControlRequest: invalid field value(s)");
	}

	virtioforwarder__port_control_request__free_unpacked(
		pc, NULL
	);

pack_response:;
	size_t cb_response =
		virtioforwarder__port_control_response__get_packed_size(&response);
	assert(cb_response <= cb_response_buffer);
	return virtioforwarder__port_control_response__pack(
		&response, response_buffer
	);
}

/** Destructor for port control service. */
static void
port_control_free(struct zmq_service *service)
{
	log_debug("Freeing ZeroMQ port control service: %p", service);
	zmq_service_free(service);
}

/** Constructor for port control service. */
static int
port_control_setup(
	struct zmq_service *service, void *setup_arg __attribute__((unused)))
{
	service->handle_request = &handle_PortControlRequest;
	service->destructor = &port_control_free;
	service->max_request_cb = 256 + MAX_NUM_BOND_SLAVES * 16; /* Each PCI request message is 16 bytes. */
	service->max_response_cb = 256;

	return 0;
}

struct zmq_service *
zmq_port_control_service_alloc(void)
{
	struct zmq_service *ans;

	ans = zmq_service_alloc(__MODULE__, &port_control_setup, NULL);
	if (ans)
		log_debug("Allocated ZeroMQ port control service: %p", ans);
	else
		log_critical("Failed to allocate ZeroMQ port control service");

	return ans;
}