Fix some typos and code formatting in libdtm.

kvap · kvap · commit afdf647b641c · 2015-11-10T13:05:34.000+03:00
diff --git a/contrib/pg_dtm/libdtm.c b/contrib/pg_dtm/libdtm.c
@@ -33,7 +33,6 @@ static char* dtm_unix_sock_dir;
 
 typedef unsigned xid_t;
 
-// Connects to the specified DTM.
 static DTMConn DtmConnect(char *host, int port)
 {
 	DTMConn dtm;
@@ -297,10 +296,6 @@ void DtmInitSnapshot(Snapshot snapshot)
 	#endif
 }
 
-// Starts a new global transaction of nParticipants size. Returns the
-// transaction id, fills the 'snapshot' and 'gxmin' on success. 'gxmin' is the
-// smallest xmin among all snapshots known to DTM. Returns INVALID_XID
-// otherwise.
 TransactionId DtmGlobalStartTransaction(Snapshot snapshot, TransactionId *gxmin)
 {
 	int i;
@@ -337,8 +332,6 @@ TransactionId DtmGlobalStartTransaction(Snapshot snapshot, TransactionId *gxmin)
 	return INVALID_XID;
 }
 
-// Asks the DTM for a fresh snapshot. Fills the 'snapshot' and 'gxmin' on
-// success. 'gxmin' is the smallest xmin among all snapshots known to DTM.
 void DtmGlobalGetSnapshot(TransactionId xid, Snapshot snapshot, TransactionId *gxmin)
 {
 	int i;
@@ -376,10 +369,6 @@ void DtmGlobalGetSnapshot(TransactionId xid, Snapshot snapshot, TransactionId *g
 	);
 }
 
-// Commits transaction only once all participants have called this function,
-// does not change CLOG otherwise. Set 'wait' to 'true' if you want this call
-// to return only after the transaction is considered finished by the DTM.
-// Returns the status on success, or -1 otherwise.
 XidStatus DtmGlobalSetTransStatus(TransactionId xid, XidStatus status, bool wait)
 {
 	int reslen;
@@ -424,9 +413,6 @@ XidStatus DtmGlobalSetTransStatus(TransactionId xid, XidStatus status, bool wait
 	return -1;
 }
 
-// Gets the status of the transaction identified by 'xid'. Returns the status
-// on success, or -1 otherwise. If 'wait' is true, then it does not return
-// until the transaction is finished.
 XidStatus DtmGlobalGetTransStatus(TransactionId xid, bool wait)
 {
 	int reslen;
@@ -462,11 +448,6 @@ XidStatus DtmGlobalGetTransStatus(TransactionId xid, bool wait)
 	return -1;
 }
 
-// Reserves at least 'nXids' successive xids for local transactions. The xids
-// reserved are not less than 'xid' in value. Returns the actual number of xids
-// reserved, and sets the 'first' xid accordingly. The number of xids reserved
-// is guaranteed to be at least nXids.
-// In other words, *first ≥ xid and result ≥ nXids.
 int DtmGlobalReserve(TransactionId xid, int nXids, TransactionId *first)
 {
 	xid_t xmin, xmax;
@@ -503,11 +484,11 @@ int DtmGlobalReserve(TransactionId xid, int nXids, TransactionId *first)
 bool DtmGlobalDetectDeadLock(TransactionId xid, void* data, int size)
 {
 	int msg_size = size + sizeof(xid)*2;
-    int data_size = sizeof(ShubMessageHdr) + msg_size;
-    char* buf = (char*)malloc(data_size);
+	int data_size = sizeof(ShubMessageHdr) + msg_size;
+	char* buf = (char*)malloc(data_size);
 	ShubMessageHdr* msg = (ShubMessageHdr*)buf;
 	xid_t* body = (xid_t*)(msg+1);
-    int sent;
+	int sent;
 	int reslen;
 	xid_t results[RESULTS_SIZE];
 	DTMConn dtm = GetConnection();
@@ -517,8 +498,8 @@ bool DtmGlobalDetectDeadLock(TransactionId xid, void* data, int size)
 	msg->size = msg_size;
 
 	*body++ = CMD_DEADLOCK;
-    *body++ = xid;
-    memcpy(body, data, size);
+	*body++ = xid;
+	memcpy(body, data, size);
 
 	sent = 0;
 	while (sent < data_size)
@@ -531,10 +512,17 @@ bool DtmGlobalDetectDeadLock(TransactionId xid, void* data, int size)
 		}
 		sent += new_bytes;
 	}
+
 	reslen = dtm_recv_results(dtm, RESULTS_SIZE, results);
-	if (reslen != 1 || (results[0] != RES_OK && results[0] != RES_DEADLOCK)) { 
-        fprintf(stderr, "DtmGlobalDetectDeadLock: failed to check deadlocks for transaction %u\n", xid);
-        return false;
-    }
+	if (reslen != 1 || (results[0] != RES_OK && results[0] != RES_DEADLOCK))
+	{
+		fprintf(
+			stderr,
+			"DtmGlobalDetectDeadLock: failed"
+			" to check xid=%u for deadlock\n",
+			xid
+		);
+		return false;
+	}
 	return results[0] == RES_DEADLOCK;
 }
