Changeset b4cbef1 in mainline for uspace/lib/libc/generic/async.c

Timestamp:

2010-02-03T16:52:37Z (14 years ago)

Author:

Martin Decky <martin@…>

Branches:

lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export

Children:

3b3e776, eda925a

Parents:

472c09d

Message:

add minimal data size check into async_data_receive
introduce more convenience wrappers for common IPC patterns:

async_data_read_forward_fast
async_data_void
async_data_forward_fast

File:

• uspace/lib/libc/generic/async.c (modified) (9 diffs)

uspace/lib/libc/generic/async.c

@@ -1287 +1287 @@
 }
 
+/** Wrapper for forwarding any read request
+ *
+ *
+ */
+int async_data_read_forward_fast(int phoneid, ipcarg_t method, ipcarg_t arg1,
+    ipcarg_t arg2, ipcarg_t arg3, ipcarg_t arg4, ipc_call_t *dataptr)
+{
+        ipc_callid_t callid;
+        if (!async_data_read_receive(&callid, NULL)) {
+                ipc_answer_0(callid, EINVAL);
+                return EINVAL;
+        }
+        
+        aid_t msg = async_send_fast(phoneid, method, arg1, arg2, arg3, arg4,
+            dataptr);
+        if (msg == 0) {
+                ipc_answer_0(callid, EINVAL);
+                return EINVAL;
+        }
+        
+        int retval = ipc_forward_fast(callid, phoneid, 0, 0, 0,
+            IPC_FF_ROUTE_FROM_ME);
+        if (retval != EOK) {
+                ipc_answer_0(callid, retval);
+                return retval;
+        }
+        
+        ipcarg_t rc;
+        async_wait_for(msg, &rc);
+        
+        return (int) rc;
+}
+
 /** Wrapper for making IPC_M_DATA_WRITE calls using the async framework.
  *
- * @param phoneid       Phone that will be used to contact the receiving side.
- * @param src           Address of the beginning of the source buffer.
- * @param size          Size of the source buffer.
- *
- * @return              Zero on success or a negative error code from errno.h.
+ * @param phoneid Phone that will be used to contact the receiving side.
+ * @param src     Address of the beginning of the source buffer.
+ * @param size    Size of the source buffer.
+ *
+ * @return Zero on success or a negative error code from errno.h.
+ *
  */
 int async_data_write_start(int phoneid, const void *src, size_t size)
@@ -1308 +1342 @@
  * So far, this wrapper is to be used from within a connection fibril.
  *
- * @param callid        Storage where the hash of the IPC_M_DATA_WRITE call will
- *                      be stored.
- * @param size          Storage where the suggested size will be stored. May be
- *                      NULL
- *
- * @return              Non-zero on success, zero on failure.
+ * @param callid Storage where the hash of the IPC_M_DATA_WRITE call will
+ *               be stored.
+ * @param size   Storage where the suggested size will be stored. May be
+ *               NULL
+ *
+ * @return Non-zero on success, zero on failure.
+ *
  */
 int async_data_write_receive(ipc_callid_t *callid, size_t *size)
@@ -1320 +1355 @@
         
         assert(callid);
-
+        
         *callid = async_get_call(&data);
         if (IPC_GET_METHOD(data) != IPC_M_DATA_WRITE)
                 return 0;
+        
         if (size)
                 *size = (size_t) IPC_GET_ARG2(data);
+        
         return 1;
 }
@@ -1334 +1371 @@
  * so that the user doesn't have to remember the meaning of each IPC argument.
  *
- * @param callid        Hash of the IPC_M_DATA_WRITE call to answer.
- * @param dst           Final destination address for the IPC_M_DATA_WRITE call.
- * @param size          Final size for the IPC_M_DATA_WRITE call.
- *
- * @return              Zero on success or a value from @ref errno.h on failure.
+ * @param callid Hash of the IPC_M_DATA_WRITE call to answer.
+ * @param dst    Final destination address for the IPC_M_DATA_WRITE call.
+ * @param size   Final size for the IPC_M_DATA_WRITE call.
+ *
+ * @return Zero on success or a value from @ref errno.h on failure.
+ *
  */
 int async_data_write_finalize(ipc_callid_t callid, void *dst, size_t size)
@@ -1345 +1383 @@
 }
 
-/** Wrapper for receiving binary data via the async_data_write_*
+/** Wrapper for receiving binary data
  *
  * This wrapper only makes it more comfortable to use async_data_write_*
- * functions to receive blobs.
+ * functions to receive binary data.
  *
  * @param data       Pointer to data pointer (which should be later disposed
  *                   by free()). If the operation fails, the pointer is not
  *                   touched.
+ * @param min_size   Minimum size (in bytes) of the data to receive.
  * @param max_size   Maximum size (in bytes) of the data to receive. 0 means
  *                   no limit.
@@ -1362 +1401 @@
  *
  */
-int async_data_receive(void **data, const size_t max_size,
-    const size_t granularity, size_t *received)
+int async_data_receive(void **data, const size_t min_size,
+    const size_t max_size, const size_t granularity, size_t *received)
 {
         ipc_callid_t callid;
@@ -1372 +1411 @@
         }
         
+        if (size < min_size) {
+                ipc_answer_0(callid, EINVAL);
+                return EINVAL;
+        }
+        
         if ((max_size > 0) && (size > max_size)) {
                 ipc_answer_0(callid, EINVAL);
@@ -1401 +1445 @@
 }
 
-/** Wrapper for receiving strings via the async_data_write_*
+/** Wrapper for receiving strings
  *
  * This wrapper only makes it more comfortable to use async_data_write_*
@@ -1450 +1494 @@
 }
 
+/** Wrapper for voiding any data that is about to be received
+ *
+ * This wrapper can be used to void any pending data
+ *
+ * @param retval Error value from @ref errno.h to be returned to the caller.
+ *
+ */
+void async_data_void(const int retval)
+{
+        ipc_callid_t callid;
+        async_data_write_receive(&callid, NULL);
+        ipc_answer_0(callid, retval);
+}
+
+/** Wrapper for forwarding any data that is about to be received
+ *
+ *
+ */
+int async_data_forward_fast(int phoneid, ipcarg_t method, ipcarg_t arg1,
+    ipcarg_t arg2, ipcarg_t arg3, ipcarg_t arg4, ipc_call_t *dataptr)
+{
+        ipc_callid_t callid;
+        if (!async_data_write_receive(&callid, NULL)) {
+                ipc_answer_0(callid, EINVAL);
+                return EINVAL;
+        }
+        
+        aid_t msg = async_send_fast(phoneid, method, arg1, arg2, arg3, arg4,
+            dataptr);
+        if (msg == 0) {
+                ipc_answer_0(callid, EINVAL);
+                return EINVAL;
+        }
+        
+        int retval = ipc_forward_fast(callid, phoneid, 0, 0, 0,
+            IPC_FF_ROUTE_FROM_ME);
+        if (retval != EOK) {
+                ipc_answer_0(callid, retval);
+                return retval;
+        }
+        
+        ipcarg_t rc;
+        async_wait_for(msg, &rc);
+        
+        return (int) rc;
+}
+
 /** @}
  */