1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689
|
/*
* Copyright (c) 2010 Mark Williams
*
* File change event API for netatalk
*
* for every detected filesystem change a UDP packet is sent to an arbitrary list
* of listeners. Each packet contains unix path of modified filesystem element,
* event reason, and a consecutive event id (32 bit). Technically we are UDP client and are sending
* out packets synchronuosly as they are created by the afp functions. This should not affect
* performance measurably. The only delaying calls occur during initialization, if we have to
* resolve non-IP hostnames to IP. All numeric data inside the packet is network byte order, so use
* ntohs / ntohl to resolve length and event id. Ideally a listener receives every packet with
* no gaps in event ids, starting with event id 1 and mode FCE_CONN_START followed by
* data events from id 2 up to 0xFFFFFFFF, followed by 0 to 0xFFFFFFFF and so on.
*
* A gap or not starting with 1 mode FCE_CONN_START or receiving mode FCE_CONN_BROKEN means that
* the listener has lost at least one filesystem event
*
* All Rights Reserved. See COPYRIGHT.
*/
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif /* HAVE_CONFIG_H */
#include <stdio.h>
#include <string.h>
#include <stdlib.h>
#include <errno.h>
#include <time.h>
#include <sys/param.h>
#include <sys/socket.h>
#include <netinet/in.h>
#include <arpa/inet.h>
#include <netdb.h>
#include <netatalk/at.h>
#include <atalk/adouble.h>
#include <atalk/vfs.h>
#include <atalk/logger.h>
#include <atalk/afp.h>
#include <atalk/util.h>
#include <atalk/cnid.h>
#include <atalk/unix.h>
#include <atalk/fce_api.h>
#include <atalk/globals.h>
#include "fork.h"
#include "file.h"
#include "directory.h"
#include "desktop.h"
#include "volume.h"
// ONLY USED IN THIS FILE
#include "fce_api_internal.h"
#define FCE_TRUE 1
#define FCE_FALSE 0
/* We store our connection data here */
static struct udp_entry udp_socket_list[FCE_MAX_UDP_SOCKS];
static int udp_sockets = 0;
static int udp_initialized = FCE_FALSE;
static unsigned long fce_ev_enabled =
(1 << FCE_FILE_MODIFY) |
(1 << FCE_FILE_DELETE) |
(1 << FCE_DIR_DELETE) |
(1 << FCE_FILE_CREATE) |
(1 << FCE_DIR_CREATE);
static uint64_t tm_used; /* used for passing to event handler */
#define MAXIOBUF 1024
static char iobuf[MAXIOBUF];
static const char *skip_files[] =
{
".DS_Store",
NULL
};
static struct fce_close_event last_close_event;
/*
*
* Initialize network structs for any listeners
* We dont give return code because all errors are handled internally (I hope..)
*
* */
void fce_init_udp()
{
int rv;
struct addrinfo hints, *servinfo, *p;
if (udp_initialized == FCE_TRUE)
return;
memset(&hints, 0, sizeof hints);
hints.ai_family = AF_UNSPEC;
hints.ai_socktype = SOCK_DGRAM;
for (int i = 0; i < udp_sockets; i++) {
struct udp_entry *udp_entry = udp_socket_list + i;
/* Close any pending sockets */
if (udp_entry->sock != -1)
close(udp_entry->sock);
if ((rv = getaddrinfo(udp_entry->addr, udp_entry->port, &hints, &servinfo)) != 0) {
LOG(log_error, logtype_afpd, "fce_init_udp: getaddrinfo(%s:%s): %s",
udp_entry->addr, udp_entry->port, gai_strerror(rv));
continue;
}
/* loop through all the results and make a socket */
for (p = servinfo; p != NULL; p = p->ai_next) {
if ((udp_entry->sock = socket(p->ai_family, p->ai_socktype, p->ai_protocol)) == -1) {
LOG(log_error, logtype_afpd, "fce_init_udp: socket(%s:%s): %s",
udp_entry->addr, udp_entry->port, strerror(errno));
continue;
}
break;
}
if (p == NULL) {
LOG(log_error, logtype_afpd, "fce_init_udp: no socket for %s:%s",
udp_entry->addr, udp_entry->port);
}
udp_entry->addrinfo = *p;
memcpy(&udp_entry->addrinfo, p, sizeof(struct addrinfo));
memcpy(&udp_entry->sockaddr, p->ai_addr, sizeof(struct sockaddr_storage));
freeaddrinfo(servinfo);
}
udp_initialized = FCE_TRUE;
}
void fce_cleanup()
{
if (udp_initialized == FCE_FALSE )
return;
for (int i = 0; i < udp_sockets; i++)
{
struct udp_entry *udp_entry = udp_socket_list + i;
/* Close any pending sockets */
if (udp_entry->sock != -1)
{
close( udp_entry->sock );
udp_entry->sock = -1;
}
}
udp_initialized = FCE_FALSE;
}
/*
* Construct a UDP packet for our listeners and return packet size
* */
static ssize_t build_fce_packet( struct fce_packet *packet, char *path, int mode, uint32_t event_id )
{
size_t pathlen = 0;
ssize_t data_len = 0;
uint64_t *t;
/* Set content of packet */
memcpy(packet->magic, FCE_PACKET_MAGIC, sizeof(packet->magic) );
packet->version = FCE_PACKET_VERSION;
packet->mode = mode;
packet->event_id = event_id;
pathlen = strlen(path); /* exclude string terminator */
/* This should never happen, but before we bust this server, we send nonsense, fce listener has to cope */
if (pathlen >= MAXPATHLEN)
pathlen = MAXPATHLEN - 1;
packet->datalen = pathlen;
/* This is the payload len. Means: the packet has len bytes more until packet is finished */
data_len = FCE_PACKET_HEADER_SIZE + pathlen;
switch (mode) {
case FCE_TM_SIZE:
t = (uint64_t *)packet->data;
*t = hton64(tm_used);
memcpy(packet->data + sizeof(tm_used), path, pathlen);
packet->datalen = pathlen + sizeof(tm_used);
data_len += sizeof(tm_used);
break;
default:
memcpy(packet->data, path, pathlen);
break;
}
/* return the packet len */
return data_len;
}
/*
* Handle Endianess and write into buffer w/o padding
**/
static void pack_fce_packet(struct fce_packet *packet, unsigned char *buf, int maxlen)
{
unsigned char *p = buf;
memcpy(p, &packet->magic[0], sizeof(packet->magic));
p += sizeof(packet->magic);
*p = packet->version;
p++;
*p = packet->mode;
p++;
uint32_t *id = (uint32_t*)p;
*id = htonl(packet->event_id);
p += sizeof(packet->event_id);
uint16_t *l = ( uint16_t *)p;
*l = htons(packet->datalen);
p += sizeof(packet->datalen);
if (((p - buf) + packet->datalen) < maxlen) {
memcpy(p, &packet->data[0], packet->datalen);
}
}
/*
* Send the fce information to all (connected) listeners
* We dont give return code because all errors are handled internally (I hope..)
* */
static void send_fce_event( char *path, int mode )
{
static int first_event = FCE_TRUE;
struct fce_packet packet;
void *data = &packet;
static uint32_t event_id = 0; /* the unique packet couter to detect packet/data loss. Going from 0xFFFFFFFF to 0x0 is a valid increment */
time_t now = time(NULL);
LOG(log_debug, logtype_afpd, "send_fce_event: start");
/* initialized ? */
if (first_event == FCE_TRUE) {
first_event = FCE_FALSE;
fce_init_udp();
/* Notify listeners the we start from the beginning */
send_fce_event( "", FCE_CONN_START );
}
/* build our data packet */
ssize_t data_len = build_fce_packet( &packet, path, mode, ++event_id );
pack_fce_packet(&packet, iobuf, MAXIOBUF);
for (int i = 0; i < udp_sockets; i++)
{
int sent_data = 0;
struct udp_entry *udp_entry = udp_socket_list + i;
/* we had a problem earlier ? */
if (udp_entry->sock == -1)
{
/* We still have to wait ?*/
if (now < udp_entry->next_try_on_error)
continue;
/* Reopen socket */
udp_entry->sock = socket(udp_entry->addrinfo.ai_family,
udp_entry->addrinfo.ai_socktype,
udp_entry->addrinfo.ai_protocol);
if (udp_entry->sock == -1) {
/* failed again, so go to rest again */
LOG(log_error, logtype_afpd, "Cannot recreate socket for fce UDP connection: errno %d", errno );
udp_entry->next_try_on_error = now + FCE_SOCKET_RETRY_DELAY_S;
continue;
}
udp_entry->next_try_on_error = 0;
/* Okay, we have a running socket again, send server that we had a problem on our side*/
data_len = build_fce_packet( &packet, "", FCE_CONN_BROKEN, 0 );
pack_fce_packet(&packet, iobuf, MAXIOBUF);
sendto(udp_entry->sock,
iobuf,
data_len,
0,
(struct sockaddr *)&udp_entry->sockaddr,
udp_entry->addrinfo.ai_addrlen);
/* Rebuild our original data packet */
data_len = build_fce_packet( &packet, path, mode, event_id );
pack_fce_packet(&packet, iobuf, MAXIOBUF);
}
sent_data = sendto(udp_entry->sock,
iobuf,
data_len,
0,
(struct sockaddr *)&udp_entry->sockaddr,
udp_entry->addrinfo.ai_addrlen);
/* Problems ? */
if (sent_data != data_len) {
/* Argh, socket broke, we close and retry later */
LOG(log_error, logtype_afpd, "send_fce_event: error sending packet to %s:%s, transfered %d of %d: %s",
udp_entry->addr, udp_entry->port, sent_data, data_len, strerror(errno));
close( udp_entry->sock );
udp_entry->sock = -1;
udp_entry->next_try_on_error = now + FCE_SOCKET_RETRY_DELAY_S;
}
}
}
static int add_udp_socket(const char *target_ip, const char *target_port )
{
if (target_port == NULL)
target_port = FCE_DEFAULT_PORT_STRING;
if (udp_sockets >= FCE_MAX_UDP_SOCKS) {
LOG(log_error, logtype_afpd, "Too many file change api UDP connections (max %d allowed)", FCE_MAX_UDP_SOCKS );
return AFPERR_PARAM;
}
udp_socket_list[udp_sockets].addr = strdup(target_ip);
udp_socket_list[udp_sockets].port = strdup(target_port);
udp_socket_list[udp_sockets].sock = -1;
memset(&udp_socket_list[udp_sockets].addrinfo, 0, sizeof(struct addrinfo));
memset(&udp_socket_list[udp_sockets].sockaddr, 0, sizeof(struct sockaddr_storage));
udp_socket_list[udp_sockets].next_try_on_error = 0;
udp_sockets++;
return AFP_OK;
}
static void save_close_event(const char *path)
{
time_t now = time(NULL);
/* Check if it's a close for the same event as the last one */
if (last_close_event.time /* is there any saved event ? */
&& (strcmp(path, last_close_event.path) != 0)) {
/* no, so send the saved event out now */
send_fce_event(last_close_event.path, FCE_FILE_MODIFY);
}
LOG(log_debug, logtype_afpd, "save_close_event: %s", path);
last_close_event.time = now;
strncpy(last_close_event.path, path, MAXPATHLEN);
}
/*
*
* Dispatcher for all incoming file change events
*
* */
static int register_fce(const char *u_name, int is_dir, int mode)
{
static int first_event = FCE_TRUE;
if (udp_sockets == 0)
/* No listeners configured */
return AFP_OK;
if (u_name == NULL)
return AFPERR_PARAM;
/* do some initialization on the fly the first time */
if (first_event) {
fce_initialize_history();
first_event = FCE_FALSE;
}
/* handle files which should not cause events (.DS_Store atc. ) */
for (int i = 0; skip_files[i] != NULL; i++)
{
if (!strcmp( u_name, skip_files[i]))
return AFP_OK;
}
char full_path_buffer[MAXPATHLEN + 1] = {""};
const char *cwd = getcwdpath();
if (mode == FCE_TM_SIZE) {
strlcpy(full_path_buffer, u_name, MAXPATHLEN);
} else if (!is_dir || mode == FCE_DIR_DELETE) {
if (strlen( cwd ) + strlen( u_name) + 1 >= MAXPATHLEN) {
LOG(log_error, logtype_afpd, "FCE file name too long: %s/%s", cwd, u_name );
return AFPERR_PARAM;
}
sprintf( full_path_buffer, "%s/%s", cwd, u_name );
} else {
if (strlen( cwd ) >= MAXPATHLEN) {
LOG(log_error, logtype_afpd, "FCE directory name too long: %s", cwd);
return AFPERR_PARAM;
}
strcpy( full_path_buffer, cwd);
}
/* Can we ignore this event based on type or history? */
if (!(mode & FCE_TM_SIZE) && fce_handle_coalescation( full_path_buffer, is_dir, mode ))
{
LOG(log_debug9, logtype_afpd, "Coalesced fc event <%d> for <%s>", mode, full_path_buffer );
return AFP_OK;
}
LOG(log_debug9, logtype_afpd, "Detected fc event <%d> for <%s>", mode, full_path_buffer );
if (mode & FCE_FILE_MODIFY) {
save_close_event(full_path_buffer);
return AFP_OK;
}
send_fce_event( full_path_buffer, mode );
return AFP_OK;
}
static void check_saved_close_events(int fmodwait)
{
time_t now = time(NULL);
/* check if configured holdclose time has passed */
if (last_close_event.time && ((last_close_event.time + fmodwait) < now)) {
LOG(log_debug, logtype_afpd, "check_saved_close_events: sending event: %s", last_close_event.path);
/* yes, send event */
send_fce_event(&last_close_event.path[0], FCE_FILE_MODIFY);
last_close_event.path[0] = 0;
last_close_event.time = 0;
}
}
/******************** External calls start here **************************/
/*
* API-Calls for file change api, called form outside (file.c directory.c ofork.c filedir.c)
* */
#ifndef FCE_TEST_MAIN
void fce_pending_events(AFPObj *obj)
{
vol_fce_tm_event();
check_saved_close_events(obj->options.fce_fmodwait);
}
int fce_register_delete_file( struct path *path )
{
int ret = AFP_OK;
if (path == NULL)
return AFPERR_PARAM;
if (!(fce_ev_enabled & (1 << FCE_FILE_DELETE)))
return ret;
ret = register_fce( path->u_name, false, FCE_FILE_DELETE );
return ret;
}
int fce_register_delete_dir( char *name )
{
int ret = AFP_OK;
if (name == NULL)
return AFPERR_PARAM;
if (!(fce_ev_enabled & (1 << FCE_DIR_DELETE)))
return ret;
ret = register_fce( name, true, FCE_DIR_DELETE);
return ret;
}
int fce_register_new_dir( struct path *path )
{
int ret = AFP_OK;
if (path == NULL)
return AFPERR_PARAM;
if (!(fce_ev_enabled & (1 << FCE_DIR_CREATE)))
return ret;
ret = register_fce( path->u_name, true, FCE_DIR_CREATE );
return ret;
}
int fce_register_new_file( struct path *path )
{
int ret = AFP_OK;
if (path == NULL)
return AFPERR_PARAM;
if (!(fce_ev_enabled & (1 << FCE_FILE_CREATE)))
return ret;
ret = register_fce( path->u_name, false, FCE_FILE_CREATE );
return ret;
}
int fce_register_file_modification( struct ofork *ofork )
{
char *u_name = NULL;
struct vol *vol;
int ret = AFP_OK;
if (ofork == NULL || ofork->of_vol == NULL)
return AFPERR_PARAM;
if (!(fce_ev_enabled & (1 << FCE_FILE_MODIFY)))
return ret;
vol = ofork->of_vol;
if (NULL == (u_name = mtoupath(vol, of_name(ofork), ofork->of_did, utf8_encoding())))
{
return AFPERR_MISC;
}
ret = register_fce( u_name, false, FCE_FILE_MODIFY );
return ret;
}
int fce_register_tm_size(const char *vol, size_t used)
{
int ret = AFP_OK;
if (vol == NULL)
return AFPERR_PARAM;
if (!(fce_ev_enabled & (1 << FCE_TM_SIZE)))
return ret;
tm_used = used; /* oh what a hack */
ret = register_fce(vol, false, FCE_TM_SIZE);
return ret;
}
#endif
/*
*
* Extern connect to afpd parameter, can be called multiple times for multiple listeners (up to MAX_UDP_SOCKS times)
*
* */
int fce_add_udp_socket(const char *target)
{
const char *port = FCE_DEFAULT_PORT_STRING;
char target_ip[256] = {""};
strncpy(target_ip, target, sizeof(target_ip) -1);
char *port_delim = strchr( target_ip, ':' );
if (port_delim) {
*port_delim = 0;
port = port_delim + 1;
}
return add_udp_socket(target_ip, port);
}
int fce_set_events(const char *events)
{
char *e;
char *p;
if (events == NULL)
return AFPERR_PARAM;
e = strdup(events);
fce_ev_enabled = 0;
for (p = strtok(e, ","); p; p = strtok(NULL, ",")) {
if (strcmp(p, "fmod") == 0) {
fce_ev_enabled |= (1 << FCE_FILE_MODIFY);
} else if (strcmp(p, "fdel") == 0) {
fce_ev_enabled |= (1 << FCE_FILE_DELETE);
} else if (strcmp(p, "ddel") == 0) {
fce_ev_enabled |= (1 << FCE_DIR_DELETE);
} else if (strcmp(p, "fcre") == 0) {
fce_ev_enabled |= (1 << FCE_FILE_CREATE);
} else if (strcmp(p, "dcre") == 0) {
fce_ev_enabled |= (1 << FCE_DIR_CREATE);
} else if (strcmp(p, "tmsz") == 0) {
fce_ev_enabled |= (1 << FCE_TM_SIZE);
}
}
free(e);
return AFP_OK;
}
#ifdef FCE_TEST_MAIN
void shortsleep( unsigned int us )
{
usleep( us );
}
int main( int argc, char*argv[] )
{
int c,ret;
char *port = FCE_DEFAULT_PORT_STRING;
char *host = "localhost";
int delay_between_events = 1000;
int event_code = FCE_FILE_MODIFY;
char pathbuff[1024];
int duration_in_seconds = 0; // TILL ETERNITY
char target[256];
char *path = getcwd( pathbuff, sizeof(pathbuff) );
// FULLSPEED TEST IS "-s 1001" -> delay is 0 -> send packets without pause
while ((c = getopt(argc, argv, "d:e:h:p:P:s:")) != -1) {
switch(c) {
case '?':
fprintf(stdout, "%s: [ -p Port -h Listener1 [ -h Listener2 ...] -P path -s Delay_between_events_in_us -e event_code -d Duration ]\n", argv[0]);
exit(1);
break;
case 'd':
duration_in_seconds = atoi(optarg);
break;
case 'e':
event_code = atoi(optarg);
break;
case 'h':
host = strdup(optarg);
break;
case 'p':
port = strdup(optarg);
break;
case 'P':
path = strdup(optarg);
break;
case 's':
delay_between_events = atoi(optarg);
break;
}
}
sprintf(target, "%s:%s", host, port);
if (fce_add_udp_socket(target) != 0)
return 1;
int ev_cnt = 0;
time_t start_time = time(NULL);
time_t end_time = 0;
if (duration_in_seconds)
end_time = start_time + duration_in_seconds;
while (1)
{
time_t now = time(NULL);
if (now > start_time)
{
start_time = now;
fprintf( stdout, "%d events/s\n", ev_cnt );
ev_cnt = 0;
}
if (end_time && now >= end_time)
break;
register_fce( path, 0, event_code );
ev_cnt++;
shortsleep( delay_between_events );
}
}
#endif /* TESTMAIN*/
|