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 CONTRIBUTORS ``AS IS'' AND ANY EXPRESS   */
  20 /*  OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED         */
  21 /*  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE    */
  22 /*  DISCLAIMED.  IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY         */
  23 /*  DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL        */
  24 /*  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS   */
  25 /*  OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)     */
  26 /*  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,       */
  27 /*  STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN  */
  28 /*  ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE           */
  29 /*  POSSIBILITY OF SUCH DAMAGE.                                               */
  30 /*                                                                            */
  31 /*   Copyright (c) 2006-2008 the Authors                                      */
  32 /*   see AUTHORS and source files for details                                 */
  33 /******************************************************************************/
  34
  35 /*
  36  * Copyright © 2008 Florent Bruneau
  37  */
  38
  39 #include <sys/mman.h>
  40 #include <sys/stat.h>
  41
  42 #include "file.h"
  43
  44 file_map_t *file_map_new(const char *file, bool memlock)
  45 {
  46     file_map_t *map = p_new(file_map_t, 1);
  47     if (!file_map_open(map, file, memlock)) {
  48         p_delete(&map);
  49         return NULL;
  50     }
  51     return map;
  52 }
  53
  54 void file_map_delete(file_map_t **map)
  55 {
  56     if (*map) {
  57         file_map_close(*map);
  58         p_delete(map);
  59     }
  60 }
  61
  62 bool file_map_open(file_map_t *map, const char *file, bool memlock)
  63 {
  64     int fd;
  65
  66     fd = open(file, O_RDONLY, 0000);
  67     if (fd < 0) {
  68         UNIXERR("open");
  69         return false;
  70     }
  71
  72     if (fstat(fd, &map->st) < 0) {
  73         UNIXERR("fstat");
  74         close(fd);
  75         return false;
  76     }
  77
  78     map->map = mmap(NULL, map->st.st_size, PROT_READ, MAP_PRIVATE, fd, 0);
  79     if (map->map == MAP_FAILED) {
  80         UNIXERR("mmap");
  81         close(fd);
  82         map->map = NULL;
  83         return false;
  84     }
  85     close(fd);
  86
  87     map->end = map->map + map->st.st_size;
  88     map->locked = memlock && mlock(map->map, map->st.st_size) == 0;
  89     return true;
  90 }
  91
  92 void file_map_close(file_map_t *map)
  93 {
  94     if (!map->map) {
  95         return;
  96     }
  97     if (map->locked) {
  98         munlock(map->map, map->end - map->map);
  99     }
 100     munmap((void*)map->map, map->end - map->map);
 101     map->map = NULL;
 102     map->end = NULL;
 103     map->locked = false;
 104 }