dali/bacnet_stack
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Make most of functions const correct (#714)

Browse Source 
* Make most of the functions const correct

Used clang-tidy and sonarlint to help find places where const could
pretty easily applied. Also lot of hand work.

This commit does not yet touch handlers and typedefs of those.

* Fix Arduino uno handler_who_is() has extra parenthesis

For some reason there is extra parenthesis. Remove it this is more
likely buildable.

* Bugfix/bacapp: Fix uninitilized array_index

We have changed bacapp_snprintf_value() to be const correct. After that
we got

```
/home/runner/work/bacnet-stack/bacnet-stack/src/bacnet/bacapp.c:3183:27: warning: 4th function call argument is an uninitialized value [core.CallAndMessage]
                ret_val = bacapp_snprintf_weeklyschedule(
                          ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1 warning generated.
```

So analyzer could now spot that we do not actually initilize array_index
at all. Fix this by setting array_index to zero. Note that I actually do
not know if zeroing is right thing to do here. I choose zero as if this
has worked before it is most likely that it will work with zero value.

* cmake: Add and ignore Wwrite-strings compiler option

Wwrite-strings helps find places where const correctness is broken.

Example it will warn about these

```C

void func1(char* str);

func("test") /* "test" is const so we should not pass it to func1().

char* func2()
{
  return "test"; /* func2() should return const char*.
}
```

We still need to ignore it as not all are fixed but let's add it already
so we remember that it should be opened at some point.

---------

Co-authored-by: Kari Argillander <kari.argillander@fidelix.com>
This commit is contained in:
Kari Argillander
2024-08-29 22:08:02 +03:00
committed by GitHub
parent 0177c59f4a
commit a2f1d6959d
408 changed files with 2608 additions and 2336 deletions
Download Patch File Download Diff File Expand all files Collapse all files
ports/bdk-atxx4-mstp/bname.c
+10 -8
View File
@@ -18,7 +18,7 @@
#include "bacnet/basic/object/device.h"
#include "bname.h"
static bool bacnet_name_isvalid(uint8_t encoding, uint8_t length, char *str)
static bool bacnet_name_isvalid(uint8_t encoding, uint8_t length, const char *str)
{
bool valid = false;
@@ -35,7 +35,7 @@ static bool bacnet_name_isvalid(uint8_t encoding, uint8_t length, char *str)
}
bool bacnet_name_save(
uint16_t offset, uint8_t encoding, char *str, uint8_t length)
uint16_t offset, uint8_t encoding, const char *str, uint8_t length)
{
uint8_t buffer[NV_EEPROM_NAME_SIZE] = { 0 };
uint8_t i = 0;
@@ -55,11 +55,11 @@ bool bacnet_name_save(
return false;
}
bool bacnet_name_set(uint16_t offset, BACNET_CHARACTER_STRING *char_string)
bool bacnet_name_set(uint16_t offset, const BACNET_CHARACTER_STRING *char_string)
{
uint8_t encoding = 0;
uint8_t length = 0;
char *str = NULL;
const char *str = NULL;
length = characterstring_length(char_string);
encoding = characterstring_encoding(char_string);
@@ -70,7 +70,7 @@ bool bacnet_name_set(uint16_t offset, BACNET_CHARACTER_STRING *char_string)
bool bacnet_name_write_unique(uint16_t offset,
BACNET_OBJECT_TYPE object_type,
uint32_t object_instance,
BACNET_CHARACTER_STRING *char_string,
const BACNET_CHARACTER_STRING *char_string,
BACNET_ERROR_CLASS *error_class,
BACNET_ERROR_CODE *error_code)
{
@@ -120,7 +120,7 @@ bool bacnet_name_write_unique(uint16_t offset,
/* no required minumum length or duplicate checking */
bool bacnet_name_write(uint16_t offset,
BACNET_CHARACTER_STRING *char_string,
const BACNET_CHARACTER_STRING *char_string,
BACNET_ERROR_CLASS *error_class,
BACNET_ERROR_CODE *error_code)
{
@@ -149,14 +149,16 @@ bool bacnet_name_write(uint16_t offset,
return status;
}
void bacnet_name_init(uint16_t offset, char *default_string)
void bacnet_name_init(uint16_t offset, const char *default_string)
{
(void)bacnet_name_save(
offset, CHARACTER_UTF8, default_string, strlen(default_string));
}
void bacnet_name(
uint16_t offset, BACNET_CHARACTER_STRING *char_string, char *default_string)
uint16_t offset,
BACNET_CHARACTER_STRING *char_string,
const char *default_string)
{
uint8_t encoding = 0;
uint8_t length = 0;
ports/bdk-atxx4-mstp/bname.h
+6 -6
View File
@@ -17,30 +17,30 @@ extern "C" {
bool bacnet_name_set(
uint16_t eeprom_offset,
BACNET_CHARACTER_STRING * char_string);
const BACNET_CHARACTER_STRING * char_string);
void bacnet_name_init(
uint16_t eeprom_offset,
char *default_string);
const char *default_string);
bool bacnet_name_save(
uint16_t offset,
uint8_t encoding,
char *str,
const char *str,
uint8_t length);
void bacnet_name(
uint16_t eeprom_offset,
BACNET_CHARACTER_STRING * char_string,
char *default_string);
const char *default_string);
bool bacnet_name_write_unique(
uint16_t offset,
BACNET_OBJECT_TYPE object_type,
uint32_t object_instance,
BACNET_CHARACTER_STRING * char_string,
const BACNET_CHARACTER_STRING * char_string,
BACNET_ERROR_CLASS * error_class,
BACNET_ERROR_CODE * error_code);
/* no required minumum length or duplicate checking */
bool bacnet_name_write(
uint16_t offset,
BACNET_CHARACTER_STRING * char_string,
const BACNET_CHARACTER_STRING * char_string,
BACNET_ERROR_CLASS * error_class,
BACNET_ERROR_CODE * error_code);
ports/bdk-atxx4-mstp/device.c
+1 -1
View File
@@ -551,7 +551,7 @@ int Device_Object_List_Element_Encode(
return apdu_len;
}
bool Device_Valid_Object_Name(BACNET_CHARACTER_STRING *object_name1,
bool Device_Valid_Object_Name(const BACNET_CHARACTER_STRING *object_name1,
BACNET_OBJECT_TYPE *object_type,
uint32_t *object_instance)
{
ports/bdk-atxx4-mstp/dlmstp.c
+7 -7
View File
@@ -196,10 +196,10 @@ void dlmstp_fill_bacnet_address(BACNET_ADDRESS *src, uint8_t mstp_address)
}
}
static bool dlmstp_compare_data_expecting_reply(uint8_t *request_pdu,
static bool dlmstp_compare_data_expecting_reply(const uint8_t *request_pdu,
uint16_t request_pdu_len,
uint8_t src_address,
uint8_t *reply_pdu,
const uint8_t *reply_pdu,
uint16_t reply_pdu_len,
uint8_t dest_address)
{
@@ -314,8 +314,8 @@ static bool dlmstp_compare_data_expecting_reply(uint8_t *request_pdu,
static void MSTP_Send_Frame(
uint8_t frame_type, /* type of frame to send - see defines */
uint8_t destination, /* destination address */
uint8_t source, /* source address */
uint8_t *data, /* any data to be sent - may be null */
uint8_t source, /* source address */
const uint8_t *data, /* any data to be sent - may be null */
uint16_t data_len)
{ /* number of bytes of data (up to 501) */
uint8_t crc8 = 0xFF; /* used to calculate the crc value */
@@ -757,7 +757,7 @@ static bool MSTP_Master_Node_FSM(void)
frame_type = FRAME_TYPE_BACNET_DATA_NOT_EXPECTING_REPLY;
}
MSTP_Send_Frame(frame_type, pkt->destination_mac, This_Station,
(uint8_t *)&pkt->buffer[0], pkt->length);
&pkt->buffer[0], pkt->length);
FrameCount++;
switch (frame_type) {
case FRAME_TYPE_BACNET_DATA_EXPECTING_REPLY:
@@ -1111,7 +1111,7 @@ static bool MSTP_Master_Node_FSM(void)
frame_type = FRAME_TYPE_BACNET_DATA_NOT_EXPECTING_REPLY;
}
MSTP_Send_Frame(frame_type, pkt->destination_mac, This_Station,
(uint8_t *)&pkt->buffer[0], pkt->length);
&pkt->buffer[0], pkt->length);
Master_State = MSTP_MASTER_STATE_IDLE;
/* clear our flag we were holding for comparison */
MSTP_Flag.ReceivedValidFrame = false;
@@ -1195,7 +1195,7 @@ static void MSTP_Slave_Node_FSM(void)
frame_type = FRAME_TYPE_BACNET_DATA_NOT_EXPECTING_REPLY;
}
MSTP_Send_Frame(frame_type, pkt->destination_mac, This_Station,
(uint8_t *)&pkt->buffer[0], pkt->length);
&pkt->buffer[0], pkt->length);
(void)Ringbuf_Pop(&PDU_Queue, NULL);
}
/* clear our flag we were holding for comparison */
ports/bdk-atxx4-mstp/eeprom.c
+1 -1
View File
@@ -30,7 +30,7 @@ int eeprom_bytes_read(
}
int eeprom_bytes_write(uint16_t eeaddr, /* EEPROM starting memory address */
uint8_t *buf, /* data to send */
const uint8_t *buf, /* data to send */
int len)
{ /* number of bytes of data */
int count = 0;
ports/bdk-atxx4-mstp/eeprom.h
+1 -1
View File
@@ -21,7 +21,7 @@ extern "C" {
int nbytes); /* number of bytes of data to read */
int eeprom_bytes_write(
uint16_t ee_address, /* EEPROM starting memory address */
uint8_t * buffer, /* data to send */
const uint8_t * buffer, /* data to send */
int nbytes); /* number of bytes of data */
#ifdef __cplusplus
ports/bdk-atxx4-mstp/netport.c
+1 -1
View File
@@ -295,7 +295,7 @@ bool Network_Port_MAC_Address(
* @return true if object-name was set
*/
bool Network_Port_MAC_Address_Set(
uint32_t object_instance, uint8_t *mac_src, uint8_t mac_len)
uint32_t object_instance, const uint8_t *mac_src, uint8_t mac_len)
{
if (mac_len == 1) {
Object_List[0].MAC_Address[0] = mac_src[0];
ports/bdk-atxx4-mstp/rs485.c
+1 -1
View File
@@ -175,7 +175,7 @@ bool rs485_receive_error(void)
* RETURN: none
* NOTES: none
*****************************************************************************/
void rs485_bytes_send(uint8_t *buffer, /* data to send */
void rs485_bytes_send(const uint8_t *buffer, /* data to send */
uint16_t nbytes)
{ /* number of bytes of data */
led_on(LED_5);
ports/bdk-atxx4-mstp/rs485.h
+1 -1
View File
@@ -23,7 +23,7 @@ extern "C" {
bool rs485_receive_error(
void);
void rs485_bytes_send(
uint8_t * buffer, /* data to send */
const uint8_t * buffer, /* data to send */
uint16_t nbytes); /* number of bytes of data */
uint32_t rs485_baud_rate(
void);