sopc_common_constants.h

Go to the documentation of this file.

/*
 * Licensed to Systerel under one or more contributor license
 * agreements. See the NOTICE file distributed with this work
 * for additional information regarding copyright ownership.
 * Systerel licenses this file to you under the Apache
 * License, Version 2.0 (the "License"); you may not use this
 * file except in compliance with the License. You may obtain
 * a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
 
#ifndef SOPC_COMMON_CONSTANTS_H_
#define SOPC_COMMON_CONSTANTS_H_
 
#include <limits.h>
#include <stdbool.h>
#include <stdint.h>
#include <stdio.h>
 
#include "sopc_protocol_constants.h"
 
typedef struct SOPC_Common_EncodingConstants
{
    /* TCP UA configuration */
    uint32_t buffer_size;
    uint32_t receive_max_msg_size;
    uint32_t receive_max_nb_chunks;
    uint32_t send_max_msg_size;
    uint32_t send_max_nb_chunks;
 
    /* OPC UA types configuration */
    int32_t max_string_length; // reception only
    int32_t max_array_length;  // reception only
    uint32_t max_nested_diag_info;
    uint32_t max_nested_struct;
} SOPC_Common_EncodingConstants;
 
SOPC_Common_EncodingConstants SOPC_Common_GetDefaultEncodingConstants(void);
 
bool SOPC_Common_SetEncodingConstants(SOPC_Common_EncodingConstants config);
 
bool SOPC_Common_EncodingConstantsGetInitialized(void);
 
#ifndef SOPC_DEFAULT_TCP_UA_MAX_BUFFER_SIZE
#define SOPC_DEFAULT_TCP_UA_MAX_BUFFER_SIZE UINT16_MAX
#endif /* SOPC_DEFAULT_TCP_UA_MAX_BUFFER_SIZE */
 
#ifndef SOPC_DEFAULT_RECEIVE_MAX_NB_CHUNKS
#define SOPC_DEFAULT_RECEIVE_MAX_NB_CHUNKS 5
#endif /* SOPC_DEFAULT_RECEIVE_MAX_NB_CHUNKS */
 
#ifndef SOPC_DEFAULT_RECEIVE_MAX_MESSAGE_LENGTH
#define SOPC_DEFAULT_RECEIVE_MAX_MESSAGE_LENGTH SOPC_DEFAULT_TCP_UA_MAX_BUFFER_SIZE* SOPC_DEFAULT_RECEIVE_MAX_NB_CHUNKS
#endif /* SOPC_DEFAULT_RECEIVE_MAX_MESSAGE_LENGTH */
 
#ifndef SOPC_DEFAULT_SEND_MAX_NB_CHUNKS
#define SOPC_DEFAULT_SEND_MAX_NB_CHUNKS 12
#endif /* SOPC_DEFAULT_SEND_MAX_NB_CHUNKS */
 
#ifndef SOPC_DEFAULT_SEND_MAX_MESSAGE_LENGTH
#define SOPC_DEFAULT_SEND_MAX_MESSAGE_LENGTH SOPC_DEFAULT_TCP_UA_MAX_BUFFER_SIZE* SOPC_DEFAULT_SEND_MAX_NB_CHUNKS
#endif /* SOPC_DEFAULT_SEND_MAX_MESSAGE_LENGTH */
 
#ifndef SOPC_DEFAULT_MAX_STRING_LENGTH
#define SOPC_DEFAULT_MAX_STRING_LENGTH UINT16_MAX
#endif /* SOPC_DEFAULT_MAX_STRING_LENGTH */
 
#ifndef SOPC_DEFAULT_MAX_ARRAY_LENGTH
#define SOPC_DEFAULT_MAX_ARRAY_LENGTH 1000000
#endif /* SOPC_DEFAULT_MAX_ARRAY_LENGTH */
 
#ifndef SOPC_DEFAULT_MAX_DIAG_INFO_NESTED_LEVEL
#define SOPC_DEFAULT_MAX_DIAG_INFO_NESTED_LEVEL 100
#endif /* SOPC_DEFAULT_MAX_DIAG_INFO_NESTED_LEVEL */
 
#ifndef SOPC_DEFAULT_MAX_STRUCT_NESTED_LEVEL
#define SOPC_DEFAULT_MAX_STRUCT_NESTED_LEVEL 50
#endif /* SOPC_DEFAULT_MAX_STRUCT_NESTED_LEVEL */
 
/* @brief Maximum number of elements in Async Queue */
#ifndef SOPC_MAX_NB_ELEMENTS_ASYNC_QUEUE
#define SOPC_MAX_NB_ELEMENTS_ASYNC_QUEUE 5000
#endif /* SOPC_MAX_NB_ELEMENTS_ASYNC_QUEUE */
 
#ifndef SOPC_MAX_NB_ELEMENTS_ASYNC_QUEUE_WARNING_ONLY
#define SOPC_MAX_NB_ELEMENTS_ASYNC_QUEUE_WARNING_ONLY true
#endif /* SOPC_MAX_NB_ELEMENTS_ASYNC_QUEUE_WARNING_ONLY */
 
