make setup in travis.yml a bit more verbose

[apt.git] / apt-pkg / contrib / mmap.cc

diff --git a/apt-pkg/contrib/mmap.cc b/apt-pkg/contrib/mmap.cc
index aa52b4c3066ef923ee5c622a98f77a21c0714622..a176da6368fcb97562968775305c173b30c13c85 100644 (file)
--- a/apt-pkg/contrib/mmap.cc
+++ b/apt-pkg/contrib/mmap.cc
@@ -17,25 +17,28 @@
                                                                        /*}}}*/
 // Include Files                                                       /*{{{*/
 #define _BSD_SOURCE
                                                                        /*}}}*/
 // Include Files                                                       /*{{{*/
 #define _BSD_SOURCE

+#include <config.h>
+

 #include <apt-pkg/mmap.h>
 #include <apt-pkg/error.h>
 #include <apt-pkg/mmap.h>
 #include <apt-pkg/error.h>

-
-#include <apti18n.h>
+#include <apt-pkg/fileutl.h>

 
 #include <sys/mman.h>
 #include <sys/stat.h>
 #include <unistd.h>
 #include <fcntl.h>
 #include <stdlib.h>
 
 #include <sys/mman.h>
 #include <sys/stat.h>
 #include <unistd.h>
 #include <fcntl.h>
 #include <stdlib.h>

-
+#include <errno.h>

 #include <cstring>
 #include <cstring>

-                                                                       /*}}}*/
+
+#include <apti18n.h>
+                                                                       /*}}}*/

 
 // MMap::MMap - Constructor                                            /*{{{*/
 // ---------------------------------------------------------------------
 /* */
 MMap::MMap(FileFd &F,unsigned long Flags) : Flags(Flags), iSize(0),
 
 // MMap::MMap - Constructor                                            /*{{{*/
 // ---------------------------------------------------------------------
 /* */
 MMap::MMap(FileFd &F,unsigned long Flags) : Flags(Flags), iSize(0),

