FD.io VPP  v19.04.4-rc0-5-ge88582fac
Vector Packet Processing
pipe.api
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2018 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 vpe control-plane API messages for
19  the Linux kernel PIPE device driver
20 */
21 
22 option version = "1.0.0";
23 
24 /** \brief Initialize a new pipe interface with the given paramters
25  @param client_index - opaque cookie to identify the sender
26  @param context - sender context, to match reply w/ request
27  @param is_specified - if non-0, a specific user_instance is being requested
28  @param user_instance - requested instance, ~0 => dynamically allocate
29 */
30 define pipe_create
31 {
36 };
37 
38 /** \brief Reply for pipe create reply
39  @param context - returned sender context, to match reply w/ request
40  @param retval - return code
41  @param sw_if_index - software index allocated for the new pipe parent interface
42  Use the parent interface for link up/down and to delete
43  @param pipe_sw_if_index - the two SW indicies that form the ends of the pipe.
44 */
45 define pipe_create_reply
46 {
50  u32 pipe_sw_if_index[2];
51 };
52 
53 /** \brief Delete pipe interface
54  @param client_index - opaque cookie to identify the sender
55  @param context - sender context, to match reply w/ request
56  @param sw_if_index - interface index of existing pipe interface
57 */
58 autoreply define pipe_delete
59 {
63 };
64 
65 /** \brief Dump pipe interfaces request */
66 define pipe_dump
67 {
70 };
71 
72 /** \brief Reply for pipe dump request
73  @param sw_if_index - software index of pipe interface
74  @param sw_if_index - software index allocated for the pipe parent interface
75  @param pipe_sw_if_index - the two SW indicies that form the ends of the pipe.
76  @param instance - instance allocated
77 */
78 define pipe_details
79 {
82  u32 pipe_sw_if_index[2];
84 };
85 
86 /*
87  * Local Variables:
88  * eval: (c-set-style "gnu")
89  * End:
90  */
unsigned char u8
Definition: types.h:56
unsigned int u32
Definition: types.h:88
signed int i32
Definition: types.h:77
option version
Definition: pipe.api:22