common/file.c

   1 /******************************************************************************/
   2 /*          pfixtools: a collection of postfix related tools                  */
   3 /*          ~~~~~~~~~                                                         */
   4 /*  ________________________________________________________________________  */
   5 /*                                                                            */
   6 /*  Redistribution and use in source and binary forms, with or without        */
   7 /*  modification, are permitted provided that the following conditions        */
   8 /*  are met:                                                                  */
   9 /*                                                                            */
  10 /*  1. Redistributions of source code must retain the above copyright         */
  11 /*     notice, this list of conditions and the following disclaimer.          */
  12 /*  2. Redistributions in binary form must reproduce the above copyright      */
  13 /*     notice, this list of conditions and the following disclaimer in the    */
  14 /*     documentation and/or other materials provided with the distribution.   */
  15 /*  3. The names of its contributors may not be used to endorse or promote    */
  16 /*     products derived from this software without specific prior written     */
  17 /*     permission.                                                            */
  18 /*                                                                            */
  19 /*  THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND   */
  20 /*  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE     */
  21 /*  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR        */
  22 /*  PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS    */
  23 /*  BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR    */
  24 /*  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF      */
  25 /*  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS  */
  26 /*  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN   */
  27 /*  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)   */
  28 /*  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF    */
  29 /*  THE POSSIBILITY OF SUCH DAMAGE.                                           */
  30 /******************************************************************************/
  31
  32 /*
  33  * Copyright © 2008 Florent Bruneau
  34  */
  35
  36 #include <sys/mman.h>
  37 #include <sys/stat.h>
  38
  39 #include "file.h"
  40
  41 file_map_t *file_map_new(const char *file, bool memlock)
  42 {
  43     file_map_t *map = p_new(file_map_t, 1);
  44     if (!file_map_open(map, file, memlock)) {
  45         p_delete(&map);
  46         return NULL;
  47     }
  48     return map;
  49 }
  50
  51 void file_map_delete(file_map_t **map)
  52 {
  53     if (*map) {
  54         file_map_close(*map);
  55         p_delete(map);
  56     }
  57 }
  58
  59 bool file_map_open(file_map_t *map, const char *file, bool memlock)
  60 {
  61     struct stat st;
  62     int fd;
  63
  64     fd = open(file, O_RDONLY, 0000);
  65     if (fd < 0) {
  66         UNIXERR("open");
  67         return false;
  68     }
  69
  70     if (fstat(fd, &st) < 0) {
  71         UNIXERR("fstat");
  72         close(fd);
  73         return false;
  74     }
  75
  76     map->map = mmap(NULL, st.st_size, PROT_READ, MAP_PRIVATE, fd, 0);
  77     if (map->map == MAP_FAILED) {
  78         UNIXERR("mmap");
  79         close(fd);
  80         map->map = NULL;
  81         return false;
  82     }
  83     close(fd);
  84
  85     map->end = map->map + st.st_size;
  86     map->locked = memlock && mlock(map->map, st.st_size) == 0;
  87     return true;
  88 }
  89
  90 void file_map_close(file_map_t *map)
  91 {
  92     if (!map->map) {
  93         return;
  94     }
  95     if (map->locked) {
  96         munlock(map->map, map->end - map->map);
  97     }
  98     munmap((void*)map->map, map->end - map->map);
  99     map->map = NULL;
 100     map->end = NULL;
 101     map->locked = false;
 102 }