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
  18 /** \brief iOAM6 Trace - Set the iOAM6 trace profile
  19     @param trace_type - Type of trace requested
  20     @param num_elts - Number of trace elements to be inserted
  21     @param node_id - Trace Node ID
  22     @param trace_tsp- Timestamp resolution
  23     @param app_data - Application specific opaque
  24 */
  25 define trace_profile_add {
  26   u32 client_index;
  27   u32 context;
  28   u8 trace_type;
  29   u8 num_elts;
  30   u8 trace_tsp;
  31   u32 node_id;
  32   u32 app_data;
  33 };
  34
  35 /** \brief Trace profile add / del response
  36     @param context - sender context, to match reply w/ request
  37     @param retval - return value for request
  38 */
  39 define trace_profile_add_reply {
  40     u32 context;
  41     i32 retval;
  42 };
  43
  44
  45
  46 /** \brief Delete trace Profile
  47     @param client_index - opaque cookie to identify the sender
  48     @param context - sender context, to match reply w/ request
  49 */
  50 define trace_profile_del {
  51   u32 client_index;
  52   u32 context;
  53 };
  54
  55 /** \brief Trace profile add / del response
  56     @param context - sender context, to match reply w/ request
  57     @param retval - return value for request
  58 */
  59 define trace_profile_del_reply {
  60     u32 context;
  61     i32 retval;
  62 };
  63
  64
  65
  66 /** \brief Show trace Profile
  67     @param client_index - opaque cookie to identify the sender
  68     @param context - sender context, to match reply w/ request
  69 */
  70 define trace_profile_show_config {
  71   u32 client_index;
  72   u32 context;
  73 };
  74
  75 /** \brief Show trace config response
  76     @param context - sender context, to match reply w/ request
  77     @param retval - return value for request
  78     @param trace_type - Type of trace requested
  79     @param num_elts - Number of trace elements to be inserted
  80     @param node_id - Trace Node ID
  81     @param trace_tsp- Timestamp resolution
  82     @param app_data - Application specific opaque
  83 */
  84 define trace_profile_show_config_reply {
  85   u32 context;
  86   i32 retval;
  87   u8 trace_type;
  88   u8 num_elts;
  89   u8 trace_tsp;
  90   u32 node_id;
  91   u32 app_data;
  92 };