messaging3: Introduce messaging_local_backend()
[samba.git] / source3 / include / messages.h
1 /* 
2    Unix SMB/CIFS implementation.
3    messages.c header
4    Copyright (C) Andrew Tridgell 2000
5    Copyright (C) 2001, 2002 by Martin Pool
6
7    This program is free software; you can redistribute it and/or modify
8    it under the terms of the GNU General Public License as published by
9    the Free Software Foundation; either version 3 of the License, or
10    (at your option) any later version.
11
12    This program 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
15    GNU General Public License for more details.
16
17    You should have received a copy of the GNU General Public License
18    along with this program.  If not, see <http://www.gnu.org/licenses/>.
19 */
20
21 #ifndef _MESSAGES_H_
22 #define _MESSAGES_H_
23
24 /* change the message version with any incompatible changes in the protocol */
25 #define MESSAGE_VERSION 2
26
27 /*
28  * Special flags passed to message_send. Allocated from the top, lets see when
29  * it collides with the message types in the lower 16 bits :-)
30  */
31
32 /*
33  * Under high load, this message can be dropped. Use for notify-style
34  * messages that are not critical for correct operation.
35  */
36 #define MSG_FLAG_LOWPRIORITY            0x80000000
37
38
39 /* Flags to classify messages - used in message_send_all() */
40 /* Sender will filter by flag. */
41
42 #define FLAG_MSG_GENERAL                0x0001
43 #define FLAG_MSG_SMBD                   0x0002
44 #define FLAG_MSG_NMBD                   0x0004
45 #define FLAG_MSG_WINBIND                0x0008
46 #define FLAG_MSG_PRINT_GENERAL          0x0010
47 /* dbwrap messages 4001-4999 */
48 #define FLAG_MSG_DBWRAP                 0x0020
49
50 /*
51  * ctdb gives us 64-bit server ids for messaging_send. This is done to avoid
52  * pid clashes and to be able to register for special messages like "all
53  * smbds".
54  *
55  * Normal individual server id's have the upper 32 bits to 0, I picked "1" for
56  * Samba, other subsystems might use something else.
57  */
58
59 #define MSG_SRVID_SAMBA 0x0000000100000000LL
60
61 #include "librpc/gen_ndr/server_id.h"
62
63 #define MSG_BROADCAST_PID_STR   "0:0"
64
65 struct messaging_context;
66 struct messaging_rec;
67
68 /*
69  * struct messaging_context belongs to messages.c, but because we still have
70  * messaging_dispatch, we need it here. Once we get rid of signals for
71  * notifying processes, this will go.
72  */
73
74 struct messaging_context {
75         struct server_id id;
76         struct tevent_context *event_ctx;
77         struct messaging_callback *callbacks;
78
79         struct tevent_req **new_waiters;
80         unsigned num_new_waiters;
81
82         struct tevent_req **waiters;
83         unsigned num_waiters;
84
85         struct messaging_backend *local;
86         struct messaging_backend *remote;
87 };
88
89 struct messaging_backend {
90         NTSTATUS (*send_fn)(struct server_id src,
91                             struct server_id pid, int msg_type,
92                             const struct iovec *iov, int iovlen,
93                             struct messaging_backend *backend);
94         void *private_data;
95 };
96
97 NTSTATUS messaging_dgm_init(struct messaging_context *msg_ctx,
98                             TALLOC_CTX *mem_ctx,
99                             struct messaging_backend **presult);
100 NTSTATUS messaging_dgm_cleanup(struct messaging_context *msg_ctx, pid_t pid);
101 NTSTATUS messaging_dgm_wipe(struct messaging_context *msg_ctx);
102 void *messaging_dgm_register_tevent_context(TALLOC_CTX *mem_ctx,
103                                             struct messaging_context *msg_ctx,
104                                             struct tevent_context *ev);
105
106 NTSTATUS messaging_ctdbd_init(struct messaging_context *msg_ctx,
107                               TALLOC_CTX *mem_ctx,
108                               struct messaging_backend **presult);
109 struct ctdbd_connection *messaging_ctdbd_connection(void);
110
111 bool message_send_all(struct messaging_context *msg_ctx,
112                       int msg_type,
113                       const void *buf, size_t len,
114                       int *n_sent);
115 struct messaging_context *messaging_init(TALLOC_CTX *mem_ctx, 
116                                          struct tevent_context *ev);
117
118 struct server_id messaging_server_id(const struct messaging_context *msg_ctx);
119 struct messaging_backend *messaging_local_backend(
120         struct messaging_context *msg_ctx);
121
122 /*
123  * re-init after a fork
124  */
125 NTSTATUS messaging_reinit(struct messaging_context *msg_ctx);
126
127 NTSTATUS messaging_register(struct messaging_context *msg_ctx,
128                             void *private_data,
129                             uint32_t msg_type,
130                             void (*fn)(struct messaging_context *msg,
131                                        void *private_data, 
132                                        uint32_t msg_type, 
133                                        struct server_id server_id,
134                                        DATA_BLOB *data));
135 void messaging_deregister(struct messaging_context *ctx, uint32_t msg_type,
136                           void *private_data);
137 NTSTATUS messaging_send(struct messaging_context *msg_ctx,
138                         struct server_id server, 
139                         uint32_t msg_type, const DATA_BLOB *data);
140
141 NTSTATUS messaging_send_buf(struct messaging_context *msg_ctx,
142                             struct server_id server, uint32_t msg_type,
143                             const uint8_t *buf, size_t len);
144 NTSTATUS messaging_send_iov(struct messaging_context *msg_ctx,
145                             struct server_id server, uint32_t msg_type,
146                             const struct iovec *iov, int iovlen);
147 void messaging_dispatch_rec(struct messaging_context *msg_ctx,
148                             struct messaging_rec *rec);
149
150 struct tevent_req *messaging_filtered_read_send(
151         TALLOC_CTX *mem_ctx, struct tevent_context *ev,
152         struct messaging_context *msg_ctx,
153         bool (*filter)(struct messaging_rec *rec, void *private_data),
154         void *private_data);
155 int messaging_filtered_read_recv(struct tevent_req *req, TALLOC_CTX *mem_ctx,
156                                  struct messaging_rec **presult);
157
158 struct tevent_req *messaging_read_send(TALLOC_CTX *mem_ctx,
159                                        struct tevent_context *ev,
160                                        struct messaging_context *msg,
161                                        uint32_t msg_type);
162 int messaging_read_recv(struct tevent_req *req, TALLOC_CTX *mem_ctx,
163                         struct messaging_rec **presult);
164
165 bool messaging_parent_dgm_cleanup_init(struct messaging_context *msg);
166
167 #include "librpc/gen_ndr/ndr_messaging.h"
168
169 #endif