src/plugins/ioam/lib-trace/trace.api

   1 /* Hey Emacs use -*- mode: C -*- */
   2 /*
   3  * Copyright (c) 2016 Cisco and/or its affiliates.
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 option version = "1.0.0";
  18
  19 /** \brief iOAM6 Trace - Set the iOAM6 trace profile
  20     @param trace_type - Type of trace requested
  21     @param num_elts - Number of trace elements to be inserted
  22     @param node_id - Trace Node ID
  23     @param trace_tsp- Timestamp resolution
  24     @param app_data - Application specific opaque
  25 */
  26 autoreply define trace_profile_add {
  27   u32 client_index;
  28   u32 context;
  29   u8 trace_type;
  30   u8 num_elts;
  31   u8 trace_tsp;
  32   u32 node_id;
  33   u32 app_data;
  34 };
  35
  36 /** \brief Delete trace Profile
  37     @param client_index - opaque cookie to identify the sender
  38     @param context - sender context, to match reply w/ request
  39 */
  40 autoreply define trace_profile_del {
  41   u32 client_index;
  42   u32 context;
  43 };
  44
  45 /** \brief Show trace Profile
  46     @param client_index - opaque cookie to identify the sender
  47     @param context - sender context, to match reply w/ request
  48 */
  49 define trace_profile_show_config {
  50   u32 client_index;
  51   u32 context;
  52 };
  53
  54 /** \brief Show trace config response
  55     @param context - sender context, to match reply w/ request
  56     @param retval - return value for request
  57     @param trace_type - Type of trace requested
  58     @param num_elts - Number of trace elements to be inserted
  59     @param node_id - Trace Node ID
  60     @param trace_tsp- Timestamp resolution
  61     @param app_data - Application specific opaque
  62 */
  63 define trace_profile_show_config_reply {
  64   u32 context;
  65   i32 retval;
  66   u8 trace_type;
  67   u8 num_elts;
  68   u8 trace_tsp;
  69   u32 node_id;
  70   u32 app_data;
  71 };