/usr/include/libknot/processing/layer.h is in libknot-dev 2.1.1-1build1.
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 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 | /* Copyright (C) 2014 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 <http://www.gnu.org/licenses/>.
*/
/*!
* \file layer.h
*
* \author Marek Vavrusa <marek.vavrusa@nic.cz>
*
* \addtogroup query_processing
* @{
*/
#pragma once
#include <stdint.h>
#include "libknot/packet/pkt.h"
#include "libknot/mm_ctx.h"
/*! Layer processing states.
* Each state represents the state machine transition,
* and determines readiness for the next action.
*/
enum knot_layer_state {
KNOT_STATE_NOOP = 0, /*!< N/A */
KNOT_STATE_CONSUME = 1 << 0, /*!< Consume data. */
KNOT_STATE_PRODUCE = 1 << 1, /*!< Produce data. */
KNOT_STATE_DONE = 1 << 2, /*!< Finished. */
KNOT_STATE_FAIL = 1 << 3 /*!< Error. */
};
/* Forward declarations. */
struct knot_layer_api;
/*! \brief Packet processing context. */
typedef struct knot_layer {
knot_mm_t *mm; /* Processing memory context. */
uint16_t state; /* Bitmap of enum knot_layer_state. */
void *data; /* Module specific. */
const struct knot_layer_api *api;
} knot_layer_t;
/*! \brief Packet processing module API. */
typedef struct knot_layer_api {
int (*begin)(knot_layer_t *ctx, void *module_param);
int (*reset)(knot_layer_t *ctx);
int (*finish)(knot_layer_t *ctx);
int (*consume)(knot_layer_t *ctx, knot_pkt_t *pkt);
int (*produce)(knot_layer_t *ctx, knot_pkt_t *pkt);
int (*fail)(knot_layer_t *ctx, knot_pkt_t *pkt);
void *data;
} knot_layer_api_t;
/*!
* \brief Initialize packet processing context.
*
* \param ctx Layer context.
* \param api Layer API.
* \param param Parameters for given module.
*
* \return Layer state.
*/
int knot_layer_begin(knot_layer_t *ctx, const knot_layer_api_t *api, void *param);
/*!
* \brief Reset current packet processing context.
*
* \param ctx Layer context.
*
* \return Layer state.
*/
int knot_layer_reset(knot_layer_t *ctx);
/*!
* \brief Finish and close packet processing context.
*
* \param ctx Layer context.
*
* \return Layer state.
*/
int knot_layer_finish(knot_layer_t *ctx);
/*!
* \brief Add more data to layer processing.
*
* \param ctx Layer context.
* \param pkt Data packet.
*
* \return Layer state.
*/
int knot_layer_consume(knot_layer_t *ctx, knot_pkt_t *pkt);
/*!
* \brief Generate output from layer.
*
* \param ctx Layer context.
* \param pkt Data packet.
*
* \return Layer state.
*/
int knot_layer_produce(knot_layer_t *ctx, knot_pkt_t *pkt);
/*! @} */
|