]> source.dussan.org Git - jgit.git/commitdiff
Add ReceivedPackStatistics for PackParser 50/81050/4
authorMasaya Suzuki <masayasuzuki@google.com>
Wed, 14 Sep 2016 00:43:18 +0000 (17:43 -0700)
committerMasaya Suzuki <masayasuzuki@google.com>
Mon, 19 Sep 2016 22:53:50 +0000 (15:53 -0700)
This is like PackStatistics, but for PackParser.

Change-Id: I854215c0956fd0b36843d631780be303e021b8be
Signed-off-by: Masaya Suzuki <masayasuzuki@google.com>
org.eclipse.jgit/src/org/eclipse/jgit/transport/BaseReceivePack.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/PackParser.java
org.eclipse.jgit/src/org/eclipse/jgit/transport/ReceivedPackStatistics.java [new file with mode: 0644]

index 0724eac701a695e7fa0213de81464b1cf5ae4b80..18e6eef991a304e5bf9efd8cdb5628fa4ae2bbf7 100644 (file)
@@ -69,6 +69,7 @@ import java.util.Map;
 import java.util.Set;
 import java.util.concurrent.TimeUnit;
 
+import org.eclipse.jgit.annotations.Nullable;
 import org.eclipse.jgit.errors.InvalidObjectIdException;
 import org.eclipse.jgit.errors.MissingObjectException;
 import org.eclipse.jgit.errors.PackProtocolException;
