lib/util/server_id.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3    Samba utility functions
   4    Copyright (C) Andrew Bartlett 2011
   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 "librpc/gen_ndr/server_id.h"
  22
  23 bool server_id_same_process(const struct server_id *p1,
  24                             const struct server_id *p2)
  25 {
  26         return ((p1->pid == p2->pid) && (p1->vnn == p2->vnn));
  27 }
  28
  29 bool server_id_equal(const struct server_id *p1, const struct server_id *p2)
  30 {
  31         if (!server_id_same_process(p1, p2)) {
  32                 return false;
  33         }
  34
  35         if (p1->task_id != p2->task_id) {
  36                 return false;
  37         }
  38
  39         if (p1->unique_id != p2->unique_id) {
  40                 return false;
  41         }
  42
  43         return true;
  44 }
  45
  46 char *server_id_str_buf(struct server_id id, struct server_id_buf *dst)
  47 {
  48         if (server_id_is_disconnected(&id)) {
  49                 strlcpy(dst->buf, "disconnected", sizeof(dst->buf));
  50         } else if ((id.vnn == NONCLUSTER_VNN) && (id.task_id == 0)) {
  51                 snprintf(dst->buf, sizeof(dst->buf), "%llu",
  52                          (unsigned long long)id.pid);
  53         } else if (id.vnn == NONCLUSTER_VNN) {
  54                 snprintf(dst->buf, sizeof(dst->buf), "%llu.%u",
  55                          (unsigned long long)id.pid, (unsigned)id.task_id);
  56         } else if (id.task_id == 0) {
  57                 snprintf(dst->buf, sizeof(dst->buf), "%u:%llu",
  58                          (unsigned)id.vnn, (unsigned long long)id.pid);
  59         } else {
  60                 snprintf(dst->buf, sizeof(dst->buf), "%u:%llu.%u",
  61                          (unsigned)id.vnn,
  62                          (unsigned long long)id.pid,
  63                          (unsigned)id.task_id);
  64         }
  65         return dst->buf;
  66 }
  67
  68 struct server_id server_id_from_string(uint32_t local_vnn,
  69                                        const char *pid_string)
  70 {
  71         struct server_id result;
  72         unsigned long long pid;
  73         unsigned int vnn, task_id = 0;
  74
  75         ZERO_STRUCT(result);
  76
  77         /*
  78          * We accept various forms with 1, 2 or 3 component forms
  79          * because the server_id_str_buf() can print different forms, and
  80          * we want backwards compatibility for scripts that may call
  81          * smbclient.
  82          */
  83         if (sscanf(pid_string, "%u:%llu.%u", &vnn, &pid, &task_id) == 3) {
  84                 result.vnn = vnn;
  85                 result.pid = pid;
  86                 result.task_id = task_id;
  87         } else if (sscanf(pid_string, "%u:%llu", &vnn, &pid) == 2) {
  88                 result.vnn = vnn;
  89                 result.pid = pid;
  90         } else if (sscanf(pid_string, "%llu.%u", &pid, &task_id) == 2) {
  91                 result.vnn = local_vnn;
  92                 result.pid = pid;
  93                 result.task_id = task_id;
  94         } else if (sscanf(pid_string, "%llu", &pid) == 1) {
  95                 result.vnn = local_vnn;
  96                 result.pid = pid;
  97         } else if (strcmp(pid_string, "disconnected") ==0) {
  98                 server_id_set_disconnected(&result);
  99         } else {
 100                 result.vnn = NONCLUSTER_VNN;
 101                 result.pid = UINT64_MAX;
 102         }
 103         return result;
 104 }
 105
 106 /**
 107  * Set the serverid to the special value that represents a disconnected
 108  * client for (e.g.) durable handles.
 109  */
 110 void server_id_set_disconnected(struct server_id *id)
 111 {
 112         SMB_ASSERT(id != NULL);
 113
 114         id->pid = UINT64_MAX;
 115         id->task_id = UINT32_MAX;
 116         id->vnn = NONCLUSTER_VNN;
 117         id->unique_id = SERVERID_UNIQUE_ID_NOT_TO_VERIFY;
 118
 119         return;
 120 }
 121
 122 /**
 123  * check whether a serverid is the special placeholder for
 124  * a disconnected client
 125  */
 126 bool server_id_is_disconnected(const struct server_id *id)
 127 {
 128         struct server_id dis;
 129
 130         SMB_ASSERT(id != NULL);
 131
 132         server_id_set_disconnected(&dis);
 133
 134         return server_id_equal(id, &dis);
 135 }
 136
 137 void server_id_put(uint8_t buf[24], const struct server_id id)
 138 {
 139         SBVAL(buf, 0,  id.pid);
 140         SIVAL(buf, 8,  id.task_id);
 141         SIVAL(buf, 12, id.vnn);
 142         SBVAL(buf, 16, id.unique_id);
 143 }
 144
 145 void server_id_get(struct server_id *id, const uint8_t buf[24])
 146 {
 147         id->pid       = BVAL(buf, 0);
 148         id->task_id   = IVAL(buf, 8);
 149         id->vnn       = IVAL(buf, 12);
 150         id->unique_id = BVAL(buf, 16);
 151 }