libcoap/option.h

/*
 * option.h -- helpers for handling options in CoAP PDUs
 *
 * Copyright (C) 2010,2011 Olaf Bergmann <bergmann@tzi.org>
 *
 * This file is part of the CoAP library libcoap. Please see
 * README for terms of use. 
 */

/**
 * @file option.h
 * @brief helpers for handling options in CoAP PDUs
 */

#ifndef _OPTION_H_
#define _OPTION_H_

#include "bits.h"
#include "pdu.h"

/** 
 * Use byte-oriented access methods here because sliding a complex
 * struct coap_opt_t over the data buffer may cause bus error on
 * certain platforms.
 */ 
typedef unsigned char coap_opt_t;
#define PCHAR(p) ((coap_opt_t *)(p))

/** Representation of CoAP options. */
typedef struct {
  unsigned short delta;
  size_t length;
  unsigned char *value;
} coap_option_t;

/**
 * Parses the option pointed to by @p opt into @p result. This
 * function returns the number of bytes that have been parsed, or @c 0
 * on error. An error is signaled when illegal delta or length values
 * are encountered or when option parsing would result in reading past
 * the option (i.e. beyond opt + length). 
 *
 * @param opt    The beginning of the option to parse.
 * @param length The maximum length of @p opt.
 * @param result A pointer to the coap_option_t structure that is
 *               filled with actual values iff coap_opt_parse() > 0.
 * @return The number of bytes parsed or @c 0 on error.
 */
size_t coap_opt_parse(const coap_opt_t *opt, size_t length, 
		      coap_option_t *result);

/**
 * Returns the size of the given option, taking into account a
 * possible option jump.
 *
 * @param opt An option jump or the beginning of the option.
 * @return The number of bytes between @p opt and the end of
 *         the option starting at @p opt. In case of an error,
 *         this function returns @c 0 as options need at least
 *         one byte storage space.
 */
size_t coap_opt_size(coap_opt_t *opt);

/** @deprecated { Use coap_opt_size() instead. } */
#define COAP_OPT_SIZE(opt) coap_opt_size(opt)

/**
 * Calculates the beginning of the PDU's option section.
 * 
 * @param pdu The PDU containing the options.
 * @return A pointer to the first option if available, or @c NULL otherwise.
 */
coap_opt_t *options_start(coap_pdu_t *pdu);

/**
 * Interprets @p opt as pointer to a CoAP option and advances to
 * the next byte past this option.
 * @hideinitializer
 */
#define options_next(opt) \
  ((coap_opt_t *)((unsigned char *)(opt) + COAP_OPT_SIZE(opt)))

/**
 * @defgroup opt_filter Option Filters
 * @{
 */

/** 
 * Fixed-size bit-vector we use for option filtering. It is large
 * enough to hold the highest option number known at build time (20 in
 * the core spec).
 */
typedef unsigned char coap_opt_filter_t[(COAP_MAX_OPT >> 3) + 1];

/** Pre-defined filter that includes all options. */
extern const coap_opt_filter_t COAP_OPT_ALL;

/** 
 * Clears filter @p f.
 * 
 * @param f The filter to clear.
 */
static inline void
coap_option_filter_clear(coap_opt_filter_t f) {
  memset(f, 0, sizeof(coap_opt_filter_t));
}

/** 
 * Sets the corresponding bit for @p type in @p filter. This function
 * returns @c 1 if bit was set or @c -1 on error (i.e. when the given
 * type does not fit in the filter).
 * 
 * @param filter The filter object to change.
 * @param type   The type for which the bit should be set. 
 * 
 * @return @c 1 if bit was set, @c -1 otherwise.
 */
inline static int
coap_option_setb(coap_opt_filter_t filter, unsigned char type) {
  return bits_setb((uint8_t *)filter, sizeof(coap_opt_filter_t), type);
}

