/* * 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 #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #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 }; /* * * 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, i; 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 (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() { int i; if (udp_initialized == FCE_FALSE ) return; for (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; ssize_t data_len = 0; strncpy(packet->magic, FCE_PACKET_MAGIC, sizeof(packet->magic) ); packet->version = FCE_PACKET_VERSION; packet->mode = mode; packet->event_id = event_id; pathlen = strlen(path) + 1; /* include 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; /* This is the payload len. Means: the stream has len bytes more until packet is finished */ /* A server should read the first 16 byte, decode them and then fetch the rest */ data_len = FCE_PACKET_HEADER_SIZE + pathlen; packet->datalen = pathlen; switch (mode) { case FCE_TM_SIZE: tm_used = hton64(tm_used); memcpy(packet->data, &tm_used, sizeof(tm_used)); strncpy(packet->data + sizeof(tm_used), path, pathlen); packet->datalen += sizeof(tm_used); data_len += sizeof(tm_used); break; default: strncpy(packet->data, path, pathlen); break; } /* return the packet len */ return data_len; } static int pack_fce_packet(struct fce_packet *packet, unsigned char *buf) { 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 = htonl(packet->event_id); memcpy(p, &id, sizeof(id)); p += sizeof(packet->event_id); uint16_t l = htons(packet->datalen); memcpy(p, &l, sizeof(l)); p += sizeof(l); memcpy(p, &packet->data[0], packet->datalen); p += packet->datalen; return 0; } /* * 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 ) { 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 */ int i; LOG(log_debug, logtype_afpd, "send_fce_event: start"); time_t now = time(NULL); /* build our data packet */ ssize_t data_len = build_fce_packet( &packet, path, mode, ++event_id ); pack_fce_packet(&packet, iobuf); for (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); 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); } 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; } /* * * Dispatcher for all incoming file change events * * */ static int register_fce(const char *u_name, int is_dir, int mode) { int i; if (udp_sockets == 0) /* No listeners configured */ return AFP_OK; if (u_name == NULL) return AFPERR_PARAM; static int first_event = FCE_TRUE; /* do some initialization on the fly the first time */ if (first_event) { fce_initialize_history(); } /* handle files which should not cause events (.DS_Store atc. ) */ for (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 ); /* we do initilization on the fly, no blocking calls in here * (except when using FQDN in broken DNS environment) */ if (first_event == FCE_TRUE) { fce_init_udp(); /* Notify listeners the we start from the beginning */ send_fce_event( "", FCE_CONN_START ); first_event = FCE_FALSE; } /* Handle UDP transport */ send_fce_event( full_path_buffer, mode ); return AFP_OK; } /******************** 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 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); } #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*/