oc_ri.h

Go to the documentation of this file.

/*
// Copyright (c) 2016-2019 Intel Corporation
// Copyright (c) 2021 Cascoda Ltd.
//
// Licensed 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 OC_RI_H
#define OC_RI_H
 
#include "oc_config.h"
#include "oc_endpoint.h"
#include "oc_rep.h"
#include "oc_uuid.h"
#include "util/oc_etimer.h"
#if defined _MSC_VER && !defined __INTEL_COMPILER
#define oc_ri_internal_expand(...) __VA_ARGS__
#define oc_ri_internal_expand_call(fn, ...)                                    \
  oc_ri_internal_expand_call2(fn, (__VA_ARGS__))
#define oc_ri_internal_expand_call2(fn, args) fn args
#endif
 
#if defined _MSC_VER && !defined __INTEL_COMPILER
#define oc_ri_create_const_resource_internal(                                  \
  next_resource, resource_name, device_index, name, uri, dpt, iface_mask,      \
  content_format, properties, get_cb, put_cb, post_cb, delete_cb, ctx,         \
  observe_period, instance, ...)                                               \
  oc_resource_data_t resource_name##_data;                                     \
  const oc_resource_t resource_name = {                                        \
    /*next*/ (oc_resource_t *)&next_resource,                                  \
    /*device*/ device_index,                                                   \
    /*name*/ oc_string_create_const(name),                                     \
    /*uri*/ oc_string_create_const(uri), /*types*/                             \
    oc_ri_internal_expand_call(oc_string_array_create_const, __VA_ARGS__),     \
    /*dpt*/ oc_string_create_const(dpt),                                       \
    /*interfaces*/ iface_mask,                                                 \
    /*content_type*/ content_format,                                           \
    /*properties*/ properties,                                                 \
    /*get_handler*/ { get_cb, ctx },                                           \
    /*put_handler*/ { put_cb, ctx },                                           \
    /*post_handler*/ { post_cb, ctx },                                         \
    /*delete_handler*/ { delete_cb, ctx },                                     \
    /*get_properties*/ { NULL, NULL },                                         \
    /*set_properties*/ { NULL, NULL },                                         \
    /*observe_period_seconds*/ observe_period,                                 \
    /*fb_instance*/ instance,                                                  \
    /*is_const*/ true,                                                         \
    /*runtime_data*/ &resource_name##_data,                                    \
  };
#else
#define oc_ri_create_const_resource_internal(                                  \
  next_resource, resource_name, device_index, name, uri, dpt, iface_mask,      \
  content_format, properties, get_cb, put_cb, post_cb, delete_cb, ctx,         \
  observe_period, instance, ...)                                               \
  oc_resource_data_t resource_name##_data;                                     \
  const oc_resource_t resource_name = {                                        \
    /*next*/ (oc_resource_t *)&next_resource,                                  \
    /*device*/ device_index,                                                   \
    /*name*/ oc_string_create_const(name),                                     \
    /*uri*/ oc_string_create_const(uri), /*types*/                             \
    oc_string_array_create_const(__VA_ARGS__),                                 \
    /*dpt*/ oc_string_create_const(dpt),                                       \
    /*interfaces*/ iface_mask,                                                 \
    /*content_type*/ content_format,                                           \
    /*properties*/ properties,                                                 \
    /*get_handler*/ { get_cb, ctx },                                           \
    /*put_handler*/ { put_cb, ctx },                                           \
    /*post_handler*/ { post_cb, ctx },                                         \
    /*delete_handler*/ { delete_cb, ctx },                                     \
    /*get_properties*/ { NULL, NULL },                                         \
    /*set_properties*/ { NULL, NULL },                                         \
    /*observe_period_seconds*/ observe_period,                                 \
    /*fb_instance*/ instance,                                                  \
    /*is_const*/ true,                                                         \
    /*runtime_data*/ &resource_name##_data,                                    \
  };