/** 
 * Clears the corresponding bit for @p type in @p filter. This function
 * returns @c 1 if bit was cleared or @c -1 on error (i.e. when the given
 * type does not fit in the filter).
 * 
 * @param filter The filter object to change.
 * @param type   The type for which the bit should be cleared. 
 * 
 * @return @c 1 if bit was set, @c -1 otherwise.
 */
inline static int
coap_option_clrb(coap_opt_filter_t filter, unsigned char type) {
  return bits_clrb((uint8_t *)filter, sizeof(coap_opt_filter_t), type);
}

/** 
 * Gets the corresponding bit for @p type in @p filter. This function
 * returns @c 1 if the bit is set @c 0 if not, or @c -1 on error (i.e.
 * when the given type does not fit in the filter).
 * 
 * @param filter The filter object to read bit from..
 * @param type   The type for which the bit should be read.
 * 
 * @return @c 1 if bit was set, @c 0 if not, @c -1 on error.
 */
inline static int
coap_option_getb(const coap_opt_filter_t filter, unsigned char type) {
  return bits_getb((uint8_t *)filter, sizeof(coap_opt_filter_t), type);
}

/** 
 * Iterator to run through PDU options. This object must be
 * initialized with coap_option_iterator_init(). Call
 * coap_option_next() to walk through the list of options.
 *
 * @code
 * coap_opt_t *option;
 * coap_opt_iterator_t opt_iter;
 * coap_option_iterator_init(pdu, &opt_iter, COAP_OPT_ALL);
 *
 * while ((option = coap_option_next(&opt_iter))) {
 *   ... do something with option ...
 * }
 * @endcode
 */
typedef struct {
  unsigned char n;		/**< number of option @deprecated */
  unsigned short length;	/**< remaining length of PDU */
  unsigned short type;		/**< decoded option type */
  coap_opt_filter_t filter;	/**< option filter */
  coap_opt_t *option;		/**< pointer to the current option */
} coap_opt_iterator_t;

/** 
 * Initializes the given option iterator @p oi to point to the
 * beginning of the @p pdu's option list. This function returns @p oi
 * on success, @c NULL otherwise (i.e. when no options exist).
 * Note that a length check on the option list must be performed before
 * coap_option_iterator_init() is called.
 * 
 * @param pdu  The PDU the options of which should be walked through.
 * @param oi   An iterator object that will be initilized.
 * @param filter An optional option type filter. 
 *               With @p type != @c COAP_OPT_ALL, coap_option_next() 
 *               will return only options matching this bitmask. 
 *               Fence-post options @c 14, @c 28, @c 42, ... are always
 *               skipped.
 * 
 * @return The iterator object @p oi on success, @c NULL otherwise.
 */
coap_opt_iterator_t *coap_option_iterator_init(coap_pdu_t *pdu,
     coap_opt_iterator_t *oi, const coap_opt_filter_t filter);

/** 
 * Updates the iterator @p oi to point to the next option. This
 * function returns a pointer to that option or @c NULL if no more
 * options exist. The contents of @p oi will be updated. In
 * particular, @c oi->n specifies the current option's ordinal number
 * (counted from @c 1), @c oi->type is the option's type code, and @c
 * oi->option points to the beginning of the current option
 * itself. When advanced past the last option, @c oi->option will be
 * @c NULL.
 * 
 * Note that options are skipped whose corresponding bits in the
 * filter specified with coap_option_iterator_init() are @c 0. Options
 * with type codes that do not fit in this filter hence will always be
 * returned.
 * 
 * @param oi The option iterator to update.
 * 
 * @return The next option or @c NULL if no more options exist.
 */
coap_opt_t *coap_option_next(coap_opt_iterator_t *oi);

/** 
 * Retrieves the first option of type @p type from @p pdu. @p oi must
 * point to a coap_opt_iterator_t object that will be initialized by
 * this function to filter only options with code @p type. This
 * function returns the first option with this type, or @c NULL if not
 * found.
 * 
 * @param pdu  The PDU to parse for options.
 * @param type The option type code to search for.
 * @param oi   An iterator object to use.
 * 
 * @return A pointer to the first option of type @p type, or @c NULL 
 *         if not found.
 */
