19#define min(a,b) ((a) < (b) ? (a) : (b))
23#ifndef COAP_ETAG_MAX_BYTES
24#define COAP_ETAG_MAX_BYTES 4
26#if COAP_ETAG_MAX_BYTES < 1 || COAP_ETAG_MAX_BYTES > 8
27#error COAP_ETAG_MAX_BYTES byte size invalid
30#if COAP_Q_BLOCK_SUPPORT
76 if (block->
szx == 7) {
88 if (block->
m && (length % 1024) != 0) {
89 coap_log_debug(
"block: Oversized packet - reduced to %zu from %zu\n",
90 length - (length % 1024), length);
91 length -= length % 1024;
124 block->
m = block_b.
m;
134 unsigned int blk_size,
size_t total) {
136 size_t avail = pdu->
max_size - token_options;
137 unsigned int start = num << (blk_size + 4);
138 unsigned int can_use_bert = block->
defined == 0 || block->
bert;
140 assert(start <= total);
141 memset(block, 0,
sizeof(*block));
143 block->
szx = block->
aszx = blk_size;
144 if (can_use_bert && blk_size == 6 && avail >= 1024 && session != NULL &&
149 block->
chunk_size = (uint32_t)((avail / 1024) * 1024);
151 block->
chunk_size = (size_t)1 << (blk_size + 4);
152 if (avail < block->chunk_size && (total - start) >= avail) {
158 coap_log_debug(
"not enough space, even the smallest block does not fit (1)\n");
161 new_blk_size =
coap_flsll((
long long)avail) - 5;
162 coap_log_debug(
"decrease block size for %zu to %d\n", avail, new_blk_size);
164 block->
szx = new_blk_size;
165 block->
num <<= szx - block->
szx;
166 block->
chunk_size = (size_t)1 << (new_blk_size + 4);
177 unsigned char buf[4];
182 start = block->
num << (block->
szx + 4);
183 if (block->
num != 0 && data_length <= start) {
193 block->
szx, data_length))
198 ((block_b.
num << 4) |
211 unsigned char buf[4];
215 start = block->
num << (block->
szx + 4);
216 if (block->
num != 0 && data_length <= start) {
224 block->
szx, data_length))
239 unsigned int block_num,
unsigned char block_szx) {
241 start = block_num << (block_szx + 4);
247 min(len - start, ((
size_t)1 << (block_szx + 4))),
254 unsigned int start = block->
num << (block->
szx + 4);
262 max_size = ((pdu->
max_size - token_options) / 1024) * 1024;
264 max_size = (size_t)1 << (block->
szx + 4);
269 min(len - start, max_size),
284 unsigned char buf[4];
286 int block2_requested = 0;
287#if COAP_SERVER_SUPPORT
293 memset(&block2, 0,
sizeof(block2));
300 block2_requested = 1;
301 if (block2.
num != 0 && length <= (block2.
num << (block2.
szx + 4))) {
304 length >> (block2.
szx + 4));
312#if COAP_SERVER_SUPPORT
318 if (request && request->
session &&
327 memcpy(&etag, digest.
key,
sizeof(etag));
328#if COAP_ETAG_MAX_BYTES != 8
351 if (block2_requested) {
404#if COAP_SERVER_SUPPORT
414 uint32_t block_mode) {
422 uint32_t block_mode) {
428#if ! COAP_Q_BLOCK_SUPPORT
436 size_t max_block_size) {
447 switch (max_block_size) {
458 coap_log_info(
"coap_context_set_max_block_size: Invalid max block size (%zu)\n",
463 max_block_size = (
coap_fls((uint32_t)max_block_size >> 4) - 1) & 0x07;
464 context->
block_mode &= ~COAP_BLOCK_MAX_SIZE_MASK;
471 const uint8_t *b,
size_t blen) {
472 return alen == blen && (alen == 0 || memcmp(a, b, alen) == 0);
479 uint64_t token_match =
483 LL_FOREACH(session->
lg_xmit, lg_xmit) {
489#if COAP_CLIENT_SUPPORT
509 lg_xmit->
next = NULL;
517 LL_PREPEND(session->
lg_xmit, lg_xmit);
522#if COAP_CLIENT_SUPPORT
540#if COAP_CLIENT_SUPPORT
564 coap_log_debug(
"** %s: coap_cancel_observe: COAP_BLOCK_USE_LIBCOAP not enabled\n",
569 LL_FOREACH_SAFE(session->
lg_crcv, lg_crcv, q) {
577#if COAP_Q_BLOCK_SUPPORT
625#if COAP_Q_BLOCK_SUPPORT
627 if (using_q_block1) {
628 mid = coap_send_q_block1(session, block, pdu, COAP_SEND_INC_PDU);
647 uint64_t token_match =
651 LL_FOREACH(session->
lg_crcv, lg_crcv) {
675 LL_PREPEND(session->
lg_crcv, lg_crcv);
681#if COAP_OSCORE_SUPPORT
727#if COAP_SERVER_SUPPORT
744 LL_FOREACH(session->
lg_xmit, lg_xmit) {
751 lg_xmit->b.b2.query ?
752 lg_xmit->b.b2.query : &empty)) {
761 memcmp(lg_xmit->
b.
b2.
rtag, rtag, rtag_length) != 0)
786#if COAP_Q_BLOCK_SUPPORT
792 int have_block_defined = 0;
794 uint8_t max_blk_size;
796 size_t token_options;
799#if COAP_Q_BLOCK_SUPPORT
803#if !COAP_SERVER_SUPPORT
809 coap_log_warn(
"coap_add_data_large: PDU already contains data\n");
817 coap_log_debug(
"** %s: coap_add_data_large: COAP_BLOCK_USE_LIBCOAP not enabled\n",
831#define MAX_BLK_LEN (((1UL << 20) - 1) * (1 << (6 + 4)))
833#if UINT_MAX > MAX_BLK_LEN
840#if COAP_SERVER_SUPPORT
861 memcpy(&etag, digest.
key,
sizeof(etag));
862#if COAP_ETAG_MAX_BYTES != 8
888 if (etag == etag_r) {
903#if COAP_Q_BLOCK_SUPPORT
919 LL_FOREACH_SAFE(session->
lg_xmit, lg_xmit, q) {
923#if COAP_CLIENT_SUPPORT
926 LL_DELETE(session->
lg_xmit, lg_xmit);
937#if COAP_Q_BLOCK_SUPPORT
938 if (session->
block_mode & COAP_BLOCK_HAS_Q_BLOCK) {
951#if COAP_SERVER_SUPPORT
959 LL_DELETE(session->
lg_xmit, lg_xmit);
966#if COAP_OSCORE_SUPPORT
967 if (session->oscore_encryption) {
975 avail = pdu->
max_size - token_options;
978#if COAP_OSCORE_SUPPORT
983 blk_size =
coap_flsll((
long long)avail) - 4 - 1;
988 if (max_blk_size && blk_size > max_blk_size)
989 blk_size = max_blk_size;
993 if (block.
szx < blk_size)
994 blk_size = block.
szx;
995 have_block_defined = 1;
997#if COAP_Q_BLOCK_SUPPORT
1000 if (have_block_defined) {
1002 coap_log_warn(
"Both BlockX and Q-BlockX cannot be set at the same time\n");
1006 if (block.
szx < blk_size)
1007 blk_size = block.
szx;
1008 have_block_defined = 1;
1009 option = alt_option;
1014 if (avail < 16 && ((ssize_t)length > avail || have_block_defined)) {
1016 coap_log_debug(
"not enough space, even the smallest block does not fit (2)\n");
1020 chunk = (size_t)1 << (blk_size + 4);
1021 if ((have_block_defined && block.
num != 0) || single_request ||
1026 if (length >= block.
num * chunk) {
1027#if COAP_SERVER_SUPPORT
1033 (
unsigned int)length),
1047 (block.
num << 4) | (block.
m << 3) | block.
aszx),
1052 if (chunk > length - block.
num * chunk)
1053 rem = length - block.
num * chunk;
1060 }
else if ((have_block_defined && length > chunk) || (ssize_t)length > avail) {
1080 lg_xmit->blk_size = blk_size;
1081 lg_xmit->option = option;
1083 if (!lg_xmit->data_info)
1085 lg_xmit->data_info->ref = 0;
1086 lg_xmit->data_info->data = data;
1087 lg_xmit->data_info->length = length;
1088#if COAP_Q_BLOCK_SUPPORT
1089 lg_xmit->non_timeout_random_ticks =
1092 lg_xmit->data_info->release_func = release_func;
1093 lg_xmit->data_info->app_ptr = app_ptr;
1100 if (!lg_xmit->b.b1.app_token)
1108 lg_xmit->b.b1.count = 1;
1110 lg_xmit->b.b1.count);
1119 (
unsigned int)length),
1132 lg_xmit->b.b2.resource = resource;
1135 if (lg_xmit->b.b2.query) {
1136 memcpy(lg_xmit->b.b2.query->s, query->
s, query->
length);
1139 lg_xmit->b.b2.query = NULL;
1144 sizeof(lg_xmit->b.b2.rtag));
1146 lg_xmit->b.b2.rtag_set = 1;
1148 lg_xmit->b.b2.rtag_set = 0;
1150 lg_xmit->b.b2.etag = etag;
1151 lg_xmit->b.b2.request_method = request_method;
1158 lg_xmit->b.b2.maxage_expire = 0;
1163 (
unsigned int)length),
1168 blk_size, lg_xmit->data_info->length))
1175 (block.
num << 4) | (block.
m << 3) | block.
aszx),
1183 avail = pdu->
max_size - token_options;
1188#if COAP_OSCORE_SUPPORT
1191 if (avail < (ssize_t)chunk) {
1194 coap_log_warn(
"not enough space, even the smallest block does not fit (3)\n");
1197 blk_size =
coap_flsll((
long long)avail) - 4 - 1;
1198 block.
num = block.
num << (lg_xmit->blk_size - blk_size);
1199 lg_xmit->blk_size = blk_size;
1200 chunk = (size_t)1 << (lg_xmit->blk_size + 4);
1206 (block.
num << 4) | (block.
m << 3) | lg_xmit->blk_size),
1211 if (rem > lg_xmit->data_info->length - block.
num * chunk)
1212 rem = lg_xmit->data_info->length - block.
num * chunk;
1217 lg_xmit->b.b1.bert_size = rem;
1219 lg_xmit->last_block = -1;
1222 LL_PREPEND(session->
lg_xmit,lg_xmit);
1225 if (have_block_defined) {
1229 (0 << 4) | (0 << 3) | blk_size), buf);
1244 }
else if (release_func) {
1250#if COAP_CLIENT_SUPPORT
1255 const uint8_t *data,
1263 release_func, app_ptr);
1272 const uint8_t *data,
1286 length, data, release_func, app_ptr, 0, 0);
1290#if COAP_SERVER_SUPPORT
1297 uint16_t media_type,
1301 const uint8_t *data,
1309 response, query, media_type, maxage, etag,
1310 length, data, release_func, app_ptr);
1321 uint16_t media_type,
1325 const uint8_t *data,
1329 unsigned char buf[4];
1331 int block_requested = 0;
1332 int single_request = 0;
1333#if COAP_Q_BLOCK_SUPPORT
1334 uint32_t block_opt = (session->
block_mode & COAP_BLOCK_HAS_Q_BLOCK) ?
1340 memset(&block, 0,
sizeof(block));
1347 block_requested = 1;
1348 if (block.
num != 0 && length <= (block.
num << (block.
szx + 4))) {
1351 length >> (block.
szx + 4));
1356#if COAP_Q_BLOCK_SUPPORT
1358 block_requested = 1;
1359 if (block.
num != 0 && length <= (block.
num << (block.
szx + 4))) {
1362 length >> (block.
szx + 4));
1366 if (!(session->
block_mode & COAP_BLOCK_HAS_Q_BLOCK)) {
1387 if (block_requested) {
1411 query, maxage, etag, length, data,
1412 release_func, app_ptr, single_request,
1415 goto error_released;
1425#if COAP_ERROR_PHRASE_LENGTH > 0
1443#if COAP_Q_BLOCK_SUPPORT
1453 LL_FOREACH_SAFE(session->
lg_xmit, lg_xmit, q) {
1457 LL_DELETE(session->
lg_xmit, lg_xmit);
1461 if (*tim_rem > lg_xmit->
last_all_sent + idle_timeout - now) {
1467 if (lg_xmit->
last_sent + partial_timeout <= now) {
1470#if COAP_CLIENT_SUPPORT
1474 LL_DELETE(session->
lg_xmit, lg_xmit);
1481 if (*tim_rem > lg_xmit->
last_sent + partial_timeout - now) {
1482 *tim_rem = lg_xmit->
last_sent + partial_timeout - now;
1491#if COAP_CLIENT_SUPPORT
1492#if COAP_Q_BLOCK_SUPPORT
1521 int block_payload_set = -1;
1537 block_size = (size_t)1 << (lg_crcv->
szx + 4);
1538 sofar = block * block_size;
1539 if (sofar < lg_crcv->total_len) {
1542 pdu = coap_build_missing_pdu(session, lg_crcv);
1548 (block << 4) | (1 << 3) | lg_crcv->
szx),
1561 pdu = coap_build_missing_pdu(session, lg_crcv);
1566 if (block_payload_set == -1)
1572 (block << 4) | (0 << 3) | lg_crcv->
szx),
1580 block_size = (size_t)1 << (lg_crcv->
szx + 4);
1581 sofar = (block + 1) * block_size;
1582 if (sofar < lg_crcv->total_len) {
1585 pdu = coap_build_missing_pdu(session, lg_crcv);
1589 sofar = (lg_crcv->
total_len + block_size - 1)/block_size;
1591 if (block_payload_set == -1)
1593 for (; block < (ssize_t)sofar &&
1597 (block << 4) | (0 << 3) | lg_crcv->
szx),
1605 if (block_payload_set != -1)
1606 lg_crcv->
rec_blocks.processing_payload_set = block_payload_set;
1621#if COAP_Q_BLOCK_SUPPORT
1627#if COAP_Q_BLOCK_SUPPORT
1629 session->
block_mode & COAP_BLOCK_HAS_Q_BLOCK)
1635 LL_FOREACH_SAFE(session->
lg_crcv, lg_crcv, q) {
1639#if COAP_Q_BLOCK_SUPPORT
1641 size_t scaled_timeout = receive_timeout *
1651 coap_request_missing_q_block2(session, lg_crcv);
1663 lg_crcv->
last_used + partial_timeout <= now) {
1664#if COAP_Q_BLOCK_SUPPORT
1668 LL_DELETE(session->
lg_crcv, lg_crcv);
1672 if (*tim_rem > lg_crcv->
last_used + partial_timeout - now) {
1673 *tim_rem = lg_crcv->
last_used + partial_timeout - now;
1682#if COAP_SERVER_SUPPORT
1683#if COAP_Q_BLOCK_SUPPORT
1711 assert(block >= 0 && block < (1 << 20));
1713 if (block < 0 || block >= (1 << 20)) {
1715 }
else if (block < 24) {
1718 }
else if (block < 0x100) {
1722 }
else if (block < 0x10000) {
1725 val[1] = block >> 8;
1726 val[2] = block & 0xff;
1730 val[1] = block >> 16;
1731 val[2] = (block >> 8) & 0xff;
1732 val[3] = block & 0xff;
1748 for (i = 0; i < rec_blocks->
used; i++) {
1749 if (block_num < rec_blocks->range[i].begin)
1751 if (block_num <= rec_blocks->range[i].end)
1757#if COAP_SERVER_SUPPORT
1759check_if_next_block(
coap_rblock_t *rec_blocks, uint32_t block_num) {
1760 if (rec_blocks->
used == 0) {
1761 return block_num == 0 ? 1 : 0;
1763 if (rec_blocks->
range[rec_blocks->
used-1].
end + 1 == block_num)
1780 for (i = 0; i < rec_blocks->
used; i++) {
1781 if (block < rec_blocks->range[i].begin)
1783 if (block < rec_blocks->range[i].end)
1789#if COAP_CLIENT_SUPPORT
1790#if COAP_Q_BLOCK_SUPPORT
1794 if (rec_blocks->
used &&
1796 rec_blocks->processing_payload_set)
1804 if (rec_blocks->
used > 1 &&
1806 rec_blocks->processing_payload_set)
1813#if COAP_SERVER_SUPPORT
1824#if COAP_Q_BLOCK_SUPPORT
1830#if COAP_Q_BLOCK_SUPPORT
1832 session->
block_mode & COAP_BLOCK_HAS_Q_BLOCK)
1838 LL_FOREACH_SAFE(session->
lg_srcv, lg_srcv, q) {
1846#if COAP_Q_BLOCK_SUPPORT
1848 size_t scaled_timeout = receive_timeout *
1858 size_t block_size = (size_t)1 << (lg_srcv->
szx + 4);
1859 size_t final_block = (lg_srcv->
total_len + block_size - 1)/block_size - 1;
1861 size_t last_payload_block;
1863 size_t no_blocks = 0;
1876 if (no_blocks == 0 && block == (
int)final_block)
1882 if (final_block > last_payload_block) {
1883 final_block = last_payload_block;
1885 no_blocks += final_block - block;
1886 if (no_blocks == 0) {
1888 final_block = (lg_srcv->
total_len + block_size - 1)/block_size - 1;
1890 if (final_block > last_payload_block) {
1891 final_block = last_payload_block;
1901 pdu = pdu_408_build(session, lg_srcv);
1907 if (!add_408_block(pdu, block)) {
1917 for (; block <= (int)final_block; block++) {
1919 pdu = pdu_408_build(session, lg_srcv);
1923 if (!add_408_block(pdu, block)) {
1943#if COAP_Q_BLOCK_SUPPORT
1963 (
const uint8_t *)
"Missing interim block");
1967 LL_DELETE(session->
lg_srcv, lg_srcv);
1971 if (*tim_rem > lg_srcv->
last_used + partial_timeout - now) {
1972 *tim_rem = lg_srcv->
last_used + partial_timeout - now;
1981#if COAP_Q_BLOCK_SUPPORT
1990 coap_send_pdu_t send_pdu) {
1995 const uint8_t *ptoken;
1997 size_t ltoken_length;
1998 uint32_t delayqueue_cnt = 0;
2001 if (send_pdu == COAP_SEND_INC_PDU)
2010 (send_pdu == COAP_SEND_INC_PDU ? 1 : 0);
2011 LL_FOREACH(session->
delayqueue, delayqueue) {
2039 ptoken, &drop_options);
2045 if (send_pdu == COAP_SEND_INC_PDU &&
2055 size_t chunk = ((size_t)1 << (lg_xmit->
blk_size + 4));
2081 ltoken_length, ptoken, &drop_options);
2086 ((block.
num) << 4) |
2125#if COAP_CLIENT_SUPPORT
2138 LL_FOREACH_SAFE(session->
lg_xmit, lg_xmit, q) {
2139 coap_tick_t non_timeout = lg_xmit->non_timeout_random_ticks;
2141 if (now <= non_timeout) {
2143 *tim_rem = non_timeout - now;
2146 timed_out = now - non_timeout;
2152 size_t chunk = (size_t)1 << (lg_xmit->
blk_size + 4);
2154 memset(&block, 0,
sizeof(block));
2155 block.
num = (uint32_t)(lg_xmit->
offset / chunk);
2158 coap_send_q_blocks(session, lg_xmit, block, lg_xmit->
sent_pdu, COAP_SEND_SKIP_PDU);
2159 if (*tim_rem > non_timeout) {
2160 *tim_rem = non_timeout;
2174 LL_DELETE(session->
lg_xmit, lg_xmit);
2178 if (*tim_rem > lg_xmit->
last_all_sent + 4 * non_timeout - now) {
2189#if COAP_SERVER_SUPPORT
2202 LL_FOREACH_SAFE(session->
lg_xmit, lg_xmit, q) {
2203 coap_tick_t non_timeout = lg_xmit->non_timeout_random_ticks;
2205 if (now <= non_timeout) {
2207 *tim_rem = non_timeout - now;
2210 timed_out = now - non_timeout;
2216 size_t chunk = (size_t)1 << (lg_xmit->
blk_size + 4);
2218 memset(&block, 0,
sizeof(block));
2219 block.
num = (uint32_t)(lg_xmit->
offset / chunk);
2223 coap_send_q_blocks(session, lg_xmit, block, lg_xmit->
sent_pdu, COAP_SEND_SKIP_PDU);
2224 if (*tim_rem > non_timeout) {
2225 *tim_rem = non_timeout;
2239 LL_DELETE(session->
lg_xmit, lg_xmit);
2243 if (*tim_rem > lg_xmit->
last_all_sent + 4 * non_timeout - now) {
2255#if COAP_CLIENT_SUPPORT
2269 if (opt && lg_crcv) {
2270 int observe_action = -1;
2281 (block_num + 1) *
sizeof(lg_crcv->
obs_token[0]));
2294 if (lg_crcv->
obs_token[block_num] == NULL)
2298 if (block_num < lg_crcv->obs_token_cnt) {
2306#if COAP_Q_BLOCK_SUPPORT
2311 coap_send_pdu_t send_request) {
2314 uint64_t token_match =
2318 LL_FOREACH(session->
lg_xmit, lg_xmit) {
2327 return coap_send_q_blocks(session, lg_xmit, block, request, send_request);
2332#if COAP_SERVER_SUPPORT
2333#if COAP_Q_BLOCK_SUPPORT
2344 coap_send_pdu_t send_response) {
2349 LL_FOREACH(session->
lg_xmit, lg_xmit) {
2354 lg_xmit->b.b2.query ? lg_xmit->b.b2.query : &empty))
2357 return coap_send_q_blocks(session, lg_xmit, block, response, send_response);
2367 if (data_info->
ref > 0) {
2378#if COAP_CLIENT_SUPPORT
2379#if COAP_Q_BLOCK_SUPPORT
2411 11, (
const uint8_t *)
".well-known");
2413 4, (
const uint8_t *)
"core");
2426 (0 << 4) | (0 << 3) | 0),
2446 if (lg_crcv == NULL)
2449 coap_log_debug(
"** %s: lg_crcv %p initialized - stateless token xxxxx%011llx\n",
2453 lg_crcv->initial = 1;
2471 const uint8_t *data;
2474 if (data_len < lg_xmit->data_info->length) {
2485 if (!lg_crcv->app_token) {
2492 lg_crcv->retry_counter = 1;
2493 lg_crcv->state_token = state_token;
2500 new_token = track_fetch_observe(pdu, lg_crcv, 0, &pdu->
actual_token);
2508 lg_crcv->o_blk_size = block.
aszx;
2519#if (COAP_MAX_LOGGING_LEVEL < _COAP_LOG_DEBUG)
2522 if (lg_crcv == NULL)
2543#if COAP_SERVER_SUPPORT
2547#if (COAP_MAX_LOGGING_LEVEL < _COAP_LOG_DEBUG)
2550 if (lg_srcv == NULL)
2565 if (lg_xmit == NULL)
2580#if COAP_SERVER_SUPPORT
2587add_block_send(uint32_t num,
int is_continue, send_track *out_blocks,
2588 uint32_t *count, uint32_t max_count) {
2591 for (i = 0; i < *count && *count < max_count; i++) {
2592 if (num == out_blocks[i].num)
2594 else if (num < out_blocks[i].num) {
2596 memmove(&out_blocks[i], &out_blocks[i+1], *count - i -1);
2597 out_blocks[i].num = num;
2598 out_blocks[i].is_continue = is_continue;
2603 if (*count < max_count) {
2604 out_blocks[i].num = num;
2605 out_blocks[i].is_continue = is_continue;
2638 uint16_t block_opt = 0;
2639 send_track *out_blocks = NULL;
2640 const char *error_phrase;
2645 uint32_t request_cnt, i;
2648#if COAP_Q_BLOCK_SUPPORT
2653 if (!(session->
block_mode & COAP_BLOCK_HAS_Q_BLOCK))
2660 coap_log_warn(
"Block2 and Q-Block2 cannot be in the same request\n");
2661 coap_add_data(response,
sizeof(
"Both Block2 and Q-Block2 invalid")-1,
2662 (
const uint8_t *)
"Both Block2 and Q-Block2 invalid");
2664 goto skip_app_handler;
2671 if (block.
num == 0) {
2676 if (lg_xmit == NULL)
2679#if COAP_Q_BLOCK_SUPPORT
2685 goto internal_issue;
2698 if (etag == lg_xmit->
b.
b2.
etag) {
2712 chunk = (size_t)1 << (lg_xmit->
blk_size + 4);
2715 coap_log_debug(
"found Block option, block is BERT, block nr. %u, M %d\n",
2716 block.
num, block.
m);
2718 coap_log_debug(
"found Block option, block size is %u, block nr. %u, M %d\n",
2719 1 << (block.
szx + 4), block.
num, block.
m);
2722 if (block.
num == 0) {
2723 if ((lg_xmit->
offset + chunk) % ((
size_t)1 << (block.
szx + 4)) == 0) {
2728 block.
num = (uint32_t)(((lg_xmit->
offset + chunk) >> (block.
szx + 4)) - 1);
2730 chunk = (size_t)1 << (lg_xmit->
blk_size + 4);
2732 coap_log_debug(
"new Block size is %u, block number %u completed\n",
2733 1 << (block.
szx + 4), block.
num);
2736 "next block is not aligned on requested block size "
2737 "boundary. (%zu x %u mod %u = %zu (which is not 0)\n",
2739 (1 << (block.
szx + 4)),
2740 (lg_xmit->
offset + chunk) % ((
size_t)1 << (block.
szx + 4)));
2743 coap_log_debug(
"ignoring request to change Block size from %u to %u\n",
2744 (1 << (lg_xmit->
blk_size + 4)), (1 << (block.
szx + 4)));
2756#if COAP_Q_BLOCK_SUPPORT
2769 sizeof(
"Changing blocksize during request invalid")-1,
2770 (
const uint8_t *)
"Changing blocksize during request invalid");
2772 goto skip_app_handler;
2774#if COAP_Q_BLOCK_SUPPORT
2779 goto call_app_handler;
2783 num + i < max_block; i++) {
2784 add_block_send(num + i, 1, out_blocks, &request_cnt,
2792 num + i < max_block; i++) {
2793 add_block_send(num + i, 0, out_blocks, &request_cnt,
2798 add_block_send(num, 0, out_blocks, &request_cnt,
2801 add_block_send(num, 0, out_blocks, &request_cnt, 1);
2805 if (request_cnt == 0) {
2809 out_blocks[0].num = 0;
2810 out_blocks[0].is_continue = 0;
2814 for (i = 0; i < request_cnt; i++) {
2817 block.
num = out_blocks[i].num;
2820 if (i + 1 < request_cnt) {
2827 if (out_blocks[i].is_continue) {
2836 goto internal_issue;
2839 if (out_blocks[i].is_continue)
2854 goto internal_issue;
2864 ((out_pdu->
max_size - token_options) /1024) * 1024;
2875 goto internal_issue;
2877 if (!(lg_xmit->
offset + chunk < lg_xmit->data_info->length)) {
2885 if (!(lg_xmit->
offset + chunk < lg_xmit->data_info->length)) {
2903 goto internal_issue;
2911 goto internal_issue;
2913 if (i + 1 < request_cnt) {
2919 goto skip_app_handler;
2920#if COAP_Q_BLOCK_SUPPORT
2930 (
const uint8_t *)error_phrase);
2951 rec_blocks->
retry = 0;
2953 for (i = 0; i < rec_blocks->
used; i++) {
2954 if (block_num >= rec_blocks->
range[i].
begin &&
2955 block_num <= rec_blocks->range[i].end)
2958 if (block_num < rec_blocks->range[i].begin) {
2959 if (block_num + 1 == rec_blocks->
range[i].
begin) {
2966 memmove(&rec_blocks->
range[i+1], &rec_blocks->
range[i],
2967 (rec_blocks->
used - i) *
sizeof(rec_blocks->
range[0]));
2973 if (block_num == rec_blocks->
range[i].
end + 1) {
2974 rec_blocks->
range[i].
end = block_num;
2975 if (i + 1 < rec_blocks->
used) {
2976 if (rec_blocks->
range[i+1].
begin == block_num + 1) {
2979 if (i+2 < rec_blocks->
used) {
2980 memmove(&rec_blocks->
range[i+1], &rec_blocks->
range[i+2],
2981 (rec_blocks->
used - (i+2)) *
sizeof(rec_blocks->
range[0]));
2989 if (i == rec_blocks->
used) {
3003#if COAP_SERVER_SUPPORT
3023 const uint8_t *data = NULL;
3028 uint16_t block_option = 0;
3035 const uint8_t *rtag;
3036 uint32_t max_block_szx;
3038 unsigned int saved_num;
3039 size_t saved_offset;
3042 *pfree_lg_srcv = NULL;
3049#if COAP_Q_BLOCK_SUPPORT
3052 coap_add_data(response,
sizeof(
"Block1 + Q-Block1 together")-1,
3053 (
const uint8_t *)
"Block1 + Q-Block1 together");
3055 goto skip_app_handler;
3059#if COAP_Q_BLOCK_SUPPORT
3065 if (!block_option ||
3068 goto call_app_handler;
3094 goto skip_app_handler;
3098 offset = block.
num << (block.
szx + 4);
3101#
if COAP_Q_BLOCK_SUPPORT
3120 if (total < (length + offset + (block.
m ? 1 : 0)))
3121 total = length + offset + (block.m ? 1 : 0);
3123 *added_block = block.
m;
3125 goto call_app_handler;
3131 LL_FOREACH(session->
lg_srcv, lg_srcv) {
3132 if (rtag_opt || lg_srcv->
rtag_set == 1) {
3133 if (!(rtag_opt && lg_srcv->
rtag_set == 1))
3136 memcmp(lg_srcv->
rtag, rtag, rtag_length) != 0)
3139 if (resource == lg_srcv->
resource) {
3150 (
const uint8_t *)
"Missing block 0");
3152 goto skip_app_handler;
3158 if (lg_srcv == NULL) {
3160 (
const uint8_t *)
"Memory issue");
3162 goto skip_app_handler;
3174 if (!block.
bert && block.
num == 0 && max_block_szx != 0 &&
3175 max_block_szx < block.
szx) {
3176 lg_srcv->
szx = max_block_szx;
3178 lg_srcv->
szx = block.
szx;
3192 LL_PREPEND(session->
lg_srcv, lg_srcv);
3200 (
const uint8_t *)
"Missing interim block");
3202 goto skip_app_handler;
3206 coap_add_data(response,
sizeof(
"Content-Format mismatch")-1,
3207 (
const uint8_t *)
"Content-Format mismatch");
3212#if COAP_Q_BLOCK_SUPPORT
3216 (
const uint8_t *)
"Size1 mismatch");
3230 saved_num = block.
num;
3231 saved_offset = offset;
3233 while (offset < saved_offset + length) {
3238 coap_add_data(response,
sizeof(
"Too many missing blocks")-1,
3239 (
const uint8_t *)
"Too many missing blocks");
3246 offset = block.
num << (block.
szx + 4);
3252#if COAP_Q_BLOCK_SUPPORT
3256 if (lg_srcv->
total_len < saved_offset + length) {
3257 lg_srcv->
total_len = saved_offset + length;
3265 length, data, saved_offset,
3269 goto skip_app_handler;
3276 (
const uint8_t *)
"Memory issue");
3278 goto skip_app_handler;
3289#if COAP_Q_BLOCK_SUPPORT
3302 goto skip_app_handler;
3306 goto skip_app_handler;
3312 if (!block.
bert && saved_num == 0 && max_block_szx != 0 &&
3313 max_block_szx < block.
aszx) {
3314 block.
aszx = max_block_szx;
3352#if COAP_Q_BLOCK_SUPPORT
3371#if COAP_Q_BLOCK_SUPPORT
3375 goto skip_app_handler;
3412 *pfree_lg_srcv = lg_srcv;
3418 LL_DELETE(session->
lg_srcv, lg_srcv);
3426#if COAP_CLIENT_SUPPORT
3427#if COAP_Q_BLOCK_SUPPORT
3429derive_cbor_value(
const uint8_t **bp,
size_t rem_len) {
3430 uint32_t value = **bp & 0x1f;
3434 }
else if (value == 24) {
3436 return (uint32_t)-1;
3440 }
else if (value == 25) {
3442 return (uint32_t)-1;
3450 return (uint32_t)-1;
3453 value |= **bp << 16;
3471 if (sent || lg_xmit || lg_crcv) {
3475 const uint8_t *data;
3485 }
else if (lg_xmit) {
3488 size_t blk_size = (size_t)1 << (lg_xmit->
blk_size + 4);
3489 size_t offset = (lg_xmit->
last_block + 1) * blk_size;
3492 data_len = (lg_xmit->
data_info->
length - offset) > blk_size ? blk_size :
3493 lg_xmit->data_info->length - offset;
3518 track_fetch_observe(echo_pdu, lg_crcv, 0, &echo_pdu->
actual_token);
3519#if COAP_OSCORE_SUPPORT
3520 if (session->oscore_encryption &&
3581 size_t chunk = (size_t)1 << (lg_xmit->
blk_size + 4);
3592 coap_log_debug(
"found Block option, block is BERT, block nr. %u (%zu)\n",
3595 coap_log_debug(
"found Block option, block size is %u, block nr. %u\n",
3596 1 << (block.
szx + 4), block.
num);
3602 1 << (block.
szx + 4), 1 << (lg_xmit->
blk_size + 4));
3603 }
else if ((lg_xmit->
offset + chunk) % ((
size_t)1 << (block.
szx + 4)) == 0) {
3608 block.
num = (uint32_t)(((lg_xmit->
offset + chunk) >> (block.
szx + 4)) - 1);
3610 chunk = (size_t)1 << (lg_xmit->
blk_size + 4);
3612 coap_log_debug(
"new Block size is %u, block number %u completed\n",
3613 1 << (block.
szx + 4), block.
num);
3618 "next block is not aligned on requested block size boundary. "
3619 "(%zu x %u mod %u = %zu != 0)\n",
3621 (1 << (block.
szx + 4)),
3622 (lg_xmit->
offset + chunk) % ((
size_t)1 << (block.
szx + 4)));
3625 track_echo(session, rcvd);
3643 lg_xmit->
offset = (block.
num + 1) * chunk;
3659 new_token = track_fetch_observe(lg_xmit->
sent_pdu, lg_crcv, block.
num + 1,
3662 assert(len <=
sizeof(buf));
3664 memcpy(buf, new_token->
s, len);
3683 size_t token_options = pdu->
data ? (size_t)(pdu->
data - pdu->
token) :
3686 ((pdu->
max_size - token_options) /1024) * 1024;
3704#if COAP_Q_BLOCK_SUPPORT
3707 if (coap_send_q_block1(session, block, pdu,
3727 int observe_action = -1;
3730 goto lg_xmit_finished;
3740 goto lg_xmit_finished;
3748 goto lg_xmit_finished;
3750 if (check_freshness(session, rcvd, sent, lg_xmit, NULL))
3752#if COAP_Q_BLOCK_SUPPORT
3761 const uint8_t *data;
3766 uint16_t fmt = fmt_opt ?
3776 coap_log_debug(
"Unexpected 4.08 - protocol violation - ignore\n");
3782 const uint8_t *bp = data;
3788 size_t ltoken_length;
3790 for (i = 0; (bp < data + length) &&
3792 if ((*bp & 0xc0) != 0x00)
3794 block.
num = derive_cbor_value(&bp, data + length - bp);
3796 if (block.
num > (1 << 20) -1)
3798 block.
m = (block.
num + 1) * chunk < lg_xmit->data_info->length;
3828 coap_log_info(
"Invalid application/missing-blocks+cbor-seq\n");
3831 goto lg_xmit_finished;
3868 LL_DELETE(session->
lg_xmit, lg_xmit);
3885 const uint8_t *data,
size_t offset,
size_t total) {
3888 if (body_data == NULL && total) {
3891 if (body_data == NULL)
3895 if (offset + length <= total && body_data->length >= total) {
3896 memcpy(&body_data->
s[offset], data, length);
3912 memcpy(&body_data->
s[offset], data, length);
3921#if COAP_CLIENT_SUPPORT
3941#if COAP_Q_BLOCK_SUPPORT
3945 uint16_t block_opt = 0;
3947 int ack_rst_sent = 0;
3950 memset(&block, 0,
sizeof(block));
3951#if COAP_Q_BLOCK_SUPPORT
3952 memset(&qblock, 0,
sizeof(qblock));
3962 const uint8_t *data;
3965 size_t size2 = size_opt ?
3977#if COAP_Q_BLOCK_SUPPORT
3980 coap_log_warn(
"Both Block1 and Q-Block1 not supported in a response\n");
3986 if (!(session->
block_mode & COAP_BLOCK_HAS_Q_BLOCK)) {
3991 track_echo(session, rcvd);
3992 if (have_block && (block.
m || length)) {
3996 uint16_t fmt = fmt_opt ?
4003 size_t saved_offset;
4016 goto expire_lg_crcv;
4019 chunk = (size_t)1 << (block.
szx + 4);
4020 offset = block.
num * chunk;
4021 if (size2 < (offset + length)) {
4023 size2 = offset + length + 1;
4025 size2 = offset + length;
4027 saved_offset = offset;
4030#if COAP_Q_BLOCK_SUPPORT
4047 lg_crcv->
szx = block.
szx;
4052#if COAP_Q_BLOCK_SUPPORT
4053 lg_crcv->
rec_blocks.processing_payload_set = 0;
4070#if COAP_Q_BLOCK_SUPPORT
4075 coap_log_warn(
"Data body updated during receipt - new request started\n");
4093 (0 << 4) | (0 << 3) | block.
aszx),
4099 goto skip_app_handler;
4111#if COAP_Q_BLOCK_SUPPORT
4117 if (block.
num == 0) {
4130 while (offset < saved_offset + length) {
4132#if COAP_Q_BLOCK_SUPPORT
4136 coap_log_debug(
"found Block option, block size is %u, block nr. %u\n",
4137 1 << (block.
szx + 4), block.
num);
4138#if COAP_Q_BLOCK_SUPPORT
4140 this_payload_set > lg_crcv->
rec_blocks.processing_payload_set &&
4141 this_payload_set != lg_crcv->
rec_blocks.latest_payload_set) {
4142 coap_request_missing_q_block2(session, lg_crcv);
4144 lg_crcv->
rec_blocks.latest_payload_set = this_payload_set;
4154 offset = block.
num << (block.
szx + 4);
4160 if (updated_block) {
4164 if (size2 < saved_offset + length) {
4165 size2 = saved_offset + length;
4171 data, saved_offset, size2);
4177 saved_offset, size2);
4191#if COAP_Q_BLOCK_SUPPORT
4197 if (check_all_blocks_in_for_payload_set(session,
4203 if (check_any_blocks_next_payload_set(session,
4206 coap_request_missing_q_block2(session, lg_crcv);
4207 goto skip_app_handler;
4212 goto skip_app_handler;
4216 goto skip_app_handler;
4239 ((block.
num + 1) << 4) |
4240 (block.
m << 3) | block.
aszx),
4245 coap_add_data_large_internal(session, NULL, pdu, NULL, NULL, -1, 0, length, data, NULL, NULL, 0, 0);
4249 goto skip_app_handler;
4252 goto skip_app_handler;
4257#if COAP_Q_BLOCK_SUPPORT
4273 goto call_app_handler;
4275#if COAP_Q_BLOCK_SUPPORT
4286#if COAP_Q_BLOCK_SUPPORT
4295 lg_crcv->
total_len : saved_offset + length;
4303#if COAP_Q_BLOCK_SUPPORT
4330 LL_DELETE(session->
lg_crcv, lg_crcv);
4332 goto skip_app_handler;
4338 goto skip_app_handler;
4357 goto expire_lg_crcv;
4362#if COAP_OSCORE_SUPPORT
4363 if (check_freshness(session, rcvd,
4364 (session->oscore_encryption == 0) ? sent : NULL,
4367 if (check_freshness(session, rcvd, sent, NULL, lg_crcv))
4369 goto skip_app_handler;
4370 goto expire_lg_crcv;
4373 goto expire_lg_crcv;
4394#
if COAP_Q_BLOCK_SUPPORT
4401 goto skip_app_handler;
4405#if COAP_Q_BLOCK_SUPPORT
4406 if (session->
block_mode & COAP_BLOCK_PROBE_Q_BLOCK) {
4412 if (block.
num != 0) {
4415 const uint8_t *data;
4416 size_t chunk = (size_t)1 << (block.
szx + 4);
4421 goto call_app_handler;
4424#if COAP_Q_BLOCK_SUPPORT
4428 if (!(session->
block_mode & COAP_BLOCK_HAS_Q_BLOCK)) {
4437 LL_PREPEND(session->
lg_crcv, lg_crcv);
4442 track_echo(session, rcvd);
4447 LL_PREPEND(session->
lg_crcv, lg_crcv);
4471 LL_DELETE(session->
lg_crcv, lg_crcv);
4484#if COAP_SERVER_SUPPORT
4493 if (response->
code == 0)
4503#if COAP_CLIENT_SUPPORT
4506 uint64_t token_match =
4513 LL_FOREACH(session->
lg_crcv, lg_crcv) {
4526 LL_FOREACH(session->
lg_xmit, lg_xmit) {
int coap_is_mcast(const coap_address_t *a)
Checks if given address a denotes a multicast address.
void coap_address_copy(coap_address_t *dst, const coap_address_t *src)
int coap_address_equals(const coap_address_t *a, const coap_address_t *b)
Compares given address objects a and b.
static void coap_block_release_lg_xmit_data(coap_session_t *session, coap_lg_xmit_data_t *data_info)
#define COAP_ETAG_MAX_BYTES
COAP_STATIC_INLINE int full_match(const uint8_t *a, size_t alen, const uint8_t *b, size_t blen)
static int update_received_blocks(coap_rblock_t *rec_blocks, uint32_t block_num, uint32_t block_m)
static int check_all_blocks_in(coap_rblock_t *rec_blocks)
static int coap_add_data_large_internal(coap_session_t *session, const coap_pdu_t *request, coap_pdu_t *pdu, coap_resource_t *resource, const coap_string_t *query, int maxage, uint64_t etag, size_t length, const uint8_t *data, coap_release_large_data_t release_func, void *app_ptr, int single_request, coap_pdu_code_t request_method)
static int setup_block_b(coap_session_t *session, coap_pdu_t *pdu, coap_block_b_t *block, unsigned int num, unsigned int blk_size, size_t total)
static int check_if_received_block(coap_rblock_t *rec_blocks, uint32_t block_num)
int coap_flsll(long long j)
int coap_fls(unsigned int i)
@ COAP_NACK_TOO_MANY_RETRIES
#define COAP_SOCKET_MULTICAST
socket is used for multicast communication
Library specific build wrapper for coap_internal.h.
void * coap_realloc_type(coap_memory_tag_t type, void *p, size_t size)
Reallocates a chunk p of bytes created by coap_malloc_type() or coap_realloc_type() and returns a poi...
void * coap_malloc_type(coap_memory_tag_t type, size_t size)
Allocates a chunk of size bytes and returns a pointer to the newly allocated memory.
void coap_free_type(coap_memory_tag_t type, void *p)
Releases the memory that was allocated by coap_malloc_type().
uint8_t coap_unique_id[8]
uint16_t coap_option_num_t
uint8_t coap_opt_t
Use byte-oriented access methods here because sliding a complex struct coap_opt_t over the data buffe...
void coap_call_response_handler(coap_session_t *session, coap_pdu_t *sent, coap_pdu_t *rcvd, void *body_free)
coap_mid_t coap_send_ack_lkd(coap_session_t *session, const coap_pdu_t *request)
Sends an ACK message with code 0 for the specified request to dst.
int coap_add_data_large_response_lkd(coap_resource_t *resource, coap_session_t *session, const coap_pdu_t *request, coap_pdu_t *response, const coap_string_t *query, uint16_t media_type, int maxage, uint64_t etag, size_t length, const uint8_t *data, coap_release_large_data_t release_func, void *app_ptr)
Associates given data with the response pdu that is passed as fourth parameter.
int coap_context_set_max_block_size_lkd(coap_context_t *context, size_t max_block_size)
Set the context level maximum block size that the server supports when sending or receiving packets w...
void coap_block_delete_lg_srcv(coap_session_t *session, coap_lg_srcv_t *lg_srcv)
void coap_context_set_block_mode_lkd(coap_context_t *context, uint32_t block_mode)
Set the context level CoAP block handling bits for handling RFC7959.
int coap_block_check_lg_crcv_timeouts(coap_session_t *session, coap_tick_t now, coap_tick_t *tim_rem)
int coap_block_check_lg_srcv_timeouts(coap_session_t *session, coap_tick_t now, coap_tick_t *tim_rem)
#define COAP_BLOCK_MAX_SIZE_SET(a)
void coap_block_delete_lg_crcv(coap_session_t *session, coap_lg_crcv_t *lg_crcv)
int coap_handle_response_get_block(coap_context_t *context, coap_session_t *session, coap_pdu_t *sent, coap_pdu_t *rcvd, coap_recurse_t recursive)
void coap_check_code_lg_xmit(const coap_session_t *session, const coap_pdu_t *request, coap_pdu_t *response, const coap_resource_t *resource, const coap_string_t *query)
The function checks that the code in a newly formed lg_xmit created by coap_add_data_large_response_l...
int coap_handle_response_send_block(coap_session_t *session, coap_pdu_t *sent, coap_pdu_t *rcvd)
coap_mid_t coap_retransmit_oscore_pdu(coap_session_t *session, coap_pdu_t *pdu, coap_opt_t *echo)
coap_lg_crcv_t * coap_find_lg_crcv(coap_session_t *session, coap_pdu_t *pdu)
Find the current lg_crcv for the session that matches the pdu.
int coap_add_data_large_request_lkd(coap_session_t *session, coap_pdu_t *pdu, size_t length, const uint8_t *data, coap_release_large_data_t release_func, void *app_ptr)
Associates given data with the pdu that is passed as second parameter.
void coap_check_update_token(coap_session_t *session, coap_pdu_t *pdu)
The function checks if the token needs to be updated before PDU is presented to the application (only...
void coap_block_delete_lg_xmit(coap_session_t *session, coap_lg_xmit_t *lg_xmit)
#define STATE_TOKEN_FULL(t, r)
#define COAP_SINGLE_BLOCK_OR_Q
int coap_handle_request_put_block(coap_context_t *context, coap_session_t *session, coap_pdu_t *pdu, coap_pdu_t *response, coap_resource_t *resource, coap_string_t *uri_path, coap_opt_t *observe, int *added_block, coap_lg_srcv_t **free_lg_srcv)
#define STATE_TOKEN_BASE(t)
#define COAP_BLOCK_SET_MASK
coap_lg_xmit_t * coap_find_lg_xmit_response(const coap_session_t *session, const coap_pdu_t *request, const coap_resource_t *resource, const coap_string_t *query)
coap_lg_crcv_t * coap_block_new_lg_crcv(coap_session_t *session, coap_pdu_t *pdu, coap_lg_xmit_t *lg_xmit)
coap_lg_xmit_t * coap_find_lg_xmit(coap_session_t *session, coap_pdu_t *pdu)
Find the current lg_xmit for the session that matches the pdu.
int coap_handle_request_send_block(coap_session_t *session, coap_pdu_t *pdu, coap_pdu_t *response, coap_resource_t *resource, coap_string_t *query)
#define COAP_BLOCK_MAX_SIZE_GET(a)
int coap_block_check_lg_xmit_timeouts(coap_session_t *session, coap_tick_t now, coap_tick_t *tim_rem)
COAP_API void coap_context_set_block_mode(coap_context_t *context, uint32_t block_mode)
Set the context level CoAP block handling bits for handling RFC7959.
COAP_API int coap_add_data_large_response(coap_resource_t *resource, coap_session_t *session, const coap_pdu_t *request, coap_pdu_t *response, const coap_string_t *query, uint16_t media_type, int maxage, uint64_t etag, size_t length, const uint8_t *data, coap_release_large_data_t release_func, void *app_ptr)
Associates given data with the response pdu that is passed as fourth parameter.
#define COAP_BLOCK_USE_M_Q_BLOCK
#define COAP_OPT_BLOCK_SZX(opt)
Returns the value of the SZX-field of a Block option opt.
#define COAP_BLOCK_STLESS_BLOCK2
COAP_API int coap_add_data_large_request(coap_session_t *session, coap_pdu_t *pdu, size_t length, const uint8_t *data, coap_release_large_data_t release_func, void *app_ptr)
Associates given data with the pdu that is passed as second parameter.
#define COAP_BLOCK_TRY_Q_BLOCK
#define COAP_BLOCK_STLESS_FETCH
COAP_API int coap_context_set_max_block_size(coap_context_t *context, size_t max_block_size)
Set the context level maximum block size that the server supports when sending or receiving packets w...
int coap_add_block_b_data(coap_pdu_t *pdu, size_t len, const uint8_t *data, coap_block_b_t *block)
Adds the appropriate payload data of the body to the pdu.
#define COAP_BLOCK_SINGLE_BODY
int coap_write_block_b_opt(coap_session_t *session, coap_block_b_t *block, coap_option_num_t number, coap_pdu_t *pdu, size_t data_length)
Writes a block option of type number to message pdu.
int coap_add_block(coap_pdu_t *pdu, size_t len, const uint8_t *data, unsigned int block_num, unsigned char block_szx)
Adds the block_num block of size 1 << (block_szx + 4) from source data to pdu.
void(* coap_release_large_data_t)(coap_session_t *session, void *app_ptr)
Callback handler for de-allocating the data based on app_ptr provided to coap_add_data_large_*() func...
void coap_add_data_blocked_response(const coap_pdu_t *request, coap_pdu_t *response, uint16_t media_type, int maxage, size_t length, const uint8_t *data)
Adds the appropriate part of data to the response pdu.
int coap_get_block_b(const coap_session_t *session, const coap_pdu_t *pdu, coap_option_num_t number, coap_block_b_t *block)
Initializes block from pdu.
#define COAP_OPT_BLOCK_MORE(opt)
Returns the value of the More-bit of a Block option opt.
unsigned int coap_opt_block_num(const coap_opt_t *block_opt)
Returns the value of field num in the given block option block_opt.
int coap_get_block(const coap_pdu_t *pdu, coap_option_num_t number, coap_block_t *block)
Initializes block from pdu.
#define COAP_BLOCK_NOT_RANDOM_BLOCK1
#define COAP_OPT_BLOCK_END_BYTE(opt)
Returns the value of the last byte of opt.
int coap_write_block_opt(coap_block_t *block, coap_option_num_t number, coap_pdu_t *pdu, size_t data_length)
Writes a block option of type number to message pdu.
#define COAP_BLOCK_FORCE_Q_BLOCK
coap_binary_t * coap_block_build_body(coap_binary_t *body_data, size_t length, const uint8_t *data, size_t offset, size_t total)
Re-assemble payloads into a body.
#define COAP_BLOCK_USE_LIBCOAP
void coap_digest_free(coap_digest_ctx_t *digest_ctx)
Free off coap_digest_ctx_t.
int coap_digest_final(coap_digest_ctx_t *digest_ctx, coap_digest_t *digest_buffer)
Finalize the coap_digest information into the provided digest_buffer.
int coap_digest_update(coap_digest_ctx_t *digest_ctx, const uint8_t *data, size_t data_len)
Update the coap_digest information with the next chunk of data.
coap_digest_ctx_t * coap_digest_setup(void)
Initialize a coap_digest.
time_t coap_time_t
CoAP time in seconds since epoch.
uint64_t coap_tick_t
This data type represents internal timer ticks with COAP_TICKS_PER_SECOND resolution.
coap_time_t coap_ticks_to_rt(coap_tick_t t)
Helper function that converts coap ticks to wallclock time.
#define COAP_TICKS_PER_SECOND
Use ms resolution on POSIX systems.
#define COAP_MAX_DELAY_TICKS
#define COAP_RESOURCE_USE_BLOCK_DATA_HANDLER
Call the block data handler for this resource if one is registered for the context.
int coap_handle_event_lkd(coap_context_t *context, coap_event_t event, coap_session_t *session)
Invokes the event handler of context for the given event and data.
uint16_t coap_new_message_id_lkd(coap_session_t *session)
Returns a new message id and updates session->tx_mid accordingly.
int coap_client_delay_first(coap_session_t *session)
Delay the sending of the first client request until some other negotiation has completed.
coap_mid_t coap_send_internal(coap_session_t *session, coap_pdu_t *pdu, coap_pdu_t *request_pdu)
Sends a CoAP message to given peer.
void coap_register_block_data_handler(coap_context_t *context, coap_block_data_handler_t block_data_handler)
Sets up a handler that is called for each received block during a block-wise transfer when COAP_BLOCK...
coap_response_t(* coap_block_data_handler_t)(coap_session_t *session, coap_pdu_t *pdu, coap_resource_t *resource, coap_binary_t **body_data, size_t length, const uint8_t *data, size_t offset, size_t total)
Definition of the block data handler function.
void coap_ticks(coap_tick_t *t)
Returns the current value of an internal tick counter.
@ COAP_RESPONSE_OK
Response is fine.
unsigned int coap_encode_var_safe(uint8_t *buf, size_t length, unsigned int val)
Encodes multiple-length byte sequences.
unsigned int coap_decode_var_bytes(const uint8_t *buf, size_t len)
Decodes multiple-length byte sequences.
uint64_t coap_decode_var_bytes8(const uint8_t *buf, size_t len)
Decodes multiple-length byte sequences.
unsigned int coap_encode_var_safe8(uint8_t *buf, size_t length, uint64_t val)
Encodes multiple-length byte sequences.
@ COAP_EVENT_PARTIAL_BLOCK
Triggered when not all of a large body has been received.
@ COAP_EVENT_XMIT_BLOCK_FAIL
Triggered when not all of a large body has been transmitted.
#define coap_lock_callback(func)
Dummy for no thread-safe code.
#define coap_lock_unlock()
Dummy for no thread-safe code.
#define coap_lock_check_locked()
Dummy for no thread-safe code.
#define coap_lock_lock(failed)
Dummy for no thread-safe code.
#define coap_log_debug(...)
void coap_show_pdu(coap_log_t level, const coap_pdu_t *pdu)
Display the contents of the specified pdu.
const char * coap_session_str(const coap_session_t *session)
Get session description.
#define coap_log_info(...)
#define coap_log_warn(...)
#define COAP_OBSERVE_CANCEL
The value COAP_OBSERVE_CANCEL in a GET/FETCH request option COAP_OPTION_OBSERVE indicates that the ob...
#define COAP_OBSERVE_ESTABLISH
The value COAP_OBSERVE_ESTABLISH in a GET/FETCH request option COAP_OPTION_OBSERVE indicates a new ob...
COAP_API int coap_cancel_observe(coap_session_t *session, coap_binary_t *token, coap_pdu_type_t message_type)
Cancel an observe that is being tracked by the client large receive logic.
coap_opt_t * coap_option_next(coap_opt_iterator_t *oi)
Updates the iterator oi to point to the next option.
uint32_t coap_opt_length(const coap_opt_t *opt)
Returns the length of the given option.
coap_opt_iterator_t * coap_option_iterator_init(const coap_pdu_t *pdu, coap_opt_iterator_t *oi, const coap_opt_filter_t *filter)
Initializes the given option iterator oi to point to the beginning of the pdu's option list.
size_t coap_opt_encode_size(uint16_t delta, size_t length)
Compute storage bytes needed for an option with given delta and length.
#define COAP_OPT_ALL
Pre-defined filter that includes all options.
coap_opt_t * coap_check_option(const coap_pdu_t *pdu, coap_option_num_t number, coap_opt_iterator_t *oi)
Retrieves the first option of number number from pdu.
const uint8_t * coap_opt_value(const coap_opt_t *opt)
Returns a pointer to the value of the given option.
int coap_option_filter_set(coap_opt_filter_t *filter, coap_option_num_t option)
Sets the corresponding entry for number in filter.
int coap_rebuild_pdu_for_proxy(coap_pdu_t *pdu)
Convert PDU to use Proxy-Scheme option if Proxy-Uri option is present.
size_t coap_oscore_overhead(coap_session_t *session, coap_pdu_t *pdu)
Determine the additional data size requirements for adding in OSCORE.
#define COAP_PDU_IS_RESPONSE(pdu)
coap_pdu_t * coap_pdu_reference_lkd(coap_pdu_t *pdu)
Increment reference counter on a pdu to stop it prematurely getting freed off when coap_delete_pdu() ...
void coap_delete_pdu_lkd(coap_pdu_t *pdu)
Dispose of an CoAP PDU and free off associated storage.
size_t coap_insert_option(coap_pdu_t *pdu, coap_option_num_t number, size_t len, const uint8_t *data)
Inserts option of given number in the pdu with the appropriate data.
int coap_remove_option(coap_pdu_t *pdu, coap_option_num_t number)
Removes (first) option of given number from the pdu.
int coap_update_token(coap_pdu_t *pdu, size_t len, const uint8_t *data)
Updates token in pdu with length len and data.
size_t coap_update_option(coap_pdu_t *pdu, coap_option_num_t number, size_t len, const uint8_t *data)
Updates existing first option of given number in the pdu with the new data.
coap_pdu_t * coap_pdu_duplicate_lkd(const coap_pdu_t *old_pdu, coap_session_t *session, size_t token_length, const uint8_t *token, coap_opt_filter_t *drop_options)
Duplicate an existing PDU.
#define COAP_PAYLOAD_START
int coap_pdu_check_resize(coap_pdu_t *pdu, size_t size)
Dynamically grows the size of pdu to new_size if needed.
#define COAP_PDU_IS_REQUEST(pdu)
size_t coap_add_option_internal(coap_pdu_t *pdu, coap_option_num_t number, size_t len, const uint8_t *data)
Adds option of given number to pdu that is passed as first parameter.
#define COAP_OPTION_BLOCK2
const char * coap_response_phrase(unsigned char code)
Returns a human-readable response phrase for the specified CoAP response code.
#define COAP_MEDIATYPE_APPLICATION_MB_CBOR_SEQ
#define COAP_OPTION_CONTENT_FORMAT
#define COAP_OPTION_SIZE2
#define COAP_OPTION_BLOCK1
#define COAP_OPTION_Q_BLOCK1
int coap_mid_t
coap_mid_t is used to store the CoAP Message ID of a CoAP PDU.
#define COAP_OPTION_URI_PATH
#define COAP_RESPONSE_CODE(N)
#define COAP_RESPONSE_CLASS(C)
coap_pdu_code_t
Set of codes available for a PDU.
#define COAP_OPTION_SIZE1
coap_pdu_type_t
CoAP PDU message type definitions.
#define COAP_MEDIATYPE_TEXT_PLAIN
int coap_add_token(coap_pdu_t *pdu, size_t len, const uint8_t *data)
Adds token of length len to pdu.
#define COAP_OPTION_CONTENT_TYPE
size_t coap_add_option(coap_pdu_t *pdu, coap_option_num_t number, size_t len, const uint8_t *data)
Adds option of given number to pdu that is passed as first parameter.
#define COAP_OPTION_Q_BLOCK2
int coap_get_data(const coap_pdu_t *pdu, size_t *len, const uint8_t **data)
Retrieves the length and data pointer of specified PDU.
coap_pdu_t * coap_pdu_init(coap_pdu_type_t type, coap_pdu_code_t code, coap_mid_t mid, size_t size)
Creates a new CoAP PDU with at least enough storage space for the given size maximum message size.
int coap_get_data_large(const coap_pdu_t *pdu, size_t *len, const uint8_t **data, size_t *offset, size_t *total)
Retrieves the data from a PDU, with support for large bodies of data that spans multiple PDUs.
#define COAP_INVALID_MID
Indicates an invalid message id.
#define COAP_OPTION_MAXAGE
#define COAP_OPTION_OBSERVE
int coap_add_data(coap_pdu_t *pdu, size_t len, const uint8_t *data)
Adds given data to the pdu that is passed as first parameter.
@ COAP_REQUEST_CODE_FETCH
#define COAP_NON_RECEIVE_TIMEOUT_TICKS(s)
The NON_RECEIVE_TIMEOUT definition for the session (s).
#define COAP_NON_TIMEOUT_TICKS(s)
void coap_handle_nack(coap_session_t *session, coap_pdu_t *sent, const coap_nack_reason_t reason, const coap_mid_t mid)
#define COAP_MAX_TRANSMIT_WAIT_TICKS(s)
#define COAP_NON_PARTIAL_TIMEOUT_TICKS(s)
The NON_PARTIAL_TIMEOUT definition for the session (s).
coap_tick_t coap_get_non_timeout_random_ticks(coap_session_t *session)
#define COAP_MAX_PAYLOADS(s)
size_t coap_session_max_pdu_size_lkd(const coap_session_t *session)
Get maximum acceptable PDU size.
#define COAP_NON_MAX_RETRANSMIT(s)
#define COAP_PROTO_NOT_RELIABLE(p)
#define COAP_PROTO_RELIABLE(p)
void coap_session_new_token(coap_session_t *session, size_t *len, uint8_t *data)
Creates a new token for use.
@ COAP_SESSION_TYPE_CLIENT
client-side
void coap_delete_bin_const(coap_bin_const_t *s)
Deletes the given const binary data and releases any memory allocated.
void coap_delete_str_const(coap_str_const_t *s)
Deletes the given const string and releases any memory allocated.
coap_binary_t * coap_new_binary(size_t size)
Returns a new binary object with at least size bytes storage allocated.
coap_bin_const_t * coap_new_bin_const(const uint8_t *data, size_t size)
Take the specified byte array (text) and create a coap_bin_const_t * Returns a new const binary objec...
coap_binary_t * coap_resize_binary(coap_binary_t *s, size_t size)
Resizes the given coap_binary_t object.
void coap_delete_binary(coap_binary_t *s)
Deletes the given coap_binary_t object and releases any memory allocated.
#define coap_binary_equal(binary1, binary2)
Compares the two binary data for equality.
#define coap_string_equal(string1, string2)
Compares the two strings for equality.
coap_string_t * coap_new_string(size_t size)
Returns a new string object with at least size+1 bytes storage allocated.
coap_str_const_t * coap_new_str_const(const uint8_t *data, size_t size)
Returns a new const string object with at least size+1 bytes storage allocated, and the provided data...
void coap_delete_string(coap_string_t *s)
Deletes the given string and releases any memory allocated.
int coap_cancel_observe_lkd(coap_session_t *session, coap_binary_t *token, coap_pdu_type_t message_type)
Cancel an observe that is being tracked by the client large receive logic.
int coap_q_block_is_supported(void)
Check whether Q-BlockX is available.
#define COAP_STATIC_INLINE
coap_address_t remote
remote address and port
coap_address_t local
local address and port
CoAP binary data definition with const data.
size_t length
length of binary data
const uint8_t * s
read-only binary data
CoAP binary data definition.
size_t length
length of binary data
Structure of Block options with BERT support.
unsigned int num
block number
uint32_t chunk_size
1024 if BERT
unsigned int bert
Operating as BERT.
unsigned int aszx
block size (0-7 including BERT
unsigned int defined
Set if block found.
unsigned int m
1 if more blocks follow, 0 otherwise
unsigned int szx
block size (0-6)
Structure of Block options.
unsigned int num
block number
unsigned int szx
block size
unsigned int m
1 if more blocks follow, 0 otherwise
The CoAP stack's global state is stored in a coap_context_t object.
coap_block_data_handler_t block_data_handler
Called with each block data during block transfers.
uint32_t block_mode
Zero or more COAP_BLOCK_ or'd options.
coap_resource_t * proxy_uri_resource
can be used for handling proxy URI resources
coap_resource_t * unknown_resource
can be used for handling unknown resources
uint64_t state_token
state token
size_t bert_size
size of last BERT block
uint32_t count
the number of packets sent for payload
coap_binary_t * app_token
original PDU token
coap_pdu_code_t request_method
Method used to request this data.
uint8_t rtag_length
RTag length.
coap_string_t * query
Associated query for the resource.
coap_resource_t * resource
associated resource
coap_time_t maxage_expire
When this entry expires.
uint8_t rtag_set
Set if RTag is in receive PDU.
uint8_t rtag[8]
RTag for block checking.
Structure to hold large body (many blocks) client receive information.
uint16_t block_option
Block option in use.
uint8_t etag[8]
ETag for block checking.
uint8_t etag_length
ETag length.
uint8_t last_type
Last request type (CON/NON)
coap_lg_xmit_data_t * obs_data
lg_xmit data info if large observe request
uint8_t observe_length
Length of observe data.
uint8_t observe[3]
Observe data (if observe_set) (only 24 bits)
uint8_t etag_set
Set if ETag is in receive PDU.
coap_rblock_t rec_blocks
list of received blocks
coap_address_t upstream
Unicast IP of server if mcast client session.
uint8_t initial
If set, has not been used yet.
uint8_t szx
size of individual blocks
uint16_t o_block_option
Block CoAP option used when initiating Observe.
uint16_t content_format
Content format for the set of blocks.
uint8_t o_blk_size
Block size used when initiating Observe.
coap_tick_t last_used
Last time all data sent or 0.
coap_bin_const_t ** obs_token
Tokens used in setting up Observe (to handle large FETCH)
uint64_t state_token
state token
coap_binary_t * app_token
app requesting PDU token
coap_pdu_t * sent_pdu
The sent pdu with all the data.
uint16_t retry_counter
Retry counter (part of state token)
coap_binary_t * body_data
Used for re-assembling entire body.
size_t obs_token_cnt
number of tokens used to set up Observe
uint8_t observe_set
Set if this is an observe receive PDU.
size_t total_len
Length as indicated by SIZE2 option.
Structure to hold large body (many blocks) server receive information.
uint8_t rtag[8]
RTag for block checking.
coap_mid_t last_mid
Last received mid for this set of packets.
uint8_t rtag_set
Set if RTag is in receive PDU.
uint16_t block_option
Block option in use.
size_t total_len
Length as indicated by SIZE1 option.
uint8_t dont_timeout
Set if app handler in use.
uint8_t observe_length
Length of observe data.
coap_rblock_t rec_blocks
set to uri_path if unknown resource
uint8_t no_more_seen
Set if block with more not set seen.
coap_binary_t * body_data
Used for re-assembling entire body.
coap_resource_t * resource
associated resource
uint8_t observe_set
Set if this is an observe receive PDU.
uint8_t rtag_length
RTag length.
uint8_t last_type
Last request type (CON/NON)
uint8_t szx
size of individual blocks
coap_tick_t last_used
Last time data sent or 0.
uint8_t observe[3]
Observe data (if set) (only 24 bits)
uint16_t content_format
Content format for the set of blocks.
coap_bin_const_t * last_token
< list of received blocks
coap_str_const_t * uri_path
void * app_ptr
applicaton provided ptr for de-alloc function
uint32_t ref
Reference count.
const uint8_t * data
large data ptr
size_t length
large data length
coap_release_large_data_t release_func
large data de-alloc function
Structure to hold large body (many blocks) transmission information.
coap_tick_t last_all_sent
Last time all data sent or 0.
uint8_t blk_size
large block transmission size
coap_tick_t last_sent
Last time any data sent.
union coap_lg_xmit_t::@1 b
coap_lg_xmit_data_t * data_info
Pointer to large data information.
int last_block
last acknowledged block number Block1 last transmitted Q-Block2
coap_tick_t last_payload
Last time MAX_PAYLOAD was sent or 0.
size_t offset
large data next offset to transmit
coap_pdu_t * sent_pdu
The sent pdu with all the data.
uint16_t option
large block transmisson CoAP option
struct coap_lg_xmit_t * next
coap_tick_t last_obs
Last time used (Observe tracking) or 0.
Iterator to run through PDU options.
coap_option_num_t number
decoded option number
uint8_t * token
first byte of token (or extended length bytes prefix), if any, or options
coap_lg_xmit_t * lg_xmit
Holds ptr to lg_xmit if sending a set of blocks.
size_t body_length
Holds body data length.
size_t max_size
maximum size for token, options and payload, or zero for variable size pdu
const uint8_t * body_data
Holds ptr to re-assembled data or NULL.
size_t body_offset
Holds body data offset.
coap_pdu_code_t code
request method (value 1–31) or response code (value 64-255)
coap_bin_const_t actual_token
Actual token in pdu.
uint8_t * data
first byte of payload, if any
coap_mid_t mid
message id, if any, in regular host byte order
size_t used_size
used bytes of storage for token, options and payload
coap_session_t * session
Session responsible for PDU or NULL.
size_t body_total
Holds body data total size.
coap_pdu_type_t type
message type
Structure to keep track of received blocks.
uint32_t total_blocks
Set to block no + 1 when More bit unset.
uint32_t used
Number of range blocks in use.
struct coap_lg_range range[COAP_RBLOCK_CNT]
Abstraction of resource that can be attached to coap_context_t.
unsigned int is_proxy_uri
resource created for proxy URI handler
unsigned int is_reverse_proxy
resource created for reverse proxy URI handler
int flags
zero or more COAP_RESOURCE_FLAGS_* or'd together
Abstraction of virtual session that can be attached to coap_context_t (client) or coap_endpoint_t (se...
coap_lg_xmit_t * lg_xmit
list of large transmissions
uint32_t block_mode
Zero or more COAP_BLOCK_ or'd options.
coap_socket_t sock
socket object for the session, if any
uint8_t csm_bert_rem_support
CSM TCP BERT blocks supported (remote)
uint64_t tx_token
Next token number to use.
coap_mid_t remote_test_mid
mid used for checking remote support
uint8_t csm_bert_loc_support
CSM TCP BERT blocks supported (local)
coap_addr_tuple_t addr_info
remote/local address info
coap_proto_t proto
protocol used
uint8_t con_active
Active CON request sent.
coap_queue_t * delayqueue
list of delayed messages waiting to be sent
uint32_t tx_rtag
Next Request-Tag number to use.
coap_lg_srcv_t * lg_srcv
Server list of expected large receives.
coap_lg_crcv_t * lg_crcv
Client list of expected large receives.
coap_session_type_t type
client or server side socket
coap_context_t * context
session's context
coap_bin_const_t * echo
last token used to make a request
coap_socket_flags_t flags
1 or more of COAP_SOCKET* flag values
CoAP string data definition.
size_t length
length of string