#endif
 
#if defined _MSC_VER && !defined __INTEL_COMPILER
#define oc_ri_create_const_resource_linked(next_resource, ...)                 \
  extern const oc_resource_t next_resource;                                    \
  oc_ri_internal_expand_call(oc_ri_create_const_resource_internal,             \
                             next_resource, __VA_ARGS__)
#else
#define oc_ri_create_const_resource_linked(next_resource, ...)                 \
  extern const oc_resource_t next_resource;                                    \
  oc_ri_create_const_resource_internal(next_resource, __VA_ARGS__)
#endif
 
#if defined _MSC_VER && !defined __INTEL_COMPILER
#define oc_ri_create_const_resource_final(resource_name, ...)                  \
  oc_resource_dummy_t resource_block_end##resource_name = { NULL, -1 };        \
  oc_ri_internal_expand_call(oc_ri_create_const_resource_internal,             \
                             resource_block_end##resource_name, resource_name, \
                             __VA_ARGS__)
#else
#define oc_ri_create_const_resource_final(resource_name, ...)                  \
  oc_resource_dummy_t resource_block_end##resource_name = { NULL, -1 };        \
                                                                               \
  oc_ri_create_const_resource_internal(resource_block_end##resource_name,      \
                                       resource_name, __VA_ARGS__)
#endif
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum {
  OC_GET = 1, 
  OC_POST,    
  OC_PUT,     
  OC_DELETE,  
  OC_FETCH    
} oc_method_t;
 
typedef enum {
  OC_UNDISCOVERABLE = 0,      
  OC_DISCOVERABLE = (1 << 0), 
  OC_OBSERVABLE = (1 << 1),   
  OC_SECURE = (1 << 4),       
  OC_PERIODIC = (1 << 6),     
  OC_SECURE_MCAST = (1 << 8)  
} oc_resource_properties_t;
 
typedef enum {
  OC_STATUS_OK = 0,                   
  OC_STATUS_CREATED,                  
  OC_STATUS_CHANGED,                  
  OC_STATUS_DELETED,                  
  OC_STATUS_NOT_MODIFIED,             
  OC_STATUS_BAD_REQUEST,              
  OC_STATUS_UNAUTHORIZED,             
  OC_STATUS_BAD_OPTION,               
  OC_STATUS_FORBIDDEN,                
  OC_STATUS_NOT_FOUND,                
  OC_STATUS_METHOD_NOT_ALLOWED,       
  OC_STATUS_NOT_ACCEPTABLE,           
  OC_STATUS_REQUEST_ENTITY_TOO_LARGE, 
  OC_STATUS_UNSUPPORTED_MEDIA_TYPE,   
  OC_STATUS_INTERNAL_SERVER_ERROR,    
  OC_STATUS_NOT_IMPLEMENTED,          
  OC_STATUS_BAD_GATEWAY,              
  OC_STATUS_SERVICE_UNAVAILABLE,      
  OC_STATUS_GATEWAY_TIMEOUT,          
  OC_STATUS_PROXYING_NOT_SUPPORTED,   
  __NUM_OC_STATUS_CODES__,
  OC_IGNORE,      
  OC_PING_TIMEOUT 
} oc_status_t;
 