coap_opt_t *coap_check_option(coap_pdu_t *pdu, 
			      unsigned char type, 
			      coap_opt_iterator_t *oi);

/**
 * Encodes the given delta and length values into @p opt. This
 * function returns the number of bytes that were required to encode
 * @p delta and @p length or @c 0 on error. Note that the result
 * indicates by how many bytes @p opt must be advanced to encode the
 * option value.
 *
 * @param opt    The option buffer space where @p delta and @p length are 
 *               written
 * @param maxlen The maximum length of @p opt
 * @param delta The actual delta value to encode.
 * @param length The actual length value to encode.
 * @return The number of bytes used or @c 0 on error.
 */
size_t coap_opt_setheader(coap_opt_t *opt, size_t maxlen, 
			  unsigned short delta, size_t length);

/**
 * Encodes option with given @p delta into @p opt. This function returns
 * the number of bytes written to @p opt or @c 0 on error. This happens
 * especially when @p opt does not provide sufficient space to store
 * the option value, delta, and option jumps when required.
 *
 * @param opt   The option buffer space where @p val is written
 * @param n     Maximum length of @p opt.
 * @param delta The option delta.
 * @param val   The option value to copy into @p opt.
 * @param len   The actual length of @p val.
 * @return The number of bytes that have been written to @p opt or
 *         @c 0 on error. The return value will always be less than @p n.
 */
size_t coap_opt_encode(coap_opt_t *opt, size_t n, unsigned short delta,
		       const unsigned char *val, size_t length);

/**
 * Checks if the delta-coding of the option starting at @p opt fits
 * in @p maxlen. This function returns @c 0 on error or the number
 * of bytes needed to read the delta value.
 *
 * @param opt The option to examine
 * @param maxlen The maximum length of *p opt
 * @return The number of bytes required for the delta value or 
 *         @c 0 on error.
 */
unsigned short coap_opt_check_delta(coap_opt_t *opt, size_t maxlen);


/**
 * Decodes the delta value of the next option. This function returns
 * the number of bytes read or @c 0 on error. The caller of this
 * function must ensure that it does not read over the boundaries
 * of @p opt (e.g. by calling coap_opt_check_delta().
 *
 * @param opt The option to examine
 * @return The number of bytes read or @c 0 on error.
 */
unsigned short coap_opt_delta(coap_opt_t *opt);

/** @deprecated { Use coap_opt_delta() instead. } */
#define COAP_OPT_DELTA(opt) coap_opt_delta(opt)

/** @deprecated { Use coap_opt_encode() instead. } */
#define COAP_OPT_SETDELTA(opt,val)			\
  coap_opt_encode((opt), COAP_MAX_PDU_SIZE, (val), NULL, 0)

/**
 * Returns the length of the given option. @p opt must point to an
 * option jump or the beginning of the option. This function returns
 * @c 0 when @p opt is not an option or the actual length of @p opt
 * (which can be @c 0 as well).
 *
 * @note {The rationale for using @c 0 in case of an error is that in
 * most contexts, the result of this function is used to skip the next
 * coap_opt_length() bytes. }
 *
 * @param opt  The option whose length should be returned.
 * @return The option's length or @c 0 when undefined.
 */
unsigned short coap_opt_length(const coap_opt_t *opt);

/** @deprecated { Use coap_opt_length() instead. } */
#define COAP_OPT_LENGTH(opt) coap_opt_length(opt)

/**
 * Returns a pointer to the value of the given option. @p opt must
 * point to an option jump or the beginning of the option. This 
 * function returns @c NULL if @p opt is not a valid option.
 *
 * @param opt  The option whose value should be returned.
 * @return A pointer to the option value or @c NULL on error.
 */
unsigned char *coap_opt_value(coap_opt_t *opt);

/** @deprecated { Use coap_opt_value() instead. } */
#define COAP_OPT_VALUE(opt) coap_opt_value(opt)

/** @} */

#endif /* _OPTION_H_ */