mirror of
https://git.proxmox.com/git/mirror_iproute2
synced 2025-10-23 13:39:14 +00:00
8b4fbf0bed
Devlink region allows access to driver defined address regions.
Each device can create its supported address regions and register
them. A device which exposes a region will allow access to it
using devlink.
This support allows reading and dumping regions snapshots as well
as presenting information such as region size and current available
snapshots.
A snapshot represents a memory image of a region taken by the driver.
If a device collects a snapshot of an address region it can be later
exposed using devlink region read or dump commands.
This functionality allows for future analyses on the snapshots.
The dump command is designed to read the full address space of a
region or of a snapshot unlike the read command which allows
reading only a specific section in a region/snapshot indicated by
an address and a length, current support is for reading and dumping
for a previously taken snapshot ID.
New commands added:
devlink region show [ DEV/REGION ]
devlink region delete DEV/REGION snapshot SNAPSHOT_ID
devlink region dump DEV/REGION [ snapshot SNAPSHOT_ID ]
devlink region read DEV/REGION [ snapshot SNAPSHOT_ID ]
address ADDRESS length length
Signed-off-by: Alex Vesker <valex@mellanox.com>
Signed-off-by: Jiri Pirko <jiri@mellanox.com>
Signed-off-by: David Ahern <dsahern@gmail.com>
126 lines
2.4 KiB
Groff
126 lines
2.4 KiB
Groff
.TH DEVLINK 8 "14 Mar 2016" "iproute2" "Linux"
|
|
.SH NAME
|
|
devlink \- Devlink tool
|
|
.SH SYNOPSIS
|
|
.sp
|
|
.ad l
|
|
.in +8
|
|
.ti -8
|
|
.B devlink
|
|
.RI "[ " OPTIONS " ] " OBJECT " { " COMMAND " | "
|
|
.BR help " }"
|
|
.sp
|
|
|
|
.ti -8
|
|
.B devlink
|
|
.RB "[ " -force " ] "
|
|
.BI "-batch " filename
|
|
.sp
|
|
|
|
.ti -8
|
|
.IR OBJECT " := { "
|
|
.BR dev " | " port " | " monitor " | " sb " | " resource " }"
|
|
.sp
|
|
|
|
.ti -8
|
|
.IR OPTIONS " := { "
|
|
\fB\-V\fR[\fIersion\fR] |
|
|
\fB\-n\fR[\fIno-nice-names\fR] }
|
|
\fB\-j\fR[\fIjson\fR] }
|
|
\fB\-p\fR[\fIpretty\fR] }
|
|
|
|
.SH OPTIONS
|
|
|
|
.TP
|
|
.BR "\-V" , " --Version"
|
|
Print the version of the
|
|
.B devlink
|
|
utility and exit.
|
|
|
|
.TP
|
|
.BR "\-b", " \-batch " <FILENAME>
|
|
Read commands from provided file or standard input and invoke them.
|
|
First failure will cause termination of devlink.
|
|
|
|
.TP
|
|
.BR "\-force"
|
|
Don't terminate devlink on errors in batch mode.
|
|
If there were any errors during execution of the commands, the application return code will be non zero.
|
|
|
|
.TP
|
|
.BR "\-n" , " --no-nice-names"
|
|
Turn off printing out nice names, for example netdevice ifnames instead of devlink port identification.
|
|
|
|
.TP
|
|
.BR "\-j" , " --json"
|
|
Generate JSON output.
|
|
|
|
.TP
|
|
.BR "\-p" , " --pretty"
|
|
When combined with -j generate a pretty JSON output.
|
|
|
|
.SS
|
|
.I OBJECT
|
|
|
|
.TP
|
|
.B dev
|
|
- devlink device.
|
|
|
|
.TP
|
|
.B port
|
|
- devlink port.
|
|
|
|
.TP
|
|
.B monitor
|
|
- watch for netlink messages.
|
|
|
|
.TP
|
|
.B sb
|
|
- devlink shared buffer configuration.
|
|
|
|
.TP
|
|
.B resource
|
|
- devlink device resource configuration.
|
|
|
|
.SS
|
|
.I COMMAND
|
|
|
|
Specifies the action to perform on the object.
|
|
The set of possible actions depends on the object type.
|
|
As a rule, it is possible to
|
|
.B show
|
|
(or
|
|
.B list
|
|
) objects, but some objects do not allow all of these operations
|
|
or have some additional commands. The
|
|
.B help
|
|
command is available for all objects. It prints
|
|
out a list of available commands and argument syntax conventions.
|
|
.sp
|
|
If no command is given, some default command is assumed.
|
|
Usually it is
|
|
.B list
|
|
or, if the objects of this class cannot be listed,
|
|
.BR "help" .
|
|
|
|
.SH EXIT STATUS
|
|
Exit status is 0 if command was successful or a positive integer upon failure.
|
|
|
|
.SH SEE ALSO
|
|
.BR devlink-dev (8),
|
|
.BR devlink-port (8),
|
|
.BR devlink-monitor (8),
|
|
.BR devlink-sb (8),
|
|
.BR devlink-resource (8),
|
|
.BR devlink-region (8),
|
|
.br
|
|
|
|
.SH REPORTING BUGS
|
|
Report any bugs to the Network Developers mailing list
|
|
.B <netdev@vger.kernel.org>
|
|
where the development and maintenance is primarily done.
|
|
You do not have to be subscribed to the list to send a message there.
|
|
|
|
.SH AUTHOR
|
|
Jiri Pirko <jiri@mellanox.com>
|