typedef enum {
  TEXT_PLAIN = 0,                    
  TEXT_XML = 1,                      
  TEXT_CSV = 2,                      
  TEXT_HTML = 3,                     
  IMAGE_GIF = 21,                    
  IMAGE_JPEG = 22,                   
  IMAGE_PNG = 23,                    
  IMAGE_TIFF = 24,                   
  AUDIO_RAW = 25,                    
  VIDEO_RAW = 26,                    
  APPLICATION_LINK_FORMAT = 40,      
  APPLICATION_XML = 41,              
  APPLICATION_OCTET_STREAM = 42,     
  APPLICATION_RDF_XML = 43,          
  APPLICATION_SOAP_XML = 44,         
  APPLICATION_ATOM_XML = 45,         
  APPLICATION_XMPP_XML = 46,         
  APPLICATION_EXI = 47,              
  APPLICATION_FASTINFOSET = 48,      
  APPLICATION_SOAP_FASTINFOSET = 49, 
  APPLICATION_JSON = 50,             
  APPLICATION_X_OBIX_BINARY = 51,    
  APPLICATION_CBOR = 60,             
  APPLICATION_SENML_JSON = 110,      
  APPLICATION_SENSML_JSON = 111,     
  APPLICATION_SENML_CBOR = 112,      
  APPLICATION_SENSML_CBOR = 113,     
  APPLICATION_SENML_EXI = 114,       
  APPLICATION_SENSML_EXI = 115,      
  APPLICATION_PKCS7_SGK =
    280, 
  APPLICATION_PKCS7_CO =
    281, 
  APPLICATION_PKCS7_CMC_REQUEST =
    282, 
  APPLICATION_PKCS7_CMC_RESPONSE =
    283, 
  APPLICATION_PKCS8 = 284,                
  APPLICATION_CRATTRS = 285,              
  APPLICATION_PKCS10 = 286,               
  APPLICATION_PKIX_CERT = 287,            
  APPLICATION_VND_OCF_CBOR = 10000,       
  APPLICATION_OSCORE = 10001,             
  APPLICATION_VND_OMA_LWM2M_TLV = 11542,  
  APPLICATION_VND_OMA_LWM2M_JSON = 11543, 
  APPLICATION_VND_OMA_LWM2M_CBOR = 11544, 
  CONTENT_NONE = 99999                    
} oc_content_format_t;
 
typedef struct oc_separate_response_s oc_separate_response_t;
 
typedef struct oc_response_buffer_s oc_response_buffer_t;
 
typedef struct oc_response_t
{
  oc_separate_response_t *separate_response; 
  oc_response_buffer_t *response_buffer;     
} oc_response_t;
 
typedef enum {
  OC_IF_NONE = 0,        
  OC_IF_I = (1 << 1),    
  OC_IF_O = (1 << 2),    
  OC_IF_G = (1 << 3),    
  OC_IF_C = (1 << 4),    
  OC_IF_P = (1 << 5),    
  OC_IF_D = (1 << 6),    
  OC_IF_A = (1 << 7),    
  OC_IF_S = (1 << 8),    
  OC_IF_LI = (1 << 9),   
  OC_IF_B = (1 << 10),   
  OC_IF_SEC = (1 << 11), 
  OC_IF_SWU = (1 << 12), 
  OC_IF_PM = (1 << 13),  
  OC_IF_M = (1 << 14)    
} oc_interface_mask_t;
 
#define OC_MAX_IF_MASKS 14
 
const char *get_interface_string(oc_interface_mask_t mask);
 
const char *get_method_name(oc_method_t method);
 
int oc_total_interface_in_mask(oc_interface_mask_t iface_mask);
 
int oc_get_interface_in_mask_in_string_array(oc_interface_mask_t iface_mask,
                                             int nr_entries,
                                             oc_string_array_t interface_array);
 
void oc_print_interface(oc_interface_mask_t iface_mask);
 
