Re-organize the Trace::File code.
authorJosé Fonseca <jose.r.fonseca@gmail.com>
Wed, 26 Oct 2011 22:37:01 +0000 (23:37 +0100)
committerJosé Fonseca <jose.r.fonseca@gmail.com>
Wed, 26 Oct 2011 22:37:01 +0000 (23:37 +0100)
This should allow stop linking the zlib code from the wrappers.

CMakeLists.txt
common/trace_file.cpp
common/trace_file.hpp
common/trace_file_snappy.cpp [moved from common/trace_snappyfile.cpp with 81% similarity]
common/trace_file_zlib.cpp [new file with mode: 0644]
common/trace_parser.cpp
common/trace_snappyfile.hpp [deleted file]
common/trace_writer.cpp

index db3d9ab..3499fe4 100755 (executable)
@@ -208,7 +208,8 @@ endif ()
 
 add_library (common STATIC
     common/trace_file.cpp
-    common/trace_snappyfile.cpp
+    common/trace_file_zlib.cpp
+    common/trace_file_snappy.cpp
     common/trace_model.cpp
     common/trace_parser.cpp
     common/trace_writer.cpp
index 8eb3bd4..93c1fb2 100644 (file)
@@ -26,8 +26,6 @@
 
 #include "trace_file.hpp"
 
-#include "trace_snappyfile.hpp"
-
 #include <assert.h>
 #include <string.h>
 
@@ -62,112 +60,3 @@ void File::setCurrentOffset(const File::Offset &offset)
     assert(0);
 }
 
-bool File::isZLibCompressed(const std::string &filename)
-{
-    std::fstream stream(filename.c_str(),
-                        std::fstream::binary | std::fstream::in);
-    if (!stream.is_open())
-        return false;
-
-    unsigned char byte1, byte2;
-    stream >> byte1;
-    stream >> byte2;
-    stream.close();
-
-    return (byte1 == 0x1f && byte2 == 0x8b);
-}
-
-
-bool File::isSnappyCompressed(const std::string &filename)
-{
-    std::fstream stream(filename.c_str(),
-                        std::fstream::binary | std::fstream::in);
-    if (!stream.is_open())
-        return false;
-
-    unsigned char byte1, byte2;
-    stream >> byte1;
-    stream >> byte2;
-    stream.close();
-
-    return (byte1 == SNAPPY_BYTE1 && byte2 == SNAPPY_BYTE2);
-}
-
-ZLibFile::ZLibFile(const std::string &filename,
-                   File::Mode mode)
-    : File(filename, mode),
-      m_gzFile(NULL)
-{
-}
-
-ZLibFile::~ZLibFile()
-{
-}
-
-bool ZLibFile::rawOpen(const std::string &filename, File::Mode mode)
-{
-    m_gzFile = gzopen(filename.c_str(),
-                      (mode == File::Write) ? "wb" : "rb");
-
-    if (mode == File::Read && m_gzFile) {
-        //XXX: unfortunately zlib doesn't support
-        //     SEEK_END or we could've done:
-        //m_endOffset = gzseek(m_gzFile, 0, SEEK_END);
-        //gzrewind(m_gzFile);
-        gz_state *state = (gz_state *)m_gzFile;
-        off_t loc = lseek(state->fd, 0, SEEK_CUR);
-        m_endOffset = lseek(state->fd, 0, SEEK_END);
-        lseek(state->fd, loc, SEEK_SET);
-    }
-
-    return m_gzFile != NULL;
-}
-
-bool ZLibFile::rawWrite(const void *buffer, size_t length)
-{
-    return gzwrite(m_gzFile, buffer, length) != -1;
-}
-
-bool ZLibFile::rawRead(void *buffer, size_t length)
-{
-    return gzread(m_gzFile, buffer, length) != -1;
-}
-
-int ZLibFile::rawGetc()
-{
-    return gzgetc(m_gzFile);
-}
-
-void ZLibFile::rawClose()
-{
-    if (m_gzFile) {
-        gzclose(m_gzFile);
-        m_gzFile = NULL;
-    }
-}
-
-void ZLibFile::rawFlush()
-{
-    gzflush(m_gzFile, Z_SYNC_FLUSH);
-}
-
-File::Offset ZLibFile::currentOffset()
-{
-    return File::Offset(gztell(m_gzFile));
-}
-
-bool ZLibFile::supportsOffsets() const
-{
-    return false;
-}
-
-bool ZLibFile::rawSkip(size_t)
-{
-    return false;
-}
-
-int ZLibFile::rawPercentRead()
-{
-    gz_state *state = (gz_state *)m_gzFile;
-    return 100 * (lseek(state->fd, 0, SEEK_CUR) / m_endOffset);
-}
index 4b1b70d..0105a2a 100644 (file)
@@ -51,6 +51,8 @@ public:
 public:
     static bool isZLibCompressed(const std::string &filename);
     static bool isSnappyCompressed(const std::string &filename);
