Commit 8062f6ea authored by Luiz Augusto von Dentz's avatar Luiz Augusto von Dentz Committed by Anas Nashif
Browse files

net: buf: Add extra logic when debug is enabled 



In case of invalid behavior such as error or warnings print caller
function name and line number so it is easier to track back when there
there is a problem.

Change-Id: I3a5f4c7f63e0560fe0cf6f25936b079f127776a8
Signed-off-by: default avatarLuiz Augusto von Dentz <luiz.von.dentz@intel.com>
parent 2de6e8da

include/net/buf.h

+22 −0
Original line number Diff line number Diff line
@@ -507,7 +507,14 @@ struct net_buf { 
 *  becomes available in the FIFO. If you want to make sure no blocking

 *  happens use net_buf_get_timeout() instead with K_NO_WAIT.

 */

#if defined(CONFIG_NET_BUF_DEBUG)

struct net_buf *net_buf_get_debug(struct k_fifo *fifo, size_t reserve_head,

				  const char *func, int line);

#define	net_buf_get(_fifo, _reserve_head) \

	net_buf_get_debug(_fifo, _reserve_head, __func__, __LINE__)

#else

struct net_buf *net_buf_get(struct k_fifo *fifo, size_t reserve_head);

#endif



/**

 *  @brief Get a new buffer from a FIFO.
@@ -526,8 +533,17 @@ struct net_buf *net_buf_get(struct k_fifo *fifo, size_t reserve_head); 
 *

 *  @return New buffer or NULL if out of buffers.

 */

#if defined(CONFIG_NET_BUF_DEBUG)

struct net_buf *net_buf_get_timeout_debug(struct k_fifo *fifo,

					  size_t reserve_head, int32_t timeout,

					  const char *func, int line);

#define	net_buf_get_timeout(_fifo, _reserve_head, _timeout) \

	net_buf_get_timeout_debug(_fifo, _reserve_head, _timeout, __func__, \

				  __LINE__)

#else

struct net_buf *net_buf_get_timeout(struct k_fifo *fifo,

				    size_t reserve_head, int32_t timeout);

#endif



/**

 *  @brief Initialize buffer with the given headroom.
@@ -560,7 +576,13 @@ void net_buf_put(struct k_fifo *fifo, struct net_buf *buf); 
 *

 *  @param buf A valid pointer on a buffer

 */

#if defined(CONFIG_NET_BUF_DEBUG)

void net_buf_unref_debug(struct net_buf *buf, const char *func, int line);

#define	net_buf_unref(_buf) \

	net_buf_unref_debug(_buf, __func__, __LINE__)

#else

void net_buf_unref(struct net_buf *buf);

#endif



/**

 *  @brief Increment the reference count of a buffer.

net/buf.c

+25 −3
Original line number Diff line number Diff line
@@ -46,8 +46,14 @@ 
#define NET_BUF_ASSERT(cond)

#endif /* CONFIG_NET_BUF_DEBUG */



#if defined(CONFIG_NET_BUF_DEBUG)

struct net_buf *net_buf_get_timeout_debug(struct k_fifo *fifo,

					  size_t reserve_head, int32_t timeout,

					  const char *func, int line)

#else

struct net_buf *net_buf_get_timeout(struct k_fifo *fifo,

				    size_t reserve_head, int32_t timeout)

#endif

{

	struct net_buf *buf, *frag;
@@ -58,7 +64,7 @@ struct net_buf *net_buf_get_timeout(struct k_fifo *fifo, 


	buf = k_fifo_get(fifo, timeout);

	if (!buf) {

		NET_BUF_ERR("Failed to get free buffer");

		NET_BUF_ERR("%s():%d: Failed to get free buffer", func, line);

		return NULL;

	}
@@ -93,7 +99,12 @@ struct net_buf *net_buf_get_timeout(struct k_fifo *fifo, 
	return buf;

}



#if defined(CONFIG_NET_BUF_DEBUG)

struct net_buf *net_buf_get_debug(struct k_fifo *fifo, size_t reserve_head,

				  const char *func, int line)

#else

struct net_buf *net_buf_get(struct k_fifo *fifo, size_t reserve_head)

#endif

{

	struct net_buf *buf;
@@ -104,7 +115,8 @@ struct net_buf *net_buf_get(struct k_fifo *fifo, size_t reserve_head) 
		return buf;

	}



	NET_BUF_WARN("Low on buffers. Waiting (fifo %p)", fifo);

	NET_BUF_WARN("%s():%d: Low on buffers. Waiting (fifo %p)", func, line,

		     fifo);



	return net_buf_get_timeout(fifo, reserve_head, K_FOREVER);

}
@@ -132,14 +144,24 @@ void net_buf_put(struct k_fifo *fifo, struct net_buf *buf) 
	k_fifo_put_list(fifo, buf, tail);

}



#if defined(CONFIG_NET_BUF_DEBUG)

void net_buf_unref_debug(struct net_buf *buf, const char *func, int line)

#else

void net_buf_unref(struct net_buf *buf)

#endif

{

	NET_BUF_ASSERT(buf);



	while (buf) {

		struct net_buf *frags = buf->frags;



		NET_BUF_ASSERT(buf->ref > 0);

#if defined(CONFIG_NET_BUF_DEBUG)

		if (!buf->ref) {

			NET_BUF_ERR("%s():%d: buf %p double free", func, line,

				    buf);

			return;

		}

#endif

		NET_BUF_DBG("buf %p ref %u fifo %p frags %p", buf, buf->ref,

			    buf->free, buf->frags);

CRA Git | Maintained and supported by SUSTech CRA and CCSE