Add comments to process_pending functions.

This commit was SVN r12346.

ompi/mca/pml/ob1/pml_ob1.h

@@ -290,8 +290,17 @@ static inline int mca_pml_ob1_send_fin(ompi_proc_t* proc, void *hdr_des)
 
     return OMPI_ERR_OUT_OF_RESOURCE;
 }
-
+/* This function tries to resend FIN/ACK packets from pckt_pending queue.
+ * Packets are added to the queue when sending of FIN or ACK is failed due to
+ * resource unavailability. bml_btl passed to the function doesn't represents
+ * packet's destination, it represents BTL on which resource was freed, so only
+ * this BTL should be considered for resending packets */
 void mca_pml_ob1_process_pending_packets(mca_bml_base_btl_t* bml_btl);
+
+/* This function retries failed PUT/GET operations on frag. When RDMA operation
+ * cannot be accomplished for some reason, frag is put on the rdma_pending list.
+ * Later the operation is retried. The destination of RDMA operation is stored
+ * inside the frag structure */
 void mca_pml_ob1_process_pending_rdma(void);
 
 #define MCA_PML_OB1_PROGRESS_PENDING(bml_btl)                   \

ompi/mca/pml/ob1/pml_ob1_recvreq.h

@@ -385,10 +385,13 @@ static inline int mca_pml_ob1_recv_request_ack_send(ompi_proc_t* proc,
     return OMPI_ERR_OUT_OF_RESOURCE;
 }
 
-int mca_pml_ob1_recv_request_get_frag(
-        mca_pml_ob1_rdma_frag_t* frag);
+int mca_pml_ob1_recv_request_get_frag(mca_pml_ob1_rdma_frag_t* frag);
 
+/* This function tries to continue recvreq that stuck due to resource
+ * unavailability. Recvreq is added to recv_pending list if scheduling of put
+ * operation cannot be accomplished for some reason. */
 void mca_pml_ob1_recv_request_process_pending(void);
+
 #if defined(c_plusplus) || defined(__cplusplus)
 }
 #endif

ompi/mca/pml/ob1/pml_ob1_sendreq.h

@@ -413,11 +413,17 @@ void mca_pml_ob1_send_request_put(
      mca_btl_base_module_t* btl,
      mca_pml_ob1_rdma_hdr_t* hdr);
 
-int mca_pml_ob1_send_request_put_frag(
-        mca_pml_ob1_rdma_frag_t* frag);
+int mca_pml_ob1_send_request_put_frag(mca_pml_ob1_rdma_frag_t* frag);
 
-void mca_pml_ob1_send_request_process_pending(
-        mca_bml_base_btl_t *bml_btl);
+/* This function tries to continue sendreq that was stuck because of resource
+ * unavailability. A sendreq may be added to send_pending list if there is no
+ * resource to send initial packet or there is not resource to schedule data
+ * for sending. The reason the sendreq was added to the list is stored inside
+ * sendreq struct and appropriate operation is retried when resource became
+ * available. bml_btl passed to the function doesn't represents sendreq
+ * destination, it represents BTL on which resource was freed, so only this BTL
+ * should be considered for sending packets */
+void mca_pml_ob1_send_request_process_pending(mca_bml_base_btl_t *bml_btl);
 
 #if defined(c_plusplus) || defined(__cplusplus)
 }