Skip to contentSkip to conversation

powerpc/pseries: read the lpar name from the firmware

PATCH Superseded Laurent Dufour 4 participants 8 messages Dec 7, 2021 – Jan 6, 2022 PowerPC

v4 of 5 Superseded Latest is v5 →

lore
Share & tools
lore
#0 lore raw

PATCH v4 1/1 powerpc/pseries: read the lpar name from the firmware

The LPAR name may be changed after the LPAR has been started in the HMC. In that case lparstat command is not reporting the updated value because it reads it from the device tree which is read at boot time.

However this value could be read from RTAS.

Adding this value in the /proc/powerpc/lparcfg output allows to read the updated value.

---
v4:
address Nathan's new comments limiting size of the buffer.
v3:
address Michael's comments.
v2:
address Nathan's comments.
change title to partition_name aligning with existing partition_id

---
 arch/powerpc/platforms/pseries/lparcfg.c | 54 ++++++++++++++++++++++++
 1 file changed, 54 insertions(+)
arch/powerpc/platforms/pseries/lparcfg.c +54 -0
index f71eac74ea92..058d9a5fe545 100644
@@ -311,6 +311,59 @@ static void parse_mpp_x_data(struct seq_file *m)
 		seq_printf(m, "coalesce_pool_spurr=%ld\n", mpp_x_data.pool_spurr_cycles);
 }
 
+/*
+ * PAPR defines, in section "7.3.16 System Parameters Option", the token 55 to
+ * read the LPAR name, and the largest output data to 4000 + 2 bytes length.
+ */
+#define SPLPAR_LPAR_NAME_TOKEN	55
+#define GET_SYS_PARM_BUF_SIZE	4002
+#if GET_SYS_PARM_BUF_SIZE > RTAS_DATA_BUF_SIZE
+#error "GET_SYS_PARM_BUF_SIZE is larger than RTAS_DATA_BUF_SIZE"
+#endif
+static void read_lpar_name(struct seq_file *m)
+{
+	int rc, len, token;
+	union {
+		char raw_buffer[GET_SYS_PARM_BUF_SIZE];
+		struct {
+			__be16 len;
+			char name[GET_SYS_PARM_BUF_SIZE-2];
+		};
+	} *local_buffer;
+
+	token = rtas_token("ibm,get-system-parameter");
+	if (token == RTAS_UNKNOWN_SERVICE)
+		return;
+
+	local_buffer = kmalloc(sizeof(*local_buffer), GFP_KERNEL);
+	if (!local_buffer)
+		return;
+
+	do {
+		spin_lock(&rtas_data_buf_lock);
+		memset(rtas_data_buf, 0, sizeof(*local_buffer));
+		rc = rtas_call(token, 3, 1, NULL, SPLPAR_LPAR_NAME_TOKEN,
+			       __pa(rtas_data_buf), sizeof(*local_buffer));
+		if (!rc)
+			memcpy(local_buffer->raw_buffer, rtas_data_buf,
+			       sizeof(local_buffer->raw_buffer));
+		spin_unlock(&rtas_data_buf_lock);
+	} while (rtas_busy_delay(rc));
+
+	if (!rc) {
+		/* Force end of string */
+		len = min((int) be16_to_cpu(local_buffer->len),
+			  (int) sizeof(local_buffer->name)-1);
+		local_buffer->name[len] = '\0';
+
+		seq_printf(m, "partition_name=%s\n", local_buffer->name);
+	} else
+		pr_err_once("Error calling get-system-parameter (0x%x)\n", rc);
+
+	kfree(local_buffer);
+}
+
+
 #define SPLPAR_CHARACTERISTICS_TOKEN 20
 #define SPLPAR_MAXLENGTH 1026*(sizeof(char))
 