typedef enum {
  OC_DEV_SN = 0, 
  OC_DEV_HWV,    
  OC_DEV_FWV,    
  OC_DEV_HWT,   
  OC_DEV_MODEL, 
  OC_DEV_HOSTNAME,    
  OC_DEV_IID,         
  OC_DEV_PM,          
  OC_DEV_IPV6,        
  OC_DEV_SA,          
  OC_DEV_DA,          
  OC_DEV_FID,         
  OC_DEV_PORT,        
  OC_DEV_MPORT,       
  OC_DEV_MID,         
  OC_DEV,             
  OC_APP,             
  OC_APP_X,           
  OC_A_LSM,           
  OC_KNX_SPAKE,       
  OC_KNX_IDEVID,      
  OC_KNX_LDEVID,      
  OC_KNX_K,           
  OC_KNX_FINGERPRINT, 
  OC_KNX_IA,          
  OC_KNX_OSN,         
  OC_KNX,             
  OC_KNX_FP_G,        
  OC_KNX_FP_G_X,      
#ifdef OC_PUBLISHER_TABLE
  OC_KNX_FP_P,   
  OC_KNX_FP_P_X, 
#endif
  OC_KNX_FP_R,         
  OC_KNX_FP_R_X,       
  OC_KNX_P,            
  OC_KNX_F,            
  OC_KNX_F_X,          
  OC_KNX_SWU_PROTOCOL, 
  OC_KNX_SWU_MAXDEFER, 
  OC_KNX_SWU_METHOD,   
  OC_KNX_LASTUPDATE,   
  OC_KNX_SWU_RESULT,   
  OC_KNX_SWU_STATE,    
  OC_KNX_SWU_UPDATE,   
  OC_KNX_SWU_PKGV,     
  OC_KNX_SWU_PKGCMD,   
  OC_KNX_SWU_PKGBYTES, 
  OC_KNX_SWU_PKGQURL,  
  OC_KNX_SWU_PKGNAMES, 
#if 0                  // THIS SHOULD BE IMPLEMENTED IF INCLUDED
  OC_KNX_SWU_PKG,           
#endif
  OC_KNX_SWU,             
  OC_KNX_SUB,             
  OC_KNX_A_SEN,           
  OC_KNX_AUTH_O_REPLWDO,  
  OC_KNX_AUTH_O_OSNDELAY, 
  OC_KNX_AUTH_O,          
  OC_KNX_AUTH_AT,         
  OC_KNX_AUTH_AT_X,       
  OC_KNX_AUTH,            
#ifdef OC_IOT_ROUTER
  OC_KNX_FP_GM,   
  OC_KNX_FP_GM_X, 
#endif
  /* List of resources on a logical device: start */
  WELLKNOWNCORE 
  /* List of resources on a logical device: end */
} oc_core_resource_t;
 
#define OC_NUM_CORE_RESOURCES_PER_DEVICE (1 + WELLKNOWNCORE)
 
typedef struct oc_resource_s oc_resource_t;
 
typedef struct oc_request_t
{
  oc_endpoint_t *origin;         
  const oc_resource_t *resource; 
  const char *query;             
  size_t query_len;              
  const char *uri_path;          
  size_t uri_path_len;           
  oc_rep_t *request_payload;     
  const uint8_t *_payload;       
  size_t _payload_len;           
  oc_content_format_t
    content_format; 
  oc_content_format_t
    accept; 
  oc_response_t *response; 
} oc_request_t;
 
typedef void (*oc_request_callback_t)(oc_request_t *, oc_interface_mask_t,
                                      void *);
 
typedef struct oc_request_handler_s
{
  oc_request_callback_t cb;
  void *user_data;
} oc_request_handler_t;
 
typedef bool (*oc_set_properties_cb_t)(oc_resource_t *, oc_rep_t *, void *);
 
typedef void (*oc_get_properties_cb_t)(oc_resource_t *, oc_interface_mask_t,
                                       void *);
 
typedef struct oc_properties_cb_t
{
  union {
    oc_set_properties_cb_t set_props;
    oc_get_properties_cb_t get_props;
  } cb;
  void *user_data;
} oc_properties_cb_t;
 
typedef struct oc_resource_data_t
{
  uint8_t num_observers; 
} oc_resource_data_t;
 
