[PATCH iproute2-next v3] rdma: Document IB device renaming option

[PATCH iproute2-next v3] rdma: Document IB device renaming option

[Leon Romanovsky]

From: Leon Romanovsky <leonro@mellanox.com>

[leonro@server /]$ lspci |grep -i Ether
00:08.0 Ethernet controller: Red Hat, Inc. Virtio network device
00:09.0 Ethernet controller: Mellanox Technologies MT27700 Family [ConnectX-4]
[leonro@server /]$ sudo rdma dev
1: mlx5_0: node_type ca fw 3.8.9999 node_guid 5254:00c0:fe12:3455
sys_image_guid 5254:00c0:fe12:3455
[leonro@server /]$ sudo rdma dev set mlx5_0 name hfi1_0
[leonro@server /]$ sudo rdma dev
1: hfi1_0: node_type ca fw 3.8.9999 node_guid 5254:00c0:fe12:3455
sys_image_guid 5254:00c0:fe12:3455

Signed-off-by: Leon Romanovsky <leonro@mellanox.com>
---
Changelog:
v2->v3:
 * Dropped "to be named" words from example section of man
---
 man/man8/rdma-dev.8 | 15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)

diff --git a/man/man8/rdma-dev.8 b/man/man8/rdma-dev.8
index 461681b6..7c275180 100644
--- a/man/man8/rdma-dev.8
+++ b/man/man8/rdma-dev.8
@@ -1,6 +1,6 @@
 .TH RDMA\-DEV 8 "06 Jul 2017" "iproute2" "Linux"
 .SH NAME
-rdmak-dev \- RDMA device configuration
+rdma-dev \- RDMA device configuration
 .SH SYNOPSIS
 .sp
 .ad l
@@ -22,10 +22,18 @@ rdmak-dev \- RDMA device configuration
 .B rdma dev show
 .RI "[ " DEV " ]"

+.ti -8
+.B rdma dev set
+.RI "[ " DEV " ]"
+.BR name
+.BR NEWNAME
+
 .ti -8
 .B rdma dev help

 .SH "DESCRIPTION"
+.SS rdma dev set - rename rdma device
+
 .SS rdma dev show - display rdma device attributes

 .PP
@@ -45,6 +53,11 @@ rdma dev show mlx5_3
 Shows the state of specified RDMA device.
 .RE
 .PP
+rdma dev set mlx5_3 name rdma_0
+.RS 4
+Renames the mlx5_3 device to rdma_0.
+.RE
+.PP

 .SH SEE ALSO
 .BR rdma (8),

Re: [PATCH iproute2-next v3] rdma: Document IB device renaming option

[David Ahern]

On 11/4/18 12:11 PM, Leon Romanovsky wrote:
> From: Leon Romanovsky <leonro@mellanox.com>
> 
> [leonro@server /]$ lspci |grep -i Ether
> 00:08.0 Ethernet controller: Red Hat, Inc. Virtio network device
> 00:09.0 Ethernet controller: Mellanox Technologies MT27700 Family [ConnectX-4]
> [leonro@server /]$ sudo rdma dev
> 1: mlx5_0: node_type ca fw 3.8.9999 node_guid 5254:00c0:fe12:3455
> sys_image_guid 5254:00c0:fe12:3455
> [leonro@server /]$ sudo rdma dev set mlx5_0 name hfi1_0
> [leonro@server /]$ sudo rdma dev
> 1: hfi1_0: node_type ca fw 3.8.9999 node_guid 5254:00c0:fe12:3455
> sys_image_guid 5254:00c0:fe12:3455
> 
> Signed-off-by: Leon Romanovsky <leonro@mellanox.com>
> ---
> Changelog:
> v2->v3:
>  * Dropped "to be named" words from example section of man
> ---
>  man/man8/rdma-dev.8 | 15 ++++++++++++++-
>  1 file changed, 14 insertions(+), 1 deletion(-)

applied to iproute2-next. Thanks

RE: [PATCH iproute2-next v3] rdma: Document IB device renaming option

[Ruhl, Michael J]

>-----Original Message-----
>From: linux-rdma-owner@vger.kernel.org [mailto:linux-rdma-
>owner@vger.kernel.org] On Behalf Of Leon Romanovsky
>Sent: Sunday, November 4, 2018 2:11 PM
>To: David Ahern <dsahern@gmail.com>
>Cc: Leon Romanovsky <leonro@mellanox.com>; netdev
><netdev@vger.kernel.org>; RDMA mailing list <linux-rdma@vger.kernel.org>;
>Stephen Hemminger <stephen@networkplumber.org>
>Subject: [PATCH iproute2-next v3] rdma: Document IB device renaming
>option
>
>From: Leon Romanovsky <leonro@mellanox.com>

