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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 * file.h: unix file handling
18 * Copyright (c) 2008 Eliot Dresselhaus
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:
28 * The above copyright notice and this permission notice shall be
29 * included in all copies or substantial portions of the Software.
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.
40 #ifndef included_clib_file_h
41 #define included_clib_file_h
43 #include <vppinfra/socket.h>
44 #include <vppinfra/pool.h>
49 typedef clib_error_t *(clib_file_function_t) (struct clib_file * f);
51 typedef struct clib_file
53 /* Unix file descriptor from open/socket. */
57 #define UNIX_FILE_DATA_AVAILABLE_TO_WRITE (1 << 0)
58 #define UNIX_FILE_EVENT_EDGE_TRIGGERED (1 << 1)
60 /* polling thread index */
61 u32 polling_thread_index;
63 /* Data available for function's use. */
66 /* Functions to be called when read/write data becomes ready. */
67 clib_file_function_t *read_function, *write_function, *error_function;
81 UNIX_FILE_UPDATE_MODIFY,
82 UNIX_FILE_UPDATE_DELETE,
83 } clib_file_update_type_t;
87 /* Pool of files to poll for input/output. */
88 clib_file_t *file_pool;
90 void (*file_update) (clib_file_t * file,
91 clib_file_update_type_t update_type);
96 clib_file_add (clib_file_main_t * um, clib_file_t * template)
99 pool_get (um->file_pool, f);
104 um->file_update (f, UNIX_FILE_UPDATE_ADD);
105 return f - um->file_pool;
109 clib_file_del (clib_file_main_t * um, clib_file_t * f)
111 um->file_update (f, UNIX_FILE_UPDATE_DELETE);
112 close (f->file_descriptor);
113 f->file_descriptor = ~0;
114 vec_free (f->description);
115 pool_put (um->file_pool, f);
119 clib_file_del_by_index (clib_file_main_t * um, uword index)
122 uf = pool_elt_at_index (um->file_pool, index);
123 clib_file_del (um, uf);
127 clib_file_set_polling_thread (clib_file_main_t * um, uword index,
130 clib_file_t *f = pool_elt_at_index (um->file_pool, index);
131 um->file_update (f, UNIX_FILE_UPDATE_DELETE);
132 f->polling_thread_index = thread_index;
133 um->file_update (f, UNIX_FILE_UPDATE_ADD);
137 clib_file_set_data_available_to_write (clib_file_main_t * um,
141 clib_file_t *uf = pool_elt_at_index (um->file_pool, clib_file_index);
142 uword was_available = (uf->flags & UNIX_FILE_DATA_AVAILABLE_TO_WRITE);
143 if ((was_available != 0) != (is_available != 0))
145 uf->flags ^= UNIX_FILE_DATA_AVAILABLE_TO_WRITE;
146 um->file_update (uf, UNIX_FILE_UPDATE_MODIFY);
148 return was_available != 0;
151 always_inline clib_file_t *
152 clib_file_get (clib_file_main_t * fm, u32 file_index)
154 if (pool_is_free_index (fm->file_pool, file_index))
156 return pool_elt_at_index (fm->file_pool, file_index);
159 #endif /* included_clib_file_h */
162 * fd.io coding-style-patch-verification: ON
165 * eval: (c-set-style "gnu")