struct oc_resource_s
{
  struct oc_resource_s *next;          
  size_t device;                       
  oc_string_t name;                    
  oc_string_t uri;                     
  oc_string_array_t types;             
  oc_string_t dpt;                     
  oc_interface_mask_t interfaces;      
  oc_content_format_t content_type;    
  oc_resource_properties_t properties; 
  oc_request_handler_t get_handler;    
  oc_request_handler_t put_handler;    
  oc_request_handler_t post_handler;   
  oc_request_handler_t delete_handler; 
  oc_properties_cb_t get_properties;   
  oc_properties_cb_t set_properties;   
  uint16_t observe_period_seconds;     
  uint8_t fb_instance; 
  const bool is_const; 
  oc_resource_data_t *runtime_data; 
};
 
typedef struct oc_resource_dummy_s
{
  struct oc_resource_s *next; 
  size_t device;              
} oc_resource_dummy_t;
 
typedef struct oc_link_s oc_link_t;
 
typedef enum {
  OC_EVENT_DONE = 0, 
  OC_EVENT_CONTINUE  
} oc_event_callback_retval_t;
 
typedef oc_event_callback_retval_t (*oc_trigger_t)(void *);
 
typedef struct oc_event_callback_s
{
  struct oc_event_callback_s *next; 
  struct oc_etimer timer;           
  oc_trigger_t callback;            
  void *data;                       
} oc_event_callback_t;
 
void oc_ri_init(void);
 
void oc_ri_shutdown(void);
 
void oc_ri_add_timed_event_callback_ticks(void *cb_data,
                                          oc_trigger_t event_callback,
                                          oc_clock_time_t ticks);
 
#define oc_ri_add_timed_event_callback_seconds(cb_data, event_callback,        \
                                               seconds)                        \
  do {                                                                         \
    oc_ri_add_timed_event_callback_ticks(cb_data, event_callback,              \
                                         (oc_clock_time_t)(seconds) *          \
                                           (oc_clock_time_t)OC_CLOCK_SECOND);  \
  } while (0)
 
void oc_ri_remove_timed_event_callback(void *cb_data,
                                       oc_trigger_t event_callback);
 
int oc_status_code(oc_status_t key);
 
bool oc_check_accept_header(oc_request_t *request, oc_content_format_t accept);
 
const oc_resource_t *oc_ri_get_app_resource_by_uri(const char *uri,
                                                   size_t uri_len,
                                                   size_t device);
 
const oc_resource_t *oc_ri_get_app_resources(void);
 
#ifdef OC_SERVER
oc_resource_t *oc_ri_alloc_resource(void);
oc_resource_data_t *oc_ri_alloc_resource_data(void);
bool oc_ri_add_resource(oc_resource_t *resource);
bool oc_ri_add_resource_block(const oc_resource_t *resource);
 
bool oc_ri_delete_resource(const oc_resource_t *resource);
bool oc_ri_delete_resource_block(const oc_resource_t *resource);
#endif /* OC_SERVER */
 
void oc_ri_free_resource_properties(oc_resource_t *resource);
 
const oc_resource_t *oc_ri_resource_next(const oc_resource_t *resource);
 
int oc_ri_get_query_nth_key_value(const char *query, size_t query_len,
                                  char **key, size_t *key_len, char **value,
                                  size_t *value_len, size_t n);
 
int oc_ri_get_query_value(const char *query, size_t query_len, const char *key,
                          char **value);
 
int oc_ri_query_exists(const char *query, size_t query_len, const char *key);
 
int oc_ri_query_nth_key_exists(const char *query, size_t query_len, char **key,
                               size_t *key_len, size_t n);
 
oc_interface_mask_t oc_ri_get_interface_mask(char *iface, size_t if_len);
 
bool oc_ri_is_app_resource_valid(const oc_resource_t *resource);
 
bool oc_ri_new_request_from_request(oc_request_t *new_request,
                                    oc_request_t *request,
                                    oc_response_buffer_t *response_buffer,
                                    oc_response_t *response_obj);
 
#ifdef __cplusplus
}
#endif
 
#endif /* OC_RI_H */