binapi/tracedump/tracedump.ba.go

   1 // Code generated by GoVPP's binapi-generator. DO NOT EDIT.
   2 // versions:
   3 //  binapi-generator: v0.5.0-dev
   4 //  VPP:              22.02-release
   5 // source: /usr/share/vpp/api/plugins/tracedump.api.json
   6
   7 // Package tracedump contains generated bindings for API file tracedump.api.
   8 //
   9 // Contents:
  10 //   1 enum
  11 //   9 messages
  12 //
  13 package tracedump
  14
  15 import (
  16         "strconv"
  17
  18         api "git.fd.io/govpp.git/api"
  19         codec "git.fd.io/govpp.git/codec"
  20 )
  21
  22 // This is a compile-time assertion to ensure that this generated file
  23 // is compatible with the GoVPP api package it is being compiled against.
  24 // A compilation error at this line likely means your copy of the
  25 // GoVPP api package needs to be updated.
  26 const _ = api.GoVppAPIPackageIsVersion2
  27
  28 const (
  29         APIFile    = "tracedump"
  30         APIVersion = "0.1.0"
  31         VersionCrc = 0x691543d5
  32 )
  33
  34 // TraceFilterFlag defines enum 'trace_filter_flag'.
  35 type TraceFilterFlag uint32
  36
  37 const (
  38         TRACE_FF_NONE               TraceFilterFlag = 0
  39         TRACE_FF_INCLUDE_NODE       TraceFilterFlag = 1
  40         TRACE_FF_EXCLUDE_NODE       TraceFilterFlag = 2
  41         TRACE_FF_INCLUDE_CLASSIFIER TraceFilterFlag = 3
  42         TRACE_FF_EXCLUDE_CLASSIFIER TraceFilterFlag = 4
  43 )
  44
  45 var (
  46         TraceFilterFlag_name = map[uint32]string{
  47                 0: "TRACE_FF_NONE",
  48                 1: "TRACE_FF_INCLUDE_NODE",
  49                 2: "TRACE_FF_EXCLUDE_NODE",
  50                 3: "TRACE_FF_INCLUDE_CLASSIFIER",
  51                 4: "TRACE_FF_EXCLUDE_CLASSIFIER",
  52         }
  53         TraceFilterFlag_value = map[string]uint32{
  54                 "TRACE_FF_NONE":               0,
  55                 "TRACE_FF_INCLUDE_NODE":       1,
  56                 "TRACE_FF_EXCLUDE_NODE":       2,
  57                 "TRACE_FF_INCLUDE_CLASSIFIER": 3,
  58                 "TRACE_FF_EXCLUDE_CLASSIFIER": 4,
  59         }
  60 )
  61
  62 func (x TraceFilterFlag) String() string {
  63         s, ok := TraceFilterFlag_name[uint32(x)]
  64         if ok {
  65                 return s
  66         }
  67         return "TraceFilterFlag(" + strconv.Itoa(int(x)) + ")"
  68 }
  69
  70 // TraceCapturePackets defines message 'trace_capture_packets'.
  71 // InProgress: the message form may change in the future versions
  72 type TraceCapturePackets struct {
  73         NodeIndex       uint32 `binapi:"u32,name=node_index" json:"node_index,omitempty"`
  74         MaxPackets      uint32 `binapi:"u32,name=max_packets" json:"max_packets,omitempty"`
  75         UseFilter       bool   `binapi:"bool,name=use_filter" json:"use_filter,omitempty"`
  76         Verbose         bool   `binapi:"bool,name=verbose" json:"verbose,omitempty"`
  77         PreCaptureClear bool   `binapi:"bool,name=pre_capture_clear" json:"pre_capture_clear,omitempty"`
  78 }
  79
  80 func (m *TraceCapturePackets) Reset()               { *m = TraceCapturePackets{} }
  81 func (*TraceCapturePackets) GetMessageName() string { return "trace_capture_packets" }
  82 func (*TraceCapturePackets) GetCrcString() string   { return "9e791a9b" }
  83 func (*TraceCapturePackets) GetMessageType() api.MessageType {
  84         return api.RequestMessage
  85 }
  86
  87 func (m *TraceCapturePackets) Size() (size int) {
  88         if m == nil {
  89                 return 0
  90         }
  91         size += 4 // m.NodeIndex
  92         size += 4 // m.MaxPackets
  93         size += 1 // m.UseFilter
  94         size += 1 // m.Verbose
  95         size += 1 // m.PreCaptureClear
  96         return size
  97 }
  98 func (m *TraceCapturePackets) Marshal(b []byte) ([]byte, error) {
  99         if b == nil {
 100                 b = make([]byte, m.Size())
 101         }
 102         buf := codec.NewBuffer(b)
 103         buf.EncodeUint32(m.NodeIndex)
 104         buf.EncodeUint32(m.MaxPackets)
 105         buf.EncodeBool(m.UseFilter)
 106         buf.EncodeBool(m.Verbose)
 107         buf.EncodeBool(m.PreCaptureClear)
 108         return buf.Bytes(), nil
 109 }
 110 func (m *TraceCapturePackets) Unmarshal(b []byte) error {
 111         buf := codec.NewBuffer(b)
 112         m.NodeIndex = buf.DecodeUint32()
 113         m.MaxPackets = buf.DecodeUint32()
 114         m.UseFilter = buf.DecodeBool()
 115         m.Verbose = buf.DecodeBool()
 116         m.PreCaptureClear = buf.DecodeBool()
 117         return nil
 118 }
 119
 120 // TraceCapturePacketsReply defines message 'trace_capture_packets_reply'.
 121 // InProgress: the message form may change in the future versions
 122 type TraceCapturePacketsReply struct {
 123         Retval int32 `binapi:"i32,name=retval" json:"retval,omitempty"`
 124 }
 125
 126 func (m *TraceCapturePacketsReply) Reset()               { *m = TraceCapturePacketsReply{} }
 127 func (*TraceCapturePacketsReply) GetMessageName() string { return "trace_capture_packets_reply" }
 128 func (*TraceCapturePacketsReply) GetCrcString() string   { return "e8d4e804" }
 129 func (*TraceCapturePacketsReply) GetMessageType() api.MessageType {
 130         return api.ReplyMessage
 131 }
 132
 133 func (m *TraceCapturePacketsReply) Size() (size int) {
 134         if m == nil {
 135                 return 0
 136         }
 137         size += 4 // m.Retval
 138         return size
 139 }
 140 func (m *TraceCapturePacketsReply) Marshal(b []byte) ([]byte, error) {
 141         if b == nil {
 142                 b = make([]byte, m.Size())
 143         }
 144         buf := codec.NewBuffer(b)
 145         buf.EncodeInt32(m.Retval)
 146         return buf.Bytes(), nil
 147 }
 148 func (m *TraceCapturePacketsReply) Unmarshal(b []byte) error {
 149         buf := codec.NewBuffer(b)
 150         m.Retval = buf.DecodeInt32()
 151         return nil
 152 }
 153
 154 // TraceClearCapture defines message 'trace_clear_capture'.
 155 // InProgress: the message form may change in the future versions
 156 type TraceClearCapture struct{}
 157
 158 func (m *TraceClearCapture) Reset()               { *m = TraceClearCapture{} }
 159 func (*TraceClearCapture) GetMessageName() string { return "trace_clear_capture" }
 160 func (*TraceClearCapture) GetCrcString() string   { return "51077d14" }
 161 func (*TraceClearCapture) GetMessageType() api.MessageType {
 162         return api.RequestMessage
 163 }
 164
 165 func (m *TraceClearCapture) Size() (size int) {
 166         if m == nil {
 167                 return 0
 168         }
 169         return size
 170 }
 171 func (m *TraceClearCapture) Marshal(b []byte) ([]byte, error) {
 172         if b == nil {
 173                 b = make([]byte, m.Size())
 174         }
 175         buf := codec.NewBuffer(b)
 176         return buf.Bytes(), nil
 177 }
 178 func (m *TraceClearCapture) Unmarshal(b []byte) error {
 179         return nil
 180 }
 181
 182 // TraceClearCaptureReply defines message 'trace_clear_capture_reply'.
 183 // InProgress: the message form may change in the future versions
 184 type TraceClearCaptureReply struct {
 185         Retval int32 `binapi:"i32,name=retval" json:"retval,omitempty"`
 186 }
 187
 188 func (m *TraceClearCaptureReply) Reset()               { *m = TraceClearCaptureReply{} }
 189 func (*TraceClearCaptureReply) GetMessageName() string { return "trace_clear_capture_reply" }
 190 func (*TraceClearCaptureReply) GetCrcString() string   { return "e8d4e804" }
 191 func (*TraceClearCaptureReply) GetMessageType() api.MessageType {
 192         return api.ReplyMessage
 193 }
 194
 195 func (m *TraceClearCaptureReply) Size() (size int) {
 196         if m == nil {
 197                 return 0
 198         }
 199         size += 4 // m.Retval
 200         return size
 201 }
 202 func (m *TraceClearCaptureReply) Marshal(b []byte) ([]byte, error) {
 203         if b == nil {
 204                 b = make([]byte, m.Size())
 205         }
 206         buf := codec.NewBuffer(b)
 207         buf.EncodeInt32(m.Retval)
 208         return buf.Bytes(), nil
 209 }
 210 func (m *TraceClearCaptureReply) Unmarshal(b []byte) error {
 211         buf := codec.NewBuffer(b)
 212         m.Retval = buf.DecodeInt32()
 213         return nil
 214 }
 215
 216 // TraceDetails defines message 'trace_details'.
 217 // InProgress: the message form may change in the future versions
 218 type TraceDetails struct {
 219         ThreadID       uint32 `binapi:"u32,name=thread_id" json:"thread_id,omitempty"`
 220         Position       uint32 `binapi:"u32,name=position" json:"position,omitempty"`
 221         MoreThisThread uint8  `binapi:"u8,name=more_this_thread" json:"more_this_thread,omitempty"`
 222         MoreThreads    uint8  `binapi:"u8,name=more_threads" json:"more_threads,omitempty"`
 223         Done           uint8  `binapi:"u8,name=done" json:"done,omitempty"`
 224         PacketNumber   uint32 `binapi:"u32,name=packet_number" json:"packet_number,omitempty"`
 225         TraceData      string `binapi:"string[],name=trace_data" json:"trace_data,omitempty"`
 226 }
 227
 228 func (m *TraceDetails) Reset()               { *m = TraceDetails{} }
 229 func (*TraceDetails) GetMessageName() string { return "trace_details" }
 230 func (*TraceDetails) GetCrcString() string   { return "1553e9eb" }
 231 func (*TraceDetails) GetMessageType() api.MessageType {
 232         return api.RequestMessage
 233 }
 234
 235 func (m *TraceDetails) Size() (size int) {
 236         if m == nil {
 237                 return 0
 238         }
 239         size += 4                    // m.ThreadID
 240         size += 4                    // m.Position
 241         size += 1                    // m.MoreThisThread
 242         size += 1                    // m.MoreThreads
 243         size += 1                    // m.Done
 244         size += 4                    // m.PacketNumber
 245         size += 4 + len(m.TraceData) // m.TraceData
 246         return size
 247 }
 248 func (m *TraceDetails) Marshal(b []byte) ([]byte, error) {
 249         if b == nil {
 250                 b = make([]byte, m.Size())
 251         }
 252         buf := codec.NewBuffer(b)
 253         buf.EncodeUint32(m.ThreadID)
 254         buf.EncodeUint32(m.Position)
 255         buf.EncodeUint8(m.MoreThisThread)
 256         buf.EncodeUint8(m.MoreThreads)
 257         buf.EncodeUint8(m.Done)
 258         buf.EncodeUint32(m.PacketNumber)
 259         buf.EncodeString(m.TraceData, 0)
 260         return buf.Bytes(), nil
 261 }
 262 func (m *TraceDetails) Unmarshal(b []byte) error {
 263         buf := codec.NewBuffer(b)
 264         m.ThreadID = buf.DecodeUint32()
 265         m.Position = buf.DecodeUint32()
 266         m.MoreThisThread = buf.DecodeUint8()
 267         m.MoreThreads = buf.DecodeUint8()
 268         m.Done = buf.DecodeUint8()
 269         m.PacketNumber = buf.DecodeUint32()
 270         m.TraceData = buf.DecodeString(0)
 271         return nil
 272 }
 273
 274 // TraceDump defines message 'trace_dump'.
 275 // InProgress: the message form may change in the future versions
 276 type TraceDump struct {
 277         ClearCache uint8  `binapi:"u8,name=clear_cache" json:"clear_cache,omitempty"`
 278         ThreadID   uint32 `binapi:"u32,name=thread_id" json:"thread_id,omitempty"`
 279         Position   uint32 `binapi:"u32,name=position" json:"position,omitempty"`
 280         MaxRecords uint32 `binapi:"u32,name=max_records" json:"max_records,omitempty"`
 281 }
 282
 283 func (m *TraceDump) Reset()               { *m = TraceDump{} }
 284 func (*TraceDump) GetMessageName() string { return "trace_dump" }
 285 func (*TraceDump) GetCrcString() string   { return "c7d6681f" }
 286 func (*TraceDump) GetMessageType() api.MessageType {
 287         return api.RequestMessage
 288 }
 289
 290 func (m *TraceDump) Size() (size int) {
 291         if m == nil {
 292                 return 0
 293         }
 294         size += 1 // m.ClearCache
 295         size += 4 // m.ThreadID
 296         size += 4 // m.Position
 297         size += 4 // m.MaxRecords
 298         return size
 299 }
 300 func (m *TraceDump) Marshal(b []byte) ([]byte, error) {
 301         if b == nil {
 302                 b = make([]byte, m.Size())
 303         }
 304         buf := codec.NewBuffer(b)
 305         buf.EncodeUint8(m.ClearCache)
 306         buf.EncodeUint32(m.ThreadID)
 307         buf.EncodeUint32(m.Position)
 308         buf.EncodeUint32(m.MaxRecords)
 309         return buf.Bytes(), nil
 310 }
 311 func (m *TraceDump) Unmarshal(b []byte) error {
 312         buf := codec.NewBuffer(b)
 313         m.ClearCache = buf.DecodeUint8()
 314         m.ThreadID = buf.DecodeUint32()
 315         m.Position = buf.DecodeUint32()
 316         m.MaxRecords = buf.DecodeUint32()
 317         return nil
 318 }
 319
 320 // TraceDumpReply defines message 'trace_dump_reply'.
 321 // InProgress: the message form may change in the future versions
 322 type TraceDumpReply struct {
 323         Retval         int32  `binapi:"i32,name=retval" json:"retval,omitempty"`
 324         LastThreadID   uint32 `binapi:"u32,name=last_thread_id" json:"last_thread_id,omitempty"`
 325         LastPosition   uint32 `binapi:"u32,name=last_position" json:"last_position,omitempty"`
 326         MoreThisThread uint8  `binapi:"u8,name=more_this_thread" json:"more_this_thread,omitempty"`
 327         MoreThreads    uint8  `binapi:"u8,name=more_threads" json:"more_threads,omitempty"`
 328         FlushOnly      uint8  `binapi:"u8,name=flush_only" json:"flush_only,omitempty"`
 329         Done           uint8  `binapi:"u8,name=done" json:"done,omitempty"`
 330 }
 331
 332 func (m *TraceDumpReply) Reset()               { *m = TraceDumpReply{} }
 333 func (*TraceDumpReply) GetMessageName() string { return "trace_dump_reply" }
 334 func (*TraceDumpReply) GetCrcString() string   { return "e0e87f9d" }
 335 func (*TraceDumpReply) GetMessageType() api.MessageType {
 336         return api.ReplyMessage
 337 }
 338
 339 func (m *TraceDumpReply) Size() (size int) {
 340         if m == nil {
 341                 return 0
 342         }
 343         size += 4 // m.Retval
 344         size += 4 // m.LastThreadID
 345         size += 4 // m.LastPosition
 346         size += 1 // m.MoreThisThread
 347         size += 1 // m.MoreThreads
 348         size += 1 // m.FlushOnly
 349         size += 1 // m.Done
 350         return size
 351 }
 352 func (m *TraceDumpReply) Marshal(b []byte) ([]byte, error) {
 353         if b == nil {
 354                 b = make([]byte, m.Size())
 355         }
 356         buf := codec.NewBuffer(b)
 357         buf.EncodeInt32(m.Retval)
 358         buf.EncodeUint32(m.LastThreadID)
 359         buf.EncodeUint32(m.LastPosition)
 360         buf.EncodeUint8(m.MoreThisThread)
 361         buf.EncodeUint8(m.MoreThreads)
 362         buf.EncodeUint8(m.FlushOnly)
 363         buf.EncodeUint8(m.Done)
 364         return buf.Bytes(), nil
 365 }
 366 func (m *TraceDumpReply) Unmarshal(b []byte) error {
 367         buf := codec.NewBuffer(b)
 368         m.Retval = buf.DecodeInt32()
 369         m.LastThreadID = buf.DecodeUint32()
 370         m.LastPosition = buf.DecodeUint32()
 371         m.MoreThisThread = buf.DecodeUint8()
 372         m.MoreThreads = buf.DecodeUint8()
 373         m.FlushOnly = buf.DecodeUint8()
 374         m.Done = buf.DecodeUint8()
 375         return nil
 376 }
 377
 378 // TraceSetFilters defines message 'trace_set_filters'.
 379 // InProgress: the message form may change in the future versions
 380 type TraceSetFilters struct {
 381         Flag                 TraceFilterFlag `binapi:"trace_filter_flag,name=flag" json:"flag,omitempty"`
 382         Count                uint32          `binapi:"u32,name=count" json:"count,omitempty"`
 383         NodeIndex            uint32          `binapi:"u32,name=node_index,default=4294967295" json:"node_index,omitempty"`
 384         ClassifierTableIndex uint32          `binapi:"u32,name=classifier_table_index,default=4294967295" json:"classifier_table_index,omitempty"`
 385 }
 386
 387 func (m *TraceSetFilters) Reset()               { *m = TraceSetFilters{} }
 388 func (*TraceSetFilters) GetMessageName() string { return "trace_set_filters" }
 389 func (*TraceSetFilters) GetCrcString() string   { return "f522b44a" }
 390 func (*TraceSetFilters) GetMessageType() api.MessageType {
 391         return api.RequestMessage
 392 }
 393
 394 func (m *TraceSetFilters) Size() (size int) {
 395         if m == nil {
 396                 return 0
 397         }
 398         size += 4 // m.Flag
 399         size += 4 // m.Count
 400         size += 4 // m.NodeIndex
 401         size += 4 // m.ClassifierTableIndex
 402         return size
 403 }
 404 func (m *TraceSetFilters) Marshal(b []byte) ([]byte, error) {
 405         if b == nil {
 406                 b = make([]byte, m.Size())
 407         }
 408         buf := codec.NewBuffer(b)
 409         buf.EncodeUint32(uint32(m.Flag))
 410         buf.EncodeUint32(m.Count)
 411         buf.EncodeUint32(m.NodeIndex)
 412         buf.EncodeUint32(m.ClassifierTableIndex)
 413         return buf.Bytes(), nil
 414 }
 415 func (m *TraceSetFilters) Unmarshal(b []byte) error {
 416         buf := codec.NewBuffer(b)
 417         m.Flag = TraceFilterFlag(buf.DecodeUint32())
 418         m.Count = buf.DecodeUint32()
 419         m.NodeIndex = buf.DecodeUint32()
 420         m.ClassifierTableIndex = buf.DecodeUint32()
 421         return nil
 422 }
 423
 424 // TraceSetFiltersReply defines message 'trace_set_filters_reply'.
 425 // InProgress: the message form may change in the future versions
 426 type TraceSetFiltersReply struct {
 427         Retval int32 `binapi:"i32,name=retval" json:"retval,omitempty"`
 428 }
 429
 430 func (m *TraceSetFiltersReply) Reset()               { *m = TraceSetFiltersReply{} }
 431 func (*TraceSetFiltersReply) GetMessageName() string { return "trace_set_filters_reply" }
 432 func (*TraceSetFiltersReply) GetCrcString() string   { return "e8d4e804" }
 433 func (*TraceSetFiltersReply) GetMessageType() api.MessageType {
 434         return api.ReplyMessage
 435 }
 436
 437 func (m *TraceSetFiltersReply) Size() (size int) {
 438         if m == nil {
 439                 return 0
 440         }
 441         size += 4 // m.Retval
 442         return size
 443 }
 444 func (m *TraceSetFiltersReply) Marshal(b []byte) ([]byte, error) {
 445         if b == nil {
 446                 b = make([]byte, m.Size())
 447         }
 448         buf := codec.NewBuffer(b)
 449         buf.EncodeInt32(m.Retval)
 450         return buf.Bytes(), nil
 451 }
 452 func (m *TraceSetFiltersReply) Unmarshal(b []byte) error {
 453         buf := codec.NewBuffer(b)
 454         m.Retval = buf.DecodeInt32()
 455         return nil
 456 }
 457
 458 func init() { file_tracedump_binapi_init() }
 459 func file_tracedump_binapi_init() {
 460         api.RegisterMessage((*TraceCapturePackets)(nil), "trace_capture_packets_9e791a9b")
 461         api.RegisterMessage((*TraceCapturePacketsReply)(nil), "trace_capture_packets_reply_e8d4e804")
 462         api.RegisterMessage((*TraceClearCapture)(nil), "trace_clear_capture_51077d14")
 463         api.RegisterMessage((*TraceClearCaptureReply)(nil), "trace_clear_capture_reply_e8d4e804")
 464         api.RegisterMessage((*TraceDetails)(nil), "trace_details_1553e9eb")
 465         api.RegisterMessage((*TraceDump)(nil), "trace_dump_c7d6681f")
 466         api.RegisterMessage((*TraceDumpReply)(nil), "trace_dump_reply_e0e87f9d")
 467         api.RegisterMessage((*TraceSetFilters)(nil), "trace_set_filters_f522b44a")
 468         api.RegisterMessage((*TraceSetFiltersReply)(nil), "trace_set_filters_reply_e8d4e804")
 469 }
 470
 471 // Messages returns list of all messages in this module.
 472 func AllMessages() []api.Message {
 473         return []api.Message{
 474                 (*TraceCapturePackets)(nil),
 475                 (*TraceCapturePacketsReply)(nil),
 476                 (*TraceClearCapture)(nil),
 477                 (*TraceClearCaptureReply)(nil),
 478                 (*TraceDetails)(nil),
 479                 (*TraceDump)(nil),
 480                 (*TraceDumpReply)(nil),
 481                 (*TraceSetFilters)(nil),
 482                 (*TraceSetFiltersReply)(nil),
 483         }
 484 }