xen/console: introduce domain_console struct

Introduce domain_console for grouping data structures used for integrating
domain's diagnostic console with Xen's console driver.

Group all pbuf-related data structures under domain_console. Rename the moved
fields to plain .buf, .idx and .lock names, since all uses of the fields are
touched.

Ensure accesses to domain_console pointer are valid in console_switch_input().

Bump the domain console buffer allocation size to 256. No extra symbol for the
value since it is used only once during data structure declaration. All size
checks use ARRAY_SIZE().

Allocate domain_console from the heap so that the parent domain struct size
stays below PAGE_SIZE boundary to account for more console-related fields
added in the future.

Finally, update the domain_console allocation and initialization code. Make
sure domain_console is not allocated for system domains.

No functional change.

Signed-off-by: Denis Mukhin <dmukhin@ford.com>
Reviewed-by: Stefano Stabellini <sstabellini@kernel.org>
This commit is contained in:
Denis Mukhin authored and Jan Beulich committed 2025-11-26 12:06:56 +01:00
1 parent 9b6ab66219
commit ada5306708
6 files changed
+49 -42

No files matched your search

+1 -1
View File
@@ -713,7 +713,7 @@ int domain_vpl011_init(struct domain *d, struct vpl011_init_info *info)
}
else
{
d->console.input_allowed = true;
d->console->input_allowed = true;
vpl011->backend_in_domain = false;
vpl011->backend.xen = xzalloc(struct vpl011_xen_backend);
+9 -7
View File
@@ -563,6 +563,7 @@ static int cf_check hvm_print_line(
int dir, unsigned int port, unsigned int bytes, uint32_t *val)
{
struct domain *cd = current->domain;
struct domain_console *cons = cd->console;
char c = *val;
ASSERT(bytes == 1 && port == XEN_HVM_DEBUGCONS_IOPORT);
@@ -580,16 +581,17 @@ static int cf_check hvm_print_line(
if ( !is_console_printable(c) )
return X86EMUL_OKAY;
spin_lock(&cd->pbuf_lock);
spin_lock(&cons->lock);
ASSERT(cons->idx < ARRAY_SIZE(cons->buf));
if ( c != '\n' )
cd->pbuf[cd->pbuf_idx++] = c;
if ( (cd->pbuf_idx == (DOMAIN_PBUF_SIZE - 1)) || (c == '\n') )
cons->buf[cons->idx++] = c;
if ( (cons->idx == (ARRAY_SIZE(cons->buf) - 1)) || (c == '\n') )
{
cd->pbuf[cd->pbuf_idx] = '\0';
guest_printk(cd, XENLOG_G_DEBUG "%s\n", cd->pbuf);
cd->pbuf_idx = 0;
cons->buf[cons->idx] = '\0';
guest_printk(cd, XENLOG_G_DEBUG "%s\n", cons->buf);
cons->idx = 0;
}
spin_unlock(&cd->pbuf_lock);
spin_unlock(&cons->lock);
return X86EMUL_OKAY;
}
+1 -1
View File
@@ -239,7 +239,7 @@ void __init pv_shim_setup_dom(struct domain *d, l4_pgentry_t *l4start,
*/
d->max_pages = domain_tot_pages(d);
d->console.input_allowed = true;
d->console->input_allowed = true;
}
static void write_start_info(struct domain *d)
+9 -10
View File
@@ -680,7 +680,7 @@ static void _domain_destroy(struct domain *d)
BUG_ON(!d->is_dying);
BUG_ON(atomic_read(&d->refcnt) != DOMAIN_DESTROYED);
xfree(d->pbuf);
XVFREE(d->console);
argo_destroy(d);
@@ -854,8 +854,6 @@ struct domain *domain_create(domid_t domid,
flags |= CDF_hardware;
if ( old_hwdom )
old_hwdom->cdf &= ~CDF_hardware;
d->console.input_allowed = true;
}
/* Holding CDF_* internal flags. */
@@ -885,8 +883,6 @@ struct domain *domain_create(domid_t domid,
spin_lock_init(&d->shutdown_lock);
d->shutdown_code = SHUTDOWN_CODE_INVALID;
spin_lock_init(&d->pbuf_lock);
rwlock_init(&d->vnuma_rwlock);
#ifdef CONFIG_HAS_PCI
@@ -932,6 +928,14 @@ struct domain *domain_create(domid_t domid,
if ( is_system_domain(d) )
return d;
err = -ENOMEM;
d->console = xvzalloc(typeof(*d->console));
if ( !d->console )
goto fail;
spin_lock_init(&d->console->lock);
d->console->input_allowed = is_hardware_domain(d);
/*
* This assertion helps static analysis tools infer that config cannot be
* NULL in this branch, which in turn means that it can be safely
@@ -984,11 +988,6 @@ struct domain *domain_create(domid_t domid,
if ( (err = argo_init(d)) != 0 )
goto fail;
err = -ENOMEM;
d->pbuf = xzalloc_array(char, DOMAIN_PBUF_SIZE);
if ( !d->pbuf )
goto fail;
if ( (err = sched_init_domain(d, config->cpupool_id)) != 0 )
goto fail;
+16 -12
View File
@@ -526,7 +526,7 @@ struct domain *console_get_domain(void)
if ( !d )
return NULL;
if ( d->console.input_allowed )
if ( d->console->input_allowed )
return d;
rcu_unlock_domain(d);
@@ -567,10 +567,13 @@ static void console_switch_input(void)
d = rcu_lock_domain_by_id(domid);
if ( d )
{
rcu_unlock_domain(d);
if ( !d->console.input_allowed )
if ( !d->console->input_allowed )
{
rcu_unlock_domain(d);
continue;
}
rcu_unlock_domain(d);
console_rx = next_rx;
printk("*** Serial input to DOM%u", domid);
@@ -749,6 +752,7 @@ static long guest_console_write(XEN_GUEST_HANDLE_PARAM(char) buffer,
else
{
char *kin = kbuf, *kout = kbuf, c;
struct domain_console *cons = cd->console;
/* Strip non-printable characters */
do
@@ -761,22 +765,22 @@ static long guest_console_write(XEN_GUEST_HANDLE_PARAM(char) buffer,
} while ( --kcount > 0 );
*kout = '\0';
spin_lock(&cd->pbuf_lock);
spin_lock(&cons->lock);
kcount = kin - kbuf;
if ( c != '\n' &&
(cd->pbuf_idx + (kout - kbuf) < (DOMAIN_PBUF_SIZE - 1)) )
(cons->idx + (kout - kbuf) < (ARRAY_SIZE(cons->buf) - 1)) )
{
/* buffer the output until a newline */
memcpy(cd->pbuf + cd->pbuf_idx, kbuf, kout - kbuf);
cd->pbuf_idx += (kout - kbuf);
memcpy(cons->buf + cons->idx, kbuf, kout - kbuf);
cons->idx += kout - kbuf;
}
else
{
cd->pbuf[cd->pbuf_idx] = '\0';
guest_printk(cd, XENLOG_G_DEBUG "%s%s\n", cd->pbuf, kbuf);
cd->pbuf_idx = 0;
cons->buf[cons->idx] = '\0';
guest_printk(cd, XENLOG_G_DEBUG "%s%s\n", cons->buf, kbuf);
cons->idx = 0;
}
spin_unlock(&cd->pbuf_lock);
spin_unlock(&cons->lock);
}
guest_handle_add_offset(buffer, kcount);
+13 -11
View File
@@ -371,6 +371,17 @@ struct evtchn_port_ops;
#define MAX_NR_IOREQ_SERVERS 8
/* Domain console settings. */
struct domain_console {
/* Permission to take ownership of the physical console input. */
bool input_allowed;
/* hvm_print_line() and guest_console_write() logging. */
unsigned int idx;
spinlock_t lock;
char buf[256];
};
struct domain
{
domid_t domain_id;
@@ -562,12 +573,6 @@ struct domain
/* Control-plane tools handle for this domain. */
xen_domain_handle_t handle;
/* hvm_print_line() and guest_console_write() logging. */
#define DOMAIN_PBUF_SIZE 200
char *pbuf;
unsigned int pbuf_idx;
spinlock_t pbuf_lock;
/* OProfile support. */
struct xenoprof *xenoprof;
@@ -656,11 +661,8 @@ struct domain
unsigned int *llc_colors;
#endif
/* Console settings. */
struct {
/* Permission to take ownership of the physical console input. */
bool input_allowed;
} console;
/* Pointer to console settings; NULL for system domains. */
struct domain_console *console;
} __aligned(PAGE_SIZE);
static inline struct page_list_head *page_to_list(
Reference in new issue
Block a user
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.