/****************************************************************************** * FunctionName : syslog_add_entry * Description : add a syslog_entry_t to the syslogQueue * Parameters : entry: the syslog_entry_t * Returns : none ******************************************************************************/ static void ICACHE_FLASH_ATTR syslog_add_entry(syslog_entry_t *entry) { syslog_entry_t *pse = syslogQueue; DBG("[%dµs] %s id=%lu\n", WDEV_NOW(), __FUNCTION__, entry->msgid); // append msg to syslog_queue if (pse == NULL) syslogQueue = entry; else { while (pse->next != NULL) pse = pse->next; pse->next = entry; // append msg to syslog queue } // Debug: show queue addr, current msgid, avail. heap and syslog datagram // DBG("%p %lu %d %s\n", entry, entry->msgid, system_get_free_heap_size(), entry->datagram); // ensure we have sufficient heap for the rest of the system if (system_get_free_heap_size() < syslogHost.min_heap_size) { if (syslogState != SYSLOG_HALTED) { // os_printf("syslog_add_entry: Warning: queue filled up (%d), halted\n", system_get_free_heap_size()); entry->next = syslog_compose(SYSLOG_FAC_USER, SYSLOG_PRIO_CRIT, "SYSLOG", "queue filled up (%d), halted", system_get_free_heap_size()); os_printf("%s\n", entry->next->datagram); if (syslogState == SYSLOG_READY) syslog_send_udp(); syslog_set_status(SYSLOG_HALTED); } } }
/****************************************************************************** * FunctionName : syslog * Description : compose and queue a new syslog message * Parameters : facility * severity * tag * message * ... * * SYSLOG-MSG = HEADER SP STRUCTURED-DATA [SP MSG] HEADER = PRI VERSION SP TIMESTAMP SP HOSTNAME SP APP-NAME SP PROCID SP MSGID PRI = "<" PRIVAL ">" PRIVAL = 1*3DIGIT ; range 0 .. 191 VERSION = NONZERO-DIGIT 0*2DIGIT HOSTNAME = NILVALUE / 1*255PRINTUSASCII APP-NAME = NILVALUE / 1*48PRINTUSASCII PROCID = NILVALUE / 1*128PRINTUSASCII MSGID = NILVALUE / 1*32PRINTUSASCII TIMESTAMP = NILVALUE / FULL-DATE "T" FULL-TIME FULL-DATE = DATE-FULLYEAR "-" DATE-MONTH "-" DATE-MDAY DATE-FULLYEAR = 4DIGIT DATE-MONTH = 2DIGIT ; 01-12 DATE-MDAY = 2DIGIT ; 01-28, 01-29, 01-30, 01-31 based on ; month/year FULL-TIME = PARTIAL-TIME TIME-OFFSET PARTIAL-TIME = TIME-HOUR ":" TIME-MINUTE ":" TIME-SECOND [TIME-SECFRAC] TIME-HOUR = 2DIGIT ; 00-23 TIME-MINUTE = 2DIGIT ; 00-59 TIME-SECOND = 2DIGIT ; 00-59 TIME-SECFRAC = "." 1*6DIGIT TIME-OFFSET = "Z" / TIME-NUMOFFSET TIME-NUMOFFSET = ("+" / "-") TIME-HOUR ":" TIME-MINUTE STRUCTURED-DATA = NILVALUE / 1*SD-ELEMENT SD-ELEMENT = "[" SD-ID *(SP SD-PARAM) "]" SD-PARAM = PARAM-NAME "=" %d34 PARAM-VALUE %d34 SD-ID = SD-NAME PARAM-NAME = SD-NAME PARAM-VALUE = UTF-8-STRING ; characters '"', '\' and ; ']' MUST be escaped. SD-NAME = 1*32PRINTUSASCII ; except '=', SP, ']', %d34 (") MSG = MSG-ANY / MSG-UTF8 MSG-ANY = *OCTET ; not starting with BOM MSG-UTF8 = BOM UTF-8-STRING BOM = %xEF.BB.BF UTF-8-STRING = *OCTET ; UTF-8 string as specified ; in RFC 3629 OCTET = %d00-255 SP = %d32 PRINTUSASCII = %d33-126 NONZERO-DIGIT = %d49-57 DIGIT = %d48 / NONZERO-DIGIT NILVALUE = "-" * * TIMESTAMP: realtime_clock == 0 ? timertick / 10⁶ : realtime_clock * HOSTNAME hostname * APPNAME: ems-esp-link * PROCID: timertick * MSGID: NILVALUE * * Returns : none *******************************************************************************/ void ICACHE_FLASH_ATTR syslog(uint8_t facility, uint8_t severity, const char *tag, const char *fmt, ...) { DBG("syslog: state=%d ", syslogState); if (syslogState == SYSLOG_ERROR || syslogState == SYSLOG_HALTED) return; // compose the syslog message void *arg = __builtin_apply_args(); void *res = __builtin_apply((void*)syslog_compose, arg, 128); syslog_entry_t *se = *(syslog_entry_t **)res; // and append it to the message queue syslog_add_entry(se); if (syslogState == SYSLOG_READY) { syslogState = SYSLOG_SENDING; syslog_send_udp(); } if (syslogState == SYSLOG_NONE) { syslogState = SYSLOG_WAIT; syslog_chk_wifi_stat(); // fire the timer to check the Wifi connection status } }
static void ICACHE_FLASH_ATTR syslog_gethostbyname_cb(const char *name, ip_addr_t *ipaddr, void *arg) { struct espconn *pespconn = (struct espconn *)arg; (void) pespconn; if (ipaddr != NULL) { syslogHost.addr.addr = ipaddr->addr; syslogState = SYSLOG_SENDING; syslog_send_udp(); } else { syslogState = SYSLOG_ERROR; DBG("syslog_gethostbyname_cb: state=SYSLOG_ERROR\n"); } }
/****************************************************************************** * FunctionName : initSyslog * Description : Initialize the syslog library * Parameters : syslog_host -- the syslog host (host:port) * host: IP-Addr | hostname * Returns : none *******************************************************************************/ void ICACHE_FLASH_ATTR syslog_init(char *syslog_host) { if (!*syslog_host) { syslogState = SYSLOG_HALTED; return; } char host[32], *port = &host[0]; syslog_task = register_usr_task(syslog_udp_send_event); syslogHost.min_heap_size = flashConfig.syslog_minheap; syslogHost.port = 514; syslogState = SYSLOG_WAIT; os_strncpy(host, syslog_host, 32); while (*port && *port != ':') // find port delimiter port++; if (*port) { *port++ = '\0'; syslogHost.port = atoi(port); } wifi_set_broadcast_if(STATIONAP_MODE); // send UDP broadcast from both station and soft-AP interface syslog_espconn.type = ESPCONN_UDP; syslog_espconn.proto.udp = (esp_udp *)os_zalloc(sizeof(esp_udp)); syslog_espconn.proto.udp->local_port = espconn_port(); // set a available port #ifdef SYSLOG_UDP_RECV espconn_regist_recvcb(&syslog_espconn, syslog_udp_recv_cb); // register a udp packet receiving callback #endif espconn_regist_sentcb(&syslog_espconn, syslog_udp_sent_cb); // register a udp packet sent callback espconn_create(&syslog_espconn); // create udp if (UTILS_StrToIP((const char *)host, (void*)&syslogHost.addr)) { syslogState = SYSLOG_SENDING; syslog_send_udp(); } else { static struct espconn espconn_ghbn; espconn_gethostbyname(&espconn_ghbn, host, &syslogHost.addr, syslog_gethostbyname_cb); // syslog_send_udp is called by syslog_gethostbyname_cb() } #ifdef SYSLOG_UDP_RECV DBG("syslog_init: host: %s, port: %d, lport: %d, recvcb: %p, sentcb: %p, state: %d\n", host, syslogHost.port, syslog_espconn.proto.udp->local_port, syslog_udp_recv_cb, syslog_udp_sent_cb, syslogState ); #else DBG("syslog_init: host: %s, port: %d, lport: %d, rsentcb: %p, state: %d\n", host, syslogHost.port, syslog_espconn.proto.udp->local_port, syslog_udp_sent_cb, syslogState ); #endif }
/****************************************************************************** * FunctionName : syslog_sent_cb * Description : udp sent successfully * fetch next syslog package, free old message * Parameters : arg -- Additional argument to pass to the callback function * Returns : none ******************************************************************************/ static void ICACHE_FLASH_ATTR syslog_udp_sent_cb(void *arg) { struct espconn *pespconn = arg; (void) pespconn; // datagram is delivered - free and advance queue syslog_entry_t *pse = syslogQueue; syslogQueue = syslogQueue -> next; os_free(pse); if (syslogQueue != NULL) syslog_send_udp(); else syslogState = SYSLOG_READY; }
/****************************************************************************** * FunctionName : syslog_add_entry * Description : add a syslog_entry_t to the syslogQueue * Parameters : entry: the syslog_entry_t * Returns : none ******************************************************************************/ static void ICACHE_FLASH_ATTR syslog_add_entry(syslog_entry_t *entry) { syslog_entry_t *pse = syslogQueue; // append msg to syslog_queue if (pse == NULL) syslogQueue = entry; else { while (pse->next != NULL) pse = pse->next; pse->next = entry; // append msg to syslog queue } // ensure we have sufficient heap for the rest of the system if (system_get_free_heap_size() < syslogHost.min_heap_size) { if (syslogState != SYSLOG_HALTED) { os_printf("syslog_add_entry: Warning: queue filled up, halted\n"); entry->next = syslog_compose(SYSLOG_FAC_SYSLOG, SYSLOG_PRIO_CRIT, "-", "queue filled up, halted"); if (syslogState == SYSLOG_READY) syslog_send_udp(); syslogState = SYSLOG_HALTED; } } }
/****************************************************************************** * FunctionName : syslog_chk_status * Description : check whether get ip addr or not * Parameters : none * Returns : none *******************************************************************************/ static void ICACHE_FLASH_ATTR syslog_chk_status(void) { struct ip_info ipconfig; DBG("[%uµs] %s: id=%lu ", WDEV_NOW(), __FUNCTION__, syslogQueue ? syslogQueue->msgid : 0); //disarm timer first syslog_timer_armed = false; //try to get ip info of ESP8266 station wifi_get_ip_info(STATION_IF, &ipconfig); int wifi_status = wifi_station_get_connect_status(); if (wifi_status == STATION_GOT_IP && ipconfig.ip.addr != 0) { // it seems we have to add an additional delay after the Wifi is up and running. // so we simply add an intermediate state with 25ms delay switch (syslogState) { case SYSLOG_WAIT: DBG("%s: Wifi connected\n", syslog_get_status()); syslog_set_status(SYSLOG_INIT); syslog_timer_arm(100); break; case SYSLOG_INIT: DBG("%s: init syslog\n", syslog_get_status()); syslog_set_status(SYSLOG_INITDONE); syslog_init(flashConfig.syslog_host); syslog_timer_arm(10); break; case SYSLOG_DNSWAIT: DBG("%s: wait for DNS resolver\n", syslog_get_status()); syslog_timer_arm(100); break; case SYSLOG_READY: DBG("%s: enforce sending\n", syslog_get_status()); syslog_send_udp(); break; case SYSLOG_SENDING: DBG("%s: delay\n", syslog_get_status()); syslog_set_status(SYSLOG_SEND); syslog_timer_arm(2); break; case SYSLOG_SEND: DBG("%s: start sending\n", syslog_get_status()); syslog_send_udp(); break; default: DBG("%s: %d\n", syslog_get_status(), syslogState); break; } } else { if ((wifi_status == STATION_WRONG_PASSWORD || wifi_status == STATION_NO_AP_FOUND || wifi_status == STATION_CONNECT_FAIL)) { syslog_set_status(SYSLOG_ERROR); os_printf("*** connect failure %d!!!\n", wifi_status); } else { DBG("re-arming timer...\n"); syslog_timer_arm(WIFI_CHK_INTERVAL); } } }