FD.io VPP  v17.01-9-ge7dcee4
Vector Packet Processing
unix-misc.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015 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  Copyright (c) 2005 Eliot Dresselhaus
17 
18  Permission is hereby granted, free of charge, to any person obtaining
19  a copy of this software and associated documentation files (the
20  "Software"), to deal in the Software without restriction, including
21  without limitation the rights to use, copy, modify, merge, publish,
22  distribute, sublicense, and/or sell copies of the Software, and to
23  permit persons to whom the Software is furnished to do so, subject to
24  the following conditions:
25 
26  The above copyright notice and this permission notice shall be
27  included in all copies or substantial portions of the Software.
28 
29  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
30  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
31  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
32  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
33  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
34  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
35  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
36 */
37 
38 #include <vppinfra/error.h>
39 #include <vppinfra/os.h>
40 #include <vppinfra/unix.h>
41 
42 #include <sys/stat.h>
43 #include <sys/types.h>
44 #include <sys/uio.h> /* writev */
45 #include <fcntl.h>
46 #include <stdio.h> /* for sprintf */
47 
49 unix_file_n_bytes (char *file, uword * result)
50 {
51  struct stat s;
52 
53  if (stat (file, &s) < 0)
54  return clib_error_return_unix (0, "stat `%s'", file);
55 
56  if (S_ISREG (s.st_mode))
57  *result = s.st_size;
58  else
59  *result = 0;
60 
61  return /* no error */ 0;
62 }
63 
65 unix_file_read_contents (char *file, u8 * result, uword n_bytes)
66 {
67  int fd = -1;
68  uword n_done, n_left;
69  clib_error_t *error = 0;
70  u8 *v = result;
71 
72  if ((fd = open (file, 0)) < 0)
73  return clib_error_return_unix (0, "open `%s'", file);
74 
75  n_left = n_bytes;
76  n_done = 0;
77  while (n_left > 0)
78  {
79  int n_read;
80  if ((n_read = read (fd, v + n_done, n_left)) < 0)
81  {
82  error = clib_error_return_unix (0, "open `%s'", file);
83  goto done;
84  }
85 
86  /* End of file. */
87  if (n_read == 0)
88  break;
89 
90  n_left -= n_read;
91  n_done += n_read;
92  }
93 
94  if (n_left > 0)
95  {
96  error =
98  " `%s' expected to read %wd bytes; read only %wd",
99  file, n_bytes, n_bytes - n_left);
100  goto done;
101  }
102 
103 done:
104  close (fd);
105  return error;
106 }
107 
108 clib_error_t *
109 unix_file_contents (char *file, u8 ** result)
110 {
111  uword n_bytes;
112  clib_error_t *error = 0;
113  u8 *v;
114 
115  if ((error = unix_file_n_bytes (file, &n_bytes)))
116  return error;
117 
118  v = 0;
119  vec_resize (v, n_bytes);
120 
121  error = unix_file_read_contents (file, v, n_bytes);
122 
123  if (error)
124  vec_free (v);
125  else
126  *result = v;
127 
128  return error;
129 }
130 
131 clib_error_t *
132 unix_proc_file_contents (char *file, u8 ** result)
133 {
134  u8 *rv = 0;
135  uword pos;
136  int bytes, fd;
137 
138  /* Unfortunately, stat(/proc/XXX) returns zero... */
139  fd = open (file, O_RDONLY);
140 
141  if (fd < 0)
142  return clib_error_return_unix (0, "open `%s'", file);
143 
144  vec_validate (rv, 4095);
145  pos = 0;
146  while (1)
147  {
148  bytes = read (fd, rv + pos, 4096);
149  if (bytes < 0)
150  {
151  close (fd);
152  vec_free (rv);
153  return clib_error_return_unix (0, "read '%s'", file);
154  }
155 
156  if (bytes == 0)
157  {
158  _vec_len (rv) = pos;
159  break;
160  }
161  pos += bytes;
162  vec_validate (rv, pos + 4095);
163  }
164  *result = rv;
165  close (fd);
166  return 0;
167 }
168 
169 void os_panic (void) __attribute__ ((weak));
170 
171 void
172 os_panic (void)
173 {
174  abort ();
175 }
176 
177 void os_exit (int) __attribute__ ((weak));
178 
179 void
180 os_exit (int code)
181 {
182  exit (code);
183 }
184 
185 void os_puts (u8 * string, uword string_length, uword is_error)
186  __attribute__ ((weak));
187 
188 void
189 os_puts (u8 * string, uword string_length, uword is_error)
190 {
191  int cpu = os_get_cpu_number ();
192  int ncpus = os_get_ncpus ();
193  char buf[64];
194  int fd = is_error ? 2 : 1;
195  struct iovec iovs[2];
196  int n_iovs = 0;
197 
198  if (ncpus > 1)
199  {
200  snprintf (buf, sizeof (buf), "%d: ", cpu);
201 
202  iovs[n_iovs].iov_base = buf;
203  iovs[n_iovs].iov_len = strlen (buf);
204  n_iovs++;
205  }
206 
207  iovs[n_iovs].iov_base = string;
208  iovs[n_iovs].iov_len = string_length;
209  n_iovs++;
210 
211  if (writev (fd, iovs, n_iovs) < 0)
212  ;
213 }
214 
215 void os_out_of_memory (void) __attribute__ ((weak));
216 void
218 {
219  os_panic ();
220 }
221 
222 uword os_get_cpu_number (void) __attribute__ ((weak));
223 uword
225 {
226  return 0;
227 }
228 
229 uword os_get_ncpus (void) __attribute__ ((weak));
230 uword
232 {
233  return 1;
234 }
235 
236 /*
237  * fd.io coding-style-patch-verification: ON
238  *
239  * Local Variables:
240  * eval: (c-set-style "gnu")
241  * End:
242  */
#define vec_validate(V, I)
Make sure vector is long enough for given index (no header, unspecified alignment) ...
Definition: vec.h:396
clib_error_t * unix_file_n_bytes(char *file, uword *result)
Definition: unix-misc.c:49
uword os_get_ncpus(void)
Definition: unix-misc.c:231
#define vec_resize(V, N)
Resize a vector (no header, unspecified alignment) Add N elements to end of given vector V...
Definition: vec.h:201
void os_exit(int)
Definition: unix-misc.c:180
#define v
Definition: acl.c:314
#define clib_error_return_unix(e, args...)
Definition: error.h:114
#define vec_free(V)
Free vector&#39;s memory (no header).
Definition: vec.h:300
uword os_get_cpu_number(void)
Definition: unix-misc.c:224
clib_error_t * unix_file_contents(char *file, u8 **result)
Definition: unix-misc.c:109
void os_puts(u8 *string, uword string_length, uword is_error)
Definition: unix-misc.c:189
u64 uword
Definition: types.h:112
clib_error_t * unix_file_read_contents(char *file, u8 *result, uword n_bytes)
Definition: unix-misc.c:65
unsigned char u8
Definition: types.h:56
clib_error_t * unix_proc_file_contents(char *file, u8 **result)
Definition: unix-misc.c:132
#define clib_error_return(e, args...)
Definition: error.h:111
void os_panic(void)
Definition: unix-misc.c:172
void os_out_of_memory(void)
Definition: unix-misc.c:217