Hi Leon,

After looking at this and Steve Wise's changes for the ADDLINK/DELLINK,
it occurred to me that the driver that handed the name to ib_register_device()
might be interested in knowing that this name change occurred.

Are there plans to include a some kind of notify mechanism so drivers can
find out when things like this occur?

Is this something that should be done?

Thanks,

Mike

>[leonro@server /]$ lspci |grep -i Ether
>00:08.0 Ethernet controller: Red Hat, Inc. Virtio network device
>00:09.0 Ethernet controller: Mellanox Technologies MT27700 Family
>[ConnectX-4]
>[leonro@server /]$ sudo rdma dev
>1: mlx5_0: node_type ca fw 3.8.9999 node_guid 5254:00c0:fe12:3455
>sys_image_guid 5254:00c0:fe12:3455
>[leonro@server /]$ sudo rdma dev set mlx5_0 name hfi1_0
>[leonro@server /]$ sudo rdma dev
>1: hfi1_0: node_type ca fw 3.8.9999 node_guid 5254:00c0:fe12:3455
>sys_image_guid 5254:00c0:fe12:3455
>
>Signed-off-by: Leon Romanovsky <leonro@mellanox.com>
>---
>Changelog:
>v2->v3:
> * Dropped "to be named" words from example section of man
>---
> man/man8/rdma-dev.8 | 15 ++++++++++++++-
> 1 file changed, 14 insertions(+), 1 deletion(-)
>
>diff --git a/man/man8/rdma-dev.8 b/man/man8/rdma-dev.8
>index 461681b6..7c275180 100644
>--- a/man/man8/rdma-dev.8
>+++ b/man/man8/rdma-dev.8
>@@ -1,6 +1,6 @@
> .TH RDMA\-DEV 8 "06 Jul 2017" "iproute2" "Linux"
> .SH NAME
>-rdmak-dev \- RDMA device configuration
>+rdma-dev \- RDMA device configuration
> .SH SYNOPSIS
> .sp
> .ad l
>@@ -22,10 +22,18 @@ rdmak-dev \- RDMA device configuration
> .B rdma dev show
> .RI "[ " DEV " ]"
>
>+.ti -8
>+.B rdma dev set
>+.RI "[ " DEV " ]"
>+.BR name
>+.BR NEWNAME
>+
> .ti -8
> .B rdma dev help
>
> .SH "DESCRIPTION"
>+.SS rdma dev set - rename rdma device
>+
> .SS rdma dev show - display rdma device attributes
>
> .PP
>@@ -45,6 +53,11 @@ rdma dev show mlx5_3
> Shows the state of specified RDMA device.
> .RE
> .PP
>+rdma dev set mlx5_3 name rdma_0
>+.RS 4
>+Renames the mlx5_3 device to rdma_0.
>+.RE
>+.PP
>
> .SH SEE ALSO
> .BR rdma (8),
>--
>2.19.1

Re: [PATCH iproute2-next v3] rdma: Document IB device renaming option

[Leon Romanovsky]

