docs: Fix some typos in the idmap backend section.
[Samba.git] / source3 / lib / smbd_shim.c
blob1b5b4e6ca529fd43ceb6c3f00c75f888411e5fae
1 /*
2 Unix SMB/CIFS implementation.
3 Runtime plugin adapter for various "smbd"-functions.
5 Copyright (C) Gerald (Jerry) Carter 2004.
6 Copyright (C) Andrew Bartlett 2011.
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program. If not, see <http://www.gnu.org/licenses/>.
22 /* Shim functions required due to the horrible dependency mess
23 in Samba. */
25 #include "includes.h"
26 #include "smbd_shim.h"
28 static struct smbd_shim shim;
30 void set_smbd_shim(const struct smbd_shim *shim_functions)
32 shim = *shim_functions;
35 void cancel_pending_lock_requests_by_fid(files_struct *fsp,
36 struct byte_range_lock *br_lck,
37 enum file_close_type close_type)
39 if (shim.cancel_pending_lock_requests_by_fid) {
41 shim.cancel_pending_lock_requests_by_fid(fsp, br_lck, close_type);
45 void send_stat_cache_delete_message(struct messaging_context *msg_ctx,
46 const char *name)
48 if (shim.send_stat_cache_delete_message) {
49 shim.send_stat_cache_delete_message(msg_ctx, name);
53 bool change_to_root_user(void)
55 if (shim.change_to_root_user) {
56 return shim.change_to_root_user();
58 return false;
61 bool become_authenticated_pipe_user(struct auth_session_info *session_info)
63 if (shim.become_authenticated_pipe_user) {
64 return shim.become_authenticated_pipe_user(session_info);
67 return false;
70 bool unbecome_authenticated_pipe_user(void)
72 if (shim.unbecome_authenticated_pipe_user) {
73 return shim.unbecome_authenticated_pipe_user();
76 return false;
79 /**
80 * The following two functions need to be called from inside the low-level BRL
81 * code for oplocks correctness in smbd. Since other utility binaries also
82 * link in some of the brl code directly, these dummy functions are necessary
83 * to avoid needing to link in the oplocks code and its dependencies to all of
84 * the utility binaries.
86 void contend_level2_oplocks_begin(files_struct *fsp,
87 enum level2_contention_type type)
89 if (shim.contend_level2_oplocks_begin) {
90 shim.contend_level2_oplocks_begin(fsp, type);
92 return;
95 void contend_level2_oplocks_end(files_struct *fsp,
96 enum level2_contention_type type)
98 if (shim.contend_level2_oplocks_end) {
99 shim.contend_level2_oplocks_end(fsp, type);
101 return;
104 void become_root(void)
106 if (shim.become_root) {
107 shim.become_root();
109 return;
112 void unbecome_root(void)
114 if (shim.unbecome_root) {
115 shim.unbecome_root();
117 return;
120 void exit_server(const char *reason)
122 if (shim.exit_server) {
123 shim.exit_server(reason);
125 exit(1);
128 void exit_server_cleanly(const char *const reason)
130 if (shim.exit_server_cleanly) {
131 shim.exit_server_cleanly(reason);
133 exit(0);