Changeset 661 for trunk/libs/libalmosmkh/almosmkh.h

Timestamp:

Oct 10, 2020, 4:41:37 PM (4 years ago)

Author:

alain

Message:

Introduce the non-standatd display_socket() syscall.
Improve the non-standard get_string() syscall.

File:

• trunk/libs/libalmosmkh/almosmkh.h (modified) (3 diffs)

trunk/libs/libalmosmkh/almosmkh.h

@@ -63 +63 @@
 
 /*************************************************************************************** 
- * This syscall returns the hardware platform parameters.
- ***************************************************************************************
- * @ x_size   : [out] number of clusters in a row.
- * @ y_size   : [out] number of clusters in a column.
- * @ ncores   : [out] number of cores per cluster.
- * @ return always 0.
- **************************************************************************************/
-int get_config( unsigned int * x_size,
-                unsigned int * y_size,
-                unsigned int * ncores );
+ * This syscall returns the hardware platform parameters in the hard_config_t pointed
+ * by the <config> argument. This structure is defined in the shared_almos.h file.
+ * The available configuration parameters are :
+ * - cores       : x_size / y_size / ncores
+ * - peripherals : nb_txt_channels / nb_nic_channels / nb_ioc_channels / nb_fbf_channels
+ ***************************************************************************************
+ * @ config   : [out] pointer on hard_config_t structure in user space.
+ * @ return 0 if success / return -1 if illegal argument.
+ **************************************************************************************/
+int get_config( struct hard_config_s * config );
 
 /*************************************************************************************** 
@@ -153 +153 @@
  * This syscall returns a character string from the standard "stdin" stream.
  * The string is copied in buffer pointed by the <string> argument. 
- * The string length (including the NUL terminating character) cannot be larger
- * than the size defined by the <size> argument.
+ * If the number of characters exceed the buffer length, all character are canceled
+ * in both the buffer & the echoed string, and a new string capture start. 
+ * - Only printable characters c such as (0x20 <= c) and (c < 0x7f) are echoed
+ *   and copied in the target buffer. 
+ * - The LF (0x0A) character signaling the end of string is replaced by an extra
+ *   NUL (0x00) character in the target buffer.
+ * - the DEL (0x7F), BS (0x08) control characters are taken into account, and can be
+ *   used to correct both the buffer content and the echoed string.
  ***************************************************************************************
  * @ string   : pointer on the string buffer.
- * @ maxlen   : max number of bytes in string buffer.
- * @ returns 0 if success / returns -1 if failure.
+ * @ maxlen   : max number of bytes in string buffer, including the terminating NUL.
+ * @ returns string length (including NUL) if success / returns -1 if failure.
  **************************************************************************************/
 int get_string( char * string,
@@ -308 +314 @@
 int display_fat( unsigned int min_slot,
                  unsigned int nb_slots );
+
+/*************************************************************************************** 
+ * This debug syscall displays on the kernel terminal the current state of
+ * a socket identified by the <pid> and <fdid> arguments.
+ * It can be called by any thread running in any cluster.
+ ***************************************************************************************
+ * @ pid        : target process identifier.
+ * @ fdid       : file descriptor identifying the target socket.
+ * @ return 0 if success / return -1 if socket not found.
+ **************************************************************************************/
+int display_socket( unsigned int pid,
+                    unsigned int fdid );
 
 /*****************************************************************************************