Neale Ranns | 039cbfe | 2018-02-27 03:45:38 -0800 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (c) 2016 Cisco and/or its affiliates. |
| 3 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | * you may not use this file except in compliance with the License. |
| 5 | * You may obtain a copy of the License at: |
| 6 | * |
| 7 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 8 | * |
| 9 | * Unless required by applicable law or agreed to in writing, software |
| 10 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 | * See the License for the specific language governing permissions and |
| 13 | * limitations under the License. |
| 14 | */ |
| 15 | |
| 16 | /** \file |
| 17 | |
| 18 | This file defines QoS record and mark API messages which are generally |
| 19 | called through a shared memory interface. |
| 20 | */ |
| 21 | |
| 22 | option version = "1.0.0"; |
| 23 | |
| 24 | /** \brief Enable/Disable QoS recording |
| 25 | The QoS bits from the packet at the specified input layer are copied |
| 26 | into the packet. Recording should be used in conjunction with marking |
| 27 | @param sw_if_index - The interface on which recording is enabled. |
| 28 | @param enable - enable=1 or disable the feautre |
| 29 | @param input_source - The input source/layer at which the QoS bits |
| 30 | are copied from the packet. See qos_source_t. |
| 31 | */ |
| 32 | autoreply define qos_record_enable_disable |
| 33 | { |
| 34 | u32 client_index; |
| 35 | u32 context; |
| 36 | u32 sw_if_index; |
| 37 | u8 input_source; |
| 38 | u8 enable; |
| 39 | }; |
| 40 | |
| 41 | /** \brief A row within a QoS map |
| 42 | Each value translates from an input value to an output. |
| 43 | */ |
| 44 | typeonly define qos_egress_map_row |
| 45 | { |
| 46 | u8 outputs[256]; |
| 47 | }; |
| 48 | |
| 49 | /** \brief Update a QoS Map |
| 50 | A QoS map, translates from the QoS value in the packet set by the 'record' |
| 51 | feature, to the value used for output in the 'mark' feature. |
| 52 | There is one row in the map for each input/record source. |
| 53 | The MAP is then applied to the egress interface at for a given output source |
| 54 | @param map_id - client provided identifier for the map |
| 55 | @param rows - one row (per-input source) of output values |
| 56 | */ |
| 57 | autoreply define qos_egress_map_update |
| 58 | { |
| 59 | u32 client_index; |
| 60 | u32 context; |
| 61 | u32 map_id; |
| 62 | vl_api_qos_egress_map_row_t rows[4]; |
| 63 | }; |
| 64 | |
| 65 | /** \brief Delete a Qos Map |
| 66 | @param map_id - ID of the map to delete |
| 67 | */ |
| 68 | autoreply define qos_egress_map_delete |
| 69 | { |
| 70 | u32 client_index; |
| 71 | u32 context; |
| 72 | u32 map_id; |
| 73 | }; |
| 74 | |
| 75 | /** \brief Enable/Disable QoS marking |
| 76 | The QoS bits from the packet are mapped (using the desired egress map) |
| 77 | into the header of the 'output-source'. Marking should be used in |
| 78 | conjunction with recording |
| 79 | @param sw_if_index - The interface on which recording is enabled. |
| 80 | @param enable - enable=1 or disable the feautre |
| 81 | @param output_source - The output source/layer at which the QoS bits |
| 82 | are written into the packet. See qos_source_t. |
| 83 | @param map_id - The ID of the MAP in which the translation from input |
| 84 | to output is performed. |
| 85 | */ |
| 86 | autoreply define qos_mark_enable_disable |
| 87 | { |
| 88 | u32 client_index; |
| 89 | u32 context; |
| 90 | u32 map_id; |
| 91 | u32 sw_if_index; |
| 92 | u8 output_source; |
| 93 | u8 enable; |
| 94 | }; |
| 95 | |
| 96 | /* |
| 97 | * Local Variables: |
| 98 | * eval: (c-set-style "gnu") |
| 99 | * End: |
| 100 | */ |