Remove one argument to receive_msg and modbus_slave_receive

- the return value is used to pass the message length - remove the hack on exception check in modbus receive - update tests

Remove one argument to receive_msg and modbus_slave_receive
- the return value is used to pass the message length - remove the hack on exception check in modbus receive - update tests
Stéphane Raimbault
1 parent f20a1860
Showing 6 changed files with 100 additions and 105 deletions
src/modbus.c
src/modbus.h
tests/bandwidth-slave-many-up.c
tests/bandwidth-slave-one.c
tests/random-test-slave.c
tests/unit-test-slave.c
 /*
- * Copyright © 2001-2008 Stéphane Raimbault <stephane.raimbault@gmail.com>
+ * Copyright © 2001-2010 Stéphane Raimbault <stephane.raimbault@gmail.com>
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Lesser Public License as published by
@@ -252,6 +252,8 @@ static unsigned int compute_response_length(modbus_param_t *mb_param,
                 length = 3;
                 break;
         case FC_REPORT_SLAVE_ID:
+                /* The response is device specific (the header provides the
+                   length) */
                 return MSG_LENGTH_UNDEFINED;
         default:
                 length = 5;
@@ -393,7 +395,7 @@ static uint16_t crc16(uint8_t *buffer, uint16_t buffer_length)
         return (crc_hi << 8 | crc_lo);
 }
-/* If CRC is correct returns 0 else returns INVALID_CRC */
+/* If CRC is correct returns msg_length else returns INVALID_CRC */
 static int check_crc16(modbus_param_t *mb_param,
                        uint8_t *msg,
                        const int msg_length)