#ifndef SOPC_LOG_MAX_USER_LINE_LENGTH
#define SOPC_LOG_MAX_USER_LINE_LENGTH 512
#endif /* SOPC_LOG_MAX_USER_LINE_LENGTH */
 
#ifndef SOPC_HAS_FILESYSTEM
#define SOPC_HAS_FILESYSTEM true
#endif /* SOPC_HAS_FILESYSTEM */
 
#ifndef SOPC_MAX_TIMERS
#define SOPC_MAX_TIMERS UINT8_MAX /* TODO: avoid static maximum (see monitoredItems Id creation) */
#endif
 
#ifndef SOPC_CONSOLE_PRINTF
#define SOPC_CONSOLE_PRINTF printf
#endif /* SOPC_CONSOLE_PRINTF */
 
#ifndef SOPC_IS_LITTLE_ENDIAN
#define SOPC_IS_LITTLE_ENDIAN 1
#endif /* SOPC_IS_LITTLE_ENDIAN */
 
#ifndef SOPC_IS_DOUBLE_MIDDLE_ENDIAN
#define SOPC_IS_DOUBLE_MIDDLE_ENDIAN 0
#endif /* SOPC_IS_DOUBLE_MIDDLE_ENDIAN */
 
/* Check use of uintptr_t is not an issue on the current platform */
#if UINTPTR_MAX < UINT32_MAX
#error "UINTPTR_MAX < UINT32_MAX whereas uintptr_t are used to store uint32_t values"
#endif
 
/* Check casts from uint32_t / int32_t to size_t are valid without verification */
#if SIZE_MAX < UINT32_MAX
#error "SIZE_MAX < UINT32_MAX whereas uint32_t are casted to size_t values"
#endif
 
/* Check casts from long to size_t are valid without verification */
#if SIZE_MAX < LONG_MAX
#error "SIZE_MAX < LONG_MAX whereas long are casted to size_t values"
#endif
 
/* Check that the message buffer is large enough to hold the minimal TCP UA chunk */
#if SOPC_DEFAULT_TCP_UA_MAX_BUFFER_SIZE < SOPC_TCP_UA_MIN_BUFFER_SIZE
#error "SOPC_DEFAULT_TCP_UA_MAX_BUFFER_SIZE is not large enough, must be >= SOPC_TCP_UA_MIN_BUFFER_SIZE"
#endif
 
/* Check that the message buffer is large enough to hold the minimal TCP UA chunk */
#if 0 != SOPC_DEFAULT_RECEIVE_MAX_MESSAGE_LENGTH && \
    (SOPC_DEFAULT_RECEIVE_MAX_MESSAGE_LENGTH < SOPC_DEFAULT_TCP_UA_MAX_BUFFER_SIZE)
#error "SOPC_DEFAULT_RECEIVE_MAX_MESSAGE_LENGTH is not large enough, must be >= SOPC_TCP_UA_MAX_BUFFER_SIZE"
#endif
 
/* Check that both number of chunks and message length are not defined to 0
 * Note: it is required to have a maximum size of message body buffer defined
 */
#if 0 == SOPC_DEFAULT_RECEIVE_MAX_MESSAGE_LENGTH && 0 == SOPC_DEFAULT_RECEIVE_MAX_NB_CHUNKS
#error \
    "It is forbidden to define both SOPC_DEFAULT_RECEIVE_MAX_MESSAGE_LENGTH and SOPC_DEFAULT_RECEIVE_MAX_NB_CHUNKS to value 0 (no limit)"
#endif
 
/* Check that the message buffer is large enough to hold the minimal TCP UA chunk */
#if 0 != SOPC_DEFAULT_SEND_MAX_MESSAGE_LENGTH && \
    (SOPC_DEFAULT_SEND_MAX_MESSAGE_LENGTH < SOPC_DEFAULT_TCP_UA_MAX_BUFFER_SIZE)
#error "SOPC_DEFAULT_SEND_MAX_MESSAGE_LENGTH is not large enough, must be >= SOPC_DEFAULT_TCP_UA_MAX_BUFFER_SIZE"
#endif
 
/* Check that both number of chunks and message length are not defined to 0
 * Note: it is required to have a maximum size of message body buffer defined
 */
#if 0 == SOPC_DEFAULT_SEND_MAX_MESSAGE_LENGTH && 0 == SOPC_DEFAULT_SEND_MAX_NB_CHUNKS
#error \
    "It is forbidden to define both SOPC_DEFAULT_SEND_MAX_MESSAGE_LENGTH and SOPC_DEFAULT_SEND_MAX_NB_CHUNKS to value 0 (no limit)"
#endif
 
/* \brief Internal use only */
const SOPC_Common_EncodingConstants* SOPC_Internal_Common_GetEncodingConstants(void);
 
/* \brief Internal use to check properties at runtime */
bool SOPC_Internal_Common_Constants_RuntimeCheck(void);
 
#endif /* SOPC_COMMON_CONSTANTS_H_ */