]> git.saurik.com Git - apt.git/blobdiff - apt-pkg/contrib/mmap.cc
French translation *comp-ple-ted*!
[apt.git] / apt-pkg / contrib / mmap.cc
index 9febc5cdde70019bc11c2b79808d632388610445..4d5fcf71e67c5bdda2ddf504cf9c39c90d0d1ed9 100644 (file)
@@ -1,6 +1,6 @@
 // -*- mode: cpp; mode: fold -*-
 // Description                                                         /*{{{*/
-// $Id: mmap.cc,v 1.2 1998/07/04 05:57:42 jgg Exp $
+// $Id: mmap.cc,v 1.22 2001/05/27 05:19:30 jgg Exp $
 /* ######################################################################
    
    MMap Class - Provides 'real' mmap or a faked mmap using read().
    libc6 generates warnings -- which should be errors, g++ isn't properly
    strict.
    
-   The configure test notes that some OS's have broken private mmap's
-   so on those OS's we can't use mmap. This means we have to use
-   configure to test mmap and can't rely on the POSIX
-   _POSIX_MAPPED_FILES test.
-   
    ##################################################################### */
                                                                        /*}}}*/
 // Include Files                                                       /*{{{*/
 #define _BSD_SOURCE
-#include <pkglib/mmap.h>
-#include <pkglib/error.h>
+#include <apt-pkg/mmap.h>
+#include <apt-pkg/error.h>
+
+#include <apti18n.h>
 
 #include <sys/mman.h>
 #include <sys/stat.h>
-#include <sys/user.h>
 #include <unistd.h>
 #include <fcntl.h>
+#include <stdlib.h>
+
+#include <cstring>
                                                                        /*}}}*/
 
 // MMap::MMap - Constructor                                            /*{{{*/
 // ---------------------------------------------------------------------
 /* */
-MMap::MMap(File &F,unsigned long Flags) : Fd(F), Flags(Flags), iSize(0),
+MMap::MMap(FileFd &F,unsigned long Flags) : Flags(Flags), iSize(0),
                      Base(0)
 {
    if ((Flags & NoImmMap) != NoImmMap)
-      Map();
+      Map(F);
+}
+                                                                       /*}}}*/
+// MMap::MMap - Constructor                                            /*{{{*/
+// ---------------------------------------------------------------------
+/* */
+MMap::MMap(unsigned long Flags) : Flags(Flags), iSize(0),
+                     Base(0)
+{
 }
                                                                        /*}}}*/
 // MMap::~MMap - Destructor                                            /*{{{*/
@@ -47,13 +54,13 @@ MMap::MMap(File &F,unsigned long Flags) : Fd(F), Flags(Flags), iSize(0),
 /* */
 MMap::~MMap()
 {
-   Close(true);
+   Close();
 }
                                                                        /*}}}*/
 // MMap::Map - Perform the mapping                                     /*{{{*/
 // ---------------------------------------------------------------------
 /* */
-bool MMap::Map()
+bool MMap::Map(FileFd &Fd)
 {
    iSize = Fd.Size();
    
@@ -65,10 +72,13 @@ bool MMap::Map()
    if ((Flags & Public) != Public)
       Map = MAP_PRIVATE;
    
+   if (iSize == 0)
+      return _error->Error(_("Can't mmap an empty file"));
+   
    // Map it.
    Base = mmap(0,iSize,Prot,Map,Fd.Fd(),0);
    if (Base == (void *)-1)
-      return _error->Errno("mmap","Couldn't make mmap of %u bytes",iSize);
+      return _error->Errno("mmap",_("Couldn't make mmap of %lu bytes"),iSize);
 
    return true;
 }
@@ -76,30 +86,36 @@ bool MMap::Map()
 // MMap::Close - Close the map                                         /*{{{*/
 // ---------------------------------------------------------------------
 /* */
