/usr/include/libkres/layer.h is in libkres-dev 2.1.1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | /* Copyright (C) 2014-2017 CZ.NIC, z.s.p.o. <knot-dns@labs.nic.cz>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
#pragma once
#include "lib/defines.h"
#include "lib/utils.h"
#ifndef NOVERBOSELOG
/** @internal Print a debug message related to resolution. */
#define QRVERBOSE(query, cls, fmt, ...) { \
const struct kr_query *q = (query); \
if (kr_log_trace_enabled(q)) { \
kr_log_trace(q, cls, fmt, ## __VA_ARGS__); \
} else WITH_VERBOSE(q) { \
unsigned _ind = 0; \
uint16_t _id = q ? q->id : 0; \
for (; q; q = q->parent, _ind += 2); \
kr_log_verbose("[%5hu][%s] %*s" fmt, _id, cls, _ind, "", ## __VA_ARGS__); \
} \
}
#else
#define QRVERBOSE(query, cls, fmt, ...)
#endif
/** Layer processing states. Only one value at a time (but see TODO).
*
* Each state represents the state machine transition,
* and determines readiness for the next action.
* See struct kr_layer_api for the actions.
*
* TODO: the cookie module sometimes sets (_FAIL | _DONE) on purpose (!)
*/
enum kr_layer_state {
KR_STATE_CONSUME = 1 << 0, /*!< Consume data. */
KR_STATE_PRODUCE = 1 << 1, /*!< Produce data. */
KR_STATE_DONE = 1 << 2, /*!< Finished successfully. */
KR_STATE_FAIL = 1 << 3, /*!< Error. */
KR_STATE_YIELD = 1 << 4, /*!< Paused, waiting for a sub-query. */
};
/* Forward declarations. */
struct kr_layer_api;
/** Packet processing context. */
typedef struct kr_layer {
int state; /*!< The current state; bitmap of enum kr_layer_state. */
struct kr_request *req; /*!< The corresponding request. */
const struct kr_layer_api *api;
} kr_layer_t;
/** Packet processing module API. All functions return the new kr_layer_state. */
struct kr_layer_api {
/** Start of processing the DNS request. */
int (*begin)(kr_layer_t *ctx);
int (*reset)(kr_layer_t *ctx);
/** Paired to begin, called both on successes and failures. */
int (*finish)(kr_layer_t *ctx);
/** Processing an answer from upstream or the answer to the request. */
int (*consume)(kr_layer_t *ctx, knot_pkt_t *pkt);
/** Produce either an answer to the request or a query for upstream (or fail). */
int (*produce)(kr_layer_t *ctx, knot_pkt_t *pkt);
/** The module can store anything in here. */
void *data;
};
typedef struct kr_layer_api kr_layer_api_t;
/** Pickled layer state (api, input, state). */
struct kr_layer_pickle {
struct kr_layer_pickle *next;
const struct kr_layer_api *api;
knot_pkt_t *pkt;
unsigned state;
};
|