Files
src/usr.sbin/ctld/ctld.cc
T
John Baldwin 6acc7afa34 ctld: Convert struct port to a hierarchy of C++ classes
The existing C struct port was used to describe three types of ports:
iSCSI ports associated with a portal_group, ioctl ports, and
"physical" ports associated with a kernel device.  This change chooses
to split these out into separate sub-classes of an abstract port base
class.  Virtual methods are used in a few places such as sending the
class-specific CTL ioctls for creating and removing CTL kernel ports.

For ownership purposes, a struct conf instance "owns" each port via a
std::unique_ptr<> in a std::unordered_map<> indexed by name.  Other
objects such as targets and portal_groups can also contain collections
of ports (targets hold a std::list of pointers, portal groups hold a
std::unordered_map<> indexed by target names).  One
not-so-straightforward case is that if a new port fails to register,
it is removed from the configuration.  In that case, these other
references also have to be removed explicitly.

Sponsored by:	Chelsio Communications
Pull Request:	https://github.com/freebsd/freebsd-src/pull/1794
2025-08-04 15:38:07 -04:00

2329 lines
54 KiB
C++

/*-
* SPDX-License-Identifier: BSD-2-Clause
*
* Copyright (c) 2012 The FreeBSD Foundation
*
* This software was developed by Edward Tomasz Napierala under sponsorship
* from the FreeBSD Foundation.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. 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.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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 <sys/types.h>
#include <sys/event.h>
#include <sys/nv.h>
#include <sys/time.h>
#include <sys/socket.h>
#include <sys/stat.h>
#include <sys/wait.h>
#include <netinet/in.h>
#include <arpa/inet.h>
#include <assert.h>
#include <ctype.h>
#include <errno.h>
#include <netdb.h>
#include <signal.h>
#include <stdbool.h>
#include <stdio.h>
#include <stdint.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
#include <cam/scsi/scsi_all.h>
#include <libutil++.hh>
#include "conf.h"
#include "ctld.hh"
#include "isns.hh"
static bool timed_out(void);
#ifdef ICL_KERNEL_PROXY
static void pdu_receive_proxy(struct pdu *pdu);
static void pdu_send_proxy(struct pdu *pdu);
#endif /* ICL_KERNEL_PROXY */
static void pdu_fail(const struct connection *conn, const char *reason);
bool proxy_mode = false;
static volatile bool sighup_received = false;
static volatile bool sigterm_received = false;
static volatile bool sigalrm_received = false;
static int kqfd;
static int nchildren = 0;
static uint16_t last_portal_group_tag = 0xff;
static struct connection_ops conn_ops = {
.timed_out = timed_out,
#ifdef ICL_KERNEL_PROXY
.pdu_receive_proxy = pdu_receive_proxy,
.pdu_send_proxy = pdu_send_proxy,
#else
.pdu_receive_proxy = nullptr,
.pdu_send_proxy = nullptr,
#endif
.fail = pdu_fail,
};
static void
usage(void)
{
fprintf(stderr, "usage: ctld [-d][-u][-f config-file]\n");
fprintf(stderr, " ctld -t [-u][-f config-file]\n");
exit(1);
}
struct conf *
conf_new(void)
{
struct conf *conf;
conf = new struct conf();
TAILQ_INIT(&conf->conf_luns);
TAILQ_INIT(&conf->conf_targets);
TAILQ_INIT(&conf->conf_portal_groups);
TAILQ_INIT(&conf->conf_isns);
conf->conf_isns_period = 900;
conf->conf_isns_timeout = 5;
conf->conf_debug = 0;
conf->conf_timeout = 60;
conf->conf_maxproc = 30;
return (conf);
}
void
conf_delete(struct conf *conf)
{
struct lun *lun, *ltmp;
struct target *targ, *tmp;
struct portal_group *pg, *cpgtmp;
struct isns *is, *istmp;
assert(conf->conf_pidfh == NULL);
TAILQ_FOREACH_SAFE(lun, &conf->conf_luns, l_next, ltmp)
lun_delete(lun);
TAILQ_FOREACH_SAFE(targ, &conf->conf_targets, t_next, tmp)
target_delete(targ);
TAILQ_FOREACH_SAFE(pg, &conf->conf_portal_groups, pg_next, cpgtmp)
portal_group_delete(pg);
TAILQ_FOREACH_SAFE(is, &conf->conf_isns, i_next, istmp)
isns_delete(is);
free(conf->conf_pidfile_path);
delete conf;
}
#ifdef ICL_KERNEL_PROXY
int
conf::add_proxy_portal(portal *portal)
{
conf_proxy_portals.push_back(portal);
return (conf_proxy_portals.size() - 1);
}
portal *
conf::proxy_portal(int id)
{
if (id >= conf_proxy_portals.size())
return (nullptr);
return (conf_proxy_portals[id]);
}
#endif
bool
auth_group::set_type(const char *str)
{
auth_type type;
if (strcmp(str, "none") == 0) {
type = auth_type::NO_AUTHENTICATION;
} else if (strcmp(str, "deny") == 0) {
type = auth_type::DENY;
} else if (strcmp(str, "chap") == 0) {
type = auth_type::CHAP;
} else if (strcmp(str, "chap-mutual") == 0) {
type = auth_type::CHAP_MUTUAL;
} else {
log_warnx("invalid auth-type \"%s\" for %s", str, label());
return (false);
}
if (ag_type != auth_type::UNKNOWN && ag_type != type) {
log_warnx("cannot set auth-type to \"%s\" for %s; "
"already has a different type", str, label());
return (false);
}
ag_type = type;
return (true);
}
void
auth_group::set_type(auth_type type)
{
assert(ag_type == auth_type::UNKNOWN);
ag_type = type;
}
const struct auth *
auth_group::find_auth(std::string_view user) const
{
auto it = ag_auths.find(std::string(user));
if (it == ag_auths.end())
return (nullptr);
return (&it->second);
}
void
auth_group::check_secret_length(const char *user, const char *secret,
const char *secret_type)
{
size_t len;
len = strlen(secret);
assert(len != 0);
if (len > 16) {
log_warnx("%s for user \"%s\", %s, is too long; it should be "
"at most 16 characters long", secret_type, user, label());
}
if (len < 12) {
log_warnx("%s for user \"%s\", %s, is too short; it should be "
"at least 12 characters long", secret_type, user, label());
}
}
bool
auth_group::add_chap(const char *user, const char *secret)
{
if (ag_type == auth_type::UNKNOWN)
ag_type = auth_type::CHAP;
if (ag_type != auth_type::CHAP) {
log_warnx("cannot mix \"chap\" authentication with "
"other types for %s", label());
return (false);
}
check_secret_length(user, secret, "secret");
const auto &pair = ag_auths.try_emplace(user, secret);
if (!pair.second) {
log_warnx("duplicate credentials for user \"%s\" for %s",
user, label());
return (false);
}
return (true);
}
bool
auth_group::add_chap_mutual(const char *user, const char *secret,
const char *user2, const char *secret2)
{
if (ag_type == auth_type::UNKNOWN)
ag_type = auth_type::CHAP_MUTUAL;
if (ag_type != auth_type::CHAP_MUTUAL) {
log_warnx("cannot mix \"chap-mutual\" authentication "
"with other types for %s", label());
return (false);
}
check_secret_length(user, secret, "secret");
check_secret_length(user, secret2, "mutual secret");
const auto &pair = ag_auths.try_emplace(user, secret, user2, secret2);
if (!pair.second) {
log_warnx("duplicate credentials for user \"%s\" for %s",
user, label());
return (false);
}
return (true);
}
bool
auth_group::add_initiator_name(std::string_view name)
{
/* Silently ignore duplicates. */
ag_names.emplace(name);
return (true);
}
bool
auth_group::initiator_permitted(std::string_view initiator_name) const
{
if (ag_names.empty())
return (true);
return (ag_names.count(std::string(initiator_name)) != 0);
}
bool
auth_portal::parse(const char *portal)
{
std::string net(portal);
std::string mask;
/* Split into 'net' (address) and 'mask'. */
size_t pos = net.find('/');
if (pos != net.npos) {
mask = net.substr(pos + 1);
if (mask.empty())
return false;
net.resize(pos);
}
if (net.empty())
return false;
/*
* If 'net' starts with a '[', ensure it ends with a ']' and
* force interpreting the address as IPv6.
*/
bool brackets = net[0] == '[';
if (brackets) {
net.erase(0, 1);
size_t len = net.length();
if (len < 2)
return false;
if (net[len - 1] != ']')
return false;
net.resize(len - 1);
}
/* Parse address from 'net' and set default mask. */
if (brackets || net.find(':') != net.npos) {
struct sockaddr_in6 *sin6 =
(struct sockaddr_in6 *)&ap_sa;
sin6->sin6_len = sizeof(*sin6);
sin6->sin6_family = AF_INET6;
if (inet_pton(AF_INET6, net.c_str(), &sin6->sin6_addr) <= 0)
return false;
ap_mask = sizeof(sin6->sin6_addr) * 8;
} else {
struct sockaddr_in *sin =
(struct sockaddr_in *)&ap_sa;
sin->sin_len = sizeof(*sin);
sin->sin_family = AF_INET;
if (inet_pton(AF_INET, net.c_str(), &sin->sin_addr) <= 0)
return false;
ap_mask = sizeof(sin->sin_addr) * 8;
}
/* Parse explicit mask if present. */
if (!mask.empty()) {
char *tmp;
long m = strtol(mask.c_str(), &tmp, 0);
if (m < 0 || m > ap_mask || tmp[0] != 0)
return false;
ap_mask = m;
}
return true;
}
bool
auth_group::add_initiator_portal(const char *portal)
{
auth_portal ap;
if (!ap.parse(portal)) {
log_warnx("invalid initiator portal \"%s\" for %s", portal,
label());
return (false);
}
ag_portals.emplace_back(ap);
return (true);
}
bool
auth_portal::matches(const struct sockaddr *sa) const
{
const uint8_t *a, *b;
int i;
if (ap_sa.ss_family != sa->sa_family)
return (false);
if (sa->sa_family == AF_INET) {
a = (const uint8_t *)
&((const struct sockaddr_in *)sa)->sin_addr;
b = (const uint8_t *)
&((const struct sockaddr_in *)&ap_sa)->sin_addr;
} else {
a = (const uint8_t *)
&((const struct sockaddr_in6 *)sa)->sin6_addr;
b = (const uint8_t *)
&((const struct sockaddr_in6 *)&ap_sa)->sin6_addr;
}
for (i = 0; i < ap_mask / 8; i++) {
if (a[i] != b[i])
return (false);
}
if ((ap_mask % 8) != 0) {
uint8_t bmask = 0xff << (8 - (ap_mask % 8));
if ((a[i] & bmask) != (b[i] & bmask))
return (false);
}
return (true);
}
bool
auth_group::initiator_permitted(const struct sockaddr *sa) const
{
if (ag_portals.empty())
return (true);
for (const auth_portal &ap : ag_portals)
if (ap.matches(sa))
return (true);
return (false);
}
struct auth_group *
auth_group_new(struct conf *conf, const char *name)
{
const auto &pair = conf->conf_auth_groups.try_emplace(name,
std::make_shared<auth_group>(freebsd::stringf("auth-group \"%s\"",
name)));
if (!pair.second) {
log_warnx("duplicated auth-group \"%s\"", name);
return (NULL);
}
return (pair.first->second.get());
}
auth_group_sp
auth_group_new(struct target *target)
{
return (std::make_shared<auth_group>(freebsd::stringf("target \"%s\"",
target->t_name)));
}
auth_group_sp
auth_group_find(const struct conf *conf, const char *name)
{
auto it = conf->conf_auth_groups.find(name);
if (it == conf->conf_auth_groups.end())
return {};
return (it->second);
}
struct portal_group *
portal_group_new(struct conf *conf, const char *name)
{
struct portal_group *pg;
pg = portal_group_find(conf, name);
if (pg != NULL) {
log_warnx("duplicated portal-group \"%s\"", name);
return (NULL);
}
pg = new portal_group();
pg->pg_name = checked_strdup(name);
pg->pg_options = nvlist_create(0);
pg->pg_conf = conf;
pg->pg_tag = 0; /* Assigned later in conf_apply(). */
pg->pg_dscp = -1;
pg->pg_pcp = -1;
TAILQ_INSERT_TAIL(&conf->conf_portal_groups, pg, pg_next);
return (pg);
}
void
portal_group_delete(struct portal_group *pg)
{
TAILQ_REMOVE(&pg->pg_conf->conf_portal_groups, pg, pg_next);
nvlist_destroy(pg->pg_options);
free(pg->pg_name);
free(pg->pg_offload);
free(pg->pg_redirection);
delete pg;
}
struct portal_group *
portal_group_find(const struct conf *conf, const char *name)
{
struct portal_group *pg;
TAILQ_FOREACH(pg, &conf->conf_portal_groups, pg_next) {
if (strcmp(pg->pg_name, name) == 0)
return (pg);
}
return (NULL);
}
static freebsd::addrinfo_up
parse_addr_port(const char *address, const char *def_port)
{
struct addrinfo hints, *ai;
int error;
std::string addr(address);
std::string port(def_port);
if (addr[0] == '[') {
/*
* IPv6 address in square brackets, perhaps with port.
*/
addr.erase(0, 1);
size_t pos = addr.find(']');
if (pos == 0 || pos == addr.npos)
return {};
if (pos < addr.length() - 1) {
port = addr.substr(pos + 1);
if (port[0] != ':' || port.length() < 2)
return {};
port.erase(0, 1);
}
addr.resize(pos);
} else {
/*
* Either IPv6 address without brackets - and without
* a port - or IPv4 address. Just count the colons.
*/
size_t pos = addr.find(':');
if (pos != addr.npos && addr.find(':', pos + 1) == addr.npos) {
/* Only a single colon at `pos`. */
if (pos == addr.length() - 1)
return {};
port = addr.substr(pos + 1);
addr.resize(pos);
}
}
memset(&hints, 0, sizeof(hints));
hints.ai_family = PF_UNSPEC;
hints.ai_socktype = SOCK_STREAM;
hints.ai_flags = AI_PASSIVE;
error = getaddrinfo(addr.c_str(), port.c_str(), &hints, &ai);
if (error != 0)
return {};
return freebsd::addrinfo_up(ai);
}
bool
portal_group_add_portal(struct portal_group *pg, const char *value, bool iser)
{
freebsd::addrinfo_up ai = parse_addr_port(value, "3260");
if (!ai) {
log_warnx("invalid listen address %s", value);
return (false);
}
/*
* XXX: getaddrinfo(3) may return multiple addresses; we should turn
* those into multiple portals.
*/
pg->pg_portals.emplace_back(std::make_unique<portal>(pg, value, iser,
std::move(ai)));
return (true);
}
bool
isns_new(struct conf *conf, const char *addr)
{
struct isns *isns;
isns = reinterpret_cast<struct isns *>(calloc(1, sizeof(*isns)));
if (isns == NULL)
log_err(1, "calloc");
isns->i_conf = conf;
TAILQ_INSERT_TAIL(&conf->conf_isns, isns, i_next);
isns->i_addr = checked_strdup(addr);
freebsd::addrinfo_up ai = parse_addr_port(isns->i_addr, "3205");
if (!ai) {
log_warnx("invalid iSNS address %s", isns->i_addr);
isns_delete(isns);
return (false);
}
/*
* XXX: getaddrinfo(3) may return multiple addresses; we should turn
* those into multiple servers.
*/
isns->i_ai = ai.release();
return (true);
}
void
isns_delete(struct isns *isns)
{
TAILQ_REMOVE(&isns->i_conf->conf_isns, isns, i_next);
free(isns->i_addr);
if (isns->i_ai != NULL)
freeaddrinfo(isns->i_ai);
free(isns);
}
static int
isns_do_connect(struct isns *isns)
{
int s;
s = socket(isns->i_ai->ai_family, isns->i_ai->ai_socktype,
isns->i_ai->ai_protocol);
if (s < 0) {
log_warn("socket(2) failed for %s", isns->i_addr);
return (-1);
}
if (connect(s, isns->i_ai->ai_addr, isns->i_ai->ai_addrlen)) {
log_warn("connect(2) failed for %s", isns->i_addr);
close(s);
return (-1);
}
return(s);
}
static void
isns_do_register(struct isns *isns, int s, const char *hostname)
{
struct conf *conf = isns->i_conf;
struct target *target;
struct portal_group *pg;
uint32_t error;
isns_req req(ISNS_FUNC_DEVATTRREG, ISNS_FLAG_CLIENT);
req.add_str(32, TAILQ_FIRST(&conf->conf_targets)->t_name);
req.add_delim();
req.add_str(1, hostname);
req.add_32(2, 2); /* 2 -- iSCSI */
req.add_32(6, conf->conf_isns_period);
TAILQ_FOREACH(pg, &conf->conf_portal_groups, pg_next) {
if (pg->pg_unassigned)
continue;
for (const portal_up &portal : pg->pg_portals) {
req.add_addr(16, portal->ai());
req.add_port(17, portal->ai());
}
}
TAILQ_FOREACH(target, &conf->conf_targets, t_next) {
req.add_str(32, target->t_name);
req.add_32(33, 1); /* 1 -- Target*/
if (target->t_alias != NULL)
req.add_str(34, target->t_alias);
for (const port *port : target->t_ports) {
pg = port->portal_group();
if (pg == nullptr)
continue;
req.add_32(51, pg->pg_tag);
for (const portal_up &portal : pg->pg_portals) {
req.add_addr(49, portal->ai());
req.add_port(50, portal->ai());
}
}
}
if (!req.send(s)) {
log_warn("send(2) failed for %s", isns->i_addr);
return;
}
if (!req.receive(s)) {
log_warn("receive(2) failed for %s", isns->i_addr);
return;
}
error = req.get_status();
if (error != 0) {
log_warnx("iSNS register error %d for %s", error, isns->i_addr);
}
}
static bool
isns_do_check(struct isns *isns, int s, const char *hostname)
{
struct conf *conf = isns->i_conf;
uint32_t error;
isns_req req(ISNS_FUNC_DEVATTRQRY, ISNS_FLAG_CLIENT);
req.add_str(32, TAILQ_FIRST(&conf->conf_targets)->t_name);
req.add_str(1, hostname);
req.add_delim();
req.add(2, 0, NULL);
if (!req.send(s)) {
log_warn("send(2) failed for %s", isns->i_addr);
return (false);
}
if (!req.receive(s)) {
log_warn("receive(2) failed for %s", isns->i_addr);
return (false);
}
error = req.get_status();
if (error != 0) {
log_warnx("iSNS check error %d for %s", error, isns->i_addr);
return (false);
}
return (true);
}
static void
isns_do_deregister(struct isns *isns, int s, const char *hostname)
{
struct conf *conf = isns->i_conf;
uint32_t error;
isns_req req(ISNS_FUNC_DEVDEREG, ISNS_FLAG_CLIENT);
req.add_str(32, TAILQ_FIRST(&conf->conf_targets)->t_name);
req.add_delim();
req.add_str(1, hostname);
if (!req.send(s)) {
log_warn("send(2) failed for %s", isns->i_addr);
return;
}
if (!req.receive(s)) {
log_warn("receive(2) failed for %s", isns->i_addr);
return;
}
error = req.get_status();
if (error != 0) {
log_warnx("iSNS deregister error %d for %s", error, isns->i_addr);
}
}
void
isns_register(struct isns *isns, struct isns *oldisns)
{
struct conf *conf = isns->i_conf;
int error, s;
char hostname[256];
if (TAILQ_EMPTY(&conf->conf_targets) ||
TAILQ_EMPTY(&conf->conf_portal_groups))
return;
set_timeout(conf->conf_isns_timeout, false);
s = isns_do_connect(isns);
if (s < 0) {
set_timeout(0, false);
return;
}
error = gethostname(hostname, sizeof(hostname));
if (error != 0)
log_err(1, "gethostname");
if (oldisns == NULL || TAILQ_EMPTY(&oldisns->i_conf->conf_targets))
oldisns = isns;
isns_do_deregister(oldisns, s, hostname);
isns_do_register(isns, s, hostname);
close(s);
set_timeout(0, false);
}
void
isns_check(struct isns *isns)
{
struct conf *conf = isns->i_conf;
int error, s;
char hostname[256];
if (TAILQ_EMPTY(&conf->conf_targets) ||
TAILQ_EMPTY(&conf->conf_portal_groups))
return;
set_timeout(conf->conf_isns_timeout, false);
s = isns_do_connect(isns);
if (s < 0) {
set_timeout(0, false);
return;
}
error = gethostname(hostname, sizeof(hostname));
if (error != 0)
log_err(1, "gethostname");
if (!isns_do_check(isns, s, hostname)) {
isns_do_deregister(isns, s, hostname);
isns_do_register(isns, s, hostname);
}
close(s);
set_timeout(0, false);
}
void
isns_deregister(struct isns *isns)
{
struct conf *conf = isns->i_conf;
int error, s;
char hostname[256];
if (TAILQ_EMPTY(&conf->conf_targets) ||
TAILQ_EMPTY(&conf->conf_portal_groups))
return;
set_timeout(conf->conf_isns_timeout, false);
s = isns_do_connect(isns);
if (s < 0)
return;
error = gethostname(hostname, sizeof(hostname));
if (error != 0)
log_err(1, "gethostname");
isns_do_deregister(isns, s, hostname);
close(s);
set_timeout(0, false);
}
bool
kports::add_port(const char *name, uint32_t ctl_port)
{
const auto &pair = pports.try_emplace(name, name, ctl_port);
if (!pair.second) {
log_warnx("duplicate kernel port \"%s\" (%u)", name, ctl_port);
return (false);
}
return (true);
}
bool
kports::has_port(std::string_view name)
{
return (pports.count(std::string(name)) > 0);
}
struct pport *
kports::find_port(std::string_view name)
{
auto it = pports.find(std::string(name));
if (it == pports.end())
return (nullptr);
return (&it->second);
}
port::port(struct target *target) :
p_target(target)
{
target->t_ports.push_back(this);
}
void
port::clear_references()
{
p_target->t_ports.remove(this);
}
portal_group_port::portal_group_port(struct target *target,
struct portal_group *pg, auth_group_sp ag) :
port(target), p_auth_group(ag), p_portal_group(pg)
{
pg->pg_ports.emplace(target->t_name, this);
}
portal_group_port::portal_group_port(struct target *target,
struct portal_group *pg, uint32_t ctl_port) :
port(target), p_portal_group(pg)
{
p_ctl_port = ctl_port;
pg->pg_ports.emplace(target->t_name, this);
}
bool
portal_group_port::is_dummy() const
{
if (p_portal_group->pg_foreign)
return (true);
if (p_portal_group->pg_portals.empty())
return (true);
return (false);
}
void
portal_group_port::clear_references()
{
auto it = p_portal_group->pg_ports.find(p_target->t_name);
p_portal_group->pg_ports.erase(it);
port::clear_references();
}
bool
port_new(struct conf *conf, struct target *target, struct portal_group *pg,
auth_group_sp ag)
{
std::string name = freebsd::stringf("%s-%s", pg->pg_name,
target->t_name);
const auto &pair = conf->conf_ports.try_emplace(name,
std::make_unique<portal_group_port>(target, pg, ag));
if (!pair.second) {
log_warnx("duplicate port \"%s\"", name.c_str());
return (false);
}
return (true);
}
bool
port_new(struct conf *conf, struct target *target, struct portal_group *pg,
uint32_t ctl_port)
{
std::string name = freebsd::stringf("%s-%s", pg->pg_name,
target->t_name);
const auto &pair = conf->conf_ports.try_emplace(name,
std::make_unique<portal_group_port>(target, pg, ctl_port));
if (!pair.second) {
log_warnx("duplicate port \"%s\"", name.c_str());
return (false);
}
return (true);
}
static bool
port_new_pp(struct conf *conf, struct target *target, struct pport *pp)
{
std::string name = freebsd::stringf("%s-%s", pp->name(),
target->t_name);
const auto &pair = conf->conf_ports.try_emplace(name,
std::make_unique<kernel_port>(target, pp));
if (!pair.second) {
log_warnx("duplicate port \"%s\"", name.c_str());
return (false);
}
pp->link();
return (true);
}
static bool
port_new_ioctl(struct conf *conf, struct kports &kports, struct target *target,
int pp, int vp)
{
struct pport *pport;
std::string pname = freebsd::stringf("ioctl/%d/%d", pp, vp);
pport = kports.find_port(pname);
if (pport != NULL)
return (port_new_pp(conf, target, pport));
std::string name = pname + "-" + target->t_name;
const auto &pair = conf->conf_ports.try_emplace(name,
std::make_unique<ioctl_port>(target, pp, vp));
if (!pair.second) {
log_warnx("duplicate port \"%s\"", name.c_str());
return (false);
}
return (true);
}
struct port *
port_find_in_pg(const struct portal_group *pg, const char *target)
{
auto it = pg->pg_ports.find(target);
if (it == pg->pg_ports.end())
return (nullptr);
return (it->second);
}
struct target *
target_new(struct conf *conf, const char *name)
{
struct target *targ;
int i, len;
targ = target_find(conf, name);
if (targ != NULL) {
log_warnx("duplicated target \"%s\"", name);
return (NULL);
}
if (valid_iscsi_name(name, log_warnx) == false) {
return (NULL);
}
targ = new target();
targ->t_name = checked_strdup(name);
/*
* RFC 3722 requires us to normalize the name to lowercase.
*/
len = strlen(name);
for (i = 0; i < len; i++)
targ->t_name[i] = tolower(targ->t_name[i]);
targ->t_conf = conf;
TAILQ_INSERT_TAIL(&conf->conf_targets, targ, t_next);
return (targ);
}
void
target_delete(struct target *targ)
{
TAILQ_REMOVE(&targ->t_conf->conf_targets, targ, t_next);
free(targ->t_pport);
free(targ->t_name);
free(targ->t_redirection);
delete targ;
}
struct target *
target_find(struct conf *conf, const char *name)
{
struct target *targ;
TAILQ_FOREACH(targ, &conf->conf_targets, t_next) {
if (strcasecmp(targ->t_name, name) == 0)
return (targ);
}
return (NULL);
}
struct lun *
lun_new(struct conf *conf, const char *name)
{
struct lun *lun;
lun = lun_find(conf, name);
if (lun != NULL) {
log_warnx("duplicated lun \"%s\"", name);
return (NULL);
}
lun = reinterpret_cast<struct lun *>(calloc(1, sizeof(*lun)));
if (lun == NULL)
log_err(1, "calloc");
lun->l_conf = conf;
lun->l_name = checked_strdup(name);
lun->l_options = nvlist_create(0);
TAILQ_INSERT_TAIL(&conf->conf_luns, lun, l_next);
lun->l_ctl_lun = -1;
return (lun);
}
void
lun_delete(struct lun *lun)
{
struct target *targ;
int i;
TAILQ_FOREACH(targ, &lun->l_conf->conf_targets, t_next) {
for (i = 0; i < MAX_LUNS; i++) {
if (targ->t_luns[i] == lun)
targ->t_luns[i] = NULL;
}
}
TAILQ_REMOVE(&lun->l_conf->conf_luns, lun, l_next);
nvlist_destroy(lun->l_options);
free(lun->l_name);
free(lun->l_backend);
free(lun->l_device_id);
free(lun->l_path);
free(lun->l_scsiname);
free(lun->l_serial);
free(lun);
}
struct lun *
lun_find(const struct conf *conf, const char *name)
{
struct lun *lun;
TAILQ_FOREACH(lun, &conf->conf_luns, l_next) {
if (strcmp(lun->l_name, name) == 0)
return (lun);
}
return (NULL);
}
void
lun_set_scsiname(struct lun *lun, const char *value)
{
free(lun->l_scsiname);
lun->l_scsiname = checked_strdup(value);
}
bool
option_new(nvlist_t *nvl, const char *name, const char *value)
{
int error;
if (nvlist_exists_string(nvl, name)) {
log_warnx("duplicated option \"%s\"", name);
return (false);
}
nvlist_add_string(nvl, name, value);
error = nvlist_error(nvl);
if (error != 0) {
log_warnc(error, "failed to add option \"%s\"", name);
return (false);
}
return (true);
}
#ifdef ICL_KERNEL_PROXY
static void
pdu_receive_proxy(struct pdu *pdu)
{
struct connection *conn;
size_t len;
assert(proxy_mode);
conn = pdu->pdu_connection;
kernel_receive(pdu);
len = pdu_ahs_length(pdu);
if (len > 0)
log_errx(1, "protocol error: non-empty AHS");
len = pdu_data_segment_length(pdu);
assert(len <= (size_t)conn->conn_max_recv_data_segment_length);
pdu->pdu_data_len = len;
}
static void
pdu_send_proxy(struct pdu *pdu)
{
assert(proxy_mode);
pdu_set_data_segment_length(pdu, pdu->pdu_data_len);
kernel_send(pdu);
}
#endif /* ICL_KERNEL_PROXY */
static void
pdu_fail(const struct connection *conn __unused, const char *reason __unused)
{
}
static struct ctld_connection *
connection_new(struct portal *portal, int fd, const char *host,
const struct sockaddr *client_sa)
{
struct ctld_connection *conn;
conn = reinterpret_cast<struct ctld_connection *>(calloc(1, sizeof(*conn)));
if (conn == NULL)
log_err(1, "calloc");
connection_init(&conn->conn, &conn_ops, proxy_mode);
conn->conn.conn_socket = fd;
conn->conn_portal = portal;
conn->conn_initiator_addr = checked_strdup(host);
conn->conn_initiator_sa = client_sa;
return (conn);
}
static bool
conf_verify_lun(struct lun *lun)
{
const struct lun *lun2;
if (lun->l_backend == NULL)
lun->l_backend = checked_strdup("block");
if (strcmp(lun->l_backend, "block") == 0) {
if (lun->l_path == NULL) {
log_warnx("missing path for lun \"%s\"",
lun->l_name);
return (false);
}
} else if (strcmp(lun->l_backend, "ramdisk") == 0) {
if (lun->l_size == 0) {
log_warnx("missing size for ramdisk-backed lun \"%s\"",
lun->l_name);
return (false);
}
if (lun->l_path != NULL) {
log_warnx("path must not be specified "
"for ramdisk-backed lun \"%s\"",
lun->l_name);
return (false);
}
}
if (lun->l_blocksize == 0) {
if (lun->l_device_type == T_CDROM)
lun->l_blocksize = DEFAULT_CD_BLOCKSIZE;
else
lun->l_blocksize = DEFAULT_BLOCKSIZE;
} else if (lun->l_blocksize < 0) {
log_warnx("invalid blocksize for lun \"%s\"; "
"must be larger than 0", lun->l_name);
return (false);
}
if (lun->l_size != 0 && lun->l_size % lun->l_blocksize != 0) {
log_warnx("invalid size for lun \"%s\"; "
"must be multiple of blocksize", lun->l_name);
return (false);
}
TAILQ_FOREACH(lun2, &lun->l_conf->conf_luns, l_next) {
if (lun == lun2)
continue;
if (lun->l_path != NULL && lun2->l_path != NULL &&
strcmp(lun->l_path, lun2->l_path) == 0) {
log_debugx("WARNING: path \"%s\" duplicated "
"between lun \"%s\", and "
"lun \"%s\"", lun->l_path,
lun->l_name, lun2->l_name);
}
}
return (true);
}
bool
conf_verify(struct conf *conf)
{
struct portal_group *pg;
struct target *targ;
struct lun *lun;
bool found;
int i;
if (conf->conf_pidfile_path == NULL)
conf->conf_pidfile_path = checked_strdup(DEFAULT_PIDFILE);
TAILQ_FOREACH(lun, &conf->conf_luns, l_next) {
if (!conf_verify_lun(lun))
return (false);
}
TAILQ_FOREACH(targ, &conf->conf_targets, t_next) {
if (targ->t_auth_group == NULL) {
targ->t_auth_group = auth_group_find(conf,
"default");
assert(targ->t_auth_group != NULL);
}
if (targ->t_ports.empty()) {
pg = portal_group_find(conf, "default");
assert(pg != NULL);
port_new(conf, targ, pg, nullptr);
}
found = false;
for (i = 0; i < MAX_LUNS; i++) {
if (targ->t_luns[i] != NULL)
found = true;
}
if (!found && targ->t_redirection == NULL) {
log_warnx("no LUNs defined for target \"%s\"",
targ->t_name);
}
if (found && targ->t_redirection != NULL) {
log_debugx("target \"%s\" contains luns, "
" but configured for redirection",
targ->t_name);
}
}
TAILQ_FOREACH(pg, &conf->conf_portal_groups, pg_next) {
assert(pg->pg_name != NULL);
if (pg->pg_discovery_auth_group == NULL) {
pg->pg_discovery_auth_group =
auth_group_find(conf, "default");
assert(pg->pg_discovery_auth_group != NULL);
}
if (pg->pg_discovery_filter == PG_FILTER_UNKNOWN)
pg->pg_discovery_filter = PG_FILTER_NONE;
if (pg->pg_redirection != NULL) {
if (!pg->pg_ports.empty()) {
log_debugx("portal-group \"%s\" assigned "
"to target, but configured "
"for redirection",
pg->pg_name);
}
pg->pg_unassigned = false;
} else if (!pg->pg_ports.empty()) {
pg->pg_unassigned = false;
} else {
if (strcmp(pg->pg_name, "default") != 0)
log_warnx("portal-group \"%s\" not assigned "
"to any target", pg->pg_name);
pg->pg_unassigned = true;
}
}
for (const auto &kv : conf->conf_auth_groups) {
const std::string &ag_name = kv.first;
if (ag_name == "default" ||
ag_name == "no-authentication" ||
ag_name == "no-access")
continue;
if (kv.second.use_count() == 1) {
log_warnx("auth-group \"%s\" not assigned "
"to any target", ag_name.c_str());
}
}
return (true);
}
bool
portal::reuse_socket(struct portal &oldp)
{
struct kevent kev;
if (p_listen != oldp.p_listen)
return (false);
if (!oldp.p_socket)
return (false);
EV_SET(&kev, oldp.p_socket, EVFILT_READ, EV_ADD, 0, 0, this);
if (kevent(kqfd, &kev, 1, NULL, 0, NULL) == -1)
return (false);
p_socket = std::move(oldp.p_socket);
return (true);
}
bool
portal::init_socket()
{
struct portal_group *pg = portal_group();
struct kevent kev;
freebsd::fd_up s;
int error, sockbuf;
int one = 1;
#ifdef ICL_KERNEL_PROXY
if (proxy_mode) {
int id = pg->pg_conf->add_proxy_portal(this);
log_debugx("listening on %s, portal-group \"%s\", "
"portal id %d, using ICL proxy", listen(), pg->pg_name,
id);
kernel_listen(ai(), p_iser, id);
return (true);
}
#endif
assert(proxy_mode == false);
assert(p_iser == false);
log_debugx("listening on %s, portal-group \"%s\"", listen(),
pg->pg_name);
s = ::socket(p_ai->ai_family, p_ai->ai_socktype, p_ai->ai_protocol);
if (!s) {
log_warn("socket(2) failed for %s", listen());
return (false);
}
sockbuf = SOCKBUF_SIZE;
if (setsockopt(s, SOL_SOCKET, SO_RCVBUF, &sockbuf,
sizeof(sockbuf)) == -1)
log_warn("setsockopt(SO_RCVBUF) failed for %s", listen());
sockbuf = SOCKBUF_SIZE;
if (setsockopt(s, SOL_SOCKET, SO_SNDBUF, &sockbuf,
sizeof(sockbuf)) == -1)
log_warn("setsockopt(SO_SNDBUF) failed for %s", listen());
if (setsockopt(s, SOL_SOCKET, SO_NO_DDP, &one,
sizeof(one)) == -1)
log_warn("setsockopt(SO_NO_DDP) failed for %s", listen());
error = setsockopt(s, SOL_SOCKET, SO_REUSEADDR, &one,
sizeof(one));
if (error != 0) {
log_warn("setsockopt(SO_REUSEADDR) failed for %s", listen());
return (false);
}
if (pg->pg_dscp != -1) {
/* Only allow the 6-bit DSCP field to be modified */
int tos = pg->pg_dscp << 2;
switch (p_ai->ai_family) {
case AF_INET:
if (setsockopt(s, IPPROTO_IP, IP_TOS,
&tos, sizeof(tos)) == -1)
log_warn("setsockopt(IP_TOS) failed for %s",
listen());
break;
case AF_INET6:
if (setsockopt(s, IPPROTO_IPV6, IPV6_TCLASS,
&tos, sizeof(tos)) == -1)
log_warn("setsockopt(IPV6_TCLASS) failed for %s",
listen());
break;
}
}
if (pg->pg_pcp != -1) {
int pcp = pg->pg_pcp;
switch (p_ai->ai_family) {
case AF_INET:
if (setsockopt(s, IPPROTO_IP, IP_VLAN_PCP,
&pcp, sizeof(pcp)) == -1)
log_warn("setsockopt(IP_VLAN_PCP) failed for %s",
listen());
break;
case AF_INET6:
if (setsockopt(s, IPPROTO_IPV6, IPV6_VLAN_PCP,
&pcp, sizeof(pcp)) == -1)
log_warn("setsockopt(IPV6_VLAN_PCP) failed for %s",
listen());
break;
}
}
error = bind(s, p_ai->ai_addr, p_ai->ai_addrlen);
if (error != 0) {
log_warn("bind(2) failed for %s", listen());
return (false);
}
error = ::listen(s, -1);
if (error != 0) {
log_warn("listen(2) failed for %s", listen());
return (false);
}
EV_SET(&kev, s, EVFILT_READ, EV_ADD, 0, 0, this);
error = kevent(kqfd, &kev, 1, NULL, 0, NULL);
if (error == -1) {
log_warn("kevent(2) failed to register for %s", listen());
return (false);
}
p_socket = std::move(s);
return (true);
}
static int
conf_apply(struct conf *oldconf, struct conf *newconf)
{
struct lun *oldlun, *newlun, *tmplun;
struct portal_group *oldpg, *newpg;
struct isns *oldns, *newns;
int changed, cumulated_error = 0, error;
if (oldconf->conf_debug != newconf->conf_debug) {
log_debugx("changing debug level to %d", newconf->conf_debug);
log_init(newconf->conf_debug);
}
if (oldconf->conf_pidfile_path != NULL &&
newconf->conf_pidfile_path != NULL)
{
if (strcmp(oldconf->conf_pidfile_path,
newconf->conf_pidfile_path) != 0)
{
/* pidfile has changed. rename it */
log_debugx("moving pidfile to %s",
newconf->conf_pidfile_path);
if (rename(oldconf->conf_pidfile_path,
newconf->conf_pidfile_path))
{
log_err(1, "renaming pidfile %s -> %s",
oldconf->conf_pidfile_path,
newconf->conf_pidfile_path);
}
}
newconf->conf_pidfh = oldconf->conf_pidfh;
oldconf->conf_pidfh = NULL;
}
/*
* Go through the new portal groups, assigning tags or preserving old.
*/
TAILQ_FOREACH(newpg, &newconf->conf_portal_groups, pg_next) {
if (newpg->pg_tag != 0)
continue;
oldpg = portal_group_find(oldconf, newpg->pg_name);
if (oldpg != NULL)
newpg->pg_tag = oldpg->pg_tag;
else
newpg->pg_tag = ++last_portal_group_tag;
}
/* Deregister on removed iSNS servers. */
TAILQ_FOREACH(oldns, &oldconf->conf_isns, i_next) {
TAILQ_FOREACH(newns, &newconf->conf_isns, i_next) {
if (strcmp(oldns->i_addr, newns->i_addr) == 0)
break;
}
if (newns == NULL)
isns_deregister(oldns);
}
/*
* XXX: If target or lun removal fails, we should somehow "move"
* the old lun or target into newconf, so that subsequent
* conf_apply() would try to remove them again. That would
* be somewhat hairy, though, and lun deletion failures don't
* really happen, so leave it as it is for now.
*/
/*
* First, remove any ports present in the old configuration
* and missing in the new one.
*/
for (const auto &kv : oldconf->conf_ports) {
const std::string &name = kv.first;
port *oldport = kv.second.get();
if (oldport->is_dummy())
continue;
const auto it = newconf->conf_ports.find(name);
if (it != newconf->conf_ports.end() &&
!it->second->is_dummy())
continue;
log_debugx("removing port \"%s\"", name.c_str());
if (!oldport->kernel_remove()) {
log_warnx("failed to remove port %s", name.c_str());
/*
* XXX: Uncomment after fixing the root cause.
*
* cumulated_error++;
*/
}
}
/*
* Second, remove any LUNs present in the old configuration
* and missing in the new one.
*/
TAILQ_FOREACH_SAFE(oldlun, &oldconf->conf_luns, l_next, tmplun) {
newlun = lun_find(newconf, oldlun->l_name);
if (newlun == NULL) {
log_debugx("lun \"%s\", CTL lun %d "
"not found in new configuration; "
"removing", oldlun->l_name, oldlun->l_ctl_lun);
error = kernel_lun_remove(oldlun);
if (error != 0) {
log_warnx("failed to remove lun \"%s\", "
"CTL lun %d",
oldlun->l_name, oldlun->l_ctl_lun);
cumulated_error++;
}
continue;
}
/*
* Also remove the LUNs changed by more than size.
*/
changed = 0;
assert(oldlun->l_backend != NULL);
assert(newlun->l_backend != NULL);
if (strcmp(newlun->l_backend, oldlun->l_backend) != 0) {
log_debugx("backend for lun \"%s\", "
"CTL lun %d changed; removing",
oldlun->l_name, oldlun->l_ctl_lun);
changed = 1;
}
if (oldlun->l_blocksize != newlun->l_blocksize) {
log_debugx("blocksize for lun \"%s\", "
"CTL lun %d changed; removing",
oldlun->l_name, oldlun->l_ctl_lun);
changed = 1;
}
if (newlun->l_device_id != NULL &&
(oldlun->l_device_id == NULL ||
strcmp(oldlun->l_device_id, newlun->l_device_id) !=
0)) {
log_debugx("device-id for lun \"%s\", "
"CTL lun %d changed; removing",
oldlun->l_name, oldlun->l_ctl_lun);
changed = 1;
}
if (newlun->l_path != NULL &&
(oldlun->l_path == NULL ||
strcmp(oldlun->l_path, newlun->l_path) != 0)) {
log_debugx("path for lun \"%s\", "
"CTL lun %d, changed; removing",
oldlun->l_name, oldlun->l_ctl_lun);
changed = 1;
}
if (newlun->l_serial != NULL &&
(oldlun->l_serial == NULL ||
strcmp(oldlun->l_serial, newlun->l_serial) != 0)) {
log_debugx("serial for lun \"%s\", "
"CTL lun %d changed; removing",
oldlun->l_name, oldlun->l_ctl_lun);
changed = 1;
}
if (changed) {
error = kernel_lun_remove(oldlun);
if (error != 0) {
log_warnx("failed to remove lun \"%s\", "
"CTL lun %d",
oldlun->l_name, oldlun->l_ctl_lun);
cumulated_error++;
}
lun_delete(oldlun);
continue;
}
newlun->l_ctl_lun = oldlun->l_ctl_lun;
}
TAILQ_FOREACH_SAFE(newlun, &newconf->conf_luns, l_next, tmplun) {
oldlun = lun_find(oldconf, newlun->l_name);
if (oldlun != NULL) {
log_debugx("modifying lun \"%s\", CTL lun %d",
newlun->l_name, newlun->l_ctl_lun);
error = kernel_lun_modify(newlun);
if (error != 0) {
log_warnx("failed to "
"modify lun \"%s\", CTL lun %d",
newlun->l_name, newlun->l_ctl_lun);
cumulated_error++;
}
continue;
}
log_debugx("adding lun \"%s\"", newlun->l_name);
error = kernel_lun_add(newlun);
if (error != 0) {
log_warnx("failed to add lun \"%s\"", newlun->l_name);
lun_delete(newlun);
cumulated_error++;
}
}
/*
* Now add new ports or modify existing ones.
*/
for (auto it = newconf->conf_ports.begin();
it != newconf->conf_ports.end(); ) {
const std::string &name = it->first;
port *newport = it->second.get();
if (newport->is_dummy()) {
it++;
continue;
}
const auto oldit = oldconf->conf_ports.find(name);
if (oldit == oldconf->conf_ports.end() ||
oldit->second->is_dummy()) {
log_debugx("adding port \"%s\"", name.c_str());
if (!newport->kernel_add()) {
log_warnx("failed to add port %s",
name.c_str());
/*
* XXX: Uncomment after fixing the
* root cause.
*
* cumulated_error++;
*/
/*
* conf "owns" the port, but other
* objects contain pointers to this
* port that must be removed before
* deleting the port.
*/
newport->clear_references();
it = newconf->conf_ports.erase(it);
} else
it++;
} else {
log_debugx("updating port \"%s\"", name.c_str());
if (!newport->kernel_update(oldit->second.get()))
log_warnx("failed to update port %s",
name.c_str());
it++;
}
}
/*
* Go through the new portals, opening the sockets as necessary.
*/
TAILQ_FOREACH(newpg, &newconf->conf_portal_groups, pg_next) {
if (newpg->pg_foreign)
continue;
if (newpg->pg_unassigned) {
log_debugx("not listening on portal-group \"%s\", "
"not assigned to any target",
newpg->pg_name);
continue;
}
for (portal_up &newp : newpg->pg_portals) {
/*
* Try to find already open portal and reuse
* the listening socket. We don't care about
* what portal or portal group that was, what
* matters is the listening address.
*/
TAILQ_FOREACH(oldpg, &oldconf->conf_portal_groups,
pg_next) {
for (portal_up &oldp : oldpg->pg_portals) {
if (newp->reuse_socket(*oldp))
goto reused;
}
}
if (!newp->init_socket()) {
cumulated_error++;
continue;
}
reused:
;
}
}
/*
* Go through the no longer used sockets, closing them.
*/
TAILQ_FOREACH(oldpg, &oldconf->conf_portal_groups, pg_next) {
for (portal_up &oldp : oldpg->pg_portals) {
if (oldp->socket() < 0)
continue;
log_debugx("closing socket for %s, portal-group \"%s\"",
oldp->listen(), oldpg->pg_name);
oldp->close();
}
}
/* (Re-)Register on remaining/new iSNS servers. */
TAILQ_FOREACH(newns, &newconf->conf_isns, i_next) {
TAILQ_FOREACH(oldns, &oldconf->conf_isns, i_next) {
if (strcmp(oldns->i_addr, newns->i_addr) == 0)
break;
}
isns_register(newns, oldns);
}
/* Schedule iSNS update */
if (!TAILQ_EMPTY(&newconf->conf_isns))
set_timeout((newconf->conf_isns_period + 2) / 3, false);
return (cumulated_error);
}
static bool
timed_out(void)
{
return (sigalrm_received);
}
static void
sigalrm_handler_fatal(int dummy __unused)
{
/*
* It would be easiest to just log an error and exit. We can't
* do this, though, because log_errx() is not signal safe, since
* it calls syslog(3). Instead, set a flag checked by pdu_send()
* and pdu_receive(), to call log_errx() there. Should they fail
* to notice, we'll exit here one second later.
*/
if (sigalrm_received) {
/*
* Oh well. Just give up and quit.
*/
_exit(2);
}
sigalrm_received = true;
}
static void
sigalrm_handler(int dummy __unused)
{
sigalrm_received = true;
}
void
set_timeout(int timeout, int fatal)
{
struct sigaction sa;
struct itimerval itv;
int error;
if (timeout <= 0) {
log_debugx("session timeout disabled");
bzero(&itv, sizeof(itv));
error = setitimer(ITIMER_REAL, &itv, NULL);
if (error != 0)
log_err(1, "setitimer");
sigalrm_received = false;
return;
}
sigalrm_received = false;
bzero(&sa, sizeof(sa));
if (fatal)
sa.sa_handler = sigalrm_handler_fatal;
else
sa.sa_handler = sigalrm_handler;
sigfillset(&sa.sa_mask);
error = sigaction(SIGALRM, &sa, NULL);
if (error != 0)
log_err(1, "sigaction");
/*
* First SIGALRM will arive after conf_timeout seconds.
* If we do nothing, another one will arrive a second later.
*/
log_debugx("setting session timeout to %d seconds", timeout);
bzero(&itv, sizeof(itv));
itv.it_interval.tv_sec = 1;
itv.it_value.tv_sec = timeout;
error = setitimer(ITIMER_REAL, &itv, NULL);
if (error != 0)
log_err(1, "setitimer");
}
static int
wait_for_children(bool block)
{
pid_t pid;
int status;
int num = 0;
for (;;) {
/*
* If "block" is true, wait for at least one process.
*/
if (block && num == 0)
pid = wait4(-1, &status, 0, NULL);
else
pid = wait4(-1, &status, WNOHANG, NULL);
if (pid <= 0)
break;
if (WIFSIGNALED(status)) {
log_warnx("child process %d terminated with signal %d",
pid, WTERMSIG(status));
} else if (WEXITSTATUS(status) != 0) {
log_warnx("child process %d terminated with exit status %d",
pid, WEXITSTATUS(status));
} else {
log_debugx("child process %d terminated gracefully", pid);
}
num++;
}
return (num);
}
static void
handle_connection(struct portal *portal, int fd,
const struct sockaddr *client_sa, bool dont_fork)
{
struct ctld_connection *conn;
struct portal_group *pg;
int error;
pid_t pid;
char host[NI_MAXHOST + 1];
struct conf *conf;
pg = portal->portal_group();
conf = pg->pg_conf;
if (dont_fork) {
log_debugx("incoming connection; not forking due to -d flag");
} else {
nchildren -= wait_for_children(false);
assert(nchildren >= 0);
while (conf->conf_maxproc > 0 && nchildren >= conf->conf_maxproc) {
log_debugx("maxproc limit of %d child processes hit; "
"waiting for child process to exit", conf->conf_maxproc);
nchildren -= wait_for_children(true);
assert(nchildren >= 0);
}
log_debugx("incoming connection; forking child process #%d",
nchildren);
nchildren++;
pid = fork();
if (pid < 0)
log_err(1, "fork");
if (pid > 0) {
close(fd);
return;
}
pidfile_close(conf->conf_pidfh);
}
error = getnameinfo(client_sa, client_sa->sa_len,
host, sizeof(host), NULL, 0, NI_NUMERICHOST);
if (error != 0)
log_errx(1, "getnameinfo: %s", gai_strerror(error));
log_debugx("accepted connection from %s; portal group \"%s\"",
host, pg->pg_name);
log_set_peer_addr(host);
setproctitle("%s", host);
conn = connection_new(portal, fd, host, client_sa);
set_timeout(conf->conf_timeout, true);
kernel_capsicate();
login(conn);
if (conn->conn_session_type == CONN_SESSION_TYPE_NORMAL) {
kernel_handoff(conn);
log_debugx("connection handed off to the kernel");
} else {
assert(conn->conn_session_type == CONN_SESSION_TYPE_DISCOVERY);
discovery(conn);
}
log_debugx("nothing more to do; exiting");
exit(0);
}
static void
main_loop(bool dont_fork)
{
struct kevent kev;
struct portal *portal;
struct sockaddr_storage client_sa;
socklen_t client_salen;
#ifdef ICL_KERNEL_PROXY
int connection_id;
int portal_id;
#endif
int error, client_fd;
for (;;) {
if (sighup_received || sigterm_received || timed_out())
return;
#ifdef ICL_KERNEL_PROXY
if (proxy_mode) {
client_salen = sizeof(client_sa);
kernel_accept(&connection_id, &portal_id,
(struct sockaddr *)&client_sa, &client_salen);
assert(client_salen >= client_sa.ss_len);
log_debugx("incoming connection, id %d, portal id %d",
connection_id, portal_id);
portal = conf->proxy_portal(portal_id);
if (portal == nullptr)
log_errx(1,
"kernel returned invalid portal_id %d",
portal_id);
handle_connection(portal, connection_id,
(struct sockaddr *)&client_sa, dont_fork);
} else {
#endif
assert(proxy_mode == false);
error = kevent(kqfd, NULL, 0, &kev, 1, NULL);
if (error == -1) {
if (errno == EINTR)
continue;
log_err(1, "kevent");
}
switch (kev.filter) {
case EVFILT_READ:
portal = reinterpret_cast<struct portal *>(kev.udata);
assert(portal->socket() == (int)kev.ident);
client_salen = sizeof(client_sa);
client_fd = accept(portal->socket(),
(struct sockaddr *)&client_sa,
&client_salen);
if (client_fd < 0) {
if (errno == ECONNABORTED)
continue;
log_err(1, "accept");
}
assert(client_salen >= client_sa.ss_len);
handle_connection(portal, client_fd,
(struct sockaddr *)&client_sa, dont_fork);
break;
default:
__assert_unreachable();
}
#ifdef ICL_KERNEL_PROXY
}
#endif
}
}
static void
sighup_handler(int dummy __unused)
{
sighup_received = true;
}
static void
sigterm_handler(int dummy __unused)
{
sigterm_received = true;
}
static void
sigchld_handler(int dummy __unused)
{
/*
* The only purpose of this handler is to make SIGCHLD
* interrupt the ISCSIDWAIT ioctl(2), so we can call
* wait_for_children().
*/
}
static void
register_signals(void)
{
struct sigaction sa;
int error;
bzero(&sa, sizeof(sa));
sa.sa_handler = sighup_handler;
sigfillset(&sa.sa_mask);
error = sigaction(SIGHUP, &sa, NULL);
if (error != 0)
log_err(1, "sigaction");
sa.sa_handler = sigterm_handler;
error = sigaction(SIGTERM, &sa, NULL);
if (error != 0)
log_err(1, "sigaction");
sa.sa_handler = sigterm_handler;
error = sigaction(SIGINT, &sa, NULL);
if (error != 0)
log_err(1, "sigaction");
sa.sa_handler = sigchld_handler;
error = sigaction(SIGCHLD, &sa, NULL);
if (error != 0)
log_err(1, "sigaction");
}
static void
check_perms(const char *path)
{
struct stat sb;
int error;
error = stat(path, &sb);
if (error != 0) {
log_warn("stat");
return;
}
if (sb.st_mode & S_IWOTH) {
log_warnx("%s is world-writable", path);
} else if (sb.st_mode & S_IROTH) {
log_warnx("%s is world-readable", path);
} else if (sb.st_mode & S_IXOTH) {
/*
* Ok, this one doesn't matter, but still do it,
* just for consistency.
*/
log_warnx("%s is world-executable", path);
}
/*
* XXX: Should we also check for owner != 0?
*/
}
static struct conf *
conf_new_from_file(const char *path, bool ucl)
{
struct conf *conf;
struct auth_group *ag;
struct portal_group *pg;
bool valid;
log_debugx("obtaining configuration from %s", path);
conf = conf_new();
ag = auth_group_new(conf, "default");
assert(ag != NULL);
ag = auth_group_new(conf, "no-authentication");
assert(ag != NULL);
ag->set_type(auth_type::NO_AUTHENTICATION);
ag = auth_group_new(conf, "no-access");
assert(ag != NULL);
ag->set_type(auth_type::DENY);
pg = portal_group_new(conf, "default");
assert(pg != NULL);
conf_start(conf);
if (ucl)
valid = uclparse_conf(path);
else
valid = parse_conf(path);
conf_finish();
if (!valid) {
conf_delete(conf);
return (NULL);
}
check_perms(path);
if (conf->conf_default_ag_defined == false) {
log_debugx("auth-group \"default\" not defined; "
"going with defaults");
ag = auth_group_find(conf, "default").get();
assert(ag != NULL);
ag->set_type(auth_type::DENY);
}
if (conf->conf_default_pg_defined == false) {
log_debugx("portal-group \"default\" not defined; "
"going with defaults");
pg = portal_group_find(conf, "default");
assert(pg != NULL);
portal_group_add_portal(pg, "0.0.0.0", false);
portal_group_add_portal(pg, "[::]", false);
}
conf->conf_kernel_port_on = true;
if (!conf_verify(conf)) {
conf_delete(conf);
return (NULL);
}
return (conf);
}
/*
* If the config file specifies physical ports for any target, associate them
* with the config file. If necessary, create them.
*/
static bool
new_pports_from_conf(struct conf *conf, struct kports &kports)
{
struct target *targ;
struct pport *pp;
int ret, i_pp, i_vp;
TAILQ_FOREACH(targ, &conf->conf_targets, t_next) {
if (!targ->t_pport)
continue;
ret = sscanf(targ->t_pport, "ioctl/%d/%d", &i_pp, &i_vp);
if (ret > 0) {
if (!port_new_ioctl(conf, kports, targ, i_pp, i_vp)) {
log_warnx("can't create new ioctl port "
"for target \"%s\"", targ->t_name);
return (false);
}
continue;
}
pp = kports.find_port(targ->t_pport);
if (pp == NULL) {
log_warnx("unknown port \"%s\" for target \"%s\"",
targ->t_pport, targ->t_name);
return (false);
}
if (pp->linked()) {
log_warnx("can't link port \"%s\" to target \"%s\", "
"port already linked to some target",
targ->t_pport, targ->t_name);
return (false);
}
if (!port_new_pp(conf, targ, pp)) {
log_warnx("can't link port \"%s\" to target \"%s\"",
targ->t_pport, targ->t_name);
return (false);
}
}
return (true);
}
int
main(int argc, char **argv)
{
struct kports kports;
struct conf *oldconf, *newconf, *tmpconf;
struct isns *newns;
const char *config_path = DEFAULT_CONFIG_PATH;
int debug = 0, ch, error;
pid_t otherpid;
bool daemonize = true;
bool test_config = false;
bool use_ucl = false;
while ((ch = getopt(argc, argv, "dtuf:R")) != -1) {
switch (ch) {
case 'd':
daemonize = false;
debug++;
break;
case 't':
test_config = true;
break;
case 'u':
use_ucl = true;
break;
case 'f':
config_path = optarg;
break;
case 'R':
#ifndef ICL_KERNEL_PROXY
log_errx(1, "ctld(8) compiled without ICL_KERNEL_PROXY "
"does not support iSER protocol");
#endif
proxy_mode = true;
break;
case '?':
default:
usage();
}
}
argc -= optind;
if (argc != 0)
usage();
log_init(debug);
kernel_init();
newconf = conf_new_from_file(config_path, use_ucl);
if (newconf == NULL)
log_errx(1, "configuration error; exiting");
if (test_config)
return (0);
assert(newconf->conf_pidfile_path != NULL);
log_debugx("opening pidfile %s", newconf->conf_pidfile_path);
newconf->conf_pidfh = pidfile_open(newconf->conf_pidfile_path, 0600,
&otherpid);
if (newconf->conf_pidfh == NULL) {
if (errno == EEXIST)
log_errx(1, "daemon already running, pid: %jd.",
(intmax_t)otherpid);
log_err(1, "cannot open or create pidfile \"%s\"",
newconf->conf_pidfile_path);
}
register_signals();
oldconf = conf_new_from_kernel(kports);
if (debug > 0) {
oldconf->conf_debug = debug;
newconf->conf_debug = debug;
}
if (!new_pports_from_conf(newconf, kports))
log_errx(1, "Error associating physical ports; exiting");
if (daemonize) {
log_debugx("daemonizing");
if (daemon(0, 0) == -1) {
log_warn("cannot daemonize");
pidfile_remove(newconf->conf_pidfh);
exit(1);
}
}
kqfd = kqueue();
if (kqfd == -1) {
log_warn("Cannot create kqueue");
pidfile_remove(newconf->conf_pidfh);
exit(1);
}
error = conf_apply(oldconf, newconf);
if (error != 0)
log_errx(1, "failed to apply configuration; exiting");
conf_delete(oldconf);
oldconf = NULL;
pidfile_write(newconf->conf_pidfh);
/* Schedule iSNS update */
if (!TAILQ_EMPTY(&newconf->conf_isns))
set_timeout((newconf->conf_isns_period + 2) / 3, false);
for (;;) {
main_loop(!daemonize);
if (sighup_received) {
sighup_received = false;
log_debugx("received SIGHUP, reloading configuration");
tmpconf = conf_new_from_file(config_path, use_ucl);
if (tmpconf == NULL) {
log_warnx("configuration error, "
"continuing with old configuration");
} else if (!new_pports_from_conf(tmpconf, kports)) {
log_warnx("Error associating physical ports, "
"continuing with old configuration");
conf_delete(tmpconf);
} else {
if (debug > 0)
tmpconf->conf_debug = debug;
oldconf = newconf;
newconf = tmpconf;
error = conf_apply(oldconf, newconf);
if (error != 0)
log_warnx("failed to reload "
"configuration");
conf_delete(oldconf);
oldconf = NULL;
}
} else if (sigterm_received) {
log_debugx("exiting on signal; "
"reloading empty configuration");
log_debugx("removing CTL iSCSI ports "
"and terminating all connections");
oldconf = newconf;
newconf = conf_new();
if (debug > 0)
newconf->conf_debug = debug;
error = conf_apply(oldconf, newconf);
if (error != 0)
log_warnx("failed to apply configuration");
if (oldconf->conf_pidfh) {
pidfile_remove(oldconf->conf_pidfh);
oldconf->conf_pidfh = NULL;
}
conf_delete(newconf);
conf_delete(oldconf);
oldconf = NULL;
log_warnx("exiting on signal");
exit(0);
} else {
nchildren -= wait_for_children(false);
assert(nchildren >= 0);
if (timed_out()) {
set_timeout(0, false);
TAILQ_FOREACH(newns, &newconf->conf_isns, i_next)
isns_check(newns);
/* Schedule iSNS update */
if (!TAILQ_EMPTY(&newconf->conf_isns)) {
set_timeout((newconf->conf_isns_period
+ 2) / 3,
false);
}
}
}
}
/* NOTREACHED */
}