+    static File *createZLib(void);
+    static File *createSnappy(void);
 public:
     File(const std::string &filename = std::string(),
          File::Mode mode = File::Read);
@@ -162,28 +164,6 @@ inline bool File::skip(size_t length)
     return rawSkip(length);
 }
 
-class ZLibFile : public File {
-public:
-    ZLibFile(const std::string &filename = std::string(),
-             File::Mode mode = File::Read);
-    virtual ~ZLibFile();
-
-
-    virtual bool supportsOffsets() const;
-    virtual File::Offset currentOffset();
-protected:
-    virtual bool rawOpen(const std::string &filename, File::Mode mode);
-    virtual bool rawWrite(const void *buffer, size_t length);
-    virtual bool rawRead(void *buffer, size_t length);
-    virtual int rawGetc();
-    virtual void rawClose();
-    virtual void rawFlush();
-    virtual bool rawSkip(size_t length);
-    virtual int  rawPercentRead();
-private:
-    void *m_gzFile;
-    double m_endOffset;
-};
 
 inline bool
 operator<(const File::Offset &one, const File::Offset &two)
similarity index 81%
rename from common/trace_snappyfile.cpp
rename to common/trace_file_snappy.cpp
index 60711d2..60f003b 100644 (file)
  **************************************************************************/
 
 
-#include "trace_snappyfile.hpp"
-
-#include <snappy.h>
-
-#include <iostream>
-
-#include <assert.h>
-#include <string.h>
-
-using namespace Trace;
-
 /*
  * Snappy file format.
  * -------------------
@@ -61,6 +50,81 @@ using namespace Trace;
  *
  */
 
+
+#include <snappy.h>
+
+#include <iostream>
+
+#include <assert.h>
+#include <string.h>
+
+#include "trace_file.hpp"
+
+
+#define SNAPPY_CHUNK_SIZE (1 * 1024 * 1024)
+
+#define SNAPPY_BYTE1 'a'
+#define SNAPPY_BYTE2 't'
+
+
+using namespace Trace;
+
+
+class SnappyFile : public File {
+public:
+    SnappyFile(const std::string &filename = std::string(),
+               File::Mode mode = File::Read);
+    virtual ~SnappyFile();
+
+    virtual bool supportsOffsets() const;
+    virtual File::Offset currentOffset();
+    virtual void setCurrentOffset(const File::Offset &offset);
+protected:
+    virtual bool rawOpen(const std::string &filename, File::Mode mode);
+    virtual bool rawWrite(const void *buffer, size_t length);
+    virtual bool rawRead(void *buffer, size_t length);
+    virtual int rawGetc();
+    virtual void rawClose();
+    virtual void rawFlush();
+    virtual bool rawSkip(size_t length);
+    virtual int rawPercentRead();
+
+private:
+    inline size_t usedCacheSize() const
+    {
+        assert(m_cachePtr >= m_cache);
+        return m_cachePtr - m_cache;
+    }
+    inline size_t freeCacheSize() const
+    {
+        assert(m_cacheSize >= usedCacheSize());
+        if (m_cacheSize > 0) {
+            return m_cacheSize - usedCacheSize();
+        } else {
+            return 0;
+        }
+    }
+    inline bool endOfData() const
+    {
+        return m_stream.eof() && freeCacheSize() == 0;
+    }
+    void flushWriteCache();
+    void flushReadCache(size_t skipLength = 0);
+    void createCache(size_t size);
+    void writeCompressedLength(size_t length);
+    size_t readCompressedLength();
+private:
+    std::fstream m_stream;
+    char *m_cache;
+    char *m_cachePtr;
+    size_t m_cacheSize;
+
+    char *m_compressedCache;
+
+    File::Offset m_currentOffset;
+    std::streampos m_endPos;
+};
+
 SnappyFile::SnappyFile(const std::string &filename,
                               File::Mode mode)
     : File(),
