Mercurial > hg
annotate contrib/chg/hgclient.c @ 28160:098cb7bd46a7
chg: forward umask from client to server
This is necessary to make chg test pass on test-inherit-mode.t.
author | Jun Wu <quark@fb.com> |
---|---|
date | Mon, 15 Feb 2016 14:35:26 +0000 |
parents | 726f8d6cc324 |
children | c6e0c2533e5f |
rev | line source |
---|---|
28060 | 1 /* |
2 * A command server client that uses Unix domain socket | |
3 * | |
4 * Copyright (c) 2011 Yuya Nishihara <yuya@tcha.org> | |
5 * | |
6 * This software may be used and distributed according to the terms of the | |
7 * GNU General Public License version 2 or any later version. | |
8 */ | |
9 | |
10 #include <arpa/inet.h> /* for ntohl(), htonl() */ | |
11 #include <assert.h> | |
12 #include <ctype.h> | |
13 #include <errno.h> | |
14 #include <fcntl.h> | |
15 #include <signal.h> | |
16 #include <stdint.h> | |
17 #include <stdio.h> | |
18 #include <stdlib.h> | |
19 #include <string.h> | |
20 #include <sys/socket.h> | |
21 #include <sys/stat.h> | |
22 #include <sys/un.h> | |
23 #include <unistd.h> | |
24 | |
25 #include "hgclient.h" | |
26 #include "util.h" | |
27 | |
28 enum { | |
29 CAP_GETENCODING = 0x0001, | |
30 CAP_RUNCOMMAND = 0x0002, | |
31 /* cHg extension: */ | |
32 CAP_ATTACHIO = 0x0100, | |
33 CAP_CHDIR = 0x0200, | |
34 CAP_GETPAGER = 0x0400, | |
35 CAP_SETENV = 0x0800, | |
28160
098cb7bd46a7
chg: forward umask from client to server
Jun Wu <quark@fb.com>
parents:
28060
diff
changeset
|
36 CAP_SETUMASK = 0x1000, |
28060 | 37 }; |
38 | |
39 typedef struct { | |
40 const char *name; | |
41 unsigned int flag; | |
42 } cappair_t; | |
43 | |
44 static const cappair_t captable[] = { | |
45 {"getencoding", CAP_GETENCODING}, | |
46 {"runcommand", CAP_RUNCOMMAND}, | |
47 {"attachio", CAP_ATTACHIO}, | |
48 {"chdir", CAP_CHDIR}, | |
49 {"getpager", CAP_GETPAGER}, | |
50 {"setenv", CAP_SETENV}, | |
28160
098cb7bd46a7
chg: forward umask from client to server
Jun Wu <quark@fb.com>
parents:
28060
diff
changeset
|
51 {"setumask", CAP_SETUMASK}, |
28060 | 52 {NULL, 0}, /* terminator */ |
53 }; | |
54 | |
55 typedef struct { | |
56 char ch; | |
57 char *data; | |
58 size_t maxdatasize; | |
59 size_t datasize; | |
60 } context_t; | |
61 | |
62 struct hgclient_tag_ { | |
63 int sockfd; | |
64 pid_t pid; | |
65 context_t ctx; | |
66 unsigned int capflags; | |
67 }; | |
68 | |
69 static const size_t defaultdatasize = 4096; | |
70 | |
71 static void initcontext(context_t *ctx) | |
72 { | |
73 ctx->ch = '\0'; | |
74 ctx->data = malloc(defaultdatasize); | |
75 ctx->maxdatasize = (ctx->data) ? defaultdatasize : 0; | |
76 ctx->datasize = 0; | |
77 debugmsg("initialize context buffer with size %zu", ctx->maxdatasize); | |
78 } | |
79 | |
80 static void enlargecontext(context_t *ctx, size_t newsize) | |
81 { | |
82 if (newsize <= ctx->maxdatasize) | |
83 return; | |
84 | |
85 newsize = defaultdatasize | |
86 * ((newsize + defaultdatasize - 1) / defaultdatasize); | |
87 char *p = realloc(ctx->data, newsize); | |
88 if (!p) | |
89 abortmsg("failed to allocate buffer"); | |
90 ctx->data = p; | |
91 ctx->maxdatasize = newsize; | |
92 debugmsg("enlarge context buffer to %zu", ctx->maxdatasize); | |
93 } | |
94 | |
95 static void freecontext(context_t *ctx) | |
96 { | |
97 debugmsg("free context buffer"); | |
98 free(ctx->data); | |
99 ctx->data = NULL; | |
100 ctx->maxdatasize = 0; | |
101 ctx->datasize = 0; | |
102 } | |
103 | |
104 /* Read channeled response from cmdserver */ | |
105 static void readchannel(hgclient_t *hgc) | |
106 { | |
107 assert(hgc); | |
108 | |
109 ssize_t rsize = recv(hgc->sockfd, &hgc->ctx.ch, sizeof(hgc->ctx.ch), 0); | |
110 if (rsize != sizeof(hgc->ctx.ch)) | |
111 abortmsg("failed to read channel"); | |
112 | |
113 uint32_t datasize_n; | |
114 rsize = recv(hgc->sockfd, &datasize_n, sizeof(datasize_n), 0); | |
115 if (rsize != sizeof(datasize_n)) | |
116 abortmsg("failed to read data size"); | |
117 | |
118 /* datasize denotes the maximum size to write if input request */ | |
119 hgc->ctx.datasize = ntohl(datasize_n); | |
120 enlargecontext(&hgc->ctx, hgc->ctx.datasize); | |
121 | |
122 if (isupper(hgc->ctx.ch) && hgc->ctx.ch != 'S') | |
123 return; /* assumes input request */ | |
124 | |
125 size_t cursize = 0; | |
126 while (cursize < hgc->ctx.datasize) { | |
127 rsize = recv(hgc->sockfd, hgc->ctx.data + cursize, | |
128 hgc->ctx.datasize - cursize, 0); | |
129 if (rsize < 0) | |
130 abortmsg("failed to read data block"); | |
131 cursize += rsize; | |
132 } | |
133 } | |
134 | |
135 static void sendall(int sockfd, const void *data, size_t datasize) | |
136 { | |
137 const char *p = data; | |
138 const char *const endp = p + datasize; | |
139 while (p < endp) { | |
140 ssize_t r = send(sockfd, p, endp - p, 0); | |
141 if (r < 0) | |
142 abortmsg("cannot communicate (errno = %d)", errno); | |
143 p += r; | |
144 } | |
145 } | |
146 | |
147 /* Write lengh-data block to cmdserver */ | |
148 static void writeblock(const hgclient_t *hgc) | |
149 { | |
150 assert(hgc); | |
151 | |
152 const uint32_t datasize_n = htonl(hgc->ctx.datasize); | |
153 sendall(hgc->sockfd, &datasize_n, sizeof(datasize_n)); | |
154 | |
155 sendall(hgc->sockfd, hgc->ctx.data, hgc->ctx.datasize); | |
156 } | |
157 | |
158 static void writeblockrequest(const hgclient_t *hgc, const char *chcmd) | |
159 { | |
160 debugmsg("request %s, block size %zu", chcmd, hgc->ctx.datasize); | |
161 | |
162 char buf[strlen(chcmd) + 1]; | |
163 memcpy(buf, chcmd, sizeof(buf) - 1); | |
164 buf[sizeof(buf) - 1] = '\n'; | |
165 sendall(hgc->sockfd, buf, sizeof(buf)); | |
166 | |
167 writeblock(hgc); | |
168 } | |
169 | |
170 /* Build '\0'-separated list of args. argsize < 0 denotes that args are | |
171 * terminated by NULL. */ | |
172 static void packcmdargs(context_t *ctx, const char *const args[], | |
173 ssize_t argsize) | |
174 { | |
175 ctx->datasize = 0; | |
176 const char *const *const end = (argsize >= 0) ? args + argsize : NULL; | |
177 for (const char *const *it = args; it != end && *it; ++it) { | |
178 const size_t n = strlen(*it) + 1; /* include '\0' */ | |
179 enlargecontext(ctx, ctx->datasize + n); | |
180 memcpy(ctx->data + ctx->datasize, *it, n); | |
181 ctx->datasize += n; | |
182 } | |
183 | |
184 if (ctx->datasize > 0) | |
185 --ctx->datasize; /* strip last '\0' */ | |
186 } | |
187 | |
188 /* Extract '\0'-separated list of args to new buffer, terminated by NULL */ | |
189 static const char **unpackcmdargsnul(const context_t *ctx) | |
190 { | |
191 const char **args = NULL; | |
192 size_t nargs = 0, maxnargs = 0; | |
193 const char *s = ctx->data; | |
194 const char *e = ctx->data + ctx->datasize; | |
195 for (;;) { | |
196 if (nargs + 1 >= maxnargs) { /* including last NULL */ | |
197 maxnargs += 256; | |
198 args = realloc(args, maxnargs * sizeof(args[0])); | |
199 if (!args) | |
200 abortmsg("failed to allocate args buffer"); | |
201 } | |
202 args[nargs] = s; | |
203 nargs++; | |
204 s = memchr(s, '\0', e - s); | |
205 if (!s) | |
206 break; | |
207 s++; | |
208 } | |
209 args[nargs] = NULL; | |
210 return args; | |
211 } | |
212 | |
213 static void handlereadrequest(hgclient_t *hgc) | |
214 { | |
215 context_t *ctx = &hgc->ctx; | |
216 size_t r = fread(ctx->data, sizeof(ctx->data[0]), ctx->datasize, stdin); | |
217 ctx->datasize = r; | |
218 writeblock(hgc); | |
219 } | |
220 | |
221 /* Read single-line */ | |
222 static void handlereadlinerequest(hgclient_t *hgc) | |
223 { | |
224 context_t *ctx = &hgc->ctx; | |
225 if (!fgets(ctx->data, ctx->datasize, stdin)) | |
226 ctx->data[0] = '\0'; | |
227 ctx->datasize = strlen(ctx->data); | |
228 writeblock(hgc); | |
229 } | |
230 | |
231 /* Execute the requested command and write exit code */ | |
232 static void handlesystemrequest(hgclient_t *hgc) | |
233 { | |
234 context_t *ctx = &hgc->ctx; | |
235 enlargecontext(ctx, ctx->datasize + 1); | |
236 ctx->data[ctx->datasize] = '\0'; /* terminate last string */ | |
237 | |
238 const char **args = unpackcmdargsnul(ctx); | |
239 if (!args[0] || !args[1]) | |
240 abortmsg("missing command or cwd in system request"); | |
241 debugmsg("run '%s' at '%s'", args[0], args[1]); | |
242 int32_t r = runshellcmd(args[0], args + 2, args[1]); | |
243 free(args); | |
244 | |
245 uint32_t r_n = htonl(r); | |
246 memcpy(ctx->data, &r_n, sizeof(r_n)); | |
247 ctx->datasize = sizeof(r_n); | |
248 writeblock(hgc); | |
249 } | |
250 | |
251 /* Read response of command execution until receiving 'r'-esult */ | |
252 static void handleresponse(hgclient_t *hgc) | |
253 { | |
254 for (;;) { | |
255 readchannel(hgc); | |
256 context_t *ctx = &hgc->ctx; | |
257 debugmsg("response read from channel %c, size %zu", | |
258 ctx->ch, ctx->datasize); | |
259 switch (ctx->ch) { | |
260 case 'o': | |
261 fwrite(ctx->data, sizeof(ctx->data[0]), ctx->datasize, | |
262 stdout); | |
263 break; | |
264 case 'e': | |
265 fwrite(ctx->data, sizeof(ctx->data[0]), ctx->datasize, | |
266 stderr); | |
267 break; | |
268 case 'd': | |
269 /* assumes last char is '\n' */ | |
270 ctx->data[ctx->datasize - 1] = '\0'; | |
271 debugmsg("server: %s", ctx->data); | |
272 break; | |
273 case 'r': | |
274 return; | |
275 case 'I': | |
276 handlereadrequest(hgc); | |
277 break; | |
278 case 'L': | |
279 handlereadlinerequest(hgc); | |
280 break; | |
281 case 'S': | |
282 handlesystemrequest(hgc); | |
283 break; | |
284 default: | |
285 if (isupper(ctx->ch)) | |
286 abortmsg("cannot handle response (ch = %c)", | |
287 ctx->ch); | |
288 } | |
289 } | |
290 } | |
291 | |
292 static unsigned int parsecapabilities(const char *s, const char *e) | |
293 { | |
294 unsigned int flags = 0; | |
295 while (s < e) { | |
296 const char *t = strchr(s, ' '); | |
297 if (!t || t > e) | |
298 t = e; | |
299 const cappair_t *cap; | |
300 for (cap = captable; cap->flag; ++cap) { | |
301 size_t n = t - s; | |
302 if (strncmp(s, cap->name, n) == 0 && | |
303 strlen(cap->name) == n) { | |
304 flags |= cap->flag; | |
305 break; | |
306 } | |
307 } | |
308 s = t + 1; | |
309 } | |
310 return flags; | |
311 } | |
312 | |
313 static void readhello(hgclient_t *hgc) | |
314 { | |
315 readchannel(hgc); | |
316 context_t *ctx = &hgc->ctx; | |
317 if (ctx->ch != 'o') | |
318 abortmsg("unexpected channel of hello message (ch = %c)", | |
319 ctx->ch); | |
320 enlargecontext(ctx, ctx->datasize + 1); | |
321 ctx->data[ctx->datasize] = '\0'; | |
322 debugmsg("hello received: %s (size = %zu)", ctx->data, ctx->datasize); | |
323 | |
324 const char *s = ctx->data; | |
325 const char *const dataend = ctx->data + ctx->datasize; | |
326 while (s < dataend) { | |
327 const char *t = strchr(s, ':'); | |
328 if (!t || t[1] != ' ') | |
329 break; | |
330 const char *u = strchr(t + 2, '\n'); | |
331 if (!u) | |
332 u = dataend; | |
333 if (strncmp(s, "capabilities:", t - s + 1) == 0) { | |
334 hgc->capflags = parsecapabilities(t + 2, u); | |
335 } else if (strncmp(s, "pid:", t - s + 1) == 0) { | |
336 hgc->pid = strtol(t + 2, NULL, 10); | |
337 } | |
338 s = u + 1; | |
339 } | |
340 debugmsg("capflags=0x%04x, pid=%d", hgc->capflags, hgc->pid); | |
341 } | |
342 | |
343 static void attachio(hgclient_t *hgc) | |
344 { | |
345 debugmsg("request attachio"); | |
346 static const char chcmd[] = "attachio\n"; | |
347 sendall(hgc->sockfd, chcmd, sizeof(chcmd) - 1); | |
348 readchannel(hgc); | |
349 context_t *ctx = &hgc->ctx; | |
350 if (ctx->ch != 'I') | |
351 abortmsg("unexpected response for attachio (ch = %c)", ctx->ch); | |
352 | |
353 static const int fds[3] = {STDIN_FILENO, STDOUT_FILENO, STDERR_FILENO}; | |
354 struct msghdr msgh; | |
355 memset(&msgh, 0, sizeof(msgh)); | |
356 struct iovec iov = {ctx->data, ctx->datasize}; /* dummy payload */ | |
357 msgh.msg_iov = &iov; | |
358 msgh.msg_iovlen = 1; | |
359 char fdbuf[CMSG_SPACE(sizeof(fds))]; | |
360 msgh.msg_control = fdbuf; | |
361 msgh.msg_controllen = sizeof(fdbuf); | |
362 struct cmsghdr *cmsg = CMSG_FIRSTHDR(&msgh); | |
363 cmsg->cmsg_level = SOL_SOCKET; | |
364 cmsg->cmsg_type = SCM_RIGHTS; | |
365 cmsg->cmsg_len = CMSG_LEN(sizeof(fds)); | |
366 memcpy(CMSG_DATA(cmsg), fds, sizeof(fds)); | |
367 msgh.msg_controllen = cmsg->cmsg_len; | |
368 ssize_t r = sendmsg(hgc->sockfd, &msgh, 0); | |
369 if (r < 0) | |
370 abortmsg("sendmsg failed (errno = %d)", errno); | |
371 | |
372 handleresponse(hgc); | |
373 int32_t n; | |
374 if (ctx->datasize != sizeof(n)) | |
375 abortmsg("unexpected size of attachio result"); | |
376 memcpy(&n, ctx->data, sizeof(n)); | |
377 n = ntohl(n); | |
378 if (n != sizeof(fds) / sizeof(fds[0])) | |
379 abortmsg("failed to send fds (n = %d)", n); | |
380 } | |
381 | |
382 static void chdirtocwd(hgclient_t *hgc) | |
383 { | |
384 if (!getcwd(hgc->ctx.data, hgc->ctx.maxdatasize)) | |
385 abortmsg("failed to getcwd (errno = %d)", errno); | |
386 hgc->ctx.datasize = strlen(hgc->ctx.data); | |
387 writeblockrequest(hgc, "chdir"); | |
388 } | |
389 | |
28160
098cb7bd46a7
chg: forward umask from client to server
Jun Wu <quark@fb.com>
parents:
28060
diff
changeset
|
390 static void forwardumask(hgclient_t *hgc) |
098cb7bd46a7
chg: forward umask from client to server
Jun Wu <quark@fb.com>
parents:
28060
diff
changeset
|
391 { |
098cb7bd46a7
chg: forward umask from client to server
Jun Wu <quark@fb.com>
parents:
28060
diff
changeset
|
392 mode_t mask = umask(0); |
098cb7bd46a7
chg: forward umask from client to server
Jun Wu <quark@fb.com>
parents:
28060
diff
changeset
|
393 umask(mask); |
098cb7bd46a7
chg: forward umask from client to server
Jun Wu <quark@fb.com>
parents:
28060
diff
changeset
|
394 |
098cb7bd46a7
chg: forward umask from client to server
Jun Wu <quark@fb.com>
parents:
28060
diff
changeset
|
395 static const char command[] = "setumask\n"; |
098cb7bd46a7
chg: forward umask from client to server
Jun Wu <quark@fb.com>
parents:
28060
diff
changeset
|
396 sendall(hgc->sockfd, command, sizeof(command) - 1); |
098cb7bd46a7
chg: forward umask from client to server
Jun Wu <quark@fb.com>
parents:
28060
diff
changeset
|
397 uint32_t data = htonl(mask); |
098cb7bd46a7
chg: forward umask from client to server
Jun Wu <quark@fb.com>
parents:
28060
diff
changeset
|
398 sendall(hgc->sockfd, &data, sizeof(data)); |
098cb7bd46a7
chg: forward umask from client to server
Jun Wu <quark@fb.com>
parents:
28060
diff
changeset
|
399 } |
098cb7bd46a7
chg: forward umask from client to server
Jun Wu <quark@fb.com>
parents:
28060
diff
changeset
|
400 |
28060 | 401 /*! |
402 * Open connection to per-user cmdserver | |
403 * | |
404 * If no background server running, returns NULL. | |
405 */ | |
406 hgclient_t *hgc_open(const char *sockname) | |
407 { | |
408 int fd = socket(AF_UNIX, SOCK_STREAM, 0); | |
409 if (fd < 0) | |
410 abortmsg("cannot create socket (errno = %d)", errno); | |
411 | |
412 /* don't keep fd on fork(), so that it can be closed when the parent | |
413 * process get terminated. */ | |
414 int flags = fcntl(fd, F_GETFD); | |
415 if (flags < 0) | |
416 abortmsg("cannot get flags of socket (errno = %d)", errno); | |
417 if (fcntl(fd, F_SETFD, flags | FD_CLOEXEC) < 0) | |
418 abortmsg("cannot set flags of socket (errno = %d)", errno); | |
419 | |
420 struct sockaddr_un addr; | |
421 addr.sun_family = AF_UNIX; | |
422 strncpy(addr.sun_path, sockname, sizeof(addr.sun_path)); | |
423 addr.sun_path[sizeof(addr.sun_path) - 1] = '\0'; | |
424 | |
425 debugmsg("connect to %s", addr.sun_path); | |
426 int r = connect(fd, (struct sockaddr *)&addr, sizeof(addr)); | |
427 if (r < 0) { | |
428 close(fd); | |
429 if (errno == ENOENT || errno == ECONNREFUSED) | |
430 return NULL; | |
431 abortmsg("cannot connect to %s (errno = %d)", | |
432 addr.sun_path, errno); | |
433 } | |
434 | |
435 hgclient_t *hgc = malloc(sizeof(hgclient_t)); | |
436 if (!hgc) | |
437 abortmsg("failed to allocate hgclient object"); | |
438 memset(hgc, 0, sizeof(*hgc)); | |
439 hgc->sockfd = fd; | |
440 initcontext(&hgc->ctx); | |
441 | |
442 readhello(hgc); | |
443 if (!(hgc->capflags & CAP_RUNCOMMAND)) | |
444 abortmsg("insufficient capability: runcommand"); | |
445 if (hgc->capflags & CAP_ATTACHIO) | |
446 attachio(hgc); | |
447 if (hgc->capflags & CAP_CHDIR) | |
448 chdirtocwd(hgc); | |
28160
098cb7bd46a7
chg: forward umask from client to server
Jun Wu <quark@fb.com>
parents:
28060
diff
changeset
|
449 if (hgc->capflags & CAP_SETUMASK) |
098cb7bd46a7
chg: forward umask from client to server
Jun Wu <quark@fb.com>
parents:
28060
diff
changeset
|
450 forwardumask(hgc); |
28060 | 451 |
452 return hgc; | |
453 } | |
454 | |
455 /*! | |
456 * Close connection and free allocated memory | |
457 */ | |
458 void hgc_close(hgclient_t *hgc) | |
459 { | |
460 assert(hgc); | |
461 freecontext(&hgc->ctx); | |
462 close(hgc->sockfd); | |
463 free(hgc); | |
464 } | |
465 | |
466 pid_t hgc_peerpid(const hgclient_t *hgc) | |
467 { | |
468 assert(hgc); | |
469 return hgc->pid; | |
470 } | |
471 | |
472 /*! | |
473 * Execute the specified Mercurial command | |
474 * | |
475 * @return result code | |
476 */ | |
477 int hgc_runcommand(hgclient_t *hgc, const char *const args[], size_t argsize) | |
478 { | |
479 assert(hgc); | |
480 | |
481 packcmdargs(&hgc->ctx, args, argsize); | |
482 writeblockrequest(hgc, "runcommand"); | |
483 handleresponse(hgc); | |
484 | |
485 int32_t exitcode_n; | |
486 if (hgc->ctx.datasize != sizeof(exitcode_n)) { | |
487 abortmsg("unexpected size of exitcode"); | |
488 } | |
489 memcpy(&exitcode_n, hgc->ctx.data, sizeof(exitcode_n)); | |
490 return ntohl(exitcode_n); | |
491 } | |
492 | |
493 /*! | |
494 * (Re-)send client's stdio channels so that the server can access to tty | |
495 */ | |
496 void hgc_attachio(hgclient_t *hgc) | |
497 { | |
498 assert(hgc); | |
499 if (!(hgc->capflags & CAP_ATTACHIO)) | |
500 return; | |
501 attachio(hgc); | |
502 } | |
503 | |
504 /*! | |
505 * Get pager command for the given Mercurial command args | |
506 * | |
507 * If no pager enabled, returns NULL. The return value becomes invalid | |
508 * once you run another request to hgc. | |
509 */ | |
510 const char *hgc_getpager(hgclient_t *hgc, const char *const args[], | |
511 size_t argsize) | |
512 { | |
513 assert(hgc); | |
514 | |
515 if (!(hgc->capflags & CAP_GETPAGER)) | |
516 return NULL; | |
517 | |
518 packcmdargs(&hgc->ctx, args, argsize); | |
519 writeblockrequest(hgc, "getpager"); | |
520 handleresponse(hgc); | |
521 | |
522 if (hgc->ctx.datasize < 1 || hgc->ctx.data[0] == '\0') | |
523 return NULL; | |
524 enlargecontext(&hgc->ctx, hgc->ctx.datasize + 1); | |
525 hgc->ctx.data[hgc->ctx.datasize] = '\0'; | |
526 return hgc->ctx.data; | |
527 } | |
528 | |
529 /*! | |
530 * Update server's environment variables | |
531 * | |
532 * @param envp list of environment variables in "NAME=VALUE" format, | |
533 * terminated by NULL. | |
534 */ | |
535 void hgc_setenv(hgclient_t *hgc, const char *const envp[]) | |
536 { | |
537 assert(hgc && envp); | |
538 if (!(hgc->capflags & CAP_SETENV)) | |
539 return; | |
540 packcmdargs(&hgc->ctx, envp, /*argsize*/ -1); | |
541 writeblockrequest(hgc, "setenv"); | |
542 } |