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 autoreply 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 Delete trace Profile
  36     @param client_index - opaque cookie to identify the sender
  37     @param context - sender context, to match reply w/ request
  38 */
  39 autoreply define trace_profile_del {
  40   u32 client_index;
  41   u32 context;
  42 };
  43
  44 /** \brief Show trace Profile
  45     @param client_index - opaque cookie to identify the sender
  46     @param context - sender context, to match reply w/ request
  47 */
  48 define trace_profile_show_config {
  49   u32 client_index;
  50   u32 context;
  51 };
  52
  53 /** \brief Show trace config response
  54     @param context - sender context, to match reply w/ request
  55     @param retval - return value for request
  56     @param trace_type - Type of trace requested
  57     @param num_elts - Number of trace elements to be inserted
  58     @param node_id - Trace Node ID
  59     @param trace_tsp- Timestamp resolution
  60     @param app_data - Application specific opaque
  61 */
  62 define trace_profile_show_config_reply {
  63   u32 context;
  64   i32 retval;
  65   u8 trace_type;
  66   u8 num_elts;
  67   u8 trace_tsp;
  68   u32 node_id;
  69   u32 app_data;
  70 };