@@ -336,3 +400,23 @@ int SnappyFile::rawPercentRead()
 {
     return 100 * (double(m_stream.tellg()) / double(m_endPos));
 }
+
+
+File* File::createSnappy(void) {
+    return new SnappyFile;
+}
+
+bool File::isSnappyCompressed(const std::string &filename)
+{
+    std::fstream stream(filename.c_str(),
+                        std::fstream::binary | std::fstream::in);
+    if (!stream.is_open())
+        return false;
+
+    unsigned char byte1, byte2;
+    stream >> byte1;
+    stream >> byte2;
+    stream.close();
+
+    return (byte1 == SNAPPY_BYTE1 && byte2 == SNAPPY_BYTE2);
+}
diff --git a/common/trace_file_zlib.cpp b/common/trace_file_zlib.cpp
new file mode 100644 (file)
index 0000000..6982c1e
--- /dev/null
@@ -0,0 +1,165 @@
+/**************************************************************************
+ *
+ * Copyright 2011 Zack Rusin
+ * All Rights Reserved.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ *
+ **************************************************************************/
+
+
+#include "trace_file.hpp"
+
+
+#include <assert.h>
+#include <string.h>
+
+#include <zlib.h>
+#include <gzguts.h>
+
+#include "os.hpp"
+
+#include <iostream>
+
+
+using namespace Trace;
+
+
+class ZLibFile : public File {
+public:
+    ZLibFile(const std::string &filename = std::string(),
+             File::Mode mode = File::Read);
+    virtual ~ZLibFile();
+
+
+    virtual bool supportsOffsets() const;
+    virtual File::Offset currentOffset();
+protected:
+    virtual bool rawOpen(const std::string &filename, File::Mode mode);
+    virtual bool rawWrite(const void *buffer, size_t length);
+    virtual bool rawRead(void *buffer, size_t length);
+    virtual int rawGetc();
+    virtual void rawClose();
+    virtual void rawFlush();
+    virtual bool rawSkip(size_t length);
+    virtual int  rawPercentRead();
+private:
+    void *m_gzFile;
+    double m_endOffset;
+};
+
+ZLibFile::ZLibFile(const std::string &filename,
+                   File::Mode mode)
+    : File(filename, mode),
+      m_gzFile(NULL)
+{
+}
+
+ZLibFile::~ZLibFile()
+{
+}
+
+bool ZLibFile::rawOpen(const std::string &filename, File::Mode mode)
+{
+    m_gzFile = gzopen(filename.c_str(),
+                      (mode == File::Write) ? "wb" : "rb");
+
+    if (mode == File::Read && m_gzFile) {
+        //XXX: unfortunately zlib doesn't support
+        //     SEEK_END or we could've done:
+        //m_endOffset = gzseek(m_gzFile, 0, SEEK_END);
+        //gzrewind(m_gzFile);
+        gz_state *state = (gz_state *)m_gzFile;
+        off_t loc = lseek(state->fd, 0, SEEK_CUR);
+        m_endOffset = lseek(state->fd, 0, SEEK_END);
+        lseek(state->fd, loc, SEEK_SET);
+    }
+
+    return m_gzFile != NULL;
+}
+
+bool ZLibFile::rawWrite(const void *buffer, size_t length)
+{
+    return gzwrite(m_gzFile, buffer, length) != -1;
+}
+
+bool ZLibFile::rawRead(void *buffer, size_t length)
+{
+    return gzread(m_gzFile, buffer, length) != -1;
+}
+
+int ZLibFile::rawGetc()
+{
+    return gzgetc(m_gzFile);
+}
+
+void ZLibFile::rawClose()
+{
+    if (m_gzFile) {
+        gzclose(m_gzFile);
+        m_gzFile = NULL;
+    }
+}
+
+void ZLibFile::rawFlush()
+{
+    gzflush(m_gzFile, Z_SYNC_FLUSH);
+}
+
+File::Offset ZLibFile::currentOffset()
+{
+    return File::Offset(gztell(m_gzFile));
+}
+
+bool ZLibFile::supportsOffsets() const
+{
+    return false;
+}
+
+bool ZLibFile::rawSkip(size_t)
+{
+    return false;
+}
+
+int ZLibFile::rawPercentRead()
+{
+    gz_state *state = (gz_state *)m_gzFile;
+    return 100 * (lseek(state->fd, 0, SEEK_CUR) / m_endOffset);
+}
+
+
+File * File::createZLib(void) {
+    return new ZLibFile;
+}
+
+bool File::isZLibCompressed(const std::string &filename)
+{
+    std::fstream stream(filename.c_str(),
+                        std::fstream::binary | std::fstream::in);
+    if (!stream.is_open())
+        return false;
+
+    unsigned char byte1, byte2;
+    stream >> byte1;
+    stream >> byte2;
+    stream.close();
+
+    return (byte1 == 0x1f && byte2 == 0x8b);
+}
+
index 17f4a15..0a28f7a 100644 (file)
@@ -29,7 +29,6 @@
 #include <stdlib.h>
 
 #include "trace_file.hpp"
