summaryrefslogtreecommitdiff
path: root/src/libknot/rrset.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/libknot/rrset.h')
-rw-r--r--src/libknot/rrset.h346
1 files changed, 265 insertions, 81 deletions
diff --git a/src/libknot/rrset.h b/src/libknot/rrset.h
index 077b067..2b0cb6b 100644
--- a/src/libknot/rrset.h
+++ b/src/libknot/rrset.h
@@ -2,6 +2,7 @@
* \file rrset.h
*
* \author Lubos Slovak <lubos.slovak@nic.cz>
+ * \author Jan Kadlec <jan.kadlec@nic.cz>
*
* \brief RRSet structure and API for manipulating it.
*
@@ -30,7 +31,6 @@
#include <stdint.h>
#include "dname.h"
-#include "rdata.h"
/*----------------------------------------------------------------------------*/
/*!
@@ -43,19 +43,25 @@
* program. Distinct Resource Records are thus represented only as distinct
* RDATA sections of corresponding RRs.
*/
+
struct knot_rrset {
/*! \brief Domain name being the owner of the RRSet. */
knot_dname_t *owner;
uint16_t type; /*!< TYPE of the RRset. */
uint16_t rclass; /*!< CLASS of the RRSet. */
uint32_t ttl; /*!< TTL of the RRSet. */
- /*!
- * \brief First item in an ordered cyclic list of RDATA items.
- *
- * \note The fact that the list is cyclic will easily allow for
- * possible round-robin rotation of RRSets.
+
+ /* [code-review] It would be fine to better describe the format of this
+ * array and the meaning of the indices. Maybe even draw some simple
+ * image :-)
+ */
+ uint8_t *rdata; /*!< RDATA array (All RRs). */
+ /*! \brief Beginnings of RRs - first one does not contain 0, last
+ * last one holds total length of all RRs together
*/
- knot_rdata_t *rdata;
+ /* [code-review] Does this have to be 32b integer? Isn't 16b enough? */
+ uint32_t *rdata_indices; /*!< Indices to beginnings of RRs (without 0)*/
+ uint16_t rdata_count; /*!< Count of RRs in this RRSet. */
struct knot_rrset *rrsigs; /*!< Set of RRSIGs covering this RRSet. */
};
@@ -76,6 +82,9 @@ typedef enum {
} knot_rrset_dupl_handling_t;
/*----------------------------------------------------------------------------*/
+
+uint32_t rrset_rdata_size_total(const knot_rrset_t *rrset);
+
/*!
* \brief Creates a new RRSet with the given properties.
*
@@ -97,31 +106,39 @@ knot_rrset_t *knot_rrset_new(knot_dname_t *owner, uint16_t type,
*
* \param rrset RRSet to add the RDATA to.
* \param rdata RDATA to add to the RRSet.
+ * \param size Size of RDATA.
*
- * \retval KNOT_EOK
- * \retval KNOT_EINVAL
- *
- * \todo Provide some function for comparing RDATAs.
+ * \retval KNOT_EINVAL on wrong arguments.
+ * \retval KNOT_EOK on success.
*/
-int knot_rrset_add_rdata(knot_rrset_t *rrset, knot_rdata_t *rdata);
+int knot_rrset_add_rdata(knot_rrset_t *rrset, const uint8_t *rdata,
+ uint16_t size);
/*!
- * \brief Adds the given RDATA to the RRSet but will not insert duplicated data.
- *
- * \warning Should be only used to insert one RDATA. (NO lists)
+ * \brief Creates RDATA memory and returns a pointer to it.
+ * If the RRSet is not empty, function will return a memory
+ * pointing to a beginning of a new RR. (Indices will be handled as well)
*
* \param rrset RRSet to add the RDATA to.
- * \param rdata RDATA to add to the RRSet.
+ * \param size Size of RR RDATA (Size in internal representation)
*
- * \retval KNOT_EOK
- * \retval KNOT_EINVAL
- *
- * \todo Provide some function for comparing RDATAs.
+ * \return Pointer to memory to be written to.
+ * \retval NULL if arguments are invalid
*/
-int knot_rrset_add_rdata_order(knot_rrset_t *rrset, knot_rdata_t *rdata);
+uint8_t* knot_rrset_create_rdata(knot_rrset_t *rrset, const uint16_t size);
-knot_rdata_t * knot_rrset_remove_rdata(knot_rrset_t *rrset,
- const knot_rdata_t *rdata);
+/*!
+ * \brief Returns size of an RR RDATA on a given position.
+ *
+ * \param rrset RRSet holding RR RDATA.
+ * \param pos RR position.
+ *
+ * \retval 0 on error.
+ * \return Item size on success.
+ */
+/* [code-review] Misleading name, maybe remove the word 'item'. */
+uint16_t rrset_rdata_item_size(const knot_rrset_t *rrset,
+ size_t pos);
/*!
* \brief Adds RRSIG signatures to this RRSet.
@@ -134,8 +151,21 @@ knot_rdata_t * knot_rrset_remove_rdata(knot_rrset_t *rrset,
*/
int knot_rrset_set_rrsigs(knot_rrset_t *rrset, knot_rrset_t *rrsigs);
+/*!
+ * \brief Adds RRSIG signatures to this RRSet.
+ *
+ * \param rrset RRSet to add the signatures into.
+ * \param rrsigs Set of RRSIGs covering this RRSet.
+ * \param dupl Merging strategy.
+ *
+ * \retval KNOT_EOK if no merge was needed.
+ * \retval 1 if merge was needed.
+ * \retval 2 if rrsig was not first, but is was skipped.
+ * \retval KNOT_EINVAL on faulty arguments or rrsig does not belong to this rrset.
+ */
+//TODO test
int knot_rrset_add_rrsigs(knot_rrset_t *rrset, knot_rrset_t *rrsigs,
- knot_rrset_dupl_handling_t dupl);
+ knot_rrset_dupl_handling_t dupl);
/*!
* \brief Returns the Owner of the RRSet.
@@ -147,7 +177,11 @@ int knot_rrset_add_rrsigs(knot_rrset_t *rrset, knot_rrset_t *rrsigs,
const knot_dname_t *knot_rrset_owner(const knot_rrset_t *rrset);
/*!
- * \todo Document me.
+ * \brief Returns the Owner of the RRSet.
+ *
+ * \param rrset RRSet to get the Owner of.
+ *
+ * \return Owner of the given RRSet.
*/
knot_dname_t *knot_rrset_get_owner(const knot_rrset_t *rrset);
@@ -161,6 +195,12 @@ knot_dname_t *knot_rrset_get_owner(const knot_rrset_t *rrset);
*/
void knot_rrset_set_owner(knot_rrset_t *rrset, knot_dname_t* owner);
+/*!
+ * \brief Sets rrset TTL to given TTL.
+ *
+ * \param rrset Specified RRSet.
+ * \param ttl New TTL.
+ */
void knot_rrset_set_ttl(knot_rrset_t *rrset, uint32_t ttl);
void knot_rrset_set_class(knot_rrset_t *rrset, uint16_t rclass);
@@ -193,43 +233,24 @@ uint16_t knot_rrset_class(const knot_rrset_t *rrset);
uint32_t knot_rrset_ttl(const knot_rrset_t *rrset);
/*!
- * \brief Returns the first RDATA in the RRSet.
- *
- * RDATAs in a RRSet are stored in a ordered cyclic list.
- *
- * \note If later a round-robin rotation of RRSets is employed, the RDATA
- * returned by this function may not be the first RDATA in canonical
- * order.
+ * \brief Returns RDATA of RR on given position.
*
* \param rrset RRSet to get the RDATA from.
+ * \param rdata_pos Position of RR to get.
*
- * \return First RDATA in the given RRSet.
+ * \retval NULL if no RDATA on rdata_pos exist.
+ * \return Pointer to RDATA on given position if successfull.
*/
-const knot_rdata_t *knot_rrset_rdata(const knot_rrset_t *rrset);
-
-const knot_rdata_t *knot_rrset_rdata_next(const knot_rrset_t *rrset,
- const knot_rdata_t *rdata);
+uint8_t *knot_rrset_get_rdata(const knot_rrset_t *rrset, size_t rdata_pos);
/*!
- * \brief Returns the first RDATA in the RRSet (non-const version).
- *
- * RDATAs in a RRSet are stored in a ordered cyclic list.
+ * \brief Returns the count of RRs in a given RRSet.
*
- * \note If later a round-robin rotation of RRSets is employed, the RDATA
- * returned by this function may not be the first RDATA in canonical
- * order.
+ * \param rrset RRSet to get the RRs count from.
*
- * \param rrset RRSet to get the RDATA from.
- *
- * \return First RDATA in the given RRSet or NULL if there is none or if no
- * rrset was provided (\a rrset is NULL).
+ * \return Count of the RRs in a given RRSet.
*/
-knot_rdata_t *knot_rrset_get_rdata(knot_rrset_t *rrset);
-
-knot_rdata_t *knot_rrset_rdata_get_next(knot_rrset_t *rrset,
- knot_rdata_t *rdata);
-
-int knot_rrset_rdata_rr_count(const knot_rrset_t *rrset);
+uint16_t knot_rrset_rdata_rr_count(const knot_rrset_t *rrset);
/*!
* \brief Returns the set of RRSIGs covering the given RRSet.
@@ -243,33 +264,26 @@ const knot_rrset_t *knot_rrset_rrsigs(const knot_rrset_t *rrset);
knot_rrset_t *knot_rrset_get_rrsigs(knot_rrset_t *rrset);
-int knot_rrset_compare_rdata(const knot_rrset_t *r1, const knot_rrset_t *r2);
-
-int knot_rrset_to_wire(const knot_rrset_t *rrset, uint8_t *wire, size_t *size,
- int *rr_count);
+int knot_rrset_rdata_equal(const knot_rrset_t *r1, const knot_rrset_t *r2);
/*!
- * \brief Compares two RRSets.
- *
- * \note This function does not return 'standard' compare return values, because
- * there is no way to define which RRSet is 'larger'.
+ * \brief Compares two RRSets for equality.
*
* \param r1 First RRSet.
* \param r2 Second RRSet.
* \param cmp Type of comparison to perform.
*
- * \retval <> 0 If RRSets are equal.
+ * \retval 1 if RRSets are equal.
* \retval 0 if RRSets are not equal.
+ * \retval < 0 if error occured.
*/
-int knot_rrset_match(const knot_rrset_t *r1,
- const knot_rrset_t *r2,
- knot_rrset_compare_type_t cmp);
+int knot_rrset_equal(const knot_rrset_t *r1,
+ const knot_rrset_t *r2,
+ knot_rrset_compare_type_t cmp);
-/*! \todo Add unit test. */
int knot_rrset_deep_copy(const knot_rrset_t *from, knot_rrset_t **to,
int copy_rdata_dnames);
-/*! \todo Add unit test. */
int knot_rrset_shallow_copy(const knot_rrset_t *from, knot_rrset_t **to);
/*! \brief Does round-robin rotation of the RRSet.
@@ -302,13 +316,18 @@ void knot_rrset_free(knot_rrset_t **rrset);
* \param rrset RRset to be destroyed.
* \param free_owner Set to 0 if you do not want the owner domain name to be
* destroyed also. Set to <> 0 otherwise.
- * \param free_rdata ***\todo DOCUMENT ME***
* \param free_rdata_dnames Set to <> 0 if you want to delete ALL domain names
* present in RDATA. Set to 0 otherwise. (See
* knot_rdata_deep_free().)
*/
void knot_rrset_deep_free(knot_rrset_t **rrset, int free_owner,
- int free_rdata, int free_rdata_dnames);
+ int free_rdata_dnames);
+
+void knot_rrset_deep_free_no_sig(knot_rrset_t **rrset, int free_owner,
+ int free_rdata_dnames);
+
+int knot_rrset_to_wire(const knot_rrset_t *rrset, uint8_t *wire, size_t *size,
+ size_t max_size, uint16_t *rr_count, void *comp_data);
/*!
* \brief Merges two RRSets.
@@ -327,18 +346,11 @@ void knot_rrset_deep_free(knot_rrset_t **rrset, int free_owner,
* \retval KNOT_EINVAL if the RRSets could not be merged, because their
* Owner, Type, Class or TTL does not match.
*/
-int knot_rrset_merge(void **r1, void **r2);
+int knot_rrset_merge(knot_rrset_t *rrset1, const knot_rrset_t *rrset2);
/*!
- * \brief Merges two RRSets, but will discard and free any duplicates in \a r2.
- *
- * Merges \a r1 into \a r2 by concatenating the list of RDATAs in \a r2 after
- * the list of RDATAs in \a r1. You must not
- * destroy the RDATAs in \a r2 as they are now identical to RDATAs in \a r1.
- * (You may use function knot_rrset_free() though, as it does not touch RDATAs).
- *
- * \note Member \a rrsigs is preserved from the first RRSet.
+ * \brief Merges two RRSets, but will only merge unique items.
*
* \param r1 Pointer to RRSet to be merged into.
* \param r2 Poitner to RRSet to be merged.
@@ -346,11 +358,183 @@ int knot_rrset_merge(void **r1, void **r2);
* \retval KNOT_EOK
* \retval KNOT_EINVAL if the RRSets could not be merged, because their
* Owner, Type, Class or TTL does not match.
- * \retval >0 if some RDATA have been removed because they were duplicate. The
- * return value indicates number of such RDATA.
*/
-int knot_rrset_merge_no_dupl(void **r1, void **r2);
+int knot_rrset_merge_no_dupl(knot_rrset_t *rrset1, const knot_rrset_t *rrset2, int *merged, int *deleted_rrs);
+
+
+//TODO test
+const knot_dname_t *knot_rrset_rdata_cname_name(const knot_rrset_t *rrset);
+//TODO test
+const knot_dname_t *knot_rrset_rdata_dname_target(const knot_rrset_t *rrset);
+//TODO test
+void knot_rrset_rdata_set_cname_name(knot_rrset_t *rrset,
+ const knot_dname_t *name);
+//TODO test
+void knot_rrset_rdata_set_dname_target(knot_rrset_t *rrset,
+ const knot_dname_t *target);
+//TODO test
+const knot_dname_t *knot_rrset_rdata_soa_primary_ns(const knot_rrset_t *rrset);
+//TODO test
+const knot_dname_t *knot_rrset_rdata_soa_mailbox(const knot_rrset_t *rrset);
+uint32_t knot_rrset_rdata_soa_serial(const knot_rrset_t *rrset);
+//TODO test
+void knot_rrset_rdata_soa_serial_set(knot_rrset_t *rrset, uint32_t serial);
+//TODO test
+uint32_t knot_rrset_rdata_soa_refresh(const knot_rrset_t *rrset);
+//TODO test
+uint32_t knot_rrset_rdata_soa_retry(const knot_rrset_t *rrset);
+//TODO test
+uint32_t knot_rrset_rdata_soa_expire(const knot_rrset_t *rrset);
+//TODO test
+uint32_t knot_rrset_rdata_soa_minimum(const knot_rrset_t *rrset);
+//TODO test
+uint16_t knot_rrset_rdata_rrsig_type_covered(const knot_rrset_t *rrset);
+/* TODO not all of these need to have rr_pos as a parameter. */
+uint8_t knot_rrset_rdata_rrsig_algorithm(const knot_rrset_t *rrset,
+ size_t rr_pos);
+uint8_t knot_rrset_rdata_rrsig_labels(const knot_rrset_t *rrset, size_t rr_pos);
+uint32_t knot_rrset_rdata_rrsig_original_ttl(const knot_rrset_t *rrset,
+ size_t rr_pos);
+uint32_t knot_rrset_rdata_rrsig_sig_expiration(const knot_rrset_t *rrset,
+ size_t rr_pos);
+uint32_t knot_rrset_rdata_rrsig_sig_inception(const knot_rrset_t *rrset,
+ size_t rr_pos);
+uint16_t knot_rrset_rdata_rrsig_key_tag(const knot_rrset_t *rrset,
+ size_t rr_pos);
+const knot_dname_t *knot_rrset_rdata_rrsig_signer_name(const knot_rrset_t *rrset,
+ size_t rr_pos);
+
+uint16_t knot_rrset_rdata_dnskey_flags(const knot_rrset_t *rrset, size_t rr_pos);
+uint8_t knot_rrset_rdata_dnskey_proto(const knot_rrset_t *rrset, size_t rr_pos);
+uint8_t knot_rrset_rdata_dnskey_alg(const knot_rrset_t *rrset, size_t rr_pos);
+void knot_rrset_rdata_dnskey_key(const knot_rrset_t *rrset, size_t rr_pos,
+ uint8_t **key, uint16_t *key_size);
+const knot_dname_t *knot_rrset_rdata_nsec_next(const knot_rrset_t *rrset,
+ size_t rr_pos);
+void knot_rrset_rdata_nsec_bitmap(const knot_rrset_t *rrset, size_t rr_pos,
+ uint8_t **bitmap, uint16_t *size);
+
+void knot_rrset_rdata_nsec3_bitmap(const knot_rrset_t *rrset, size_t rr_pos,
+ uint8_t **bitmap, uint16_t *size);
+//TODO test
+uint8_t knot_rrset_rdata_nsec3_algorithm(const knot_rrset_t *rrset,
+ size_t pos);
+uint8_t knot_rrset_rdata_nsec3_flags(const knot_rrset_t *rrset,
+ size_t pos);
+//TODO test
+uint16_t knot_rrset_rdata_nsec3_iterations(const knot_rrset_t *rrset,
+ size_t pos);
+//TODO test
+uint8_t knot_rrset_rdata_nsec3_salt_length(const knot_rrset_t *rrset,
+ size_t pos);
+// TODO same as salt, size and data
+void knot_rrset_rdata_nsec3_next_hashed(const knot_rrset_t *rrset, size_t pos,
+ uint8_t **name, uint8_t *name_size);
+//TODO test
+const uint8_t *knot_rrset_rdata_nsec3_salt(const knot_rrset_t *rrset,
+ size_t pos);
+//TODO test
+uint8_t knot_rrset_rdata_nsec3param_algorithm(const knot_rrset_t *rrset);
+//TODO test
+uint8_t knot_rrset_rdata_nsec3param_flags(const knot_rrset_t *rrset);
+//TODO test
+uint16_t knot_rrset_rdata_nsec3param_iterations(const knot_rrset_t *rrset);
+//TODO test
+uint8_t knot_rrset_rdata_nsec3param_salt_length(const knot_rrset_t *rrset);
+//TODO test
+const uint8_t *knot_rrset_rdata_nsec3param_salt(const knot_rrset_t *rrset);
+
+const knot_dname_t *knot_rrset_rdata_rp_first_dname(const knot_rrset_t *rrset,
+ size_t pos);
+const knot_dname_t *knot_rrset_rdata_rp_second_dname(const knot_rrset_t *rrset,
+ size_t pos);
+const knot_dname_t *knot_rrset_rdata_minfo_first_dname(const knot_rrset_t *rrset,
+ size_t pos);
+const knot_dname_t *knot_rrset_rdata_minfo_second_dname(const knot_rrset_t *rrset,
+ size_t pos);
+
+/*!
+ * \brief Find next dname in rrset relative to prev.
+ *
+ * \param rrset Inspected rrset.
+ * \param prev_dname Pointer to previous dname.
+ * \return next dname or NULL.
+ */
+/* [code-review] Emphasize that the 'prev' pointer must point into the RDATA
+ * array of the given RRSet.
+ */
+knot_dname_t **knot_rrset_get_next_dname(const knot_rrset_t *rrset,
+ knot_dname_t **prev);
+
+/*!
+ * \brief Find next dname in RR relative to previous one.
+ *
+ * \param rrset Inspected rrset.
+ * \param prev_dname Previous dname. This must be a pointer to the rrset's
+ * RDATA array.
+ * \param rr_pos Position of RR.
+ * \return Next dname or NULL if there is no other dname in the RR.
+ */
+knot_dname_t **knot_rrset_get_next_rr_dname(const knot_rrset_t *rrset,
+ knot_dname_t **prev_dname,
+ size_t rr_pos);
+
+const knot_dname_t *knot_rrset_rdata_ns_name(const knot_rrset_t *rrset,
+ size_t rdata_pos);
+
+const knot_dname_t *knot_rrset_rdata_mx_name(const knot_rrset_t *rrset,
+ size_t rdata_pos);
+
+const knot_dname_t *knot_rrset_rdata_srv_name(const knot_rrset_t *rrset,
+ size_t rdata_pos);
+
+const knot_dname_t *knot_rrset_rdata_name(const knot_rrset_t *rrset,
+ size_t rdata_pos);
+
+void knot_rrset_dump(const knot_rrset_t *rrset);
+
+//TODO test
+int rrset_serialize(const knot_rrset_t *rrset, uint8_t *stream, size_t *size);
+uint64_t rrset_binary_size(const knot_rrset_t *rrset);
+
+//TODO test
+int rrset_serialize_alloc(const knot_rrset_t *rrset, uint8_t **stream,
+ size_t *size);
+
+//TODO test
+int rrset_deserialize(uint8_t *stream, size_t *stream_size,
+ knot_rrset_t **rrset);
+
+int knot_rrset_remove_rr(knot_rrset_t *dest,
+ const knot_rrset_t *source, size_t rdata_pos);
+
+int knot_rrset_rdata_reset(knot_rrset_t *rrset);
+
+int knot_rrset_add_rr_from_rrset(knot_rrset_t *dest, const knot_rrset_t *source,
+ size_t rdata_pos);
+
+int knot_rrset_remove_rr_using_rrset(knot_rrset_t *from,
+ const knot_rrset_t *what,
+ knot_rrset_t **rr_deleted, int ddns_check);
+
+int knot_rrset_remove_rr_using_rrset_del(knot_rrset_t *from,
+ const knot_rrset_t *what);
+
+int knot_rrset_find_rr_pos(const knot_rrset_t *rr_search_in,
+ const knot_rrset_t *rr_reference, size_t pos,
+ size_t *pos_out);
+
+int rrset_rr_dnames_apply(knot_rrset_t *rrset, size_t rdata_pos,
+ int (*func)(knot_dname_t **, void *), void *data);
+
+int rrset_dnames_apply(knot_rrset_t *rrset, int (*func)(knot_dname_t **, void *),
+ void *data);
+
+int knot_rrset_rdata_from_wire_one(knot_rrset_t *rrset,
+ const uint8_t *wire, size_t *pos,
+ size_t total_size, size_t rdlength);
+int knot_rrset_ds_check(const knot_rrset_t *rrset);
#endif /* _KNOT_RRSET_H_ */
/*! @} */
generated by cgit v1.2.3 (git 2.39.1) at 2025-07-30 23:35:35 +0000