Changeset 27d293a in mainline

Timestamp:

2007-12-31T16:46:43Z (16 years ago)

Author:

Jakub Jermar <jakub@…>

Branches:

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

Children:

215e375

Parents:

3115355

Message:

Rename IPC_M_AS_AREA_SEND to IPC_M_SHARE_OUT. Rename IPC_M_AS_AREA_RECV to
IPC_M_SHARE_IN. Provide user-friendly wrappers for these methods so that even
dummies can get it right. Some applications using simpler protocols still use
these methods directly.

Files:

• kernel/generic/include/ipc/ipc.h (modified) (2 diffs)
• kernel/generic/src/ipc/sysipc.c (modified) (5 diffs)
• uspace/app/klog/klog.c (modified) (1 diff)
• uspace/lib/libc/generic/ipc.c (modified) (1 diff)
• uspace/lib/libc/generic/time.c (modified) (2 diffs)
• uspace/lib/libc/include/ipc/ipc.h (modified) (1 diff)
• uspace/lib/libfs/libfs.c (modified) (1 diff)
• uspace/srv/console/console.c (modified) (1 diff)
• uspace/srv/console/gcons.c (modified) (2 diffs)
• uspace/srv/fb/ega.c (modified) (1 diff)
• uspace/srv/fb/fb.c (modified) (1 diff)
• uspace/srv/ns/ns.c (modified) (1 diff)
• uspace/srv/rd/rd.c (modified) (1 diff)
• uspace/srv/vfs/vfs_register.c (modified) (3 diffs)

kernel/generic/include/ipc/ipc.h

@@ -160 +160 @@
  * - ARG1 - dst as_area base adress
  */
-#define IPC_M_AS_AREA_SEND      4       
+#define IPC_M_SHARE_OUT         4       
 
 /** Receive as_area over IPC.
@@ -172 +172 @@
  * - ARG2 - flags that will be used for sharing
  */
-#define IPC_M_AS_AREA_RECV      5       
+#define IPC_M_SHARE_IN          5       
 
 /** Send data to another address space over IPC.

kernel/generic/src/ipc/sysipc.c

@@ -113 +113 @@
 {
         switch (method) {
-        case IPC_M_AS_AREA_SEND:
-        case IPC_M_AS_AREA_RECV:
+        case IPC_M_SHARE_OUT:
+        case IPC_M_SHARE_IN:
         case IPC_M_DATA_WRITE:
         case IPC_M_DATA_READ:
@@ -142 +142 @@
         case IPC_M_CONNECT_TO_ME:
         case IPC_M_CONNECT_ME_TO:
-        case IPC_M_AS_AREA_SEND:
-        case IPC_M_AS_AREA_RECV:
+        case IPC_M_SHARE_OUT:
+        case IPC_M_SHARE_IN:
         case IPC_M_DATA_WRITE:
         case IPC_M_DATA_READ:
@@ -200 +200 @@
                             &TASK->answerbox);
                 }
-        } else if (IPC_GET_METHOD(*olddata) == IPC_M_AS_AREA_SEND) {
+        } else if (IPC_GET_METHOD(*olddata) == IPC_M_SHARE_OUT) {
                 if (!IPC_GET_RETVAL(answer->data)) {
                         /* Accepted, handle as_area receipt */
@@ -219 +219 @@
                         return rc;
                 }