-#include "trace_snappyfile.hpp"
 #include "trace_parser.hpp"
 
 
@@ -54,9 +53,9 @@ Parser::~Parser() {
 bool Parser::open(const char *filename) {
     assert(!file);
     if (File::isZLibCompressed(filename)) {
-        file = new ZLibFile;
+        file = File::createZLib();
     } else {
-        file = new SnappyFile;
+        file = File::createSnappy();
     }
 
     if (!file->open(filename, File::Read)) {
diff --git a/common/trace_snappyfile.hpp b/common/trace_snappyfile.hpp
deleted file mode 100644 (file)
index 33159ec..0000000
+++ /dev/null
@@ -1,106 +0,0 @@
-/**************************************************************************
- *
- * Copyright 2011 Zack Rusin
- * All Rights Reserved.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
- * THE SOFTWARE.
- *
- **************************************************************************/
-
-
-#ifndef TRACE_SNAPPYFILE_HPP
-#define TRACE_SNAPPYFILE_HPP
-
-#include <assert.h>
-
-#include "trace_file.hpp"
-
-#include <string>
-#include <fstream>
-
-namespace snappy {
-    class File;
-}
-
-namespace Trace {
-
-#define SNAPPY_CHUNK_SIZE (1 * 1024 * 1024)
-
-#define SNAPPY_BYTE1 'a'
-#define SNAPPY_BYTE2 't'
-
-
-class SnappyFile : public File {
-public:
-    SnappyFile(const std::string &filename = std::string(),
-               File::Mode mode = File::Read);
-    virtual ~SnappyFile();
-
-    virtual bool supportsOffsets() const;
-    virtual File::Offset currentOffset();
-    virtual void setCurrentOffset(const File::Offset &offset);
-protected:
-    virtual bool rawOpen(const std::string &filename, File::Mode mode);
-    virtual bool rawWrite(const void *buffer, size_t length);
-    virtual bool rawRead(void *buffer, size_t length);
-    virtual int rawGetc();
-    virtual void rawClose();
-    virtual void rawFlush();
-    virtual bool rawSkip(size_t length);
-    virtual int rawPercentRead();
-
-private:
-    inline size_t usedCacheSize() const
-    {
-        assert(m_cachePtr >= m_cache);
-        return m_cachePtr - m_cache;
-    }
-    inline size_t freeCacheSize() const
-    {
-        assert(m_cacheSize >= usedCacheSize());
-        if (m_cacheSize > 0) {
-            return m_cacheSize - usedCacheSize();
-        } else {
-            return 0;
-        }
-    }
-    inline bool endOfData() const
-    {
-        return m_stream.eof() && freeCacheSize() == 0;
-    }
-    void flushWriteCache();
-    void flushReadCache(size_t skipLength = 0);
-    void createCache(size_t size);
-    void writeCompressedLength(size_t length);
-    size_t readCompressedLength();
-private:
-    std::fstream m_stream;
-    char *m_cache;
-    char *m_cachePtr;
-    size_t m_cacheSize;
-
-    char *m_compressedCache;
-
-    File::Offset m_currentOffset;
-    std::streampos m_endPos;
-};
-
-}
-
-#endif // TRACE_SNAPPYFILE_HPP
index 5a5f1f7..41f5e63 100644 (file)
@@ -31,8 +31,8 @@
 #include <string.h>
 
 #include "os.hpp"
+#include "trace_file.hpp"
 #include "trace_writer.hpp"
-#include "trace_snappyfile.hpp"
 #include "trace_format.hpp"
 
 
@@ -42,7 +42,7 @@ namespace Trace {
 Writer::Writer() :
     call_no(0)
 {
-    m_file = new Trace::SnappyFile;
+    m_file = File::createSnappy();
     close();
 }