Changes between Version 48 and Version 49 of kernel_syscalls

Timestamp:

Dec 4, 2016, 8:38:19 PM (7 years ago)

Author:

alain

Comment:

--

kernel_syscalls

@@ -138 +138 @@
 == NIC related syscall handlers ==
 
-These 6 functions can be used for both a NIC_RX or NIC_TX channel, depending on the '''is_rx''' argument.
-
-=== 1) int '''_sys_nic_alloc'''( unsigned int is_rx ,  unsigned int xmax ,  unsigned int ymax ) ===
-This function allocates a private NIC_RX or NIC_TX channel, and a private CMA channel to the calling task. It register these channel indexes in the task context. It allocates the distributed kernel chbuf associated to the NIC channel: both  the distributed 4 Kbytes containers (one container per cluster from the distributed kernel heap), and the chbuf  descriptor (in the seg_kernel_data segment in cluster [0,0]). The number of involved clusters is defined by the (xmax / ymax) parameters, that cannot be larger than (X_SIZE, Y_SIZE), but can be smaller.
- * '''is_rx''' : boolean (RX transfer if non zero)
- * '''xmax''' : number of clusters in a row 
- * '''ymax''' : number of clusters in a column
-Returns the NIC channel index if success. Return -1 if no NIC channel available, if no CMA channel available, if (xmax / ymax) are too large, or if not enough memory in the kernel heap.
-
-=== 2) int '''_sys_nic_start'''( unsigned int is_rx,  unsigned int channel ) ===
-This function starts the NIC channel allocated to the calling task, and starts the CMA transfer between the NIC chbuf and the distributed kernel chbuf. The CMA component is configured in OUT_OF_ORDER transfer mode (non blocking when a SRC or DST container is not available).
- * '''is_rx''' : boolean (RX transfer if non zero)
- * '''channel''' : RX or TX channel index
-Returns 0 if success. Returns -1 if no NIC channel or no CMA channel allocated to the calling task.
-
-=== 3) int '''_sys_nic_move'''(  unsigned int is_rx,  unsigned int channel,  void* buffer ) ===
-This function moves one 4 Kbytes container from the kernel chbuf defined by the ''nic_channel'' argument, to an user buffer defined by the ''buffer'' argument. To enforce locality, this blocking function returns only when the container  located in the same cluster as the calling task is full.  
- * '''is_rx''' : boolean (RX transfer if non zero)
- * '''channel''' : RX or TX channel index.
- * '''buffer''' is the user buffer virtual base address.
-Returns 0 if success, returns -1 if the user buffer address is illegal, or if the NIC channel is too large, or if the timeout is elapsed.
-
-=== 4) int '''_sys_nic_stop'''( unsigned int is_rx,  unsigned int channel ) ===
-This function stops the NIC and the CMA channels allocated to the calling task.
- * '''is_rx''' : boolean (RX transfer if non zero)
- * '''channel''' : RX or TX channel index
-Returns 0 if success. Returns -1 if no NIC channel or no CMA channel allocated to the calling task.
-
-=== 5) int '''_sys_nic_clear'''( unsigned int is_rx,  unsigned int channel ) ===
-This function reset the NIC instrumentation registers (packet counters).
-* '''is_rx''' : boolean (RX channels if non zero)
- * '''channel''' : RX or TX channel index
-
-=== 6) int '''_sys_nic_stats'''( unsigned int is_rx,  unsigned int channel ) ===
+=== 1) void '''_sys_nic_init'''( ) ===
+This function is called by the kernel_init() function.
+It allocates and initializes, for each NIC channel, the kernel NIC_TX_FIFO and the NIC_RX / NIC_TX kernel threads.
+
+=== 2) int '''_sys_nic_open'''( ) ===
+This function allocates a socket index to the calling thread, and allocates the socket descriptor in the same cluster as the calling thread. Then it allocates and initialize the NIC_RX_FIFO associated to the socket.
+Returns 0 if success. Returns -1 if no socket available.
+
+=== 3) int '''_sys_nic_bind'''(  unsigned int index ,  unsigned int local_addr , unsigned int local_port ) ===
+This function register the local IP address and local port number in the  socket descriptor identified by the <index> argument. 
+ * '''index''' : socket index.
+ * '''local_addr''' : local IPV4 address.
+ * '''local_port''' : local port.
+Returns 0 if success, returns -1 if the socket is not allocated to calling thread.
+
+=== 4) int '''_sys_nic_connect'''( unsigned int index ,  unsigned int remote_addr , unsigned int remote_port ) ===
+This function register the local IP address and local port number in the socket descriptor identified by the <index> argument. 
+ * '''index''' : socket index.
+ * '''remote_addr''' : local IPV4 address.
+ * '''remote_port''' : local port.
+Returns 0 if success. Returns -1 if the socket is not allocated to calling thread.
+
+=== 5) int '''_sys_nic_close'''( unsigned int index ) ===
+This function release the memory allocated for a socket identified by the <index> argument.
+ * '''index''' : socket index.
+Returns 0 if success, returns -1 if the socket is not allocated to calling thread.
+
+=== 6) int '''_sys_nic_write'''( unsigned int is_rx,  unsigned int channel ) ===
 This function displays on TTY0 the values stored in the NIC instrumentation registers (packet counters).
 * '''is_rx''' : boolean (RX channels if non zero)