-                     Base(0)
+                     Base(0), SyncToFd(NULL)

 {
    if ((Flags & NoImmMap) != NoImmMap)
       Map(F);
 {
    if ((Flags & NoImmMap) != NoImmMap)
       Map(F);


@@ -45,7 +48,7 @@ MMap::MMap(FileFd &F,unsigned long Flags) : Flags(Flags), iSize(0),
 // ---------------------------------------------------------------------
 /* */
 MMap::MMap(unsigned long Flags) : Flags(Flags), iSize(0),
 // ---------------------------------------------------------------------
 /* */
 MMap::MMap(unsigned long Flags) : Flags(Flags), iSize(0),

-                     Base(0)
+                     Base(0), SyncToFd(NULL)

 {
 }
                                                                        /*}}}*/
 {
 }
                                                                        /*}}}*/


@@ -63,7 +66,7 @@ MMap::~MMap()
 bool MMap::Map(FileFd &Fd)
 {
    iSize = Fd.Size();
 bool MMap::Map(FileFd &Fd)
 {
    iSize = Fd.Size();

-   
+

    // Set the permissions.
    int Prot = PROT_READ;
    int Map = MAP_SHARED;
    // Set the permissions.
    int Prot = PROT_READ;
    int Map = MAP_SHARED;


@@ -74,11 +77,48 @@ bool MMap::Map(FileFd &Fd)
    
    if (iSize == 0)
       return _error->Error(_("Can't mmap an empty file"));
    
    if (iSize == 0)
       return _error->Error(_("Can't mmap an empty file"));

-   
+
+   // We can't mmap compressed fd's directly, so we need to read it completely
+   if (Fd.IsCompressed() == true)
+   {
+      if ((Flags & ReadOnly) != ReadOnly)
+        return _error->Error("Compressed file %s can only be mapped readonly", Fd.Name().c_str());
+      Base = malloc(iSize);
+      SyncToFd = new FileFd();
+      if (Fd.Seek(0L) == false || Fd.Read(Base, iSize) == false)
+        return _error->Error("Compressed file %s can't be read into mmap", Fd.Name().c_str());
+      return true;
+   }
+

    // Map it.
    // Map it.

-   Base = mmap(0,iSize,Prot,Map,Fd.Fd(),0);
+   Base = (Flags & Fallback) ? MAP_FAILED : mmap(0,iSize,Prot,Map,Fd.Fd(),0);

    if (Base == (void *)-1)
    if (Base == (void *)-1)

-      return _error->Errno("mmap",_("Couldn't make mmap of %lu bytes"),iSize);
+   {
+      if (errno == ENODEV || errno == EINVAL || (Flags & Fallback))
+      {
+        // The filesystem doesn't support this particular kind of mmap.
+        // So we allocate a buffer and read the whole file into it.
+        if ((Flags & ReadOnly) == ReadOnly)
+        {
+           // for readonly, we don't need sync, so make it simple
+           Base = malloc(iSize);
+           SyncToFd = new FileFd();
+           return Fd.Read(Base, iSize);
+        }
+        // FIXME: Writing to compressed fd's ?
+        int const dupped_fd = dup(Fd.Fd());
+        if (dupped_fd == -1)
+           return _error->Errno("mmap", _("Couldn't duplicate file descriptor %i"), Fd.Fd());
+
+        Base = calloc(iSize, 1);
+        SyncToFd = new FileFd (dupped_fd);
+        if (!SyncToFd->Seek(0L) || !SyncToFd->Read(Base, iSize))
+           return false;
+      }
+      else
+        return _error->Errno("mmap",_("Couldn't make mmap of %llu bytes"),
+                             iSize);
+     }

 
    return true;
 }
 
    return true;
 }


@@ -88,15 +128,24 @@ bool MMap::Map(FileFd &Fd)
 /* */
 bool MMap::Close(bool DoSync)
 {
 /* */
 bool MMap::Close(bool DoSync)
 {

-   if ((Flags & UnMapped) == UnMapped || Base == 0 || iSize == 0)
+   if ((Flags & UnMapped) == UnMapped || validData() == false || iSize == 0)

       return true;
    
    if (DoSync == true)
       Sync();
       return true;
    
    if (DoSync == true)
       Sync();

-   
-   if (munmap((char *)Base,iSize) != 0)
-      _error->Warning("Unable to munmap");
-   
+
+   if (SyncToFd != NULL)
+   {
+      free(Base);
+      delete SyncToFd;
+      SyncToFd = NULL;
+   }
+   else
+   {
+      if (munmap((char *)Base, iSize) != 0)
+        _error->WarningE("mmap", _("Unable to close mmap"));
+   }
+

    iSize = 0;
    Base = 0;
    return true;
    iSize = 0;
    Base = 0;
    return true;


@@ -107,15 +156,25 @@ bool MMap::Close(bool DoSync)
 /* This is done in syncronous mode - the docs indicate that this will 
    not return till all IO is complete */
 bool MMap::Sync()
 /* This is done in syncronous mode - the docs indicate that this will 
    not return till all IO is complete */
 bool MMap::Sync()

-{   
+{

    if ((Flags & UnMapped) == UnMapped)
       return true;
    if ((Flags & UnMapped) == UnMapped)
       return true;

-   
-#ifdef _POSIX_SYNCHRONIZED_IO   
+

    if ((Flags & ReadOnly) != ReadOnly)
    if ((Flags & ReadOnly) != ReadOnly)

-      if (msync((char *)Base,iSize,MS_SYNC) < 0)
-        return _error->Errno("msync","Unable to write mmap");
-#endif   
+   {
+      if (SyncToFd != NULL)
+      {
+        if (!SyncToFd->Seek(0) || !SyncToFd->Write(Base, iSize))
+           return false;
+      }
+      else
+      {
+#ifdef _POSIX_SYNCHRONIZED_IO
+        if (msync((char *)Base, iSize, MS_SYNC) < 0)
+           return _error->Errno("msync", _("Unable to synchronize mmap"));
+#endif
+      }
+   }

    return true;
 }
                                                                        /*}}}*/
    return true;
 }
                                                                        /*}}}*/


@@ -126,13 +185,24 @@ bool MMap::Sync(unsigned long Start,unsigned long Stop)
 {
    if ((Flags & UnMapped) == UnMapped)
       return true;
 {
    if ((Flags & UnMapped) == UnMapped)
       return true;

-   
-#ifdef _POSIX_SYNCHRONIZED_IO
-   unsigned long PSize = sysconf(_SC_PAGESIZE);
+

    if ((Flags & ReadOnly) != ReadOnly)
    if ((Flags & ReadOnly) != ReadOnly)

-      if (msync((char *)Base+(int)(Start/PSize)*PSize,Stop - Start,MS_SYNC) < 0)
-        return _error->Errno("msync","Unable to write mmap");
-#endif   
+   {
+      if (SyncToFd != 0)
+      {
+        if (!SyncToFd->Seek(0) ||
+            !SyncToFd->Write (((char *)Base)+Start, Stop-Start))
+           return false;
+      }
+      else
+      {
+#ifdef _POSIX_SYNCHRONIZED_IO
+        unsigned long long const PSize = sysconf(_SC_PAGESIZE);
+        if (msync((char *)Base+(unsigned long long)(Start/PSize)*PSize,Stop - Start,MS_SYNC) < 0)
+           return _error->Errno("msync", _("Unable to synchronize mmap"));
+#endif
+      }
+   }

    return true;
 }
                                                                        /*}}}*/
    return true;
 }
                                                                        /*}}}*/


@@ -140,13 +210,25 @@ bool MMap::Sync(unsigned long Start,unsigned long Stop)
 // DynamicMMap::DynamicMMap - Constructor                              /*{{{*/
 // ---------------------------------------------------------------------
 /* */
 // DynamicMMap::DynamicMMap - Constructor                              /*{{{*/
 // ---------------------------------------------------------------------
 /* */

-DynamicMMap::DynamicMMap(FileFd &F,unsigned long Flags,unsigned long WorkSpace) :
-             MMap(F,Flags | NoImmMap), Fd(&F), WorkSpace(WorkSpace)
+DynamicMMap::DynamicMMap(FileFd &F,unsigned long Flags,unsigned long const &Workspace,
+                        unsigned long const &Grow, unsigned long const &Limit) :
+               MMap(F,Flags | NoImmMap), Fd(&F), WorkSpace(Workspace),
+               GrowFactor(Grow), Limit(Limit)

 {
    if (_error->PendingError() == true)
       return;
 {
    if (_error->PendingError() == true)
       return;

-   
-   unsigned long EndOfFile = Fd->Size();
+
+   // disable Moveable if we don't grow
+   if (Grow == 0)
+      this->Flags &= ~Moveable;
+
+#ifndef __linux__
+   // kfreebsd doesn't have mremap, so we use the fallback
+   if ((this->Flags & Moveable) == Moveable)
+      this->Flags |= Fallback;
+#endif
+
+   unsigned long long EndOfFile = Fd->Size();

    if (EndOfFile > WorkSpace)
       WorkSpace = EndOfFile;
    else if(WorkSpace > 0)
    if (EndOfFile > WorkSpace)
       WorkSpace = EndOfFile;
    else if(WorkSpace > 0)


@@ -165,32 +247,55 @@ DynamicMMap::DynamicMMap(FileFd &F,unsigned long Flags,unsigned long WorkSpace)
 /* We try here to use mmap to reserve some space - this is much more
    cooler than the fallback solution to simply allocate a char array
    and could come in handy later than we are able to grow such an mmap */
 /* We try here to use mmap to reserve some space - this is much more
    cooler than the fallback solution to simply allocate a char array
    and could come in handy later than we are able to grow such an mmap */

-DynamicMMap::DynamicMMap(unsigned long Flags,unsigned long WorkSpace) :
-             MMap(Flags | NoImmMap | UnMapped), Fd(0), WorkSpace(WorkSpace)
+DynamicMMap::DynamicMMap(unsigned long Flags,unsigned long const &WorkSpace,
+                        unsigned long const &Grow, unsigned long const &Limit) :
+               MMap(Flags | NoImmMap | UnMapped), Fd(0), WorkSpace(WorkSpace),
+               GrowFactor(Grow), Limit(Limit)

 {
 {

-   if (_error->PendingError() == true)
-      return;
+       if (_error->PendingError() == true)
+               return;

 
 

-#ifdef _POSIX_MAPPED_FILES
-   // Set the permissions.
-   int Prot = PROT_READ;
-   int Map = MAP_PRIVATE | MAP_ANONYMOUS;
-   if ((Flags & ReadOnly) != ReadOnly)
-      Prot |= PROT_WRITE;
-   if ((Flags & Public) == Public)
-      Map = MAP_SHARED | MAP_ANONYMOUS;
+       // disable Moveable if we don't grow
+       if (Grow == 0)
+               this->Flags &= ~Moveable;

 
 

-   // use anonymous mmap() to get the memory
-   Base = (unsigned char*) mmap(0, WorkSpace, Prot, Map, -1, 0);
+#ifndef __linux__
+       // kfreebsd doesn't have mremap, so we use the fallback
+       if ((this->Flags & Moveable) == Moveable)
+               this->Flags |= Fallback;
+#endif

 
 

-   if(Base == MAP_FAILED)
-      _error->Errno("DynamicMMap",_("Couldn't make mmap of %lu bytes"),WorkSpace);
+#ifdef _POSIX_MAPPED_FILES
+       if ((this->Flags & Fallback) != Fallback) {
+               // Set the permissions.
+               int Prot = PROT_READ;
+#ifdef MAP_ANONYMOUS
+               int Map = MAP_PRIVATE | MAP_ANONYMOUS;

 #else
 #else

-   // fallback to a static allocated space
-   Base = new unsigned char[WorkSpace];
-   memset(Base,0,WorkSpace);
+               int Map = MAP_PRIVATE | MAP_ANON;

 #endif
 #endif

-   iSize = 0;
+               if ((this->Flags & ReadOnly) != ReadOnly)
+                       Prot |= PROT_WRITE;
+               if ((this->Flags & Public) == Public)
+#ifdef MAP_ANONYMOUS
+                       Map = MAP_SHARED | MAP_ANONYMOUS;
+#else
+                       Map = MAP_SHARED | MAP_ANON;
+#endif
+
+               // use anonymous mmap() to get the memory
+               Base = (unsigned char*) mmap(0, WorkSpace, Prot, Map, -1, 0);
+
+               if(Base == MAP_FAILED)
+                       _error->Errno("DynamicMMap",_("Couldn't make mmap of %lu bytes"),WorkSpace);
+
+               iSize = 0;
+               return;
+       }
+#endif
+       // fallback to a static allocated space
+       Base = calloc(WorkSpace, 1);
+       iSize = 0;

 }
                                                                        /*}}}*/
 // DynamicMMap::~DynamicMMap - Destructor                              /*{{{*/
 }
                                                                        /*}}}*/
 // DynamicMMap::~DynamicMMap - Destructor                              /*{{{*/


@@ -200,15 +305,17 @@ DynamicMMap::~DynamicMMap()
 {
    if (Fd == 0)
    {
 {
    if (Fd == 0)
    {

+      if (validData() == false)
+        return;

 #ifdef _POSIX_MAPPED_FILES
       munmap(Base, WorkSpace);
 #else
 #ifdef _POSIX_MAPPED_FILES
       munmap(Base, WorkSpace);
 #else

-      delete [] (unsigned char *)Base;
+      free(Base);

 #endif
       return;
    }
    
 #endif
       return;
    }
    

-   unsigned long EndOfFile = iSize;
+   unsigned long long EndOfFile = iSize;

    iSize = WorkSpace;
    Close(false);
    if(ftruncate(Fd->Fd(),EndOfFile) < 0)
    iSize = WorkSpace;
    Close(false);
    if(ftruncate(Fd->Fd(),EndOfFile) < 0)


@@ -218,9 +325,9 @@ DynamicMMap::~DynamicMMap()
 // DynamicMMap::RawAllocate - Allocate a raw chunk of unaligned space  /*{{{*/
 // ---------------------------------------------------------------------
 /* This allocates a block of memory aligned to the given size */
 // DynamicMMap::RawAllocate - Allocate a raw chunk of unaligned space  /*{{{*/
 // ---------------------------------------------------------------------
 /* This allocates a block of memory aligned to the given size */

-unsigned long DynamicMMap::RawAllocate(unsigned long Size,unsigned long Aln)
+unsigned long DynamicMMap::RawAllocate(unsigned long long Size,unsigned long Aln)

 {
 {

-   unsigned long Result = iSize;
+   unsigned long long Result = iSize;

    if (Aln != 0)
       Result += Aln - (iSize%Aln);
 
    if (Aln != 0)
       Result += Aln - (iSize%Aln);
 


@@ -231,8 +338,8 @@ unsigned long DynamicMMap::RawAllocate(unsigned long Size,unsigned long Aln)
    {
       if(!Grow())
       {
    {
       if(!Grow())
       {

-        _error->Error(_("Dynamic MMap ran out of room. Please increase the size "
-                        "of APT::Cache-Limit. Current value: %lu. (man 5 apt.conf)"), WorkSpace);
+        _error->Fatal(_("Dynamic MMap ran out of room. Please increase the size "
+                        "of APT::Cache-Start. Current value: %lu. (man 5 apt.conf)"), WorkSpace);

         return 0;
       }
    }
         return 0;
       }
    }


@@ -248,7 +355,7 @@ unsigned long DynamicMMap::Allocate(unsigned long ItemSize)
    // Look for a matching pool entry
    Pool *I;
    Pool *Empty = 0;
    // Look for a matching pool entry
    Pool *I;
    Pool *Empty = 0;

-   for (I = Pools; I != Pools + PoolCount; I++)
+   for (I = Pools; I != Pools + PoolCount; ++I)

    {
       if (I->ItemSize == 0)
         Empty = I;
    {
       if (I->ItemSize == 0)
         Empty = I;


@@ -276,7 +383,11 @@ unsigned long DynamicMMap::Allocate(unsigned long ItemSize)
    {
       const unsigned long size = 20*1024;
       I->Count = size/ItemSize;
    {
       const unsigned long size = 20*1024;
       I->Count = size/ItemSize;

+      Pool* oldPools = Pools;

       Result = RawAllocate(size,ItemSize);
       Result = RawAllocate(size,ItemSize);

+      if (Pools != oldPools)
+        I += Pools - oldPools;
+

       // Does the allocation failed ?
       if (Result == 0 && _error->PendingError())
         return 0;
       // Does the allocation failed ?
       if (Result == 0 && _error->PendingError())
         return 0;


@@ -299,7 +410,7 @@ unsigned long DynamicMMap::WriteString(const char *String,
    if (Len == (unsigned long)-1)
       Len = strlen(String);
 
    if (Len == (unsigned long)-1)
       Len = strlen(String);
 

-   unsigned long Result = RawAllocate(Len+1,0);
+   unsigned long const Result = RawAllocate(Len+1,0);

 
    if (Result == 0 && _error->PendingError())
       return 0;
 
    if (Result == 0 && _error->PendingError())
       return 0;


@@ -311,30 +422,65 @@ unsigned long DynamicMMap::WriteString(const char *String,
                                                                        /*}}}*/
 // DynamicMMap::Grow - Grow the mmap                                   /*{{{*/
 // ---------------------------------------------------------------------
                                                                        /*}}}*/
 // DynamicMMap::Grow - Grow the mmap                                   /*{{{*/
 // ---------------------------------------------------------------------

-/* This method will try to grow the mmap we currently use. This doesn't
-   work most of the time because we can't move the mmap around in the
-   memory for now as this would require to adjust quite a lot of pointers
-   but why we should not at least try to grow it before we give up? */
-bool DynamicMMap::Grow()
-{
-#ifdef _POSIX_MAPPED_FILES
-   unsigned long newSize = WorkSpace + 1024*1024;
+/* This method is a wrapper around different methods to (try to) grow
+   a mmap (or our char[]-fallback). Encounterable environments:
+   1. Moveable + !Fallback + linux -> mremap with MREMAP_MAYMOVE
+   2. Moveable + !Fallback + !linux -> not possible (forbidden by constructor)
+   3. Moveable + Fallback -> realloc
+   4. !Moveable + !Fallback + linux -> mremap alone - which will fail in 99,9%
+   5. !Moveable + !Fallback + !linux -> not possible (forbidden by constructor)
+   6. !Moveable + Fallback -> not possible
+   [ While Moveable and Fallback stands for the equally named flags and
+     "linux" indicates a linux kernel instead of a freebsd kernel. ]
+   So what you can see here is, that a MMAP which want to be growable need
+   to be moveable to have a real chance but that this method will at least try
+   the nearly impossible 4 to grow it before it finally give up: Never say never. */
+bool DynamicMMap::Grow() {
+       if (Limit != 0 && WorkSpace >= Limit)
+               return _error->Error(_("Unable to increase the size of the MMap as the "
+                                      "limit of %lu bytes is already reached."), Limit);
+       if (GrowFactor <= 0)
+               return _error->Error(_("Unable to increase size of the MMap as automatic growing is disabled by user."));

 
 

-   if(Fd != 0)
-   {
-      Fd->Seek(newSize - 1);
-      char C = 0;
-      Fd->Write(&C,sizeof(C));
-   }
+       unsigned long long const newSize = WorkSpace + GrowFactor;

 
 

-   Base = mremap(Base, WorkSpace, newSize, 0);
-   if(Base == MAP_FAILED)
-      return false;
+       if(Fd != 0) {
+               Fd->Seek(newSize - 1);
+               char C = 0;
+               Fd->Write(&C,sizeof(C));
+       }

 
 

-   WorkSpace = newSize;
-   return true;
+       unsigned long const poolOffset = Pools - ((Pool*) Base);
+
+       if ((Flags & Fallback) != Fallback) {
+#if defined(_POSIX_MAPPED_FILES) && defined(__linux__)
+   #ifdef MREMAP_MAYMOVE
+
+               if ((Flags & Moveable) == Moveable)
+                       Base = mremap(Base, WorkSpace, newSize, MREMAP_MAYMOVE);
+               else
+   #endif
+                       Base = mremap(Base, WorkSpace, newSize, 0);
+
+               if(Base == MAP_FAILED)
+                       return false;

 #else
 #else

-   return false;
+               return false;

 #endif
 #endif

+       } else {
+               if ((Flags & Moveable) != Moveable)
+                       return false;
+
+               Base = realloc(Base, newSize);
+               if (Base == NULL)
+                       return false;
+               else
+                       /* Set new memory to 0 */
+                       memset((char*)Base + WorkSpace, 0, newSize - WorkSpace);
+       }
+
+       Pools =(Pool*) Base + poolOffset;
+       WorkSpace = newSize;
+       return true;

 }
                                                                        /*}}}*/
 }
                                                                        /*}}}*/