@@ -496,6 +549,7 @@ static int pseries_lparcfg_data(struct seq_file *m, void *v)
 
 	if (firmware_has_feature(FW_FEATURE_SPLPAR)) {
 		/* this call handles the ibm,get-system-parameter contents */
+		read_lpar_name(m);
 		parse_system_parameter_string(m);
 		parse_ppp_data(m);
 		parse_mpp_data(m);
Signature · 1 line
2.34.1
#1 lore raw

Happy New Year, Michael!

Do you consider taking that patch soon?

Thanks,
Laurent.

Quoted 95 lines · Laurent Dufour

The LPAR name may be changed after the LPAR has been started in the HMC. In that case lparstat command is not reporting the updated value because it reads it from the device tree which is read at boot time.

However this value could be read from RTAS.

Adding this value in the /proc/powerpc/lparcfg output allows to read the updated value.

---
v4:
address Nathan's new comments limiting size of the buffer.
v3:
address Michael's comments.
v2:
address Nathan's comments.
change title to partition_name aligning with existing partition_id

---
 arch/powerpc/platforms/pseries/lparcfg.c | 54 ++++++++++++++++++++++++
 1 file changed, 54 insertions(+)
arch/powerpc/platforms/pseries/lparcfg.c +54 -0
index f71eac74ea92..058d9a5fe545 100644
@@ -311,6 +311,59 @@ static void parse_mpp_x_data(struct seq_file *m)
 		seq_printf(m, "coalesce_pool_spurr=%ld\n", mpp_x_data.pool_spurr_cycles);
 }
 
+/*
+ * PAPR defines, in section "7.3.16 System Parameters Option", the token 55 to
+ * read the LPAR name, and the largest output data to 4000 + 2 bytes length.
+ */
+#define SPLPAR_LPAR_NAME_TOKEN	55
+#define GET_SYS_PARM_BUF_SIZE	4002
+#if GET_SYS_PARM_BUF_SIZE > RTAS_DATA_BUF_SIZE
+#error "GET_SYS_PARM_BUF_SIZE is larger than RTAS_DATA_BUF_SIZE"
+#endif
+static void read_lpar_name(struct seq_file *m)
+{
+	int rc, len, token;
+	union {
+		char raw_buffer[GET_SYS_PARM_BUF_SIZE];
+		struct {
+			__be16 len;
+			char name[GET_SYS_PARM_BUF_SIZE-2];
+		};
+	} *local_buffer;
+
+	token = rtas_token("ibm,get-system-parameter");
+	if (token == RTAS_UNKNOWN_SERVICE)
+		return;
+
+	local_buffer = kmalloc(sizeof(*local_buffer), GFP_KERNEL);
+	if (!local_buffer)
+		return;
+
+	do {
+		spin_lock(&rtas_data_buf_lock);
+		memset(rtas_data_buf, 0, sizeof(*local_buffer));
+		rc = rtas_call(token, 3, 1, NULL, SPLPAR_LPAR_NAME_TOKEN,
+			       __pa(rtas_data_buf), sizeof(*local_buffer));
+		if (!rc)
+			memcpy(local_buffer->raw_buffer, rtas_data_buf,
+			       sizeof(local_buffer->raw_buffer));
+		spin_unlock(&rtas_data_buf_lock);
+	} while (rtas_busy_delay(rc));
+
+	if (!rc) {
+		/* Force end of string */
+		len = min((int) be16_to_cpu(local_buffer->len),
+			  (int) sizeof(local_buffer->name)-1);
+		local_buffer->name[len] = '\0';
+
+		seq_printf(m, "partition_name=%s\n", local_buffer->name);
+	} else
+		pr_err_once("Error calling get-system-parameter (0x%x)\n", rc);
+
+	kfree(local_buffer);
+}
+
+
 #define SPLPAR_CHARACTERISTICS_TOKEN 20
 #define SPLPAR_MAXLENGTH 1026*(sizeof(char))
 
