Commit 3e51f2cb authored by Jakub Kicinski's avatar Jakub Kicinski
Browse files

tools: ynl: add --list-ops and --list-msgs to CLI 



I often forget the exact naming of ops and have to look at
the spec to find it. Add support for listing the operations:

  $ ./cli.py --spec .../netdev.yaml --list-ops
  dev-get  [ do, dump ]
  page-pool-get  [ do, dump ]
  page-pool-stats-get  [ do, dump ]
  queue-get  [ do, dump ]
  napi-get  [ do, dump ]
  qstats-get  [ dump ]

For completeness also support listing all ops (including
notifications:

  # ./cli.py --spec .../netdev.yaml --list-msgs
  dev-get  [ dump, do ]
  dev-add-ntf  [ notify ]
  dev-del-ntf  [ notify ]
  dev-change-ntf  [ notify ]
  page-pool-get  [ dump, do ]
  page-pool-add-ntf  [ notify ]
  page-pool-del-ntf  [ notify ]
  page-pool-change-ntf  [ notify ]
  page-pool-stats-get  [ dump, do ]
  queue-get  [ dump, do ]
  napi-get  [ dump, do ]
  qstats-get  [ dump ]

Use double space after the name for slightly easier to read
output.

Reviewed-by: default avatarJiri Pirko <jiri@nvidia.com>
Reviewed-by: default avatarDonald Hunter <donald.hunter@gmail.com>
Link: https://lore.kernel.org/r/20240502164043.2130184-1-kuba@kernel.org


Signed-off-by: default avatarJakub Kicinski <kuba@kernel.org>
parent f3ad4914

tools/net/ynl/cli.py

+9 −0
Original line number Diff line number Diff line
@@ -40,6 +40,8 @@ def main(): 
    group.add_argument('--multi', dest='multi', nargs=2, action='append',

                       metavar=('DO-OPERATION', 'JSON_TEXT'), type=str)

    group.add_argument('--dump', dest='dump', metavar='DUMP-OPERATION', type=str)

    group.add_argument('--list-ops', action='store_true')

    group.add_argument('--list-msgs', action='store_true')



    parser.add_argument('--sleep', dest='sleep', type=int)

    parser.add_argument('--subscribe', dest='ntf', type=str)
@@ -81,6 +83,13 @@ def main(): 
    if args.sleep:

        time.sleep(args.sleep)



    if args.list_ops:

        for op_name, op in ynl.ops.items():

            print(op_name, " [", ", ".join(op.modes), "]")

    if args.list_msgs:

        for op_name, op in ynl.msgs.items():

            print(op_name, " [", ", ".join(op.modes), "]")



    try:

        if args.do:

            reply = ynl.do(args.do, attrs, args.flags)

tools/net/ynl/lib/nlspec.py

+2 −0
Original line number Diff line number Diff line
@@ -335,6 +335,7 @@ class SpecOperation(SpecElement): 


        req_value       numerical ID when serialized, user -> kernel

        rsp_value       numerical ID when serialized, user <- kernel

        modes           supported operation modes (do, dump, event etc.)

        is_call         bool, whether the operation is a call

        is_async        bool, whether the operation is a notification

        is_resv         bool, whether the operation does not exist (it's just a reserved ID)
@@ -350,6 +351,7 @@ class SpecOperation(SpecElement): 
        self.req_value = req_value

        self.rsp_value = rsp_value



        self.modes = yaml.keys() & {'do', 'dump', 'event', 'notify'}

        self.is_call = 'do' in yaml or 'dump' in yaml

        self.is_async = 'notify' in yaml or 'event' in yaml

        self.is_resv = not self.is_async and not self.is_call