Changes between Version 155 and Version 156 of library_stdio

Timestamp:

Dec 11, 2016, 7:43:49 PM (8 years ago)

Author:

alain

Comment:

--

library_stdio

@@ -408 +408 @@
  * return socket identifier if success / returns -1 if error.
 
- === 2) void '''giet_nic_close'''( int socket ) ===
+ === 2) int '''giet_nic_close'''( int socket ) ===
 This function releases all memory allocated for a socket: the socket descriptor itself, and the RX packets / Tx packets queues associated to the socket. The kernel threads associated to these queues are desactivated.
  * '''socket''' : socket identifier.
  * return 0 if success / returns -1 if error.
 
- === 3) void '''giet_nic_bind'''( int socket , sockaddr_t * addr , int addr_len ) ===
+ === 3) int '''giet_nic_bind'''( int socket , sockaddr_t * addr , int addr_len ) ===
 This function makes the binding between a socket identified by the <socket> argument, and a local socket addres, that is a couple (IPV4 address  / port number). The default value
 INADDR_ANY value can be used fot thr IPV4 address, toask the kernel to define the value.
  * '''socket''' : socket identifier.
  * '''addr''' : pointer on the local socket address.
- * '''addr_len''' : address structure length (in bytes).
+ * '''addr_len''' : socket address length (in bytes).
  * return 0 if success / returns -1 if error.
 
- === 4) void '''giet_nic_connect'''( int socket , sockaddr_t * addr , int addr_len ) ===
+ === 4) int '''giet_nic_connect'''( int socket , sockaddr_t * addr , int addr_len ) ===
 This function is generally used by a client to connect a local client socket to a remote
 server socket. It forces the local socket in connected mode, and register the remote socket address in the local socket descriptor. It allows the client to use the read() / write() sytem call without specifying the explicitely the remote server address.
@@ -429 +429 @@
  * return 0 if success / returns -1 if error.
 
- === 5) void '''giet_nic_tx_move'''(  void* buffer ) ===
-This blocking function transfer one container (4 Kbytes)  from an user buffer to the kernel chbuf defined by the NIC_TX channel registered in the calling thread context. The <buffer> argument is the container base address in user space.
-Several user threads can concurrently access the same chbuf, because the syscall handler takes the lock protecting the chbuf. It returns only when the container has been fully transfered.
-The calling thread exit if the buffer is not in user space, or if no allocated NIC_TX channel, or in case of timeout. 
-
- === 6) void '''giet_nic_rx_move'''( void* buffer ) ===
-This blocking function transfer one container (4 Kbytes)  from the kernel chbuf defined by the NIC_RX channel registered in the calling thread context to an user buffer. The <buffer> argument is the container base address in user space.
-Several user threads can concurrently access the same chbuf, because the syscall handler takes the lock protecting the chbuf. It returns only when the container has been fully transfered.
-The calling thread exit if the buffer is not in user space, or if no allocated NIC_RX channel, or in case of timeout. 
-
- === 7) void '''giet_nic_tx_stop'''( ) ===
-This function must be called by one single thread (typically the main() ). It desactivates both the NIC_TX channel and the CMA_TX channel allocated to the calling thread.
-The calling thread exit if no allocated NIC_TX channel or no allocated CMA_TX channel.
-
- === 8) void '''giet_nic_rx_stop'''( ) ===
-This function  must be called by one single thread (typically the main() ). It desactivates both the NIC_RX channel and the CMA channel allocated to the calling thread.
-The calling thread exit if no allocated NIC_RX channel or no allocated CMA channel.
-
- === 9) void '''giet_nic_rx_clear'''( ) ===
-This function reset all instrumentation (packets counters) associated to the RX channels.
-
- === 10) void '''giet_nic_tx_clear'''( ) ===
-This function reset all instrumentation (packets counters) associated to the TX channels.
-
- === 11) void '''giet_nic_rx_stats'''( ) ===
-This function display on kernel TTY0 the content of the instrumentation registers associated to the RX channels.
-
- === 12) void '''giet_nic_tx_stats'''( ) ===
-This function display on kernel TTY0 the content of the instrumentation registers associated to the TX channels.
+ === 5) int '''giet_nic_sendto'''( int socket , void * buffer , int length , int flags , sockaddr_t * dest_addr , int addr_len ) ===
+This blocking function moves one ''raw'' packet from an user buffer defined by the <buffer> argument to a kernel buffer. The packet length (in bytes) is defned by the <length> arguments. It uses the the <socket> and <dest_addr> arguments to build the ETH/IP/UDP header. It returns only when the user buffer can be re-used. The user thread blocking uses a descheduling policy.
+ * '''socket''' : socket identifier.
+ * '''buffer''' : pointer on user buffer.
+ * '''length''' : raw packet length (bytes).
+ * '''flags''' : unsupported / must be 0.
+ * '''dest_addr''' : remote socket address.
+ * '''addr_len''' : socket address length (in bytes).
+ * return 0 if success / returns -1 if error.
+
+ === 6) int '''giet_nic_recvfrom'''( int socket , void * buffer , int length , int flags , sockaddr_t * dest_addr , int * addr_len ) ===
+This blocking function moves one ''raw'' packet from a kernel buffer to an user buffer defined by the <buffer> argument. The <length> argument define the user buffer size (in bytes). Packets exceeding this size are discarded. Only packets matching the local IP address and local port number, defined by the <socket> argument will be delivered (2 matching conditions). If the socket is in ''connected'' mode, the matching must also be on remote IP address an remote port number (4 matching conditions). The received packet length is written in the <addr_len> argument. The remote socket address is written in the <dest_addr> argument. It returns only when the user buffer has been written. The user thread blocking uses a descheduling policy.
+ * '''socket''' : socket identifier.
+ * '''buffer''' : pointer on user buffer.
+ * '''length''' : raw packet length (bytes).
+ * '''flags''' : unsupported / must be 0.
+ * '''dest_addr''' : pointer on remote socket address.
+ * '''addr_len''' : pointer on actual raw packet length. (in bytes).
+ * return 0 if success / returns -1 if error.
+
+ === 7) int '''giet_nic_write'''( int socket , void * buffer , int length void* buffer ) ===
+This blocking function makes the same as the giet_nic_sendto() function, with only one difference: the remote socket address must have been previously registered in the local socket descriptor using the giet_nic_connect() function.
+ * '''socket''' : socket identifier.
+ * '''buffer''' : pointer on user buffer.
+ * '''length''' : raw packet length (bytes).
+ * returns 0 if success / returns -1 if error.
+
+ === 8) void '''giet_nic_read'''( int socket , void * buffer , int length void* buffer ) ===
+This blocking function makes the same as the giet_nic_recvfrom() function, with two differences: (i) the remote socket address must have been previously registered in the local socket descriptor using the giet_nic_connect() function, (ii) the matching condition is computed on 4 conditions: local IP address, local port number, remote IP addresses, remote port number.
+ * '''socket''' : socket identifier.
+ * '''buffer''' : pointer on user buffer.
+ * '''length''' : raw packet length (bytes).
+ * returns 0 if success / returns -1 if error.
+
+ === 9) void '''giet_nic_print_stats'''( ) ===
+This function  print on the calling thread terminal the current values of the hardware NIC instrumentation counters.
+
+ === 10) void '''giet_nic_clear_stats'''( ) ===
+This function reset all Hardware NIC instrumentation counters.
+