-bool MMap::Close(bool DoClose)
+bool MMap::Close(bool DoSync)
 {
-   if (Fd.IsOpen() == false)
+   if ((Flags & UnMapped) == UnMapped || Base == 0 || iSize == 0)
       return true;
-
-   Sync();
+   
+   if (DoSync == true)
+      Sync();
    
    if (munmap((char *)Base,iSize) != 0)
       _error->Warning("Unable to munmap");
    
    iSize = 0;
-   if (DoClose == true)
-      Fd.Close();
+   Base = 0;
    return true;
 }
                                                                        /*}}}*/
 // MMap::Sync - Syncronize the map with the disk                       /*{{{*/
 // ---------------------------------------------------------------------
-/* */
+/* This is done in syncronous mode - the docs indicate that this will 
+   not return till all IO is complete */
 bool MMap::Sync()
 {   
-   if ((Flags & ReadOnly) == ReadOnly)
-      if (msync((char *)Base,iSize,MS_SYNC) != 0)
-        return _error->Error("msync","Unable to write mmap");
+   if ((Flags & UnMapped) == UnMapped)
+      return true;
+   
+#ifdef _POSIX_SYNCHRONIZED_IO   
+   if ((Flags & ReadOnly) != ReadOnly)
+      if (msync((char *)Base,iSize,MS_SYNC) < 0)
+        return _error->Errno("msync","Unable to write mmap");
+#endif   
    return true;
 }
                                                                        /*}}}*/
@@ -108,9 +124,15 @@ bool MMap::Sync()
 /* */
 bool MMap::Sync(unsigned long Start,unsigned long Stop)
 {
-   if ((Flags & ReadOnly) == ReadOnly)
-      if (msync((char *)Base+(int)(Start/PAGE_SIZE)*PAGE_SIZE,Stop - Start,MS_SYNC) != 0)
-        return _error->Error("msync","Unable to write mmap");
+   if ((Flags & UnMapped) == UnMapped)
+      return true;
+   
+#ifdef _POSIX_SYNCHRONIZED_IO
+   unsigned long PSize = sysconf(_SC_PAGESIZE);
+   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   
    return true;
 }
                                                                        /*}}}*/
@@ -118,26 +140,79 @@ bool MMap::Sync(unsigned long Start,unsigned long Stop)
 // DynamicMMap::DynamicMMap - Constructor                              /*{{{*/
 // ---------------------------------------------------------------------
 /* */
-DynamicMMap::DynamicMMap(File &F,unsigned long Flags,unsigned long WorkSpace) : 
-             MMap(F,Flags | NoImmMap), WorkSpace(WorkSpace)
+DynamicMMap::DynamicMMap(FileFd &F,unsigned long Flags,unsigned long WorkSpace) :
+             MMap(F,Flags | NoImmMap), Fd(&F), WorkSpace(WorkSpace)
 {
-   unsigned long EndOfFile = Fd.Size();
-   Fd.Seek(WorkSpace);
-   char C = 0;
-   Fd.Write(&C,sizeof(C));
-   Map();
+   if (_error->PendingError() == true)
+      return;
+   
+   unsigned long EndOfFile = Fd->Size();
+   if (EndOfFile > WorkSpace)
+      WorkSpace = EndOfFile;
+   else if(WorkSpace > 0)
+   {
+      Fd->Seek(WorkSpace - 1);
+      char C = 0;
+      Fd->Write(&C,sizeof(C));
+   }
+   
+   Map(F);
    iSize = EndOfFile;
 }
                                                                        /*}}}*/
+// DynamicMMap::DynamicMMap - Constructor for a non-file backed map    /*{{{*/
+// ---------------------------------------------------------------------
+/* 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)
+{
+   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;
+
+   // 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);
+#else
+   // fallback to a static allocated space
+   Base = new unsigned char[WorkSpace];
+   memset(Base,0,WorkSpace);
+#endif
+   iSize = 0;
+}
+                                                                       /*}}}*/
 // DynamicMMap::~DynamicMMap - Destructor                              /*{{{*/
 // ---------------------------------------------------------------------
 /* We truncate the file to the size of the memory data set */
 DynamicMMap::~DynamicMMap()
 {
+   if (Fd == 0)
+   {
+#ifdef _POSIX_MAPPED_FILES
+      munmap(Base, WorkSpace);
+#else
+      delete [] (unsigned char *)Base;
+#endif
+      return;
+   }
+   
    unsigned long EndOfFile = iSize;
+   iSize = WorkSpace;
    Close(false);
-   ftruncate(Fd.Fd(),EndOfFile);
-   Fd.Close();
+   if(ftruncate(Fd->Fd(),EndOfFile) < 0)
+      _error->Errno("ftruncate", _("Failed to truncate file"));
 }  
                                                                        /*}}}*/
 // DynamicMMap::RawAllocate - Allocate a raw chunk of unaligned space  /*{{{*/
