src/vppinfra/file.h

   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   /* Data available for function's use. */
  61   uword private_data;
  62
  63   /* Functions to be called when read/write data becomes ready. */
  64   clib_file_function_t *read_function, *write_function, *error_function;
  65 } clib_file_t;
  66
  67 typedef enum
  68 {
  69   UNIX_FILE_UPDATE_ADD,
  70   UNIX_FILE_UPDATE_MODIFY,
  71   UNIX_FILE_UPDATE_DELETE,
  72 } clib_file_update_type_t;
  73
  74 typedef struct
  75 {
  76   /* Pool of files to poll for input/output. */
  77   clib_file_t *file_pool;
  78
  79   void (*file_update) (clib_file_t * file,
  80                        clib_file_update_type_t update_type);
  81
  82 } clib_file_main_t;
  83
  84 always_inline uword
  85 clib_file_add (clib_file_main_t * um, clib_file_t * template)
  86 {
  87   clib_file_t *f;
  88   pool_get (um->file_pool, f);
  89   f[0] = template[0];
  90   um->file_update (f, UNIX_FILE_UPDATE_ADD);
  91   return f - um->file_pool;
  92 }
  93
  94 always_inline void
  95 clib_file_del (clib_file_main_t * um, clib_file_t * f)
  96 {
  97   um->file_update (f, UNIX_FILE_UPDATE_DELETE);
  98   close (f->file_descriptor);
  99   f->file_descriptor = ~0;
 100   pool_put (um->file_pool, f);
 101 }
 102
 103 always_inline void
 104 clib_file_del_by_index (clib_file_main_t * um, uword index)
 105 {
 106   clib_file_t *uf;
 107   uf = pool_elt_at_index (um->file_pool, index);
 108   clib_file_del (um, uf);
 109 }
 110
 111 always_inline uword
 112 clib_file_set_data_available_to_write (clib_file_main_t * um,
 113                                        u32 clib_file_index,
 114                                        uword is_available)
 115 {
 116   clib_file_t *uf = pool_elt_at_index (um->file_pool, clib_file_index);
 117   uword was_available = (uf->flags & UNIX_FILE_DATA_AVAILABLE_TO_WRITE);
 118   if ((was_available != 0) != (is_available != 0))
 119     {
 120       uf->flags ^= UNIX_FILE_DATA_AVAILABLE_TO_WRITE;
 121       um->file_update (uf, UNIX_FILE_UPDATE_MODIFY);
 122     }
 123   return was_available != 0;
 124 }
 125
 126 always_inline clib_file_t *
 127 clib_file_get (clib_file_main_t * fm, u32 file_index)
 128 {
 129   if (pool_is_free_index (fm->file_pool, file_index))
 130     return 0;
 131   return pool_elt_at_index (fm->file_pool, file_index);
 132 }
 133
 134 #endif /* included_clib_file_h */
 135
 136 /*
 137  * fd.io coding-style-patch-verification: ON
 138  *
 139  * Local Variables:
 140  * eval: (c-set-style "gnu")
 141  * End:
 142  */