blob: b4e9396e0d3469bdf76482ba7db3050362ceec93 [file] [log] [blame]
Willy Tarreau8a8d83b2015-04-13 13:24:54 +02001/*
2 * include/proto/applet.h
3 * This file contains applet function prototypes
4 *
5 * Copyright (C) 2000-2015 Willy Tarreau - w@1wt.eu
6 *
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation, version 2.1
10 * exclusively.
11 *
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20 */
21
22#ifndef _PROTO_APPLET_H
23#define _PROTO_APPLET_H
24
25#include <stdlib.h>
26
27#include <common/config.h>
Willy Tarreau8280ea92019-07-18 10:41:36 +020028#include <common/memory.h>
Willy Tarreau81f38d62015-04-13 17:11:11 +020029#include <common/mini-clist.h>
Willy Tarreau8a8d83b2015-04-13 13:24:54 +020030#include <types/applet.h>
Olivier Houchard673867c2018-05-25 16:58:52 +020031#include <proto/task.h>
Willy Tarreau8a8d83b2015-04-13 13:24:54 +020032
Christopher Faulet1cbe74c2016-12-06 09:13:22 +010033extern unsigned int nb_applets;
Willy Tarreau8280ea92019-07-18 10:41:36 +020034extern struct pool_head *pool_head_appctx;
Willy Tarreau81f38d62015-04-13 17:11:11 +020035
Olivier Houchard673867c2018-05-25 16:58:52 +020036struct task *task_run_applet(struct task *t, void *context, unsigned short state);
Willy Tarreau3c595ac2015-04-19 09:59:31 +020037
Willy Tarreau21028b52018-11-06 17:32:37 +010038int appctx_buf_available(void *arg);
Christopher Fauleta73e59b2016-12-09 17:30:18 +010039
Christopher Fauleta73e59b2016-12-09 17:30:18 +010040
Willy Tarreau8a8d83b2015-04-13 13:24:54 +020041/* Initializes all required fields for a new appctx. Note that it does the
42 * minimum acceptable initialization for an appctx. This means only the
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +020043 * 3 integer states st0, st1, st2 and the chunk used to gather unfinished
44 * commands are zeroed
Willy Tarreau8a8d83b2015-04-13 13:24:54 +020045 */
Emeric Brun1138fd02017-06-19 12:38:55 +020046static inline void appctx_init(struct appctx *appctx, unsigned long thread_mask)
Willy Tarreau8a8d83b2015-04-13 13:24:54 +020047{
48 appctx->st0 = appctx->st1 = appctx->st2 = 0;
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +020049 appctx->chunk = NULL;
Thierry FOURNIER / OZON.IO6a22dcb2016-11-12 10:51:33 +010050 appctx->io_release = NULL;
Willy Tarreauf65610a2017-10-31 16:06:06 +010051 appctx->thread_mask = thread_mask;
Willy Tarreau22d63a22019-04-24 08:41:29 +020052 appctx->call_rate.curr_sec = 0;
53 appctx->call_rate.curr_ctr = 0;
54 appctx->call_rate.prev_ctr = 0;
Olivier Houchard673867c2018-05-25 16:58:52 +020055 appctx->state = 0;
Willy Tarreau8a8d83b2015-04-13 13:24:54 +020056}
57
58/* Tries to allocate a new appctx and initialize its main fields. The appctx
59 * is returned on success, NULL on failure. The appctx must be released using
Willy Tarreau8280ea92019-07-18 10:41:36 +020060 * appctx_free(). <applet> is assigned as the applet, but it can be NULL.
Willy Tarreau8a8d83b2015-04-13 13:24:54 +020061 */
Emeric Brun1138fd02017-06-19 12:38:55 +020062static inline struct appctx *appctx_new(struct applet *applet, unsigned long thread_mask)
Willy Tarreau8a8d83b2015-04-13 13:24:54 +020063{
64 struct appctx *appctx;
65
Willy Tarreau8280ea92019-07-18 10:41:36 +020066 appctx = pool_alloc(pool_head_appctx);
Willy Tarreau8a8d83b2015-04-13 13:24:54 +020067 if (likely(appctx != NULL)) {
68 appctx->obj_type = OBJ_TYPE_APPCTX;
69 appctx->applet = applet;
Emeric Brun1138fd02017-06-19 12:38:55 +020070 appctx_init(appctx, thread_mask);
Olivier Houchard673867c2018-05-25 16:58:52 +020071 appctx->t = task_new(thread_mask);
72 if (unlikely(appctx->t == NULL)) {
Willy Tarreau8280ea92019-07-18 10:41:36 +020073 pool_free(pool_head_appctx, appctx);
Olivier Houchard673867c2018-05-25 16:58:52 +020074 return NULL;
75 }
76 appctx->t->process = task_run_applet;
77 appctx->t->context = appctx;
Christopher Fauleta73e59b2016-12-09 17:30:18 +010078 LIST_INIT(&appctx->buffer_wait.list);
79 appctx->buffer_wait.target = appctx;
Willy Tarreau21028b52018-11-06 17:32:37 +010080 appctx->buffer_wait.wakeup_cb = appctx_buf_available;
Olivier Houcharda2735342019-03-08 18:46:48 +010081 _HA_ATOMIC_ADD(&nb_applets, 1);
Willy Tarreau8a8d83b2015-04-13 13:24:54 +020082 }
83 return appctx;
84}
85
Willy Tarreau8280ea92019-07-18 10:41:36 +020086/* Releases an appctx previously allocated by appctx_new(). */
Emeric Brunc7306062017-06-26 16:36:53 +020087static inline void __appctx_free(struct appctx *appctx)
Willy Tarreau8a8d83b2015-04-13 13:24:54 +020088{
Olivier Houchard3f795f72019-04-17 22:51:06 +020089 task_destroy(appctx->t);
Christopher Fauleta73e59b2016-12-09 17:30:18 +010090 if (!LIST_ISEMPTY(&appctx->buffer_wait.list)) {
Christopher Faulet2a944ee2017-11-07 10:42:54 +010091 HA_SPIN_LOCK(BUF_WQ_LOCK, &buffer_wq_lock);
Christopher Fauleta73e59b2016-12-09 17:30:18 +010092 LIST_DEL(&appctx->buffer_wait.list);
93 LIST_INIT(&appctx->buffer_wait.list);
Christopher Faulet2a944ee2017-11-07 10:42:54 +010094 HA_SPIN_UNLOCK(BUF_WQ_LOCK, &buffer_wq_lock);
Christopher Fauleta73e59b2016-12-09 17:30:18 +010095 }
Emeric Brun1138fd02017-06-19 12:38:55 +020096
Willy Tarreau8280ea92019-07-18 10:41:36 +020097 pool_free(pool_head_appctx, appctx);
Olivier Houcharda2735342019-03-08 18:46:48 +010098 _HA_ATOMIC_SUB(&nb_applets, 1);
Willy Tarreau8a8d83b2015-04-13 13:24:54 +020099}
Olivier Houchard673867c2018-05-25 16:58:52 +0200100
Emeric Brunc7306062017-06-26 16:36:53 +0200101static inline void appctx_free(struct appctx *appctx)
102{
Olivier Houchard673867c2018-05-25 16:58:52 +0200103 /* The task is supposed to be run on this thread, so we can just
104 * check if it's running already (or about to run) or not
105 */
Willy Tarreaua70bfaa2019-04-17 21:58:23 +0200106 if (!(appctx->t->state & (TASK_QUEUED | TASK_RUNNING)))
Olivier Houchard673867c2018-05-25 16:58:52 +0200107 __appctx_free(appctx);
108 else {
109 /* if it's running, or about to run, defer the freeing
110 * until the callback is called.
111 */
Emeric Brunc7306062017-06-26 16:36:53 +0200112 appctx->state |= APPLET_WANT_DIE;
Olivier Houchard673867c2018-05-25 16:58:52 +0200113 task_wakeup(appctx->t, TASK_WOKEN_OTHER);
Emeric Brunc7306062017-06-26 16:36:53 +0200114 }
Emeric Brunc7306062017-06-26 16:36:53 +0200115}
Willy Tarreau8a8d83b2015-04-13 13:24:54 +0200116
Willy Tarreau81f38d62015-04-13 17:11:11 +0200117/* wakes up an applet when conditions have changed */
Emeric Brunc7306062017-06-26 16:36:53 +0200118static inline void appctx_wakeup(struct appctx *appctx)
Willy Tarreau3c595ac2015-04-19 09:59:31 +0200119{
Olivier Houchard673867c2018-05-25 16:58:52 +0200120 task_wakeup(appctx->t, TASK_WOKEN_OTHER);
Christopher Fauleta73e59b2016-12-09 17:30:18 +0100121}
122
Willy Tarreau8a8d83b2015-04-13 13:24:54 +0200123#endif /* _PROTO_APPLET_H */
124
125/*
126 * Local variables:
127 * c-indent-level: 8
128 * c-basic-offset: 8
129 * End:
130 */