File: mmap.h

package info (click to toggle)
mrtrix 0.2.12-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 5,980 kB
  • ctags: 4,172
  • sloc: cpp: 26,485; python: 913; xml: 39; makefile: 22; sh: 10
file content (152 lines) | stat: -rw-r--r-- 4,658 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
/*
    Copyright 2008 Brain Research Institute, Melbourne, Australia

    Written by J-Donald Tournier, 27/06/08.

    This file is part of MRtrix.

    MRtrix is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    MRtrix is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with MRtrix.  If not, see <http://www.gnu.org/licenses/>.


    02-09-2008 J-Donald Tournier <d.tournier@brain.org.au>
    * tidied up class structure (MMap::Base is now private to MMap)

*/

#ifndef __file_mmap_h__
#define __file_mmap_h__

#include "ptr.h"

namespace MR {
  namespace File {

    class MMap {
      public:

        MMap () : base (NULL) { }
        MMap (const String& fname, gsize desired_size_if_inexistant = 0, const gchar* suffix = NULL) : base (NULL) { init (fname, desired_size_if_inexistant, suffix); }

        void              init (const String& fname, gsize desired_size_if_inexistant = 0, const gchar* suffix = NULL);
        String            name () const                     { return (base ? base->filename : ""); }
        gsize             size () const                     { return (base ? base->msize : 0); }
        void              resize (gsize  new_size);

        void              map ();
        void*             address () const                  { return (base ? base->addr : NULL); }
        void              unmap ();

        void              set_read_only (bool is_read_only);
        void              mark_for_deletion ()           { if (base) base->delete_after = true; }

        bool              is_ready () const                  { return (base ? base->msize : false); }
        bool              is_mapped () const                 { return (base ? ( base->addr != NULL ) : false); }
        bool              is_read_only () const              { return (base ? base->read_only : true); }
        bool              is_marked_for_deletion () const    { return (base ? base->delete_after : false); }

        bool              changed () const;

        friend std::ostream& operator<< (std::ostream& stream, const MMap& m)
        {
          stream << "MMap: ";
          if (!m.base) stream << "(null)";
          else stream << *m.base;
          return (stream);
        }

      private:
        class Base {
          private:
            Base () : fd (-1), addr (NULL), msize (0), read_only (true), delete_after (false), mtime (0) { }
            ~Base ();

            int               fd;
            String            filename;     /**< The name of the file. */
            void*             addr;         /**< The address in memory where the file has been mapped. */
            gsize             msize;        /**< The size of the memory-mapping, should correspond to the size of the file. */
            bool              read_only;    /**< A flag to indicate whether the file is mapped as read-only. */
            bool              delete_after;
            time_t            mtime;

            void              map ();
            void              unmap ();
            void              resize (gsize  new_size);

            friend class RefPtr<Base>;
            friend class MMap;
            friend std::ostream& operator<< (std::ostream& stream, const Base& m)
            {
              stream << "{ " << m.filename << " [" << m.fd << "] mapped at " << m.addr << ", size " << m.msize << " }";
              return (stream);
            }
        };


        RefPtr<Base>  base;
    };












    inline void MMap::set_read_only (bool is_read_only)   
    { 
      if (!base) return;
      if (base->read_only == is_read_only) return; 
      bool was_mapped = (base->addr != NULL);
      base->unmap(); 
      base->read_only = is_read_only; 
      if (was_mapped) base->map();
    }




    inline void MMap::map ()
    {
      if (!base) throw Exception ("MMap not initialised!");
      if (!base->addr) base->map();
    }



    inline void MMap::unmap ()
    {
      if (!base) throw Exception ("MMap not initialised!");
      if (base->addr) base->unmap();
    }


    inline void MMap::resize (gsize new_size)
    {
      if (!base) throw Exception ("MMap not initialised!");
      base->resize (new_size);
    }





  }
}

#endif