apt-pkg/contrib/mmap.cc

   1 // -*- mode: cpp; mode: fold -*-
   2 // Description                                                          /*{{{*/
   3 // $Id: mmap.cc,v 1.22 2001/05/27 05:19:30 jgg Exp $
   4 /* ######################################################################
   5
   6    MMap Class - Provides 'real' mmap or a faked mmap using read().
   7
   8    MMap cover class.
   9
  10    Some broken versions of glibc2 (libc6) have a broken definition
  11    of mmap that accepts a char * -- all other systems (and libc5) use
  12    void *. We can't safely do anything here that would be portable, so
  13    libc6 generates warnings -- which should be errors, g++ isn't properly
  14    strict.
  15
  16    ##################################################################### */
  17                                                                         /*}}}*/
  18 // Include Files                                                        /*{{{*/
  19 #define _BSD_SOURCE
  20 #include <config.h>
  21
  22 #include <apt-pkg/mmap.h>
  23 #include <apt-pkg/error.h>
  24 #include <apt-pkg/fileutl.h>
  25
  26 #include <sys/mman.h>
  27 #include <sys/stat.h>
  28 #include <unistd.h>
  29 #include <fcntl.h>
  30 #include <stdlib.h>
  31 #include <errno.h>
  32 #include <cstring>
  33
  34 #include <apti18n.h>
  35                                                                         /*}}}*/
  36
  37 // MMap::MMap - Constructor                                             /*{{{*/
  38 // ---------------------------------------------------------------------
  39 /* */
  40 MMap::MMap(FileFd &F,unsigned long Flags) : Flags(Flags), iSize(0),
  41                      Base(0), SyncToFd(NULL)
  42 {
  43    if ((Flags & NoImmMap) != NoImmMap)
  44       Map(F);
  45 }
  46                                                                         /*}}}*/
  47 // MMap::MMap - Constructor                                             /*{{{*/
  48 // ---------------------------------------------------------------------
  49 /* */
  50 MMap::MMap(unsigned long Flags) : Flags(Flags), iSize(0),
  51                      Base(0), SyncToFd(NULL)
  52 {
  53 }
  54                                                                         /*}}}*/
  55 // MMap::~MMap - Destructor                                             /*{{{*/
  56 // ---------------------------------------------------------------------
  57 /* */
  58 MMap::~MMap()
  59 {
  60    Close();
  61 }
  62                                                                         /*}}}*/
  63 // MMap::Map - Perform the mapping                                      /*{{{*/
  64 // ---------------------------------------------------------------------
  65 /* */
  66 bool MMap::Map(FileFd &Fd)
  67 {
  68    iSize = Fd.Size();
  69
  70    // Set the permissions.
  71    int Prot = PROT_READ;
  72    int Map = MAP_SHARED;
  73    if ((Flags & ReadOnly) != ReadOnly)
  74       Prot |= PROT_WRITE;
  75    if ((Flags & Public) != Public)
  76       Map = MAP_PRIVATE;
  77
  78    if (iSize == 0)
  79       return _error->Error(_("Can't mmap an empty file"));
  80
  81    // We can't mmap compressed fd's directly, so we need to read it completely
  82    if (Fd.IsCompressed() == true)
  83    {
  84       if ((Flags & ReadOnly) != ReadOnly)
  85          return _error->Error("Compressed file %s can only be mapped readonly", Fd.Name().c_str());
  86       Base = malloc(iSize);
  87       SyncToFd = new FileFd();
  88       if (Fd.Seek(0L) == false || Fd.Read(Base, iSize) == false)
  89          return _error->Error("Compressed file %s can't be read into mmap", Fd.Name().c_str());
  90       return true;
  91    }
  92
  93    // Map it.
  94    Base = (Flags & Fallback) ? MAP_FAILED : mmap(0,iSize,Prot,Map,Fd.Fd(),0);
  95    if (Base == (void *)-1)
  96    {
  97       if (errno == ENODEV || errno == EINVAL || (Flags & Fallback))
  98       {
  99          // The filesystem doesn't support this particular kind of mmap.
 100          // So we allocate a buffer and read the whole file into it.
 101          if ((Flags & ReadOnly) == ReadOnly)
 102          {
 103             // for readonly, we don't need sync, so make it simple
 104             Base = malloc(iSize);
 105             return Fd.Read(Base, iSize);
 106          }
 107          // FIXME: Writing to compressed fd's ?
 108          int const dupped_fd = dup(Fd.Fd());
 109          if (dupped_fd == -1)
 110             return _error->Errno("mmap", _("Couldn't duplicate file descriptor %i"), Fd.Fd());
 111
 112          Base = calloc(iSize, 1);
 113          SyncToFd = new FileFd (dupped_fd);
 114          if (!SyncToFd->Seek(0L) || !SyncToFd->Read(Base, iSize))
 115             return false;
 116       }
 117       else
 118          return _error->Errno("mmap",_("Couldn't make mmap of %llu bytes"),
 119                               iSize);
 120      }
 121
 122    return true;
 123 }
 124                                                                         /*}}}*/
 125 // MMap::Close - Close the map                                          /*{{{*/
 126 // ---------------------------------------------------------------------
 127 /* */
 128 bool MMap::Close(bool DoSync)
 129 {
 130    if ((Flags & UnMapped) == UnMapped || validData() == false || iSize == 0)
 131       return true;
 132
 133    if (DoSync == true)
 134       Sync();
 135
 136    if (SyncToFd != NULL)
 137    {
 138       free(Base);
 139       delete SyncToFd;
 140       SyncToFd = NULL;
 141    }
 142    else
 143    {
 144       if (munmap((char *)Base, iSize) != 0)
 145          _error->WarningE("mmap", _("Unable to close mmap"));
 146    }
 147
 148    iSize = 0;
 149    Base = 0;
 150    return true;
 151 }
 152                                                                         /*}}}*/
 153 // MMap::Sync - Syncronize the map with the disk                        /*{{{*/
 154 // ---------------------------------------------------------------------
 155 /* This is done in syncronous mode - the docs indicate that this will
 156    not return till all IO is complete */
 157 bool MMap::Sync()
 158 {
 159    if ((Flags & UnMapped) == UnMapped)
 160       return true;
 161
 162 #ifdef _POSIX_SYNCHRONIZED_IO
 163    if ((Flags & ReadOnly) != ReadOnly)
 164    {
 165       if (SyncToFd != NULL)
 166       {
 167          if (!SyncToFd->Seek(0) || !SyncToFd->Write(Base, iSize))
 168             return false;
 169       }
 170       else
 171       {
 172          if (msync((char *)Base, iSize, MS_SYNC) < 0)
 173             return _error->Errno("msync", _("Unable to synchronize mmap"));
 174       }
 175    }
 176 #endif
 177    return true;
 178 }
 179                                                                         /*}}}*/
 180 // MMap::Sync - Syncronize a section of the file to disk                /*{{{*/
 181 // ---------------------------------------------------------------------
 182 /* */
 183 bool MMap::Sync(unsigned long Start,unsigned long Stop)
 184 {
 185    if ((Flags & UnMapped) == UnMapped)
 186       return true;
 187
 188 #ifdef _POSIX_SYNCHRONIZED_IO
 189    unsigned long long PSize = sysconf(_SC_PAGESIZE);
 190    if ((Flags & ReadOnly) != ReadOnly)
 191    {
 192       if (SyncToFd != 0)
 193       {
 194          if (!SyncToFd->Seek(0) ||
 195              !SyncToFd->Write (((char *)Base)+Start, Stop-Start))
 196             return false;
 197       }
 198       else
 199       {
 200          if (msync((char *)Base+(unsigned long long)(Start/PSize)*PSize,Stop - Start,MS_SYNC) < 0)
 201             return _error->Errno("msync", _("Unable to synchronize mmap"));
 202       }
 203    }
 204 #endif
 205    return true;
 206 }
 207                                                                         /*}}}*/
 208
 209 // DynamicMMap::DynamicMMap - Constructor                               /*{{{*/
 210 // ---------------------------------------------------------------------
 211 /* */
 212 DynamicMMap::DynamicMMap(FileFd &F,unsigned long Flags,unsigned long const &Workspace,
 213                          unsigned long const &Grow, unsigned long const &Limit) :
 214                 MMap(F,Flags | NoImmMap), Fd(&F), WorkSpace(Workspace),
 215                 GrowFactor(Grow), Limit(Limit)
 216 {
 217    if (_error->PendingError() == true)
 218       return;
 219
 220    // disable Moveable if we don't grow
 221    if (Grow == 0)
 222       this->Flags &= ~Moveable;
 223
 224 #ifndef __linux__
 225    // kfreebsd doesn't have mremap, so we use the fallback
 226    if ((this->Flags & Moveable) == Moveable)
 227       this->Flags |= Fallback;
 228 #endif
 229
 230    unsigned long long EndOfFile = Fd->Size();
 231    if (EndOfFile > WorkSpace)
 232       WorkSpace = EndOfFile;
 233    else if(WorkSpace > 0)
 234    {
 235       Fd->Seek(WorkSpace - 1);
 236       char C = 0;
 237       Fd->Write(&C,sizeof(C));
 238    }
 239
 240    Map(F);
 241    iSize = EndOfFile;
 242 }
 243                                                                         /*}}}*/
 244 // DynamicMMap::DynamicMMap - Constructor for a non-file backed map     /*{{{*/
 245 // ---------------------------------------------------------------------
 246 /* We try here to use mmap to reserve some space - this is much more
 247    cooler than the fallback solution to simply allocate a char array
 248    and could come in handy later than we are able to grow such an mmap */
 249 DynamicMMap::DynamicMMap(unsigned long Flags,unsigned long const &WorkSpace,
 250                          unsigned long const &Grow, unsigned long const &Limit) :
 251                 MMap(Flags | NoImmMap | UnMapped), Fd(0), WorkSpace(WorkSpace),
 252                 GrowFactor(Grow), Limit(Limit)
 253 {
 254         if (_error->PendingError() == true)
 255                 return;
 256
 257         // disable Moveable if we don't grow
 258         if (Grow == 0)
 259                 this->Flags &= ~Moveable;
 260
 261 #ifndef __linux__
 262         // kfreebsd doesn't have mremap, so we use the fallback
 263         if ((this->Flags & Moveable) == Moveable)
 264                 this->Flags |= Fallback;
 265 #endif
 266
 267 #ifdef _POSIX_MAPPED_FILES
 268         if ((this->Flags & Fallback) != Fallback) {
 269                 // Set the permissions.
 270                 int Prot = PROT_READ;
 271 #ifdef MAP_ANONYMOUS
 272                 int Map = MAP_PRIVATE | MAP_ANONYMOUS;
 273 #else
 274                 int Map = MAP_PRIVATE | MAP_ANON;
 275 #endif
 276                 if ((this->Flags & ReadOnly) != ReadOnly)
 277                         Prot |= PROT_WRITE;
 278                 if ((this->Flags & Public) == Public)
 279 #ifdef MAP_ANONYMOUS
 280                         Map = MAP_SHARED | MAP_ANONYMOUS;
 281 #else
 282                         Map = MAP_SHARED | MAP_ANON;
 283 #endif
 284
 285                 // use anonymous mmap() to get the memory
 286                 Base = (unsigned char*) mmap(0, WorkSpace, Prot, Map, -1, 0);
 287
 288                 if(Base == MAP_FAILED)
 289                         _error->Errno("DynamicMMap",_("Couldn't make mmap of %lu bytes"),WorkSpace);
 290
 291                 iSize = 0;
 292                 return;
 293         }
 294 #endif
 295         // fallback to a static allocated space
 296         Base = calloc(WorkSpace, 1);
 297         iSize = 0;
 298 }
 299                                                                         /*}}}*/
 300 // DynamicMMap::~DynamicMMap - Destructor                               /*{{{*/
 301 // ---------------------------------------------------------------------
 302 /* We truncate the file to the size of the memory data set */
 303 DynamicMMap::~DynamicMMap()
 304 {
 305    if (Fd == 0)
 306    {
 307       if (validData() == false)
 308          return;
 309 #ifdef _POSIX_MAPPED_FILES
 310       munmap(Base, WorkSpace);
 311 #else
 312       free(Base);
 313 #endif
 314       return;
 315    }
 316
 317    unsigned long long EndOfFile = iSize;
 318    iSize = WorkSpace;
 319    Close(false);
 320    if(ftruncate(Fd->Fd(),EndOfFile) < 0)
 321       _error->Errno("ftruncate", _("Failed to truncate file"));
 322 }
 323                                                                         /*}}}*/
 324 // DynamicMMap::RawAllocate - Allocate a raw chunk of unaligned space   /*{{{*/
 325 // ---------------------------------------------------------------------
 326 /* This allocates a block of memory aligned to the given size */
 327 unsigned long DynamicMMap::RawAllocate(unsigned long long Size,unsigned long Aln)
 328 {
 329    unsigned long long Result = iSize;
 330    if (Aln != 0)
 331       Result += Aln - (iSize%Aln);
 332
 333    iSize = Result + Size;
 334
 335    // try to grow the buffer
 336    while(Result + Size > WorkSpace)
 337    {
 338       if(!Grow())
 339       {
 340          _error->Fatal(_("Dynamic MMap ran out of room. Please increase the size "
 341                          "of APT::Cache-Start. Current value: %lu. (man 5 apt.conf)"), WorkSpace);
 342          return 0;
 343       }
 344    }
 345    return Result;
 346 }
 347                                                                         /*}}}*/
 348 // DynamicMMap::Allocate - Pooled aligned allocation                    /*{{{*/
 349 // ---------------------------------------------------------------------
 350 /* This allocates an Item of size ItemSize so that it is aligned to its
 351    size in the file. */
 352 unsigned long DynamicMMap::Allocate(unsigned long ItemSize)
 353 {
 354    // Look for a matching pool entry
 355    Pool *I;
 356    Pool *Empty = 0;
 357    for (I = Pools; I != Pools + PoolCount; ++I)
 358    {
 359       if (I->ItemSize == 0)
 360          Empty = I;
 361       if (I->ItemSize == ItemSize)
 362          break;
 363    }
 364    // No pool is allocated, use an unallocated one
 365    if (I == Pools + PoolCount)
 366    {
 367       // Woops, we ran out, the calling code should allocate more.
 368       if (Empty == 0)
 369       {
 370          _error->Error("Ran out of allocation pools");
 371          return 0;
 372       }
 373
 374       I = Empty;
 375       I->ItemSize = ItemSize;
 376       I->Count = 0;
 377    }
 378
 379    unsigned long Result = 0;
 380    // Out of space, allocate some more
 381    if (I->Count == 0)
 382    {
 383       const unsigned long size = 20*1024;
 384       I->Count = size/ItemSize;
 385       Pool* oldPools = Pools;
 386       Result = RawAllocate(size,ItemSize);
 387       if (Pools != oldPools)
 388          I += Pools - oldPools;
 389
 390       // Does the allocation failed ?
 391       if (Result == 0 && _error->PendingError())
 392          return 0;
 393       I->Start = Result;
 394    }
 395    else
 396       Result = I->Start;
 397
 398    I->Count--;
 399    I->Start += ItemSize;
 400    return Result/ItemSize;
 401 }
 402                                                                         /*}}}*/
 403 // DynamicMMap::WriteString - Write a string to the file                /*{{{*/
 404 // ---------------------------------------------------------------------
 405 /* Strings are not aligned to anything */
 406 unsigned long DynamicMMap::WriteString(const char *String,
 407                                        unsigned long Len)
 408 {
 409    if (Len == (unsigned long)-1)
 410       Len = strlen(String);
 411
 412    unsigned long const Result = RawAllocate(Len+1,0);
 413
 414    if (Result == 0 && _error->PendingError())
 415       return 0;
 416
 417    memcpy((char *)Base + Result,String,Len);
 418    ((char *)Base)[Result + Len] = 0;
 419    return Result;
 420 }
 421                                                                         /*}}}*/
 422 // DynamicMMap::Grow - Grow the mmap                                    /*{{{*/
 423 // ---------------------------------------------------------------------
 424 /* This method is a wrapper around different methods to (try to) grow
 425    a mmap (or our char[]-fallback). Encounterable environments:
 426    1. Moveable + !Fallback + linux -> mremap with MREMAP_MAYMOVE
 427    2. Moveable + !Fallback + !linux -> not possible (forbidden by constructor)
 428    3. Moveable + Fallback -> realloc
 429    4. !Moveable + !Fallback + linux -> mremap alone - which will fail in 99,9%
 430    5. !Moveable + !Fallback + !linux -> not possible (forbidden by constructor)
 431    6. !Moveable + Fallback -> not possible
 432    [ While Moveable and Fallback stands for the equally named flags and
 433      "linux" indicates a linux kernel instead of a freebsd kernel. ]
 434    So what you can see here is, that a MMAP which want to be growable need
 435    to be moveable to have a real chance but that this method will at least try
 436    the nearly impossible 4 to grow it before it finally give up: Never say never. */
 437 bool DynamicMMap::Grow() {
 438         if (Limit != 0 && WorkSpace >= Limit)
 439                 return _error->Error(_("Unable to increase the size of the MMap as the "
 440                                        "limit of %lu bytes is already reached."), Limit);
 441         if (GrowFactor <= 0)
 442                 return _error->Error(_("Unable to increase size of the MMap as automatic growing is disabled by user."));
 443
 444         unsigned long long const newSize = WorkSpace + GrowFactor;
 445
 446         if(Fd != 0) {
 447                 Fd->Seek(newSize - 1);
 448                 char C = 0;
 449                 Fd->Write(&C,sizeof(C));
 450         }
 451
 452         unsigned long const poolOffset = Pools - ((Pool*) Base);
 453
 454         if ((Flags & Fallback) != Fallback) {
 455 #if defined(_POSIX_MAPPED_FILES) && defined(__linux__)
 456    #ifdef MREMAP_MAYMOVE
 457
 458                 if ((Flags & Moveable) == Moveable)
 459                         Base = mremap(Base, WorkSpace, newSize, MREMAP_MAYMOVE);
 460                 else
 461    #endif
 462                         Base = mremap(Base, WorkSpace, newSize, 0);
 463
 464                 if(Base == MAP_FAILED)
 465                         return false;
 466 #else
 467                 return false;
 468 #endif
 469         } else {
 470                 if ((Flags & Moveable) != Moveable)
 471                         return false;
 472
 473                 Base = realloc(Base, newSize);
 474                 if (Base == NULL)
 475                         return false;
 476                 else
 477                         /* Set new memory to 0 */
 478                         memset((char*)Base + WorkSpace, 0, newSize - WorkSpace);
 479         }
 480
 481         Pools =(Pool*) Base + poolOffset;
 482         WorkSpace = newSize;
 483         return true;
 484 }
 485                                                                         /*}}}*/