diff --git a/contrib/pg_dtm/libdtm.h b/contrib/pg_dtm/libdtm.h
@@ -9,7 +9,7 @@
 #define INVALID_XID 0
 
 /**
- * Sets up the host and port for DTM connection.
+ * Sets up the host and port for arbiter connection.
  * The defaults are "127.0.0.1" and 5431.
  */
 void DtmGlobalConfig(char *host, int port, char* sock_dir);
@@ -19,21 +19,21 @@ void DtmInitSnapshot(Snapshot snapshot);
 /**
  * Starts a new global transaction. Returns the
  * transaction id, fills the 'snapshot' and 'gxmin' on success. 'gxmin' is the
- * smallest xmin among all snapshots known to DTM. Returns INVALID_XID
+ * smallest xmin among all snapshots known to arbiter. Returns INVALID_XID
  * otherwise.
  */
 TransactionId DtmGlobalStartTransaction(Snapshot snapshot, TransactionId *gxmin);
 
 /**
- * Asks the DTM for a fresh snapshot. Fills the 'snapshot' and 'gxmin' on
- * success. 'gxmin' is the smallest xmin among all snapshots known to DTM.
+ * Asks the arbiter for a fresh snapshot. Fills the 'snapshot' and 'gxmin' on
+ * success. 'gxmin' is the smallest xmin among all snapshots known to arbiter.
  */
 void DtmGlobalGetSnapshot(TransactionId xid, Snapshot snapshot, TransactionId *gxmin);
 
 /**
  * Commits transaction only once all participants have called this function,
  * does not change CLOG otherwise. Set 'wait' to 'true' if you want this call
- * to return only after the transaction is considered finished by the DTM.
+ * to return only after the transaction is considered finished by the arbiter.
  * Returns the status on success, or -1 otherwise.
  */
 XidStatus DtmGlobalSetTransStatus(TransactionId xid, XidStatus status, bool wait);
@@ -55,9 +55,12 @@ XidStatus DtmGlobalGetTransStatus(TransactionId xid, bool wait);
 int DtmGlobalReserve(TransactionId xid, int nXids, TransactionId *first);
 
 /**
- * Detect global deadlock. This funcions send serialized local resource graph to arbiter which appends them to global graph.
- * Once loop is detected in global resoruce graph, arbiter returns true. Otherwise false is returned.
- * Abiter should replace local part of resource graph if new graph is recevied from this cluster node (not backend).
+ * Detect global deadlock. This function sends serialized local resource graph
+ * to the arbiter which appends them to the global graph. Once a loop is
+ * detected in global resource graph, the arbiter returns true. Otherwise false
+ * is returned. Arbiter should replace the corresponding part of the global
+ * resource graph if a new local graph is received from this cluster node (not
+ * backend).
  */
 bool DtmGlobalDetectDeadLock(TransactionId xid, void* graph, int size);
 
