1 /* 2 * pythonmod_utils.h: utils header file 3 * 4 * Copyright (c) 2009, Zdenek Vasicek (vasicek AT fit.vutbr.cz) 5 * Marek Vavrusa (xvavru00 AT stud.fit.vutbr.cz) 6 * 7 * This software is open source. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 12 * 13 * * Redistributions of source code must retain the above copyright notice, 14 * this list of conditions and the following disclaimer. 15 * 16 * * Redistributions in binary form must reproduce the above copyright notice, 17 * this list of conditions and the following disclaimer in the documentation 18 * and/or other materials provided with the distribution. 19 * 20 * * Neither the name of the organization nor the names of its 21 * contributors may be used to endorse or promote products derived from this 22 * software without specific prior written permission. 23 * 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 25 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 26 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 27 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE 28 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 29 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 30 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 31 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 32 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 33 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 34 * POSSIBILITY OF SUCH DAMAGE. 35 */ 36 /** 37 * \file 38 * Utility functions for the python module that perform stores and loads and 39 * conversions. 40 */ 41 #ifndef PYTHONMOD_UTILS_H 42 #define PYTHONMOD_UTILS_H 43 44 #include "util/module.h" 45 struct delegpt_addr; 46 struct sldns_buffer; 47 48 /** 49 * Store the reply_info and query_info pair in message cache 50 * (qstate->msg_cache). 51 * 52 * @param qstate: module environment 53 * @param qinfo: query info, the query for which answer is stored. 54 * @param msgrep: reply in dns_msg 55 * @param is_referral: If true, then the given message to be stored is a 56 * referral. The cache implementation may use this as a hint. 57 * It will store only the RRsets, not the message. 58 * @return 0 on alloc error (out of memory). 59 */ 60 int storeQueryInCache(struct module_qstate* qstate, struct query_info* qinfo, 61 struct reply_info* msgrep, int is_referral); 62 63 64 /** 65 * Invalidate the message associated with query_info stored in message cache. 66 * 67 * This function invalidates the record in message cache associated with the 68 * given query only if such a record exists. 69 * 70 * @param qstate: module environment 71 * @param qinfo: query info, the query for which answer is stored. 72 */ 73 void invalidateQueryInCache(struct module_qstate* qstate, 74 struct query_info* qinfo); 75 76 /** 77 * Create response according to the ldns packet content. 78 * 79 * This function fills qstate.return_msg up with data of a given packet 80 * 81 * @param qstate: module environment 82 * @param pkt: a sldns_buffer which contains sldns_packet data 83 * @return 0 on failure, out of memory or parse error. 84 */ 85 int createResponse(struct module_qstate* qstate, struct sldns_buffer* pkt); 86 87 /** 88 * Convert reply->addr to string. 89 * @param reply: comm reply with address in it. 90 * @param dest: destination string. 91 * @param maxlen: length of string buffer. 92 */ 93 void reply_addr2str(struct comm_reply* reply, char* dest, int maxlen); 94 95 /** 96 * Convert target->addr to string. 97 * @param target: delegpt_addr with address in it. 98 * @param dest: destination string. 99 * @param maxlen: length of string buffer. 100 */ 101 void delegpt_addr_addr2str(struct delegpt_addr* target, char *dest, 102 int maxlen); 103 104 #endif /* PYTHONMOD_UTILS_H */ 105