@@ -148,14 +223,18 @@ unsigned long DynamicMMap::RawAllocate(unsigned long Size,unsigned long Aln)
    unsigned long Result = iSize;
    if (Aln != 0)
       Result += Aln - (iSize%Aln);
-   
+
    iSize = Result + Size;
-   
-   // Just in case error check
-   if (Result > WorkSpace)
+
+   // try to grow the buffer
+   while(Result + Size > WorkSpace)
    {
-      _error->Error("Dynamic MMap ran out of room");
-      return 0;
+      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);
+        return 0;
+      }
    }
    return Result;
 }
@@ -165,7 +244,7 @@ unsigned long DynamicMMap::RawAllocate(unsigned long Size,unsigned long Aln)
 /* This allocates an Item of size ItemSize so that it is aligned to its
    size in the file. */
 unsigned long DynamicMMap::Allocate(unsigned long ItemSize)
-{   
+{
    // Look for a matching pool entry
    Pool *I;
    Pool *Empty = 0;
@@ -176,7 +255,6 @@ unsigned long DynamicMMap::Allocate(unsigned long ItemSize)
       if (I->ItemSize == ItemSize)
         break;
    }
-
    // No pool is allocated, use an unallocated one
    if (I == Pools + PoolCount)
    {
@@ -191,16 +269,23 @@ unsigned long DynamicMMap::Allocate(unsigned long ItemSize)
       I->ItemSize = ItemSize;
       I->Count = 0;
    }
-   
+
+   unsigned long Result = 0;
    // Out of space, allocate some more
    if (I->Count == 0)
    {
-      I->Count = 20*1024/ItemSize;
-      I->Start = RawAllocate(I->Count*ItemSize,ItemSize);
-   }   
+      const unsigned long size = 20*1024;
+      I->Count = size/ItemSize;
+      Result = RawAllocate(size,ItemSize);
+      // Does the allocation failed ?
+      if (Result == 0 && _error->PendingError())
+        return 0;
+      I->Start = Result;
+   }
+   else
+      Result = I->Start;
 
    I->Count--;
-   unsigned long Result = I->Start;
    I->Start += ItemSize;
    return Result/ItemSize;
 }
@@ -211,19 +296,45 @@ unsigned long DynamicMMap::Allocate(unsigned long ItemSize)
 unsigned long DynamicMMap::WriteString(const char *String,
                                       unsigned long Len)
 {
-   unsigned long Result = iSize;
-   // Just in case error check
-   if (Result > WorkSpace)
-   {
-      _error->Error("Dynamic MMap ran out of room");
-      return 0;
-   }   
-   
-   if (Len == 0)
+   if (Len == (unsigned long)-1)
       Len = strlen(String);
-   iSize += Len + 1;
+
+   unsigned long Result = RawAllocate(Len+1,0);
+
+   if (Result == 0 && _error->PendingError())
+      return 0;
+
    memcpy((char *)Base + Result,String,Len);
    ((char *)Base)[Result + Len] = 0;
    return Result;
 }
                                                                        /*}}}*/
+// 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()
+{
+#if defined(_POSIX_MAPPED_FILES) && defined(__linux__)
+   unsigned long newSize = WorkSpace + 1024*1024;
+
+   if(Fd != 0)
+   {
+      Fd->Seek(newSize - 1);
+      char C = 0;
+      Fd->Write(&C,sizeof(C));
+   }
+
+   Base = mremap(Base, WorkSpace, newSize, 0);
+   if(Base == MAP_FAILED)
+      return false;
+
+   WorkSpace = newSize;
+   return true;
+#else
+   return false;
+#endif
+}
+                                                                       /*}}}*/