-        } else if (IPC_GET_METHOD(*olddata) == IPC_M_AS_AREA_RECV) {
+        } else if (IPC_GET_METHOD(*olddata) == IPC_M_SHARE_IN) {
                 if (!IPC_GET_RETVAL(answer->data)) { 
                         ipl_t ipl;
@@ -314 +314 @@
                 call->priv = newphid;
                 break;
-        case IPC_M_AS_AREA_SEND:
+        case IPC_M_SHARE_OUT:
                 size = as_area_get_size(IPC_GET_ARG1(call->data));
                 if (!size)

uspace/app/klog/klog.c

@@ -64 +64 @@
         
         mapping = as_get_mappable_page(PAGE_SIZE);
-        res = ipc_call_sync_3_0(PHONE_NS, IPC_M_AS_AREA_RECV,
-            (sysarg_t) mapping, PAGE_SIZE, SERVICE_MEM_KLOG);
+        res = ipc_share_in_send_1_0(PHONE_NS, mapping, PAGE_SIZE,
+            SERVICE_MEM_KLOG);
         if (res) {
                 printf("Failed to initialize klog memarea\n");

uspace/lib/libc/generic/ipc.c

@@ -667 +667 @@
 }
 
+/** Wrapper for making IPC_M_SHARE_IN calls.
+ *
+ * @param phoneid       Phone that will be used to contact the receiving side.
+ * @param dst           Destination address space area base.
+ * @param size          Size of the destination address space area.
+ * @param arg           User defined argument.
+ * @param flags         Storage where the received flags will be stored. Can be
+ *                      NULL.
+ *
+ * @return              Zero on success or a negative error code from errno.h.
+ */
+int ipc_share_in_send(int phoneid, void *dst, size_t size, ipcarg_t arg,
+    int *flags)
+{
+        int res;
+        sysarg_t tmp_flags;
+        res = ipc_call_sync_3_2(phoneid, IPC_M_SHARE_IN, (ipcarg_t) dst,
+            (ipcarg_t) size, arg, NULL, &tmp_flags);
+        if (flags)
+                *flags = tmp_flags;
+        return res;
+}
+
+/** Wrapper for receiving the IPC_M_SHARE_IN calls.
+ *
+ * This wrapper only makes it more comfortable to receive IPC_M_SHARE_IN calls
+ * so that the user doesn't have to remember the meaning of each IPC argument.
+ *
+ * So far, this wrapper is to be used from within a connection fibril.
+ *
+ * @param callid        Storage where the hash of the IPC_M_SHARE_IN call will
+ *                      be stored.
+ * @param size          Destination address space area size.    
+ *
+ * @return              Non-zero on success, zero on failure.
+ */
+int ipc_share_in_receive(ipc_callid_t *callid, size_t *size)
+{
+        ipc_call_t data;
+        
+        assert(callid);
+        assert(size);
+
+        *callid = async_get_call(&data);
+        if (IPC_GET_METHOD(data) != IPC_M_SHARE_IN)
+                return 0;
+        *size = (size_t) IPC_GET_ARG2(data);
+        return 1;
+}
+
+/** Wrapper for answering the IPC_M_SHARE_IN calls.
+ *
+ * This wrapper only makes it more comfortable to answer IPC_M_DATA_READ calls
+ * so that the user doesn't have to remember the meaning of each IPC argument.
+ *
+ * @param callid        Hash of the IPC_M_DATA_READ call to answer.
+ * @param src           Source address space base.
+ * @param flags         Flags to be used for sharing. Bits can be only cleared.
+ *
+ * @return              Zero on success or a value from @ref errno.h on failure.
+ */
+int ipc_share_in_deliver(ipc_callid_t callid, void *src, int flags)
+{
+        return ipc_answer_2(callid, EOK, (ipcarg_t) src, (ipcarg_t) flags);
+}
+
+/** Wrapper for making IPC_M_SHARE_OUT calls.
+ *
+ * @param phoneid       Phone that will be used to contact the receiving side.
+ * @param src           Source address space area base address.
+ * @param flags         Flags to be used for sharing. Bits can be only cleared.
+ *
+ * @return              Zero on success or a negative error code from errno.h.
+ */
+int ipc_share_out_send(int phoneid, void *src, int flags)
+{
+        return ipc_call_sync_3_0(phoneid, IPC_M_SHARE_OUT, (ipcarg_t) src, 0,
+            (ipcarg_t) flags);
+}
+
+/** Wrapper for receiving the IPC_M_SHARE_OUT calls.
+ *
+ * This wrapper only makes it more comfortable to receive IPC_M_SHARE_OUT calls
+ * so that the user doesn't have to remember the meaning of each IPC argument.
+ *
+ * So far, this wrapper is to be used from within a connection fibril.
+ *
+ * @param callid        Storage where the hash of the IPC_M_SHARE_OUT call will
+ *                      be stored.
+ * @param size          Storage where the source address space area size will be
+ *                      stored.
+ * @param flags         Storage where the sharing flags will be stored.
+ *
+ * @return              Non-zero on success, zero on failure.
+ */
+int ipc_share_out_receive(ipc_callid_t *callid, size_t *size, int *flags)
+{
+        ipc_call_t data;
+        
+        assert(callid);
+        assert(size);
+        assert(flags);
+
+        *callid = async_get_call(&data);
+        if (IPC_GET_METHOD(data) != IPC_M_DATA_WRITE)
+                return 0;
+        *size = (size_t) IPC_GET_ARG2(data);
+        *flags = (int) IPC_GET_ARG3(data);
+        return 1;
+}
+
+/** Wrapper for answering the IPC_M_SHARE_OUT calls.
+ *
+ * This wrapper only makes it more comfortable to answer IPC_M_SHARE_OUT calls
+ * 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           Destination address space area base address.    
+ *
+ * @return              Zero on success or a value from @ref errno.h on failure.
+ */
+int ipc_share_out_deliver(ipc_callid_t callid, void *dst)
+{
+        return ipc_answer_1(callid, EOK, (ipcarg_t) dst);
+}
+
+
 /** Wrapper for making IPC_M_DATA_READ calls.
  *

uspace/lib/libc/generic/time.c

@@ -136 +136 @@
         void *mapping;
         sysarg_t s1, s2;
-        sysarg_t rights;
+        int rights;
         int res;
 
@@ -142 +142 @@
                 mapping = as_get_mappable_page(PAGE_SIZE);
                 /* Get the mapping of kernel clock */
-                res = ipc_call_sync_3_2(PHONE_NS, IPC_M_AS_AREA_RECV,
-                    (sysarg_t) mapping, PAGE_SIZE, SERVICE_MEM_REALTIME, NULL,
-                    &rights);
+                res = ipc_share_in_send_1_1(PHONE_NS, mapping, PAGE_SIZE,
+                    SERVICE_MEM_REALTIME, &rights);
                 if (res) {
                         printf("Failed to initialize timeofday memarea\n");

uspace/lib/libc/include/ipc/ipc.h

@@ -263 +263 @@
 
 
+/*
+ * User-friendly wrappers for ipc_share_in_send().
+ */
+#define ipc_share_in_send_0_0(phoneid, dst, size) \
+    ipc_share_in_send((phoneid), (dst), (size), 0, NULL)
+#define ipc_share_in_send_0_1(phoneid, dst, size, flags) \
+    ipc_share_in_send((phoneid), (dst), (size), 0, (flags))
+#define ipc_share_in_send_1_0(phoneid, dst, size, arg) \
+    ipc_share_in_send((phoneid), (dst), (size), (arg), NULL)
+#define ipc_share_in_send_1_1(phoneid, dst, size, arg, flags) \
+    ipc_share_in_send((phoneid), (dst), (size), (arg), (flags))
+
+extern int ipc_share_in_send(int phoneid, void *dst, size_t size, ipcarg_t arg,
+    int *flags);
+extern int ipc_share_in_receive(ipc_callid_t *callid, size_t *size);
+extern int ipc_share_in_deliver(ipc_callid_t callid, void *src, int flags);
+extern int ipc_share_out_send(int phoneid, void *src, int flags);
+extern int ipc_share_out_receive(ipc_callid_t *callid, size_t *size, int *flags);
+extern int ipc_share_out_deliver(ipc_callid_t callid, void *dst);
 extern int ipc_data_read_send(int phoneid, void *dst, size_t size);
 extern int ipc_data_read_receive(ipc_callid_t *callid, size_t *size);

uspace/lib/libfs/libfs.c

@@ -95 +95 @@
          * Request sharing the Path Lookup Buffer with VFS.
          */
-        rc = ipc_call_sync_2_0(vfs_phone, IPC_M_AS_AREA_RECV,
-            (ipcarg_t) reg->plb_ro, PLB_SIZE);
+        rc = ipc_share_in_send_0_0(vfs_phone, reg->plb_ro, PLB_SIZE);
         if (rc) {
                 async_wait_for(req, NULL);

uspace/srv/console/console.c

@@ -538 +538 @@
             PROTO_READ | PROTO_WRITE, MAP_ANONYMOUS | MAP_PRIVATE, 0, 0);
         if (!interbuffer) {
-                if (async_req_3_0(fb_info.phone, IPC_M_AS_AREA_SEND,
-                    (ipcarg_t) interbuffer, 0, AS_AREA_READ) != 0) {
+                if (ipc_share_out_send(fb_info.phone, interbuffer,
+                    AS_AREA_READ) != EOK) {
                         munmap(interbuffer,
                             sizeof(keyfield_t) * fb_info.cols * fb_info.rows);

uspace/srv/console/gcons.c

@@ -326 +326 @@
         if (rc)
                 goto exit;
-        rc = async_req_3_0(fbphone, IPC_M_AS_AREA_SEND, (ipcarg_t) shm, 0,
-            PROTO_READ);
+        rc = ipc_share_out_send(fbphone, shm, PROTO_READ);
         if (rc)
                 goto drop;
@@ -388 +387 @@
         if (rc)
                 goto exit;
-        rc = async_req_3_0(fbphone, IPC_M_AS_AREA_SEND, (ipcarg_t) shm, 0,
-            PROTO_READ);
+        rc = ipc_share_out_send(fbphone, shm, PROTO_READ);
         if (rc)
                 goto drop;

uspace/srv/fb/ega.c

@@ -209 +209 @@
                         ipc_answer_0(callid, EOK);
                         return; /* Exit thread */
-                case IPC_M_AS_AREA_SEND:
+                case IPC_M_SHARE_OUT:
                         /* We accept one area for data interchange */
                         intersize = IPC_GET_ARG2(call);

uspace/srv/fb/fb.c

@@ -748 +748 @@
 
         switch (IPC_GET_METHOD(*call)) {
-        case IPC_M_AS_AREA_SEND:
+        case IPC_M_SHARE_OUT:
                 /* We accept one area for data interchange */
                 if (IPC_GET_ARG1(*call) == shm_id) {

uspace/srv/ns/ns.c

@@ -118 +118 @@
                 callid = ipc_wait_for_call(&call);
                 switch (IPC_GET_METHOD(call)) {
-                case IPC_M_AS_AREA_RECV:
+                case IPC_M_SHARE_IN:
                         switch (IPC_GET_ARG3(call)) {
                         case SERVICE_MEM_REALTIME:

uspace/srv/rd/rd.c

@@ -104 +104 @@
          * Now we wait for the client to send us its communication as_area.
          */
-        callid = async_get_call(&call);
-        if (IPC_GET_METHOD(call) == IPC_M_AS_AREA_SEND) {
-                if (IPC_GET_ARG1(call) >= (ipcarg_t) BLOCK_SIZE) {
+        size_t size;
+        if (ipc_share_out_receive(&callid, &size, NULL)) {
+                if (size >= BLOCK_SIZE) {
                         /*
                          * The client sends an as_area that can absorb the whole
                          * block.
                          */
-                        ipc_answer_1(callid, EOK, (uintptr_t) fs_va);
+                        (void) ipc_share_out_deliver(callid, fs_va);
                 } else {
                         /*

uspace/srv/vfs/vfs_register.c

@@ -271 +271 @@
          * The client will want us to send him the address space area with PLB.
          */
-        callid = async_get_call(&call);
-        if (IPC_GET_METHOD(call) != IPC_M_AS_AREA_RECV) {
+
+        if (!ipc_share_in_receive(&callid, &size)) {
                 dprintf("Unexpected call, method = %d\n", IPC_GET_METHOD(call));
                 list_remove(&fs_info->fs_link);
@@ -286 +286 @@
          * We can only send the client address space area PLB_SIZE bytes long.
          */
-        size = IPC_GET_ARG2(call);
         if (size != PLB_SIZE) {
                 dprintf("Client suggests wrong size of PFB, size = %d\n", size);
@@ -301 +300 @@
          * Commit to read-only sharing the PLB with the client.
          */
-        ipc_answer_2(callid, EOK, (ipcarg_t) plb,
-            (ipcarg_t) (AS_AREA_READ | AS_AREA_CACHEABLE));     
+        (void) ipc_share_in_deliver(callid, plb,
+            AS_AREA_READ | AS_AREA_CACHEABLE);
 
         dprintf("Sharing PLB.\n");