aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJohn Baldwin <jhb@FreeBSD.org>2025-08-04 15:38:07 -0400
committerJohn Baldwin <jhb@FreeBSD.org>2025-08-04 15:38:07 -0400
commitd6d8a7ba4216d0f12e32c858d4332ba29cc7dc9b (patch)
treee59bc00faa4cf15f298074fc65ceb2ee7a2fd56c
parent6acc7afa34aa5da8d9132e927f2026e594e73701 (diff)
ctld: Convert struct portal_group to a C++ class
- Use std::string, freebsd_nvlist_up to manage life cycle of class members. - Use an unordered_map<> keyed by std::string in struct conf to replace the previous TAILQ. - Replace PG_FILTER_* macros with a scoped enum. - Provide a variety of accessors as portal groups are widely used while keeping members private. - The logic to "move" sockets from existing portals to new portals when parsing new configuration is now split into several operations across the conf and portal_group classes to preserve some semblance of data hiding. Sponsored by: Chelsio Communications Pull Request: https://github.com/freebsd/freebsd-src/pull/1794
-rw-r--r--usr.sbin/ctld/conf.cc94
-rw-r--r--usr.sbin/ctld/ctld.cc454
-rw-r--r--usr.sbin/ctld/ctld.hh92
-rw-r--r--usr.sbin/ctld/discovery.cc20
-rw-r--r--usr.sbin/ctld/kernel.cc18
-rw-r--r--usr.sbin/ctld/login.cc24
6 files changed, 415 insertions, 287 deletions
diff --git a/usr.sbin/ctld/conf.cc b/usr.sbin/ctld/conf.cc
index 2bf7b99409de..ce2003b09880 100644
--- a/usr.sbin/ctld/conf.cc
+++ b/usr.sbin/ctld/conf.cc
@@ -204,135 +204,61 @@ portal_group_finish(void)
bool
portal_group_add_listen(const char *listen, bool iser)
{
- return (portal_group_add_portal(portal_group, listen, iser));
+ return (portal_group->add_portal(listen, iser));
}
bool
portal_group_add_option(const char *name, const char *value)
{
- return (option_new(portal_group->pg_options, name, value));
+ return (portal_group->add_option(name, value));
}
bool
portal_group_set_discovery_auth_group(const char *name)
{
- if (portal_group->pg_discovery_auth_group != nullptr) {
- log_warnx("discovery-auth-group for portal-group "
- "\"%s\" specified more than once",
- portal_group->pg_name);
- return (false);
- }
- portal_group->pg_discovery_auth_group = auth_group_find(conf, name);
- if (portal_group->pg_discovery_auth_group == nullptr) {
- log_warnx("unknown discovery-auth-group \"%s\" "
- "for portal-group \"%s\"", name, portal_group->pg_name);
- return (false);
- }
- return (true);
+ return (portal_group->set_discovery_auth_group(name));
}
bool
portal_group_set_dscp(u_int dscp)
{
- if (dscp >= 0x40) {
- log_warnx("invalid DSCP value %u for portal-group \"%s\"",
- dscp, portal_group->pg_name);
- return (false);
- }
-
- portal_group->pg_dscp = dscp;
- return (true);
+ return (portal_group->set_dscp(dscp));
}
bool
portal_group_set_filter(const char *str)
{
- int filter;
-
- if (strcmp(str, "none") == 0) {
- filter = PG_FILTER_NONE;
- } else if (strcmp(str, "portal") == 0) {
- filter = PG_FILTER_PORTAL;
- } else if (strcmp(str, "portal-name") == 0) {
- filter = PG_FILTER_PORTAL_NAME;
- } else if (strcmp(str, "portal-name-auth") == 0) {
- filter = PG_FILTER_PORTAL_NAME_AUTH;
- } else {
- log_warnx("invalid discovery-filter \"%s\" for portal-group "
- "\"%s\"; valid values are \"none\", \"portal\", "
- "\"portal-name\", and \"portal-name-auth\"",
- str, portal_group->pg_name);
- return (false);
- }
-
- if (portal_group->pg_discovery_filter != PG_FILTER_UNKNOWN &&
- portal_group->pg_discovery_filter != filter) {
- log_warnx("cannot set discovery-filter to \"%s\" for "
- "portal-group \"%s\"; already has a different "
- "value", str, portal_group->pg_name);
- return (false);
- }
-
- portal_group->pg_discovery_filter = filter;
-
- return (true);
+ return (portal_group->set_filter(str));
}
void
portal_group_set_foreign(void)
{
- portal_group->pg_foreign = true;
+ portal_group->set_foreign();
}
bool
portal_group_set_offload(const char *offload)
{
-
- if (portal_group->pg_offload != NULL) {
- log_warnx("cannot set offload to \"%s\" for "
- "portal-group \"%s\"; already defined",
- offload, portal_group->pg_name);
- return (false);
- }
-
- portal_group->pg_offload = checked_strdup(offload);
-
- return (true);
+ return (portal_group->set_offload(offload));
}
bool
portal_group_set_pcp(u_int pcp)
{
- if (pcp > 7) {
- log_warnx("invalid PCP value %u for portal-group \"%s\"",
- pcp, portal_group->pg_name);
- return (false);
- }
-
- portal_group->pg_pcp = pcp;
- return (true);
+ return (portal_group->set_pcp(pcp));
}
bool
portal_group_set_redirection(const char *addr)
{
-
- if (portal_group->pg_redirection != NULL) {
- log_warnx("cannot set redirection to \"%s\" for "
- "portal-group \"%s\"; already defined",
- addr, portal_group->pg_name);
- return (false);
- }
-
- portal_group->pg_redirection = checked_strdup(addr);
-
- return (true);
+ return (portal_group->set_redirection(addr));
}
void
portal_group_set_tag(uint16_t tag)
{
- portal_group->pg_tag = tag;
+ portal_group->set_tag(tag);
}
bool
diff --git a/usr.sbin/ctld/ctld.cc b/usr.sbin/ctld/ctld.cc
index e8770cb9315d..8815034930b4 100644
--- a/usr.sbin/ctld/ctld.cc
+++ b/usr.sbin/ctld/ctld.cc
@@ -103,7 +103,6 @@ conf_new(void)
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;
@@ -120,7 +119,6 @@ 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);
@@ -129,8 +127,6 @@ conf_delete(struct conf *conf)
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);
@@ -439,52 +435,42 @@ auth_group_find(const struct conf *conf, const char *name)
return (it->second);
}
+portal_group::portal_group(struct conf *conf, std::string_view name)
+ : pg_conf(conf), pg_options(nvlist_create(0)), pg_name(name)
+{
+}
+
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) {
+ auto pair = conf->conf_portal_groups.try_emplace(name,
+ std::make_unique<portal_group>(conf, name));
+ if (!pair.second) {
log_warnx("duplicated portal-group \"%s\"", name);
- return (NULL);
+ return (nullptr);
}
- 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);
+ return (pair.first->second.get());
}
-void
-portal_group_delete(struct portal_group *pg)
+struct portal_group *
+portal_group_find(struct conf *conf, const char *name)
{
- TAILQ_REMOVE(&pg->pg_conf->conf_portal_groups, pg, pg_next);
+ auto it = conf->conf_portal_groups.find(name);
+ if (it == conf->conf_portal_groups.end())
+ return (nullptr);
- nvlist_destroy(pg->pg_options);
- free(pg->pg_name);
- free(pg->pg_offload);
- free(pg->pg_redirection);
- delete pg;
+ return (it->second.get());
}
-struct portal_group *
-portal_group_find(const struct conf *conf, const char *name)
+bool
+portal_group::is_dummy() const
{
- struct portal_group *pg;
-
- TAILQ_FOREACH(pg, &conf->conf_portal_groups, pg_next) {
- if (strcmp(pg->pg_name, name) == 0)
- return (pg);
- }
-
- return (NULL);
+ if (pg_foreign)
+ return (true);
+ if (pg_portals.empty())
+ return (true);
+ return (false);
}
static freebsd::addrinfo_up
@@ -535,8 +521,27 @@ parse_addr_port(const char *address, const char *def_port)
return freebsd::addrinfo_up(ai);
}
+void
+portal_group::add_port(struct portal_group_port *port)
+{
+ pg_ports.emplace(port->target()->t_name, port);
+}
+
+void
+portal_group::remove_port(struct portal_group_port *port)
+{
+ auto it = pg_ports.find(port->target()->t_name);
+ pg_ports.erase(it);
+}
+
+freebsd::nvlist_up
+portal_group::options() const
+{
+ return (freebsd::nvlist_up(nvlist_clone(pg_options.get())));
+}
+
bool
-portal_group_add_portal(struct portal_group *pg, const char *value, bool iser)
+portal_group::add_portal(const char *value, bool iser)
{
freebsd::addrinfo_up ai = parse_addr_port(value, "3260");
if (!ai) {
@@ -549,12 +554,219 @@ portal_group_add_portal(struct portal_group *pg, const char *value, bool iser)
* those into multiple portals.
*/
- pg->pg_portals.emplace_back(std::make_unique<portal>(pg, value, iser,
+ pg_portals.emplace_back(std::make_unique<portal>(this, value, iser,
std::move(ai)));
return (true);
}
bool
+portal_group::add_option(const char *name, const char *value)
+{
+ return (option_new(pg_options.get(), name, value));
+}
+
+bool
+portal_group::set_discovery_auth_group(const char *ag_name)
+{
+ if (pg_discovery_auth_group != nullptr) {
+ log_warnx("discovery-auth-group for portal-group "
+ "\"%s\" specified more than once", name());
+ return (false);
+ }
+ pg_discovery_auth_group = auth_group_find(pg_conf, ag_name);
+ if (pg_discovery_auth_group == nullptr) {
+ log_warnx("unknown discovery-auth-group \"%s\" "
+ "for portal-group \"%s\"", ag_name, name());
+ return (false);
+ }
+ return (true);
+}
+
+bool
+portal_group::set_dscp(u_int dscp)
+{
+ if (dscp >= 0x40) {
+ log_warnx("invalid DSCP value %u for portal-group \"%s\"",
+ dscp, name());
+ return (false);
+ }
+
+ pg_dscp = dscp;
+ return (true);
+}
+
+bool
+portal_group::set_filter(const char *str)
+{
+ enum discovery_filter filter;
+
+ if (strcmp(str, "none") == 0) {
+ filter = discovery_filter::NONE;
+ } else if (strcmp(str, "portal") == 0) {
+ filter = discovery_filter::PORTAL;
+ } else if (strcmp(str, "portal-name") == 0) {
+ filter = discovery_filter::PORTAL_NAME;
+ } else if (strcmp(str, "portal-name-auth") == 0) {
+ filter = discovery_filter::PORTAL_NAME_AUTH;
+ } else {
+ log_warnx("invalid discovery-filter \"%s\" for portal-group "
+ "\"%s\"; valid values are \"none\", \"portal\", "
+ "\"portal-name\", and \"portal-name-auth\"",
+ str, name());
+ return (false);
+ }
+
+ if (pg_discovery_filter != discovery_filter::UNKNOWN &&
+ pg_discovery_filter != filter) {
+ log_warnx("cannot set discovery-filter to \"%s\" for "
+ "portal-group \"%s\"; already has a different "
+ "value", str, name());
+ return (false);
+ }
+
+ pg_discovery_filter = filter;
+ return (true);
+}
+
+void
+portal_group::set_foreign()
+{
+ pg_foreign = true;
+}
+
+bool
+portal_group::set_offload(const char *offload)
+{
+ if (!pg_offload.empty()) {
+ log_warnx("cannot set offload to \"%s\" for "
+ "portal-group \"%s\"; already defined",
+ offload, name());
+ return (false);
+ }
+
+ pg_offload = offload;
+ return (true);
+}
+
+bool
+portal_group::set_pcp(u_int pcp)
+{
+ if (pcp > 7) {
+ log_warnx("invalid PCP value %u for portal-group \"%s\"",
+ pcp, name());
+ return (false);
+ }
+
+ pg_pcp = pcp;
+ return (true);
+}
+
+bool
+portal_group::set_redirection(const char *addr)
+{
+ if (!pg_redirection.empty()) {
+ log_warnx("cannot set redirection to \"%s\" for "
+ "portal-group \"%s\"; already defined",
+ addr, name());
+ return (false);
+ }
+
+ pg_redirection = addr;
+ return (true);
+}
+
+void
+portal_group::set_tag(uint16_t tag)
+{
+ pg_tag = tag;
+}
+
+void
+portal_group::verify(struct conf *conf)
+{
+ if (pg_discovery_auth_group == nullptr) {
+ pg_discovery_auth_group = auth_group_find(conf, "default");
+ assert(pg_discovery_auth_group != nullptr);
+ }
+
+ if (pg_discovery_filter == discovery_filter::UNKNOWN)
+ pg_discovery_filter = discovery_filter::NONE;
+
+ if (!pg_redirection.empty()) {
+ if (!pg_ports.empty()) {
+ log_debugx("portal-group \"%s\" assigned to target, "
+ "but configured for redirection", name());
+ }
+ pg_assigned = true;
+ } else if (!pg_ports.empty()) {
+ pg_assigned = true;
+ } else {
+ if (pg_name != "default")
+ log_warnx("portal-group \"%s\" not assigned "
+ "to any target", name());
+ pg_assigned = false;
+ }
+}
+
+/*
+ * Try to reuse a socket for 'newp' from an existing socket in one of
+ * our portals.
+ */
+bool
+portal_group::reuse_socket(struct portal &newp)
+{
+ for (portal_up &portal : pg_portals) {
+ if (newp.reuse_socket(*portal))
+ return (true);
+ }
+ return (false);
+}
+
+int
+portal_group::open_sockets(struct conf &oldconf)
+{
+ int cumulated_error = 0;
+
+ if (pg_foreign)
+ return (0);
+
+ if (!pg_assigned) {
+ log_debugx("not listening on portal-group \"%s\", "
+ "not assigned to any target", name());
+ return (0);
+ }
+
+ for (portal_up &portal : 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.
+ */
+ if (oldconf.reuse_portal_group_socket(*portal))
+ continue;
+
+ if (!portal->init_socket()) {
+ cumulated_error++;
+ continue;
+ }
+ }
+ return (cumulated_error);
+}
+
+void
+portal_group::close_sockets()
+{
+ for (portal_up &portal : pg_portals) {
+ if (portal->socket() < 0)
+ continue;
+ log_debugx("closing socket for %s, portal-group \"%s\"",
+ portal->listen(), name());
+ portal->close();
+ }
+}
+
+bool
isns_new(struct conf *conf, const char *addr)
{
struct isns *isns;
@@ -617,7 +829,7 @@ isns_do_register(struct isns *isns, int s, const char *hostname)
{
struct conf *conf = isns->i_conf;
struct target *target;
- struct portal_group *pg;
+ const struct portal_group *pg;
uint32_t error;
isns_req req(ISNS_FUNC_DEVATTRREG, ISNS_FLAG_CLIENT);
@@ -626,10 +838,12 @@ isns_do_register(struct isns *isns, int s, const char *hostname)
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)
+ for (const auto &kv : conf->conf_portal_groups) {
+ pg = kv.second.get();
+
+ if (!pg->assigned())
continue;
- for (const portal_up &portal : pg->pg_portals) {
+ for (const portal_up &portal : pg->portals()) {
req.add_addr(16, portal->ai());
req.add_port(17, portal->ai());
}
@@ -643,8 +857,8 @@ isns_do_register(struct isns *isns, int s, const char *hostname)
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_32(51, pg->tag());
+ for (const portal_up &portal : pg->portals()) {
req.add_addr(49, portal->ai());
req.add_port(50, portal->ai());
}
@@ -723,7 +937,7 @@ isns_register(struct isns *isns, struct isns *oldisns)
char hostname[256];
if (TAILQ_EMPTY(&conf->conf_targets) ||
- TAILQ_EMPTY(&conf->conf_portal_groups))
+ conf->conf_portal_groups.empty())
return;
set_timeout(conf->conf_isns_timeout, false);
s = isns_do_connect(isns);
@@ -751,7 +965,7 @@ isns_check(struct isns *isns)
char hostname[256];
if (TAILQ_EMPTY(&conf->conf_targets) ||
- TAILQ_EMPTY(&conf->conf_portal_groups))
+ conf->conf_portal_groups.empty())
return;
set_timeout(conf->conf_isns_timeout, false);
s = isns_do_connect(isns);
@@ -779,7 +993,7 @@ isns_deregister(struct isns *isns)
char hostname[256];
if (TAILQ_EMPTY(&conf->conf_targets) ||
- TAILQ_EMPTY(&conf->conf_portal_groups))
+ conf->conf_portal_groups.empty())
return;
set_timeout(conf->conf_isns_timeout, false);
s = isns_do_connect(isns);
@@ -837,7 +1051,7 @@ 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);
+ p_portal_group->add_port(this);
}
portal_group_port::portal_group_port(struct target *target,
@@ -845,24 +1059,19 @@ portal_group_port::portal_group_port(struct target *target,
port(target), p_portal_group(pg)
{
p_ctl_port = ctl_port;
- pg->pg_ports.emplace(target->t_name, this);
+ p_portal_group->add_port(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);
+ return (p_portal_group->is_dummy());
}
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);
+ p_portal_group->remove_port(this);
port::clear_references();
}
@@ -870,7 +1079,7 @@ 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,
+ std::string name = freebsd::stringf("%s-%s", pg->name(),
target->t_name);
const auto &pair = conf->conf_ports.try_emplace(name,
std::make_unique<portal_group_port>(target, pg, ag));
@@ -886,7 +1095,7 @@ 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,
+ std::string name = freebsd::stringf("%s-%s", pg->name(),
target->t_name);
const auto &pair = conf->conf_ports.try_emplace(name,
std::make_unique<portal_group_port>(target, pg, ctl_port));
@@ -937,11 +1146,11 @@ port_new_ioctl(struct conf *conf, struct kports &kports, struct target *target,
return (true);
}
-struct port *
-port_find_in_pg(const struct portal_group *pg, const char *target)
+const struct port *
+portal_group::find_port(std::string_view target) const
{
- auto it = pg->pg_ports.find(target);
- if (it == pg->pg_ports.end())
+ auto it = pg_ports.find(std::string(target));
+ if (it == pg_ports.end())
return (nullptr);
return (it->second);
}
@@ -1241,33 +1450,8 @@ conf_verify(struct conf *conf)
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 (auto &kv : conf->conf_portal_groups) {
+ kv.second->verify(conf);
}
for (const auto &kv : conf->conf_auth_groups) {
const std::string &ag_name = kv.first;
@@ -1315,7 +1499,7 @@ portal::init_socket()
#ifdef ICL_KERNEL_PROXY
if (proxy_mode) {
- int id = pg->pg_conf->add_proxy_portal(this);
+ int id = 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);
@@ -1327,7 +1511,7 @@ portal::init_socket()
assert(p_iser == false);
log_debugx("listening on %s, portal-group \"%s\"", listen(),
- pg->pg_name);
+ 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());
@@ -1352,9 +1536,9 @@ portal::init_socket()
return (false);
}
- if (pg->pg_dscp != -1) {
+ if (pg->dscp() != -1) {
/* Only allow the 6-bit DSCP field to be modified */
- int tos = pg->pg_dscp << 2;
+ int tos = pg->dscp() << 2;
switch (p_ai->ai_family) {
case AF_INET:
if (setsockopt(s, IPPROTO_IP, IP_TOS,
@@ -1370,8 +1554,8 @@ portal::init_socket()
break;
}
}
- if (pg->pg_pcp != -1) {
- int pcp = pg->pg_pcp;
+ if (pg->pcp() != -1) {
+ int pcp = pg->pcp();
switch (p_ai->ai_family) {
case AF_INET:
if (setsockopt(s, IPPROTO_IP, IP_VLAN_PCP,
@@ -1408,11 +1592,22 @@ portal::init_socket()
return (true);
}
+bool
+conf::reuse_portal_group_socket(struct portal &newp)
+{
+ for (auto &kv : conf_portal_groups) {
+ struct portal_group &pg = *kv.second;
+
+ if (pg.reuse_socket(newp))
+ return (true);
+ }
+ return (false);
+}
+
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;
@@ -1445,14 +1640,16 @@ conf_apply(struct conf *oldconf, struct conf *newconf)
/*
* 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)
+ for (auto &kv : newconf->conf_portal_groups) {
+ struct portal_group &newpg = *kv.second;
+
+ if (newpg.tag() != 0)
continue;
- oldpg = portal_group_find(oldconf, newpg->pg_name);
- if (oldpg != NULL)
- newpg->pg_tag = oldpg->pg_tag;
+ auto it = oldconf->conf_portal_groups.find(kv.first);
+ if (it != oldconf->conf_portal_groups.end())
+ newpg.set_tag(it->second->tag());
else
- newpg->pg_tag = ++last_portal_group_tag;
+ newpg.set_tag(++last_portal_group_tag);
}
/* Deregister on removed iSNS servers. */
@@ -1647,50 +1844,15 @@ conf_apply(struct conf *oldconf, struct conf *newconf)
/*
* 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:
- ;
- }
+ for (auto &kv : newconf->conf_portal_groups) {
+ cumulated_error += kv.second->open_sockets(*oldconf);
}
/*
* 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();
- }
+ for (auto &kv : oldconf->conf_portal_groups) {
+ kv.second->close_sockets();
}
/* (Re-)Register on remaining/new iSNS servers. */
@@ -1828,7 +1990,7 @@ handle_connection(struct portal *portal, int fd,
struct conf *conf;
pg = portal->portal_group();
- conf = pg->pg_conf;
+ conf = pg->conf();
if (dont_fork) {
log_debugx("incoming connection; not forking due to -d flag");
@@ -1861,7 +2023,7 @@ handle_connection(struct portal *portal, int fd,
log_errx(1, "getnameinfo: %s", gai_strerror(error));
log_debugx("accepted connection from %s; portal group \"%s\"",
- host, pg->pg_name);
+ host, pg->name());
log_set_peer_addr(host);
setproctitle("%s", host);
@@ -2088,8 +2250,8 @@ conf_new_from_file(const char *path, bool ucl)
"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);
+ pg->add_portal("0.0.0.0", false);
+ pg->add_portal("[::]", false);
}
conf->conf_kernel_port_on = true;
diff --git a/usr.sbin/ctld/ctld.hh b/usr.sbin/ctld/ctld.hh
index 3d9c30b31977..afd49d172d15 100644
--- a/usr.sbin/ctld/ctld.hh
+++ b/usr.sbin/ctld/ctld.hh
@@ -154,31 +154,79 @@ private:
using portal_up = std::unique_ptr<portal>;
-#define PG_FILTER_UNKNOWN 0
-#define PG_FILTER_NONE 1
-#define PG_FILTER_PORTAL 2
-#define PG_FILTER_PORTAL_NAME 3
-#define PG_FILTER_PORTAL_NAME_AUTH 4
+enum class discovery_filter {
+ UNKNOWN,
+ NONE,
+ PORTAL,
+ PORTAL_NAME,
+ PORTAL_NAME_AUTH
+};
struct portal_group {
- TAILQ_ENTRY(portal_group) pg_next;
+ portal_group(struct conf *conf, std::string_view name);
+
+ struct conf *conf() const { return pg_conf; }
+ const char *name() const { return pg_name.c_str(); }
+ bool assigned() const { return pg_assigned; }
+ bool is_dummy() const;
+ bool is_redirecting() const { return !pg_redirection.empty(); }
+ struct auth_group *discovery_auth_group() const
+ { return pg_discovery_auth_group.get(); }
+ discovery_filter discovery_filter() const
+ { return pg_discovery_filter; }
+ int dscp() const { return pg_dscp; }
+ const char *offload() const { return pg_offload.c_str(); }
+ const char *redirection() const { return pg_redirection.c_str(); }
+ int pcp() const { return pg_pcp; }
+ uint16_t tag() const { return pg_tag; }
+
+ freebsd::nvlist_up options() const;
+
+ const std::list<portal_up> &portals() const { return pg_portals; }
+ const std::unordered_map<std::string, port *> &ports() const
+ { return pg_ports; }
+
+ bool add_portal(const char *value, bool iser);
+ bool add_option(const char *name, const char *value);
+ bool set_discovery_auth_group(const char *name);
+ bool set_dscp(u_int dscp);
+ bool set_filter(const char *str);
+ void set_foreign();
+ bool set_offload(const char *offload);
+ bool set_pcp(u_int pcp);
+ bool set_redirection(const char *addr);
+ void set_tag(uint16_t tag);
+
+ void add_port(struct portal_group_port *port);
+ const struct port *find_port(std::string_view target) const;
+ void remove_port(struct portal_group_port *port);
+ void verify(struct conf *conf);
+
+ bool reuse_socket(struct portal &newp);
+ int open_sockets(struct conf &oldconf);
+ void close_sockets();
+
+private:
struct conf *pg_conf;
- nvlist_t *pg_options;
- char *pg_name;
+ freebsd::nvlist_up pg_options;
+ std::string pg_name;
auth_group_sp pg_discovery_auth_group;
- int pg_discovery_filter = PG_FILTER_UNKNOWN;
+ enum discovery_filter pg_discovery_filter =
+ discovery_filter::UNKNOWN;
bool pg_foreign = false;
- bool pg_unassigned = false;
+ bool pg_assigned = false;
std::list<portal_up> pg_portals;
std::unordered_map<std::string, port *> pg_ports;
- char *pg_offload = nullptr;
- char *pg_redirection = nullptr;
- int pg_dscp;
- int pg_pcp;
+ std::string pg_offload;
+ std::string pg_redirection;
+ int pg_dscp = -1;
+ int pg_pcp = -1;
- uint16_t pg_tag;
+ uint16_t pg_tag = 0;
};
+using portal_group_up = std::unique_ptr<portal_group>;
+
struct port {
port(struct target *target);
virtual ~port() = default;
@@ -292,12 +340,14 @@ struct isns {
};
struct conf {
+ bool reuse_portal_group_socket(struct portal &newp);
+
char *conf_pidfile_path = nullptr;
TAILQ_HEAD(, lun) conf_luns;
TAILQ_HEAD(, target) conf_targets;
std::unordered_map<std::string, auth_group_sp> conf_auth_groups;
std::unordered_map<std::string, std::unique_ptr<port>> conf_ports;
- TAILQ_HEAD(, portal_group) conf_portal_groups;
+ std::unordered_map<std::string, portal_group_up> conf_portal_groups;
TAILQ_HEAD(, isns) conf_isns;
int conf_isns_period;
int conf_isns_timeout;
@@ -352,7 +402,7 @@ private:
struct ctld_connection {
struct connection conn;
struct portal *conn_portal;
- struct port *conn_port;
+ const struct port *conn_port;
struct target *conn_target;
int conn_session_type;
char *conn_initiator_name;
@@ -386,11 +436,7 @@ auth_group_sp auth_group_find(const struct conf *conf,
const char *name);
struct portal_group *portal_group_new(struct conf *conf, const char *name);
-void portal_group_delete(struct portal_group *pg);
-struct portal_group *portal_group_find(const struct conf *conf,
- const char *name);
-bool portal_group_add_portal(struct portal_group *pg,
- const char *value, bool iser);
+struct portal_group *portal_group_find(struct conf *conf, const char *name);
bool isns_new(struct conf *conf, const char *addr);
void isns_delete(struct isns *is);
@@ -402,8 +448,6 @@ bool port_new(struct conf *conf, struct target *target,
struct portal_group *pg, auth_group_sp ag);
bool port_new(struct conf *conf, struct target *target,
struct portal_group *pg, uint32_t ctl_port);
-struct port *port_find_in_pg(const struct portal_group *pg,
- const char *target);
struct target *target_new(struct conf *conf, const char *name);
void target_delete(struct target *target);
diff --git a/usr.sbin/ctld/discovery.cc b/usr.sbin/ctld/discovery.cc
index d52d4919ddc5..f3c1766ffc06 100644
--- a/usr.sbin/ctld/discovery.cc
+++ b/usr.sbin/ctld/discovery.cc
@@ -111,7 +111,7 @@ discovery_add_target(struct keys *response_keys, const struct target *targ)
const struct portal_group *pg = port->portal_group();
if (pg == nullptr)
continue;
- for (const portal_up &portal : pg->pg_portals) {
+ for (const portal_up &portal : pg->portals()) {
ai = portal->ai();
ret = getnameinfo(ai->ai_addr, ai->ai_addrlen,
hbuf, sizeof(hbuf), sbuf, sizeof(sbuf),
@@ -125,13 +125,13 @@ discovery_add_target(struct keys *response_keys, const struct target *targ)
if (strcmp(hbuf, "0.0.0.0") == 0)
continue;
ret = asprintf(&buf, "%s:%s,%d", hbuf, sbuf,
- pg->pg_tag);
+ pg->tag());
break;
case AF_INET6:
if (strcmp(hbuf, "::") == 0)
continue;
ret = asprintf(&buf, "[%s]:%s,%d", hbuf, sbuf,
- pg->pg_tag);
+ pg->tag());
break;
default:
continue;
@@ -160,26 +160,26 @@ discovery_target_filtered_out(const struct ctld_connection *conn,
ag = targ->t_auth_group.get();
pg = conn->conn_portal->portal_group();
- assert(pg->pg_discovery_filter != PG_FILTER_UNKNOWN);
+ assert(pg->discovery_filter() != discovery_filter::UNKNOWN);
- if (pg->pg_discovery_filter >= PG_FILTER_PORTAL &&
+ if (pg->discovery_filter() >= discovery_filter::PORTAL &&
!ag->initiator_permitted(conn->conn_initiator_sa)) {
log_debugx("initiator does not match initiator portals "
"allowed for target \"%s\"; skipping", targ->t_name);
return (true);
}
- if (pg->pg_discovery_filter >= PG_FILTER_PORTAL_NAME &&
+ if (pg->discovery_filter() >= discovery_filter::PORTAL_NAME &&
!ag->initiator_permitted(conn->conn_initiator_name)) {
log_debugx("initiator does not match initiator names "
"allowed for target \"%s\"; skipping", targ->t_name);
return (true);
}
- if (pg->pg_discovery_filter >= PG_FILTER_PORTAL_NAME_AUTH &&
+ if (pg->discovery_filter() >= discovery_filter::PORTAL_NAME_AUTH &&
ag->type() != auth_type::NO_AUTHENTICATION) {
if (conn->conn_chap == NULL) {
- assert(pg->pg_discovery_auth_group->type() ==
+ assert(pg->discovery_auth_group()->type() ==
auth_type::NO_AUTHENTICATION);
log_debugx("initiator didn't authenticate, but target "
@@ -228,7 +228,7 @@ discovery(struct ctld_connection *conn)
response_keys = keys_new();
if (strcmp(send_targets, "All") == 0) {
- for (const auto &kv : pg->pg_ports) {
+ for (const auto &kv : pg->ports()) {
port = kv.second;
if (discovery_target_filtered_out(conn, port)) {
/* Ignore this target. */
@@ -237,7 +237,7 @@ discovery(struct ctld_connection *conn)
discovery_add_target(response_keys, port->target());
}
} else {
- port = port_find_in_pg(pg, send_targets);
+ port = pg->find_port(send_targets);
if (port == NULL) {
log_debugx("initiator requested information on unknown "
"target \"%s\"; returning nothing", send_targets);
diff --git a/usr.sbin/ctld/kernel.cc b/usr.sbin/ctld/kernel.cc
index 2325895a31fd..8ccfd3cd55fa 100644
--- a/usr.sbin/ctld/kernel.cc
+++ b/usr.sbin/ctld/kernel.cc
@@ -573,7 +573,7 @@ retry_port:
continue;
}
}
- pg->pg_tag = port->cfiscsi_portal_group_tag;
+ pg->set_tag(port->cfiscsi_portal_group_tag);
if (!port_new(conf, targ, pg, port->port_id)) {
log_warnx("port_new failed");
continue;
@@ -853,10 +853,8 @@ kernel_handoff(struct ctld_connection *conn)
sizeof(req.data.handoff.initiator_isid));
strlcpy(req.data.handoff.target_name,
conn->conn_target->t_name, sizeof(req.data.handoff.target_name));
- if (pg->pg_offload != NULL) {
- strlcpy(req.data.handoff.offload, pg->pg_offload,
- sizeof(req.data.handoff.offload));
- }
+ strlcpy(req.data.handoff.offload, pg->offload(),
+ sizeof(req.data.handoff.offload));
#ifdef ICL_KERNEL_PROXY
if (proxy_mode)
req.data.handoff.connection_id = conn->conn.conn_socket;
@@ -865,7 +863,7 @@ kernel_handoff(struct ctld_connection *conn)
#else
req.data.handoff.socket = conn->conn.conn_socket;
#endif
- req.data.handoff.portal_group_tag = pg->pg_tag;
+ req.data.handoff.portal_group_tag = pg->tag();
if (conn->conn.conn_header_digest == CONN_DIGEST_CRC32C)
req.data.handoff.header_digest = CTL_ISCSI_DIGEST_CRC32C;
if (conn->conn.conn_data_digest == CONN_DIGEST_CRC32C)
@@ -946,11 +944,11 @@ portal_group_port::kernel_create_port()
struct portal_group *pg = p_portal_group;
struct target *targ = p_target;
- freebsd::nvlist_up nvl(nvlist_clone(pg->pg_options));
+ freebsd::nvlist_up nvl = pg->options();
nvlist_add_string(nvl.get(), "cfiscsi_target", targ->t_name);
- nvlist_add_string(nvl.get(), "ctld_portal_group_name", pg->pg_name);
+ nvlist_add_string(nvl.get(), "ctld_portal_group_name", pg->name());
nvlist_add_stringf(nvl.get(), "cfiscsi_portal_group_tag", "%u",
- pg->pg_tag);
+ pg->tag());
if (targ->t_alias) {
nvlist_add_string(nvl.get(), "cfiscsi_target_alias",
@@ -1105,7 +1103,7 @@ portal_group_port::kernel_remove_port()
freebsd::nvlist_up nvl(nvlist_create(0));
nvlist_add_string(nvl.get(), "cfiscsi_target", p_target->t_name);
nvlist_add_stringf(nvl.get(), "cfiscsi_portal_group_tag", "%u",
- p_portal_group->pg_tag);
+ p_portal_group->tag());
return (ctl_remove_port("iscsi", nvl.get()));
}
diff --git a/usr.sbin/ctld/login.cc b/usr.sbin/ctld/login.cc
index 6cbb882c41ee..491cdc220aa6 100644
--- a/usr.sbin/ctld/login.cc
+++ b/usr.sbin/ctld/login.cc
@@ -60,9 +60,7 @@ kernel_limits(const char *offload, int s, int *max_recv_dsl, int *max_send_dsl,
req.type = CTL_ISCSI_LIMITS;
cilp = (struct ctl_iscsi_limits_params *)&(req.data.limits);
- if (offload != NULL) {
- strlcpy(cilp->offload, offload, sizeof(cilp->offload));
- }
+ strlcpy(cilp->offload, offload, sizeof(cilp->offload));
cilp->socket = s;
if (ioctl(ctl_fd, CTL_ISCSI, &req) == -1) {
@@ -88,7 +86,7 @@ kernel_limits(const char *offload, int s, int *max_recv_dsl, int *max_send_dsl,
if (*max_burst_length < *first_burst_length)
*first_burst_length = *max_burst_length;
- if (offload != NULL) {
+ if (offload[0] != '\0') {
log_debugx("Kernel limits for offload \"%s\" are "
"MaxRecvDataSegment=%d, max_send_dsl=%d, "
"MaxBurstLength=%d, FirstBurstLength=%d",
@@ -704,12 +702,12 @@ login_portal_redirect(struct ctld_connection *conn, struct pdu *request)
const struct portal_group *pg;
pg = conn->conn_portal->portal_group();
- if (pg->pg_redirection == NULL)
+ if (!pg->is_redirecting())
return (false);
log_debugx("portal-group \"%s\" configured to redirect to %s",
- pg->pg_name, pg->pg_redirection);
- login_redirect(request, pg->pg_redirection);
+ pg->name(), pg->redirection());
+ login_redirect(request, pg->redirection());
return (true);
}
@@ -719,7 +717,7 @@ login_target_redirect(struct ctld_connection *conn, struct pdu *request)
{
const char *target_address;
- assert(conn->conn_portal->portal_group()->pg_redirection == NULL);
+ assert(!conn->conn_portal->portal_group()->is_redirecting());
if (conn->conn_target == NULL)
return (false);
@@ -755,7 +753,7 @@ login_negotiate(struct ctld_connection *conn, struct pdu *request)
conn->conn_max_send_data_segment_limit = (1 << 24) - 1;
conn->conn_max_burst_limit = (1 << 24) - 1;
conn->conn_first_burst_limit = (1 << 24) - 1;
- kernel_limits(pg->pg_offload,
+ kernel_limits(pg->offload(),
conn->conn.conn_socket,
&conn->conn_max_recv_data_segment_limit,
&conn->conn_max_send_data_segment_limit,
@@ -827,7 +825,7 @@ login_negotiate(struct ctld_connection *conn, struct pdu *request)
keys_add(response_keys,
"TargetAlias", conn->conn_target->t_alias);
keys_add_int(response_keys, "TargetPortalGroupTag",
- pg->pg_tag);
+ pg->tag());
}
for (i = 0; i < KEYS_MAX; i++) {
@@ -975,7 +973,7 @@ login(struct ctld_connection *conn)
log_errx(1, "received Login PDU without TargetName");
}
- conn->conn_port = port_find_in_pg(pg, target_name);
+ conn->conn_port = pg->find_port(target_name);
if (conn->conn_port == NULL) {
login_send_error(request, 0x02, 0x03);
log_errx(1, "requested target \"%s\" not found",
@@ -1002,7 +1000,7 @@ login(struct ctld_connection *conn)
}
} else {
assert(conn->conn_session_type == CONN_SESSION_TYPE_DISCOVERY);
- ag = pg->pg_discovery_auth_group.get();
+ ag = pg->discovery_auth_group();
log_debugx("initiator requests discovery session; %s",
ag->label());
}
@@ -1089,7 +1087,7 @@ login(struct ctld_connection *conn)
keys_add(response_keys,
"TargetAlias", conn->conn_target->t_alias);
keys_add_int(response_keys,
- "TargetPortalGroupTag", pg->pg_tag);
+ "TargetPortalGroupTag", pg->tag());
}
keys_save_pdu(response_keys, response);