@@ -407,7 +409,7 @@ static int check_crc16(modbus_param_t *mb_param,
         /* Check CRC of msg */
         if (crc_calc == crc_received) {
-                ret = 0;
+                ret = msg_length;
         } else {
                 char s_error[64];
                 sprintf(s_error,
@@ -512,28 +514,35 @@ static int compute_query_length_data(modbus_param_t *mb_param, uint8_t *msg)
     }                                                                              \
                                                                                    \
     if (select_ret == 0) {                                                         \
-            /* Call to error_treat is done later to manage exceptions */           \
-            return SELECT_TIMEOUT;                                                 \
+            /* Timeout */                                                          \
+            if (msg_length == (TAB_HEADER_LENGTH[mb_param->type_com] + 2 +         \
+                               TAB_CHECKSUM_LENGTH[mb_param->type_com])) {         \
+                    /* Optimization allowed because exception response is          \
+                       the smallest trame in modbus protocol (3) so always         \
+                       raise a timeout error */                                    \
+                    return MB_EXCEPTION;                                           \
+            } else {                                                               \
+                    /* Call to error_treat is done later to manage exceptions */   \
+                    return SELECT_TIMEOUT;                                         \
+            }                                                                      \
     }                                                                              \
 }
 /* Waits a reply from a modbus slave or a query from a modbus master.
-   This function blocks for timeout seconds if there is no reply.
+   This function blocks if there is no replies (3 timeouts).
    In
    - msg_length_computed must be set to MSG_LENGTH_UNDEFINED if undefined
    Out
    - msg is an array of uint8_t to receive the message
-   - p_msg_length, the variable is assigned to the number of
-     characters received. This value won't be greater than
-     msg_length_computed.
-   Returns 0 in success or a negative value if an error occured.
+   On success, return the number of received characters. On error, return
+   a negative value.
 */
 static int receive_msg(modbus_param_t *mb_param,
                        int msg_length_computed,
-                       uint8_t *msg, int *p_msg_length)
+                       uint8_t *msg)
 {
         int select_ret;
         int read_ret;
@@ -544,9 +553,7 @@ static int receive_msg(modbus_param_t *mb_param,
         enum { FUNCTION, BYTE, COMPLETE };
         int state;
-        /* Initialize the return length before a call to WAIT_DATA because a
-         * time out can quit the function. */
-        (*p_msg_length) = 0;
+        int msg_length = 0;
         if (mb_param->debug) {
                 if (msg_length_computed == MSG_LENGTH_UNDEFINED)
@@ -599,7 +606,7 @@ static int receive_msg(modbus_param_t *mb_param,
                 }
                 /* Sums bytes received */
-                (*p_msg_length) += read_ret;
+                msg_length += read_ret;
                 /* Display the hex code of each character received */
                 if (mb_param->debug) {
@@ -608,9 +615,9 @@ static int receive_msg(modbus_param_t *mb_param,
                                 printf("<%.2X>", p_msg[i]);
                 }
-                if ((*p_msg_length) < msg_length_computed) {
+                if (msg_length < msg_length_computed) {
                         /* Message incomplete */
-                        length_to_read = msg_length_computed - (*p_msg_length);
+                        length_to_read = msg_length_computed - msg_length;
                 } else {
                         switch (state) {
                         case FUNCTION:
@@ -618,9 +625,9 @@ static int receive_msg(modbus_param_t *mb_param,
                                 length_to_read = compute_query_length_header(
                                         msg[TAB_HEADER_LENGTH[mb_param->type_com]]);
                                 msg_length_computed += length_to_read;
-                                /* It's useless to check
-                                   p_msg_length_computed value in this
-                                   case (only defined values are used). */
+                                /* It's useless to check the value of
+                                   msg_length_computed in this case (only
+                                   defined values are used). */
                                 state = BYTE;
                                 break;
                         case BYTE:
@@ -658,10 +665,12 @@ static int receive_msg(modbus_param_t *mb_param,
                 printf("\n");
         if (mb_param->type_com == RTU) {
-                return check_crc16(mb_param, msg, (*p_msg_length));
+                /* Returns msg_length on success and a negative value on
+                   failure */
+                return check_crc16(mb_param, msg, msg_length);
         } else {
                 /* OK */
-                return 0;
+                return msg_length;
         }
 }
@@ -670,28 +679,24 @@ static int receive_msg(modbus_param_t *mb_param,
    internal one of modbus_param_t.
    Returns:
-   - 0 on success, or a negative error number if the request fails
+   - byte length of the message on success, or a negative error number if the
+     request fails
    - query, message received
-   - query_length, length in bytes of the message */
-int modbus_slave_receive(modbus_param_t *mb_param, int sockfd,
-                         uint8_t *query, int *query_length)
+*/
+int modbus_slave_receive(modbus_param_t *mb_param, int sockfd, uint8_t *query)
 {
-        int ret;
-
         if (sockfd != -1) {
                 mb_param->fd = sockfd;
         }
         /* The length of the query to receive isn't known. */
-        ret = receive_msg(mb_param, MSG_LENGTH_UNDEFINED, query, query_length);
-
-        return ret;
+        return receive_msg(mb_param, MSG_LENGTH_UNDEFINED, query);
 }
 /* Receives the response and checks values (and checksum in RTU).
    Returns:
-   - the number of values (bits or word) if success or the response
+   - the number of values (bits or words) if success or the response
      length if no value is returned
    - less than 0 for exception errors
@@ -702,14 +707,12 @@ static int modbus_receive(modbus_param_t *mb_param,
                           uint8_t *response)
 {
         int ret;
-        int response_length;
         int response_length_computed;
         int offset = TAB_HEADER_LENGTH[mb_param->type_com];
         response_length_computed = compute_response_length(mb_param, query);
-        ret = receive_msg(mb_param, response_length_computed,
-                          response, &response_length);
-        if (ret == 0) {
+        ret = receive_msg(mb_param, response_length_computed, response);
+        if (ret >= 0) {
                 /* GOOD RESPONSE */
                 int query_nb_value;
                 int response_nb_value;
@@ -740,7 +743,7 @@ static int modbus_receive(modbus_param_t *mb_param,
                         break;
                 case FC_REPORT_SLAVE_ID:
                         /* Report slave ID (bytes received) */
-                        query_nb_value = response_nb_value = response_length;
+                        query_nb_value = response_nb_value = ret;
                         break;
                 default:
                         /* 1 Write functions & others */
@@ -757,55 +760,46 @@ static int modbus_receive(modbus_param_t *mb_param,
                         error_treat(mb_param, ret, s_error);
                         free(s_error);
                 }
-        } else if (ret == SELECT_TIMEOUT) {
-
-                if (response_length == (offset + 2 + TAB_CHECKSUM_LENGTH[mb_param->type_com])) {
-                        /* EXCEPTION CODE RECEIVED */
-
-                        /* Optimization allowed because exception response is
-                           the smallest trame in modbus protocol (3) so always
-                           raise a timeout error */
-
-                        /* CRC must be checked here (not done in receive_msg) */
-                        if (mb_param->type_com == RTU) {
-                                ret = check_crc16(mb_param, response, response_length);
-                                if (ret != 0)
-                                        return ret;
-                        }
+        } else if (ret == MB_EXCEPTION) {
+                /* EXCEPTION CODE RECEIVED */
+
+                /* CRC must be checked here (not done in receive_msg) */
+                if (mb_param->type_com == RTU) {
+                        ret = check_crc16(mb_param, response, EXCEPTION_RESPONSE_LENGTH_RTU);
+                        if (ret < 0)
+                                return ret;
+                }
-                        /* Check for exception response.
-                           0x80 + function is stored in the exception
-                           response. */
-                        if (0x80 + query[offset] == response[offset]) {
-
-                                int exception_code = response[offset + 1];
-                                // FIXME check test
-                                if (exception_code < NB_TAB_ERROR_MSG) {
-                                        error_treat(mb_param, -exception_code,
-                                                    TAB_ERROR_MSG[response[offset + 1]]);
-                                        /* RETURN THE EXCEPTION CODE */
-                                        /* Modbus error code is negative */
-                                        return -exception_code;
-                                } else {
-                                        /* The chances are low to hit this
-                                           case but it can avoid a vicious
-                                           segfault */
-                                        char *s_error = malloc(64 * sizeof(char));
-                                        sprintf(s_error,
-                                                "Invalid exception code %d",
-                                                response[offset + 1]);
-                                        error_treat(mb_param, INVALID_EXCEPTION_CODE,
-                                                    s_error);
-                                        free(s_error);
-                                        return INVALID_EXCEPTION_CODE;
-                                }
+                /* Check for exception response.
+                   0x80 + function is stored in the exception
+                   response. */
+                if (0x80 + query[offset] == response[offset]) {
+
+                        int exception_code = response[offset + 1];
+                        // FIXME check test
+                        if (exception_code < NB_TAB_ERROR_MSG) {
+                                error_treat(mb_param, -exception_code,
+                                            TAB_ERROR_MSG[response[offset + 1]]);
+                                /* RETURN THE EXCEPTION CODE */
+                                /* Modbus error code is negative */
+                                return -exception_code;
+                        } else {
+                                /* The chances are low to hit this
+                                   case but it can avoid a vicious
+                                   segfault */
+                                char *s_error = malloc(64 * sizeof(char));
+                                sprintf(s_error,
+                                        "Invalid exception code %d",
+                                        response[offset + 1]);
+                                error_treat(mb_param, INVALID_EXCEPTION_CODE,
+                                            s_error);
+                                free(s_error);
+                                return INVALID_EXCEPTION_CODE;
                         }
-                        /* If doesn't return previously, return as
-                           TIME OUT here */
                 }
-
-                error_treat(mb_param, ret, "Select timeout");
-                return ret;
+        } else {
+                /* Other errors */
+                error_treat(mb_param, ret, "receive_msg");
         }
         return ret;
 /*
- * Copyright © 2001-2009 Stéphane Raimbault <stephane.raimbault@gmail.com>
+ * Copyright © 2001-2010 Stéphane Raimbault <stephane.raimbault@gmail.com>
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Lesser Public License as published by
@@ -72,6 +72,8 @@ extern &quot;C&quot; {
 /* Kept for compatibility reasons (deprecated) */
 #define MAX_MESSAGE_LENGTH        260
+#define EXCEPTION_RESPONSE_LENGTH_RTU  5
+
 /* Modbus_Application_Protocol_V1_1b.pdf (chapter 6 section 1 page 12)
  * Quantity of Coils (2 bytes): 1 to 2000 (0x7D0)
  */
@@ -139,6 +141,7 @@ extern &quot;C&quot; {
 #define SELECT_FAILURE          -0x14
 #define SOCKET_FAILURE          -0x15
 #define CONNECTION_CLOSED       -0x16
+#define MB_EXCEPTION             -0x17
 /* Internal using */
 #define MSG_LENGTH_UNDEFINED -1
@@ -318,15 +321,15 @@ int modbus_slave_listen_tcp(modbus_param_t *mb_param, int nb_connection);
 int modbus_slave_accept_tcp(modbus_param_t *mb_param, int *socket);
 /* Listens for any query from a modbus master in TCP, requires the socket file
-   descriptor etablished with the master device in argument.
+   descriptor etablished with the master device in argument or -1 to use the
+   internal one of modbus_param_t.
    Returns:
-   - 0 on success, or a negative error number if the request fails
+   - byte length of the message on success, or a negative error number if the
+     request fails
    - query, message received
-   - query_length, length in bytes of the message
 */
-int modbus_slave_receive(modbus_param_t *mb_param, int sockfd,
-                         uint8_t *query, int *query_length);
+int modbus_slave_receive(modbus_param_t *mb_param, int sockfd, uint8_t *query);
 /* Manages the received query.
    Analyses the query and constructs a response.
@@ -106,11 +106,10 @@ int main(void)
                                 } else {
                                         /* An already connected master has sent a new query */
                                         uint8_t query[MAX_MESSAGE_LENGTH];
-                                        int query_size;
-                                        ret = modbus_slave_receive(&mb_param, master_socket, query, &query_size);
-                                        if (ret == 0) {
-                                                modbus_slave_manage(&mb_param, query, query_size, &mb_mapping);
+                                        ret = modbus_slave_receive(&mb_param, master_socket, query);
+                                        if (ret >= 0) {
+                                                modbus_slave_manage(&mb_param, query, ret, &mb_mapping);
                                         } else {
                                                 /* Connection closed by the client, end of server */
                                                 printf("Connection closed on socket %d\n", master_socket);
@@ -44,11 +44,10 @@ int main(void)
         while (1) {
                 uint8_t query[MAX_MESSAGE_LENGTH];
-                int query_size;
-                ret = modbus_slave_receive(&mb_param, -1, query, &query_size);
-                if (ret == 0) {
-                        modbus_slave_manage(&mb_param, query, query_size, &mb_mapping);
+                ret = modbus_slave_receive(&mb_param, -1, query);
+                if (ret >= 0) {
+                        modbus_slave_manage(&mb_param, query, ret, &mb_mapping);
                 } else if (ret == CONNECTION_CLOSED) {
                         /* Connection closed by the client, end of server */
                         break;
@@ -44,11 +44,12 @@ int main(void)
         while (1) {
                 uint8_t query[MAX_MESSAGE_LENGTH];
-                int query_size;
+                int ret;
-                ret = modbus_slave_receive(&mb_param, -1, query, &query_size);
-                if (ret == 0) {
-                        modbus_slave_manage(&mb_param, query, query_size, &mb_mapping);
+                ret = modbus_slave_receive(&mb_param, -1, query);
+                if (ret >= 0) {
+                        /* ret is the query size */
+                        modbus_slave_manage(&mb_param, query, ret, &mb_mapping);
                 } else if (ret == CONNECTION_CLOSED) {
                         /* Connection closed by the client, end of server */
                         break;
@@ -63,10 +63,9 @@ int main(void)
         while (1) {
                 uint8_t query[MAX_MESSAGE_LENGTH];
-                int query_size;
-                ret = modbus_slave_receive(&mb_param, -1, query, &query_size);
-                if (ret == 0) {
+                ret = modbus_slave_receive(&mb_param, -1, query);
+                if (ret >= 0) {
                         if (((query[HEADER_LENGTH_TCP + 3] << 8) + query[HEADER_LENGTH_TCP + 4])
                             == UT_HOLDING_REGISTERS_NB_POINTS_SPECIAL) {
                                 /* Change the number of values (offset
@@ -75,7 +74,7 @@ int main(void)
                                 query[HEADER_LENGTH_TCP + 4] = UT_HOLDING_REGISTERS_NB_POINTS;
                         }
-                        modbus_slave_manage(&mb_param, query, query_size, &mb_mapping);
+                        modbus_slave_manage(&mb_param, query, ret, &mb_mapping);
                 } else if (ret == CONNECTION_CLOSED) {
                         /* Connection closed by the client, end of server */
                         break;