@@ -496,6 +549,7 @@ static int pseries_lparcfg_data(struct seq_file *m, void *v)
 
 	if (firmware_has_feature(FW_FEATURE_SPLPAR)) {
 		/* this call handles the ibm,get-system-parameter contents */
+		read_lpar_name(m);
 		parse_system_parameter_string(m);
 		parse_ppp_data(m);
 		parse_mpp_data(m);
#2 lore raw
Quoted 11 lines · Laurent Dufour
Quoted 8 lines · Laurent Dufour

The LPAR name may be changed after the LPAR has been started in the HMC. In that case lparstat command is not reporting the updated value because it reads it from the device tree which is read at boot time.

However this value could be read from RTAS.

Adding this value in the /proc/powerpc/lparcfg output allows to read the updated value.

Do you consider taking that patch soon?

This version prints an error on non-PowerVM guests the first time lparcfg is read.

And I still contend that having this function fall back to reporting the partition name in the DT would provide a beneficial consistency in the user-facing API, allowing programs to avoid hypervisor-specific branches in their code. I don't understand the resistance I've encountered here. The fallback I'm suggesting (a root node property lookup) is certainly not more complex than the RTAS call sequence you've already implemented.

#3 lore raw
Quoted 8 lines · Nathan Lynch
Quoted 7 lines · Laurent Dufour
Quoted 6 lines · Laurent Dufour

The LPAR name may be changed after the LPAR has been started in the HMC. In that case lparstat command is not reporting the updated value because it reads it from the device tree which is read at boot time.

However this value could be read from RTAS.

Quoted 7 lines
Quoted 4 lines
Quoted 2 lines

Adding this value in the /proc/powerpc/lparcfg output allows to read the updated value.

Do you consider taking that patch soon?

This version prints an error on non-PowerVM guests the first time lparcfg is read.

I assume because QEMU doesn't implement the LPAR_NAME token for get_sysparm.

Quoted 5 lines

And I still contend that having this function fall back to reporting the partition name in the DT would provide a beneficial consistency in the user-facing API, allowing programs to avoid hypervisor-specific branches in their code.

Agreed, if the get_sysparm fails just report the lpar-name from the device tree.

I don't understand the resistance I've encountered here.

Quoted 3 lines

The fallback I'm suggesting (a root node property lookup) is certainly not more complex than the RTAS call sequence you've already implemented.

Is there benefit of adding a partition_name field/value pair to lparcfg? The lparstat utility can just as easily make the get_sysparm call via librtas. Further, rtas_filters allows this particular RTAS call from userspace.

-Tyrel

#4 lore raw
Quoted 12 lines · Tyrel Datwyler
Quoted 11 lines · Nathan Lynch
Quoted 10 lines · Laurent Dufour
Quoted 8 lines · Laurent Dufour

The LPAR name may be changed after the LPAR has been started in the HMC. In that case lparstat command is not reporting the updated value because it reads it from the device tree which is read at boot time.

However this value could be read from RTAS.

Adding this value in the /proc/powerpc/lparcfg output allows to read the updated value.

Quoted 7 lines
Quoted 4 lines
Quoted 1 line

Do you consider taking that patch soon?

This version prints an error on non-PowerVM guests the first time lparcfg is read.

I assume because QEMU doesn't implement the LPAR_NAME token for get_sysparm.

Correct.

Quoted 7 lines
Quoted 4 lines

And I still contend that having this function fall back to reporting the partition name in the DT would provide a beneficial consistency in the user-facing API, allowing programs to avoid hypervisor-specific branches in their code.

Agreed, if the get_sysparm fails just report the lpar-name from the device tree.

Quoted 8 lines
Quoted 4 lines

I don't understand the resistance I've encountered here.
The fallback I'm suggesting (a root node property lookup) is certainly not more complex than the RTAS call sequence you've already implemented.

Is there benefit of adding a partition_name field/value pair to lparcfg? The lparstat utility can just as easily make the get_sysparm call via librtas. Further, rtas_filters allows this particular RTAS call from userspace.

The RTAS syscall is root-only, but we want the partition name (whether supplied by RTAS or the device tree) to be available to unprivileged programs.

#5 lore raw
Quoted 4 lines · Nathan Lynch
Quoted 3 lines · Tyrel Datwyler
Quoted 1 line · Nathan Lynch
Quoted 8 lines
Quoted 3 lines

Is there benefit of adding a partition_name field/value pair to lparcfg? The lparstat utility can just as easily make the get_sysparm call via librtas. Further, rtas_filters allows this particular RTAS call from userspace.

The RTAS syscall is root-only, but we want the partition name (whether supplied by RTAS or the device tree) to be available to unprivileged programs.

Ah, right. I recall this discussion now from previous iterations.

-Tyrel

#6 lore raw
In reply to Tyrel Datwyler
Quoted 20 lines · Tyrel Datwyler
Quoted 8 lines · Nathan Lynch
Quoted 7 lines · Laurent Dufour
Quoted 6 lines · Laurent Dufour

The LPAR name may be changed after the LPAR has been started in the HMC. In that case lparstat command is not reporting the updated value because it reads it from the device tree which is read at boot time.

However this value could be read from RTAS.

Quoted 7 lines
Quoted 4 lines
Quoted 2 lines

Adding this value in the /proc/powerpc/lparcfg output allows to read the updated value.

Do you consider taking that patch soon?

This version prints an error on non-PowerVM guests the first time lparcfg is read.

I assume because QEMU doesn't implement the LPAR_NAME token for get_sysparm.

Quoted 1 line
Quoted 6 lines
Quoted 4 lines

And I still contend that having this function fall back to reporting the partition name in the DT would provide a beneficial consistency in the user-facing API, allowing programs to avoid hypervisor-specific branches in their code.

Agreed, if the get_sysparm fails just report the lpar-name from the device tree.

My aim is to not do in the kernel what can be easily done in user space but avoiding user space program hypervisor-specific branches is a good point.

Note that if the RTAS call has been available to unprivileged user, all that stuff would have been made in user space, so hypervisor-specific...

Anyway, I'll work on a new version fetching the DT value in the case the RTAS call is failing.

Thanks,
Laurent.

#7 lore raw
In reply to Laurent Dufour
Quoted 3 lines · Laurent Dufour

Happy New Year, Michael!

Do you consider taking that patch soon?

I did but I was hoping you and Nathan could come to an agreement.

Looks like you did while I was sleeping, perfect :)

