FD.io VPP  v18.01.2-1-g9b554f3
Vector Packet Processing
file.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017 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.h: unix file handling
17  *
18  * Copyright (c) 2008 Eliot Dresselhaus
19  *
20  * Permission is hereby granted, free of charge, to any person obtaining
21  * a copy of this software and associated documentation files (the
22  * "Software"), to deal in the Software without restriction, including
23  * without limitation the rights to use, copy, modify, merge, publish,
24  * distribute, sublicense, and/or sell copies of the Software, and to
25  * permit persons to whom the Software is furnished to do so, subject to
26  * the following conditions:
27  *
28  * The above copyright notice and this permission notice shall be
29  * included in all copies or substantial portions of the Software.
30  *
31  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
32  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
33  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
34  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
35  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
36  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
37  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
38  */
39 
40 #ifndef included_clib_file_h
41 #define included_clib_file_h
42 
43 #include <vppinfra/socket.h>
44 #include <termios.h>
45 
46 
47 struct clib_file;
49 
50 typedef struct clib_file
51 {
52  /* Unix file descriptor from open/socket. */
54 
56 #define UNIX_FILE_DATA_AVAILABLE_TO_WRITE (1 << 0)
57 #define UNIX_FILE_EVENT_EDGE_TRIGGERED (1 << 1)
58 
59  /* Data available for function's use. */
61 
62  /* Functions to be called when read/write data becomes ready. */
64 } clib_file_t;
65 
66 typedef enum
67 {
72 
73 typedef struct
74 {
75  /* Pool of files to poll for input/output. */
77 
78  void (*file_update) (clib_file_t * file,
79  clib_file_update_type_t update_type);
80 
82 
85 {
86  clib_file_t *f;
87  pool_get (um->file_pool, f);
88  f[0] = template[0];
90  return f - um->file_pool;
91 }
92 
93 always_inline void
95 {
97  close (f->file_descriptor);
98  f->file_descriptor = ~0;
99  pool_put (um->file_pool, f);
100 }
101 
102 always_inline void
104 {
105  clib_file_t *uf;
106  uf = pool_elt_at_index (um->file_pool, index);
107  clib_file_del (um, uf);
108 }
109 
112  u32 clib_file_index,
113  uword is_available)
114 {
115  clib_file_t *uf = pool_elt_at_index (um->file_pool, clib_file_index);
116  uword was_available = (uf->flags & UNIX_FILE_DATA_AVAILABLE_TO_WRITE);
117  if ((was_available != 0) != (is_available != 0))
118  {
121  }
122  return was_available != 0;
123 }
124 
125 
126 #endif /* included_clib_file_h */
127 
128 /*
129  * fd.io coding-style-patch-verification: ON
130  *
131  * Local Variables:
132  * eval: (c-set-style "gnu")
133  * End:
134  */
static void clib_file_del(clib_file_main_t *um, clib_file_t *f)
Definition: file.h:94
struct clib_file clib_file_t
u32 file_descriptor
Definition: file.h:53
clib_error_t *( clib_file_function_t)(struct clib_file *f)
Definition: file.h:48
#define pool_get(P, E)
Allocate an object E from a pool P (unspecified alignment).
Definition: pool.h:225
static uword clib_file_set_data_available_to_write(clib_file_main_t *um, u32 clib_file_index, uword is_available)
Definition: file.h:111
clib_file_function_t * read_function
Definition: file.h:63
clib_file_t * file_pool
Definition: file.h:76
#define always_inline
Definition: clib.h:92
clib_file_update_type_t
Definition: file.h:66
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:459
#define pool_put(P, E)
Free an object E in pool P.
Definition: pool.h:271
u32 flags
Definition: file.h:55
void(* file_update)(clib_file_t *file, clib_file_update_type_t update_type)
Definition: file.h:78
unsigned int u32
Definition: types.h:88
static uword clib_file_add(clib_file_main_t *um, clib_file_t *template)
Definition: file.h:84
static void clib_file_del_by_index(clib_file_main_t *um, uword index)
Definition: file.h:103
#define UNIX_FILE_DATA_AVAILABLE_TO_WRITE
Definition: file.h:56
u64 uword
Definition: types.h:112
clib_file_function_t * error_function
Definition: file.h:63
uword private_data
Definition: file.h:60
Definition: file.h:50
clib_file_function_t * write_function
Definition: file.h:63