Line data Source code
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 <vppinfra/pool.h>
45 : #include <termios.h>
46 :
47 :
48 : struct clib_file;
49 : typedef clib_error_t *(clib_file_function_t) (struct clib_file * f);
50 :
51 : typedef struct clib_file
52 : {
53 : /* Unix file descriptor from open/socket. */
54 : u32 file_descriptor;
55 :
56 : u32 flags;
57 : #define UNIX_FILE_DATA_AVAILABLE_TO_WRITE (1 << 0)
58 : #define UNIX_FILE_EVENT_EDGE_TRIGGERED (1 << 1)
59 :
60 : /* polling thread index */
61 : u32 polling_thread_index;
62 :
63 : /* Data available for function's use. */
64 : u64 private_data;
65 :
66 : /* Functions to be called when read/write data becomes ready. */
67 : clib_file_function_t *read_function, *write_function, *error_function;
68 :
69 : /* Description */
70 : u8 *description;
71 :
72 : /* Stats */
73 : u64 read_events;
74 : u64 write_events;
75 : u64 error_events;
76 : } clib_file_t;
77 :
78 : typedef enum
79 : {
80 : UNIX_FILE_UPDATE_ADD,
81 : UNIX_FILE_UPDATE_MODIFY,
82 : UNIX_FILE_UPDATE_DELETE,
83 : } clib_file_update_type_t;
84 :
85 : typedef struct
86 : {
87 : /* Pool of files to poll for input/output. */
88 : clib_file_t *file_pool;
89 :
90 : void (*file_update) (clib_file_t * file,
91 : clib_file_update_type_t update_type);
92 :
93 : } clib_file_main_t;
94 :
95 : always_inline uword
96 2929 : clib_file_add (clib_file_main_t * um, clib_file_t * template)
97 : {
98 : clib_file_t *f;
99 2929 : pool_get (um->file_pool, f);
100 2929 : f[0] = template[0];
101 2929 : f->read_events = 0;
102 2929 : f->write_events = 0;
103 2929 : f->error_events = 0;
104 2929 : um->file_update (f, UNIX_FILE_UPDATE_ADD);
105 2929 : return f - um->file_pool;
106 : }
107 :
108 : always_inline void
109 1754 : clib_file_del (clib_file_main_t * um, clib_file_t * f)
110 : {
111 1754 : um->file_update (f, UNIX_FILE_UPDATE_DELETE);
112 1754 : close (f->file_descriptor);
113 1754 : f->file_descriptor = ~0;
114 1754 : vec_free (f->description);
115 1754 : pool_put (um->file_pool, f);
116 1754 : }
117 :
118 : always_inline void
119 580 : clib_file_del_by_index (clib_file_main_t * um, uword index)
120 : {
121 : clib_file_t *uf;
122 580 : uf = pool_elt_at_index (um->file_pool, index);
123 580 : clib_file_del (um, uf);
124 580 : }
125 :
126 : always_inline void
127 566 : clib_file_set_polling_thread (clib_file_main_t * um, uword index,
128 : u32 thread_index)
129 : {
130 566 : clib_file_t *f = pool_elt_at_index (um->file_pool, index);
131 566 : um->file_update (f, UNIX_FILE_UPDATE_DELETE);
132 566 : f->polling_thread_index = thread_index;
133 566 : um->file_update (f, UNIX_FILE_UPDATE_ADD);
134 566 : }
135 :
136 : always_inline uword
137 168 : clib_file_set_data_available_to_write (clib_file_main_t * um,
138 : u32 clib_file_index,
139 : uword is_available)
140 : {
141 168 : clib_file_t *uf = pool_elt_at_index (um->file_pool, clib_file_index);
142 168 : uword was_available = (uf->flags & UNIX_FILE_DATA_AVAILABLE_TO_WRITE);
143 168 : if ((was_available != 0) != (is_available != 0))
144 : {
145 168 : uf->flags ^= UNIX_FILE_DATA_AVAILABLE_TO_WRITE;
146 168 : um->file_update (uf, UNIX_FILE_UPDATE_MODIFY);
147 : }
148 168 : return was_available != 0;
149 : }
150 :
151 : always_inline clib_file_t *
152 684104 : clib_file_get (clib_file_main_t * fm, u32 file_index)
153 : {
154 684104 : if (pool_is_free_index (fm->file_pool, file_index))
155 0 : return 0;
156 684104 : return pool_elt_at_index (fm->file_pool, file_index);
157 : }
158 :
159 : always_inline clib_error_t *
160 682857 : clib_file_write (clib_file_t * f)
161 : {
162 682857 : f->write_events++;
163 682857 : return f->write_function (f);
164 : }
165 :
166 : #endif /* included_clib_file_h */
167 :
168 : /*
169 : * fd.io coding-style-patch-verification: ON
170 : *
171 : * Local Variables:
172 : * eval: (c-set-style "gnu")
173 : * End:
174 : */
|