I'll pick up v5.

cheers

Quoted 96 lines · Laurent Dufour
Quoted 95 lines

The LPAR name may be changed after the LPAR has been started in the HMC. In that case lparstat command is not reporting the updated value because it reads it from the device tree which is read at boot time.

However this value could be read from RTAS.

Adding this value in the /proc/powerpc/lparcfg output allows to read the updated value.

---
v4:
address Nathan's new comments limiting size of the buffer.
v3:
address Michael's comments.
v2:
address Nathan's comments.
change title to partition_name aligning with existing partition_id

---
 arch/powerpc/platforms/pseries/lparcfg.c | 54 ++++++++++++++++++++++++
 1 file changed, 54 insertions(+)
arch/powerpc/platforms/pseries/lparcfg.c +54 -0
index f71eac74ea92..058d9a5fe545 100644
@@ -311,6 +311,59 @@ static void parse_mpp_x_data(struct seq_file *m)
 		seq_printf(m, "coalesce_pool_spurr=%ld\n", mpp_x_data.pool_spurr_cycles);
 }
 
+/*
+ * PAPR defines, in section "7.3.16 System Parameters Option", the token 55 to
+ * read the LPAR name, and the largest output data to 4000 + 2 bytes length.
+ */
+#define SPLPAR_LPAR_NAME_TOKEN	55
+#define GET_SYS_PARM_BUF_SIZE	4002
+#if GET_SYS_PARM_BUF_SIZE > RTAS_DATA_BUF_SIZE
+#error "GET_SYS_PARM_BUF_SIZE is larger than RTAS_DATA_BUF_SIZE"
+#endif
+static void read_lpar_name(struct seq_file *m)
+{
+	int rc, len, token;
+	union {
+		char raw_buffer[GET_SYS_PARM_BUF_SIZE];
+		struct {
+			__be16 len;
+			char name[GET_SYS_PARM_BUF_SIZE-2];
+		};
+	} *local_buffer;
+
+	token = rtas_token("ibm,get-system-parameter");
+	if (token == RTAS_UNKNOWN_SERVICE)
+		return;
+
+	local_buffer = kmalloc(sizeof(*local_buffer), GFP_KERNEL);
+	if (!local_buffer)
+		return;
+
+	do {
+		spin_lock(&rtas_data_buf_lock);
+		memset(rtas_data_buf, 0, sizeof(*local_buffer));
+		rc = rtas_call(token, 3, 1, NULL, SPLPAR_LPAR_NAME_TOKEN,
+			       __pa(rtas_data_buf), sizeof(*local_buffer));
+		if (!rc)
+			memcpy(local_buffer->raw_buffer, rtas_data_buf,
+			       sizeof(local_buffer->raw_buffer));
+		spin_unlock(&rtas_data_buf_lock);
+	} while (rtas_busy_delay(rc));
+
+	if (!rc) {
+		/* Force end of string */
+		len = min((int) be16_to_cpu(local_buffer->len),
+			  (int) sizeof(local_buffer->name)-1);
+		local_buffer->name[len] = '\0';
+
+		seq_printf(m, "partition_name=%s\n", local_buffer->name);
+	} else
+		pr_err_once("Error calling get-system-parameter (0x%x)\n", rc);
+
+	kfree(local_buffer);
+}
+
+
 #define SPLPAR_CHARACTERISTICS_TOKEN 20
 #define SPLPAR_MAXLENGTH 1026*(sizeof(char))
 
@@ -496,6 +549,7 @@ static int pseries_lparcfg_data(struct seq_file *m, void *v)
 
 	if (firmware_has_feature(FW_FEATURE_SPLPAR)) {
 		/* this call handles the ibm,get-system-parameter contents */
+		read_lpar_name(m);
 		parse_system_parameter_string(m);
 		parse_ppp_data(m);
 		parse_mpp_data(m);