source3/lib/serverid.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3    Implementation of a reliable server_exists()
   4    Copyright (C) Volker Lendecke 2010
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 3 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #include "includes.h"
  21 #include "serverid.h"
  22
  23 struct serverid_key {
  24         pid_t pid;
  25 #ifdef CLUSTER_SUPPORT
  26         uint32_t vnn;
  27 #endif
  28 };
  29
  30 bool serverid_parent_init(void)
  31 {
  32         struct tdb_wrap *db;
  33
  34         /*
  35          * Open the tdb in the parent process (smbd) so that our
  36          * CLEAR_IF_FIRST optimization in tdb_reopen_all can properly
  37          * work.
  38          */
  39
  40         db = tdb_wrap_open(talloc_autofree_context(),
  41                            lock_path("serverid.tdb"),
  42                            0, TDB_DEFAULT|TDB_CLEAR_IF_FIRST, O_RDWR|O_CREAT,
  43                            0644);
  44         if (db == NULL) {
  45                 DEBUG(1, ("could not open serverid.tdb: %s\n",
  46                           strerror(errno)));
  47                 return false;
  48         }
  49         return true;
  50 }
  51
  52 struct serverid_data {
  53         uint64_t unique_id;
  54         uint32_t msg_flags;
  55 };
  56
  57 static struct db_context *serverid_db(void)
  58 {
  59         static struct db_context *db;
  60
  61         if (db != NULL) {
  62                 return db;
  63         }
  64         db = db_open(talloc_autofree_context(), lock_path("serverid.tdb"),
  65                      0, TDB_DEFAULT|TDB_CLEAR_IF_FIRST, O_RDWR|O_CREAT, 0644);
  66         return db;
  67 }
  68
  69 static void serverid_fill_key(const struct server_id *id,
  70                               struct serverid_key *key)
  71 {
  72         ZERO_STRUCTP(key);
  73         key->pid = id->pid;
  74 #ifdef CLUSTER_SUPPORT
  75         key->vnn = id->vnn;
  76 #endif
  77 }
  78
  79 bool serverid_register(const struct server_id id, uint32_t msg_flags)
  80 {
  81         struct db_context *db;
  82         struct serverid_key key;
  83         struct serverid_data data;
  84         struct db_record *rec;
  85         TDB_DATA tdbkey, tdbdata;
  86         NTSTATUS status;
  87         bool ret = false;
  88
  89         db = serverid_db();
  90         if (db == NULL) {
  91                 return false;
  92         }
  93
  94         serverid_fill_key(&id, &key);
  95         tdbkey = make_tdb_data((uint8_t *)&key, sizeof(key));
  96
  97         rec = db->fetch_locked(db, talloc_tos(), tdbkey);
  98         if (rec == NULL) {
  99                 DEBUG(1, ("Could not fetch_lock serverid.tdb record\n"));
 100                 return false;
 101         }
 102
 103         ZERO_STRUCT(data);
 104         data.unique_id = id.unique_id;
 105         data.msg_flags = msg_flags;
 106
 107         tdbdata = make_tdb_data((uint8_t *)&data, sizeof(data));
 108         status = rec->store(rec, tdbdata, 0);
 109         if (!NT_STATUS_IS_OK(status)) {
 110                 DEBUG(1, ("Storing serverid.tdb record failed: %s\n",
 111                           nt_errstr(status)));
 112                 goto done;
 113         }
 114         ret = true;
 115 done:
 116         TALLOC_FREE(rec);
 117         return ret;
 118 }
 119
 120 bool serverid_register_msg_flags(const struct server_id id, bool do_reg,
 121                                  uint32_t msg_flags)
 122 {
 123         struct db_context *db;
 124         struct serverid_key key;
 125         struct serverid_data *data;
 126         struct db_record *rec;
 127         TDB_DATA tdbkey, tdbdata;
 128         NTSTATUS status;
 129         bool ret = false;
 130
 131         db = serverid_db();
 132         if (db == NULL) {
 133                 return false;
 134         }
 135
 136         serverid_fill_key(&id, &key);
 137         tdbkey = make_tdb_data((uint8_t *)&key, sizeof(key));
 138
 139         rec = db->fetch_locked(db, talloc_tos(), tdbkey);
 140         if (rec == NULL) {
 141                 DEBUG(1, ("Could not fetch_lock serverid.tdb record\n"));
 142                 return false;
 143         }
 144
 145         if (rec->value.dsize != sizeof(struct serverid_data)) {
 146                 DEBUG(1, ("serverid record has unexpected size %d "
 147                           "(wanted %d)\n", (int)rec->value.dsize,
 148                           sizeof(struct serverid_data)));
 149                 goto done;
 150         }
 151
 152         data = (struct serverid_data *)rec->value.dptr;
 153
 154         if (do_reg) {
 155                 data->msg_flags |= msg_flags;
 156         } else {
 157                 data->msg_flags &= ~msg_flags;
 158         }
 159
 160         status = rec->store(rec, tdbdata, 0);
 161         if (!NT_STATUS_IS_OK(status)) {
 162                 DEBUG(1, ("Storing serverid.tdb record failed: %s\n",
 163                           nt_errstr(status)));
 164                 goto done;
 165         }
 166         ret = true;
 167 done:
 168         TALLOC_FREE(rec);
 169         return ret;
 170 }
 171
 172 bool serverid_deregister(struct server_id id)
 173 {
 174         struct db_context *db;
 175         struct serverid_key key;
 176         struct db_record *rec;
 177         TDB_DATA tdbkey;
 178         NTSTATUS status;
 179         bool ret = false;
 180
 181         db = serverid_db();
 182         if (db == NULL) {
 183                 return false;
 184         }
 185
 186         serverid_fill_key(&id, &key);
 187         tdbkey = make_tdb_data((uint8_t *)&key, sizeof(key));
 188
 189         rec = db->fetch_locked(db, talloc_tos(), tdbkey);
 190         if (rec == NULL) {
 191                 DEBUG(1, ("Could not fetch_lock serverid.tdb record\n"));
 192                 return false;
 193         }
 194
 195         status = rec->delete_rec(rec);
 196         if (!NT_STATUS_IS_OK(status)) {
 197                 DEBUG(1, ("Deleting serverid.tdb record failed: %s\n",
 198                           nt_errstr(status)));
 199                 goto done;
 200         }
 201         ret = true;
 202 done:
 203         TALLOC_FREE(rec);
 204         return ret;
 205 }
 206
 207 struct serverid_exists_state {
 208         const struct server_id *id;
 209         bool exists;
 210 };
 211
 212 static int server_exists_parse(TDB_DATA key, TDB_DATA data, void *priv)
 213 {
 214         struct serverid_exists_state *state =
 215                 (struct serverid_exists_state *)priv;
 216         uint64_t unique_id;
 217
 218         if (data.dsize != sizeof(struct serverid_data)) {
 219                 return -1;
 220         }
 221
 222         /*
 223          * Use memcmp, not direct compare. data.dptr might not be
 224          * aligned.
 225          */
 226         state->exists = (memcmp(&state->id->unique_id, data.dptr,
 227                                 sizeof(unique_id)) == 0);
 228         return 0;
 229 }
 230
 231 bool serverid_exists(const struct server_id *id)
 232 {
 233         struct db_context *db;
 234         struct serverid_exists_state state;
 235         struct serverid_key key;
 236         TDB_DATA tdbkey;
 237
 238         db = serverid_db();
 239         if (db == NULL) {
 240                 return false;
 241         }
 242
 243         serverid_fill_key(id, &key);
 244         tdbkey = make_tdb_data((uint8_t *)&key, sizeof(key));
 245
 246         state.id = id;
 247         state.exists = false;
 248
 249         if (db->parse_record(db, tdbkey, server_exists_parse, &state) == -1) {
 250                 return false;
 251         }
 252         return state.exists;
 253 }
 254
 255 static bool serverid_rec_parse(const struct db_record *rec,
 256                                struct server_id *id, uint32_t *msg_flags)
 257 {
 258         struct serverid_key key;
 259         struct serverid_data data;
 260
 261         if (rec->key.dsize != sizeof(key)) {
 262                 DEBUG(1, ("Found invalid key length %d in serverid.tdb\n",
 263                           (int)rec->key.dsize));
 264                 return false;
 265         }
 266         if (rec->value.dsize != sizeof(data)) {
 267                 DEBUG(1, ("Found invalid value length %d in serverid.tdb\n",
 268                           (int)rec->value.dsize));
 269                 return false;
 270         }
 271
 272         memcpy(&key, rec->key.dptr, sizeof(key));
 273         memcpy(&data, rec->value.dptr, sizeof(data));
 274
 275         id->pid = key.pid;
 276 #ifdef CLUSTER_SUPPORT
 277         id->vnn = key.vnn;
 278 #endif
 279         id->unique_id = data.unique_id;
 280         *msg_flags = data.msg_flags;
 281         return true;
 282 }
 283
 284 struct serverid_traverse_read_state {
 285         int (*fn)(const struct server_id *id, uint32_t msg_flags,
 286                   void *private_data);
 287         void *private_data;
 288 };
 289
 290 static int serverid_traverse_read_fn(struct db_record *rec, void *private_data)
 291 {
 292         struct serverid_traverse_read_state *state =
 293                 (struct serverid_traverse_read_state *)private_data;
 294         struct server_id id;
 295         uint32_t msg_flags;
 296
 297         if (!serverid_rec_parse(rec, &id, &msg_flags)) {
 298                 return 0;
 299         }
 300         return state->fn(&id, msg_flags,state->private_data);
 301 }
 302
 303 bool serverid_traverse_read(int (*fn)(const struct server_id *id,
 304                                       uint32_t msg_flags, void *private_data),
 305                             void *private_data)
 306 {
 307         struct db_context *db;
 308         struct serverid_traverse_read_state state;
 309
 310         db = serverid_db();
 311         if (db == NULL) {
 312                 return false;
 313         }
 314         state.fn = fn;
 315         state.private_data = private_data;
 316         return db->traverse_read(db, serverid_traverse_read_fn, &state);
 317 }
 318
 319 struct serverid_traverse_state {
 320         int (*fn)(struct db_record *rec, const struct server_id *id,
 321                   uint32_t msg_flags, void *private_data);
 322         void *private_data;
 323 };
 324
 325 static int serverid_traverse_fn(struct db_record *rec, void *private_data)
 326 {
 327         struct serverid_traverse_state *state =
 328                 (struct serverid_traverse_state *)private_data;
 329         struct server_id id;
 330         uint32_t msg_flags;
 331
 332         if (!serverid_rec_parse(rec, &id, &msg_flags)) {
 333                 return 0;
 334         }
 335         return state->fn(rec, &id, msg_flags, state->private_data);
 336 }
 337
 338 bool serverid_traverse(int (*fn)(struct db_record *rec,
 339                                  const struct server_id *id,
 340                                  uint32_t msg_flags, void *private_data),
 341                             void *private_data)
 342 {
 343         struct db_context *db;
 344         struct serverid_traverse_state state;
 345
 346         db = serverid_db();
 347         if (db == NULL) {
 348                 return false;
 349         }
 350         state.fn = fn;
 351         state.private_data = private_data;
 352         return db->traverse(db, serverid_traverse_fn, &state);
 353 }