[-- Attachment #1: Type: text/plain, Size: 3114 bytes --]

On Fri, Nov 16, 2018 at 08:10:35PM +0000, Ruhl, Michael J wrote:
> >-----Original Message-----
> >From: linux-rdma-owner@vger.kernel.org [mailto:linux-rdma-
> >owner@vger.kernel.org] On Behalf Of Leon Romanovsky
> >Sent: Sunday, November 4, 2018 2:11 PM
> >To: David Ahern <dsahern@gmail.com>
> >Cc: Leon Romanovsky <leonro@mellanox.com>; netdev
> ><netdev@vger.kernel.org>; RDMA mailing list <linux-rdma@vger.kernel.org>;
> >Stephen Hemminger <stephen@networkplumber.org>
> >Subject: [PATCH iproute2-next v3] rdma: Document IB device renaming
> >option
> >
> >From: Leon Romanovsky <leonro@mellanox.com>
>
> Hi Leon,
>
> After looking at this and Steve Wise's changes for the ADDLINK/DELLINK,
> it occurred to me that the driver that handed the name to ib_register_device()
> might be interested in knowing that this name change occurred.
>
> Are there plans to include a some kind of notify mechanism so drivers can
> find out when things like this occur?

At least for device rename, I don't see any real need for such event,
because drivers are not supposed to rely on names.

I would say that it is probably driver bug to rely on device name
during its execution.

>
> Is this something that should be done?

I think yes, we can extend ib_event to support more events than now,
but should we?

>
> Thanks,
>
> Mike
>
> >[leonro@server /]$ lspci |grep -i Ether
> >00:08.0 Ethernet controller: Red Hat, Inc. Virtio network device
> >00:09.0 Ethernet controller: Mellanox Technologies MT27700 Family
> >[ConnectX-4]
> >[leonro@server /]$ sudo rdma dev
> >1: mlx5_0: node_type ca fw 3.8.9999 node_guid 5254:00c0:fe12:3455
> >sys_image_guid 5254:00c0:fe12:3455
> >[leonro@server /]$ sudo rdma dev set mlx5_0 name hfi1_0
> >[leonro@server /]$ sudo rdma dev
> >1: hfi1_0: node_type ca fw 3.8.9999 node_guid 5254:00c0:fe12:3455
> >sys_image_guid 5254:00c0:fe12:3455
> >
> >Signed-off-by: Leon Romanovsky <leonro@mellanox.com>
> >---
> >Changelog:
> >v2->v3:
> > * Dropped "to be named" words from example section of man
> >---
> > man/man8/rdma-dev.8 | 15 ++++++++++++++-
> > 1 file changed, 14 insertions(+), 1 deletion(-)
> >
> >diff --git a/man/man8/rdma-dev.8 b/man/man8/rdma-dev.8
> >index 461681b6..7c275180 100644
> >--- a/man/man8/rdma-dev.8
> >+++ b/man/man8/rdma-dev.8
> >@@ -1,6 +1,6 @@
> > .TH RDMA\-DEV 8 "06 Jul 2017" "iproute2" "Linux"
> > .SH NAME
> >-rdmak-dev \- RDMA device configuration
> >+rdma-dev \- RDMA device configuration
> > .SH SYNOPSIS
> > .sp
> > .ad l
> >@@ -22,10 +22,18 @@ rdmak-dev \- RDMA device configuration
> > .B rdma dev show
> > .RI "[ " DEV " ]"
> >
> >+.ti -8
> >+.B rdma dev set
> >+.RI "[ " DEV " ]"
> >+.BR name
> >+.BR NEWNAME
> >+
> > .ti -8
> > .B rdma dev help
> >
> > .SH "DESCRIPTION"
> >+.SS rdma dev set - rename rdma device
> >+
> > .SS rdma dev show - display rdma device attributes
> >
> > .PP
> >@@ -45,6 +53,11 @@ rdma dev show mlx5_3
> > Shows the state of specified RDMA device.
> > .RE
> > .PP
> >+rdma dev set mlx5_3 name rdma_0
> >+.RS 4
> >+Renames the mlx5_3 device to rdma_0.
> >+.RE
> >+.PP
> >
> > .SH SEE ALSO
> > .BR rdma (8),
> >--
> >2.19.1
>

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 801 bytes --]

Re: [PATCH iproute2-next v3] rdma: Document IB device renaming option

[Dennis Dalessandro]

On 11/18/2018 6:05 AM, Leon Romanovsky wrote:
> On Fri, Nov 16, 2018 at 08:10:35PM +0000, Ruhl, Michael J wrote:
>>> -----Original Message-----
>>> From: linux-rdma-owner@vger.kernel.org [mailto:linux-rdma-
>>> owner@vger.kernel.org] On Behalf Of Leon Romanovsky
>>> Sent: Sunday, November 4, 2018 2:11 PM
>>> To: David Ahern <dsahern@gmail.com>
>>> Cc: Leon Romanovsky <leonro@mellanox.com>; netdev
>>> <netdev@vger.kernel.org>; RDMA mailing list <linux-rdma@vger.kernel.org>;
>>> Stephen Hemminger <stephen@networkplumber.org>
>>> Subject: [PATCH iproute2-next v3] rdma: Document IB device renaming
>>> option
>>>
>>> From: Leon Romanovsky <leonro@mellanox.com>
>>
>> Hi Leon,
>>
>> After looking at this and Steve Wise's changes for the ADDLINK/DELLINK,
>> it occurred to me that the driver that handed the name to ib_register_device()
>> might be interested in knowing that this name change occurred.
>>
>> Are there plans to include a some kind of notify mechanism so drivers can
>> find out when things like this occur?
> 
> At least for device rename, I don't see any real need for such event,
> because drivers are not supposed to rely on names.

It just seems like something they want to know. But agree driver should 
not rely on a name.

> I would say that it is probably driver bug to rely on device name
> during its execution.
> 
>>
>> Is this something that should be done?
> 
> I think yes, we can extend ib_event to support more events than now,
> but should we?

On one hand it make sense to have an event. In case the driver had 
something it wanted to do with the name but I can't really think of a 
compelling reason it does. So I'd say we don't worry about it now but if 
someone finds a use for it then adding it later should be an option that 
is on the table.

-Denny