@@ -268,6 +269,7 @@ public abstract class BaseReceivePack {
        private PushCertificateParser pushCertificateParser;
        private SignedPushConfig signedPushConfig;
        private PushCertificate pushCert;
+       private ReceivedPackStatistics stats;
 
        /**
         * Get the push certificate used to verify the pusher's identity.
@@ -1114,6 +1116,18 @@ public abstract class BaseReceivePack {
                adv.end();
        }
 
+       /**
+        * Returns the statistics on the received pack if available. This should be
+        * called after {@link #receivePack} is called.
+        *
+        * @return ReceivedPackStatistics
+        * @since 4.5
+        */
+       @Nullable
+       public ReceivedPackStatistics getReceivedPackStatistics() {
+               return stats;
+       }
+
        /**
         * Receive a list of commands from the input.
         *
@@ -1307,6 +1321,7 @@ public abstract class BaseReceivePack {
                        parser.setMaxObjectSizeLimit(maxObjectSizeLimit);
                        packLock = parser.parse(receiving, resolving);
                        packSize = Long.valueOf(parser.getPackSize());
+                       stats = parser.getReceivedPackStatistics();
                        ins.flush();
                }
 
index b96fe885e15a83b7a80924f6599e7c3c02864fe3..4c98d5768269de8b1d31af9986aa967cb2bdaae3 100644 (file)
@@ -186,6 +186,9 @@ public abstract class PackParser {
        /** Git object size limit */
        private long maxObjectSizeLimit;
 
+       private final ReceivedPackStatistics.Builder stats =
+                       new ReceivedPackStatistics.Builder();
+
        /**
         * Initialize a pack parser.
         *
@@ -455,8 +458,8 @@ public abstract class PackParser {
        }
 
        /**
-        * Get the size of the parsed pack.
-        *
+        * Get the size of the newly created pack.
+        * <p>
         * This will also include the pack index size if an index was created. This
         * method should only be called after pack parsing is finished.
         *
@@ -468,6 +471,18 @@ public abstract class PackParser {
                return -1;
        }
 
+       /**
+        * Returns the statistics of the parsed pack.
+        * <p>
+        * This should only be called after pack parsing is finished.
+        *
+        * @return {@link ReceivedPackStatistics}
+        * @since 4.5
+        */
+       public ReceivedPackStatistics getReceivedPackStatistics() {
+               return stats.build();
+       }
+
        /**
         * Parse the pack stream.
         *
@@ -626,6 +641,7 @@ public abstract class PackParser {
        private void resolveDeltas(DeltaVisit visit, final int type,
                        ObjectTypeAndSize info, ProgressMonitor progress)
                        throws IOException {
+               stats.addDeltaObject(type);
                do {
                        progress.update(1);
                        info = openDatabase(visit.delta, info);
@@ -919,6 +935,7 @@ public abstract class PackParser {
 
        // Cleanup all resources associated with our input parsing.
        private void endInput() {
+               stats.setNumBytesRead(streamPosition());
                in = null;
        }
 
@@ -947,12 +964,14 @@ public abstract class PackParser {
                case Constants.OBJ_TREE:
                case Constants.OBJ_BLOB:
                case Constants.OBJ_TAG:
+                       stats.addWholeObject(typeCode);
                        onBeginWholeObject(streamPosition, typeCode, sz);
                        onObjectHeader(Source.INPUT, hdrBuf, 0, hdrPtr);
                        whole(streamPosition, typeCode, sz);
                        break;
 
                case Constants.OBJ_OFS_DELTA: {
+                       stats.addOffsetDelta();
                        c = readFrom(Source.INPUT);
                        hdrBuf[hdrPtr++] = (byte) c;
                        long ofs = c & 127;
@@ -975,6 +994,7 @@ public abstract class PackParser {
                }
 
                case Constants.OBJ_REF_DELTA: {
+                       stats.addRefDelta();
                        c = fill(Source.INPUT, 20);
                        final ObjectId base = ObjectId.fromRaw(buf, c);
                        System.arraycopy(buf, c, hdrBuf, hdrPtr, 20);
diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/transport/ReceivedPackStatistics.java b/org.eclipse.jgit/src/org/eclipse/jgit/transport/ReceivedPackStatistics.java
new file mode 100644 (file)
index 0000000..127a214
--- /dev/null
@@ -0,0 +1,231 @@
+/*
+ * Copyright (C) 2016, Google Inc.
+ * and other copyright owners as documented in the project's IP log.
+ *
+ * This program and the accompanying materials are made available
+ * under the terms of the Eclipse Distribution License v1.0 which
+ * accompanies this distribution, is reproduced below, and is
+ * available at http://www.eclipse.org/org/documents/edl-v10.php
+ *
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or
+ * without modification, are permitted provided that the following
+ * conditions are met:
+ *
+ * - Redistributions of source code must retain the above copyright
+ *   notice, this list of conditions and the following disclaimer.
+ *
+ * - Redistributions in binary form must reproduce the above
+ *   copyright notice, this list of conditions and the following
+ *   disclaimer in the documentation and/or other materials provided
+ *   with the distribution.
+ *
+ * - Neither the name of the Eclipse Foundation, Inc. nor the
+ *   names of its contributors may be used to endorse or promote
+ *   products derived from this software without specific prior
+ *   written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
+ * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
+ * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+ * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+ * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+ * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+ * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package org.eclipse.jgit.transport;
+
+import org.eclipse.jgit.lib.Constants;
+
+/**
+ * Statistics about {@link PackParser}.
+ *
+ * @since 4.5
+ */
+public class ReceivedPackStatistics {
+       private long numBytesRead;
+
+       private long numWholeCommit;
+       private long numWholeTree;
+       private long numWholeBlob;
+       private long numWholeTag;
+       private long numOfsDelta;
+       private long numRefDelta;
+
+       private long numDeltaCommit;
+       private long numDeltaTree;
+       private long numDeltaBlob;
+       private long numDeltaTag;
+
+       /** @return number of bytes read from the input stream */
+       public long getNumBytesRead() {
+               return numBytesRead;
+       }
+
+       /** @return number of whole commit objects in the pack */
+       public long getNumWholeCommit() {
+               return numWholeCommit;
+       }
+
+       /** @return number of whole tree objects in the pack */
+       public long getNumWholeTree() {
+               return numWholeTree;
+       }
+
+       /** @return number of whole blob objects in the pack */
+       public long getNumWholeBlob() {
+               return numWholeBlob;
+       }
+
+       /** @return number of whole tag objects in the pack */
+       public long getNumWholeTag() {
+               return numWholeTag;
+       }
+
+       /** @return number of offset delta objects in the pack */
+       public long getNumOfsDelta() {
+               return numOfsDelta;
+       }
+
+       /** @return number of ref delta objects in the pack */
+       public long getNumRefDelta() {
+               return numRefDelta;
+       }
+
+       /** @return number of delta commit objects in the pack */
+       public long getNumDeltaCommit() {
+               return numDeltaCommit;
+       }
+
+       /** @return number of delta tree objects in the pack */
+       public long getNumDeltaTree() {
+               return numDeltaTree;
+       }
+
+       /** @return number of delta blob objects in the pack */
+       public long getNumDeltaBlob() {
+               return numDeltaBlob;
+       }
+
+       /** @return number of delta tag objects in the pack */
+       public long getNumDeltaTag() {
+               return numDeltaTag;
+       }
+
+       /** A builder for {@link ReceivedPackStatistics}. */
+       public static class Builder {
+               private long numBytesRead;
+
+               private long numWholeCommit;
+               private long numWholeTree;
+               private long numWholeBlob;
+               private long numWholeTag;
+               private long numOfsDelta;
+               private long numRefDelta;
+
+               private long numDeltaCommit;
+               private long numDeltaTree;
+               private long numDeltaBlob;
+               private long numDeltaTag;
+
+               /**
+                * @param numBytesRead number of bytes read from the input stream
+                * @return this
+                */
+               public Builder setNumBytesRead(long numBytesRead) {
+                       this.numBytesRead = numBytesRead;
+                       return this;
+               }
+
+               /**
+                * Increment a whole object count.
+                *
+                * @param type OBJ_COMMIT, OBJ_TREE, OBJ_BLOB, or OBJ_TAG
+                * @return this
+                */
+               public Builder addWholeObject(int type) {
+                       switch (type) {
+                               case Constants.OBJ_COMMIT:
+                                       numWholeCommit++;
+                                       break;
+                               case Constants.OBJ_TREE:
+                                       numWholeTree++;
+                                       break;
+                               case Constants.OBJ_BLOB:
+                                       numWholeBlob++;
+                                       break;
+                               case Constants.OBJ_TAG:
+                                       numWholeTag++;
+                                       break;
+                               default:
+                                       throw new IllegalArgumentException(
+                                                       type + " cannot be a whole object"); //$NON-NLS-1$
+                       }
+                       return this;
+               }
+
+               /** @return this */
+               public Builder addOffsetDelta() {
+                       numOfsDelta++;
+                       return this;
+               }
+
+               /** @return this */
+               public Builder addRefDelta() {
+                       numRefDelta++;
+                       return this;
+               }
+
+               /**
+                * Increment a delta object count.
+                *
+                * @param type OBJ_COMMIT, OBJ_TREE, OBJ_BLOB, or OBJ_TAG
+                * @return this
+                */
+               public Builder addDeltaObject(int type) {
+                       switch (type) {
+                               case Constants.OBJ_COMMIT:
+                                       numDeltaCommit++;
+                                       break;
+                               case Constants.OBJ_TREE:
+                                       numDeltaTree++;
+                                       break;
+                               case Constants.OBJ_BLOB:
+                                       numDeltaBlob++;
+                                       break;
+                               case Constants.OBJ_TAG:
+                                       numDeltaTag++;
+                                       break;
+                               default:
+                                       throw new IllegalArgumentException(
+                                                       "delta should be a delta to a whole object. " + //$NON-NLS-1$
+                                                       type + " cannot be a whole object"); //$NON-NLS-1$
+                       }
+                       return this;
+               }
+
+               ReceivedPackStatistics build() {
+                       ReceivedPackStatistics s = new ReceivedPackStatistics();
+                       s.numBytesRead = numBytesRead;
+                       s.numWholeCommit = numWholeCommit;
+                       s.numWholeTree = numWholeTree;
+                       s.numWholeBlob = numWholeBlob;
+                       s.numWholeTag = numWholeTag;
+                       s.numOfsDelta = numOfsDelta;
+                       s.numRefDelta = numRefDelta;
+                       s.numDeltaCommit = numDeltaCommit;
+                       s.numDeltaTree = numDeltaTree;
+                       s.numDeltaBlob = numDeltaBlob;
+                       s.numDeltaTag = numDeltaTag;
+                       return s;
+               }
+       }
+}