path: root/lib/lib_errors.c

/*
 * Library-specific error messages.
 * Copyright (C) 2018  Cumulus Networks, Inc.
 *                     Donald Sharp
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the Free
 * Software Foundation; either version 2 of the License, or (at your option)
 * any later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; see the file COPYING; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 */

#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

#include "lib_errors.h"

/* clang-format off */
static struct log_ref ferr_lib_warn[] = {
	{
		.code = EC_LIB_SNMP,
		.title = "SNMP has discovered a warning",
		.description = "The SNMP AgentX library has returned a warning that we should report to the end user",
		.suggestion = "Gather Log data and open an Issue.",
	},
	{
		.code = EC_LIB_STREAM,
		.title = "The stream subsystem has encountered an error",
		.description = "During sanity checking stream.c has detected an error in the data associated with a particular stream",
		.suggestion = "Gather log data and open an Issue, restart FRR",
	},
	{
		.code = EC_LIB_LINUX_NS,
		.title = "The Linux namespace subsystem has encountered a parsing error",
		.description = "During system startup an invalid parameter for the namesapce was give to FRR",
		.suggestion = "Gather log data and open an Issue. restart FRR",
	},
	{
		.code = EC_LIB_SLOW_THREAD_CPU,
		.title = "The Event subsystem has detected a slow cpu time process",
		.description = "The Event subsystem has detected a slow process, this typically indicates that FRR is having trouble completing work in a timely manner.  This can be either a misconfiguration, bug, or some combination therof.  In this case total CPU time was over 5 seconds.  Which indicates that FRR is very busy doing some work and should be addressed",
		.suggestion = "Gather log data and open an Issue",
	},
	{
		.code = EC_LIB_SLOW_THREAD_WALL,
		.title = "The Event subsystem has detected a slow wall time process",
		.description = "The Event subsystem has detected a slow process, this typically indicates that FRR is having trouble completing work in a timely manner.  This can be either a misconfiguration, bug or some combination therof.  In this case total WALL time was over 5 seconds.  Which indicates that FRR might be having trouble being scheduled or some system call is delaying",
		.suggestion = "Gather log data and open an Issue",
	},
	{
		.code = EC_LIB_NO_THREAD,
		.title = "The Event subsystem has detected an internal FD problem",
		.description = "The Event subsystem has detected a file descriptor read/write event without an associated handling function.  This is a bug, please collect log data and open an issue.",
		.suggestion = "Gather log data and open an Issue",
	},
	{
		.code = EC_LIB_RMAP_RECURSION_LIMIT,
		.title = "Reached the Route-Map Recursion Limit",
		.description = "The Route-Map subsystem has detected a route-map depth of RMAP_RECURSION_LIMIT and has stopped processing",
		.suggestion = "Re-work the Route-Map in question to not have so many route-map statements, or recompile FRR with a higher limit",
	},
	{
		.code = EC_LIB_BACKUP_CONFIG,
		.title = "Unable to open configuration file",
		.description = "The config subsystem attempted to read in it's configuration file which failed, so we are falling back to the backup config file to see if it is available",
		.suggestion = "Create configuration file",
	},
	{
		.code = EC_LIB_VRF_LENGTH,
		.title = "The VRF subsystem has encountered a parsing error",
		.description = "The VRF subsystem, during initialization, has found a parsing error with input it has received",
		.suggestion = "Check the length of the vrf name and adjust accordingly",
	},
	{
		.code = EC_LIB_YANG_DATA_TRUNCATED,
		.title = "YANG data truncation",
		.description = "The northbound subsystem has detected that YANG data has been truncated as the given buffer wasn't big enough",
		.suggestion = "Gather log data and open an Issue",
	},
	{
		.code = EC_LIB_YANG_UNKNOWN_DATA_PATH,
		.title = "Unknown YANG data path",
		.description = "The northbound subsystem has detected an unknown YANG data path",
		.suggestion = "Gather log data and open an Issue",
	},
	{
		.code = EC_LIB_YANG_TRANSLATOR_LOAD,
		.title = "Unable to load YANG module translator",
		.description = "The northbound subsystem has detected an error while loading a YANG module translator",
		.suggestion = "Ensure the YANG module translator file is valid. See documentation for further information.",
	},
	{
		.code = EC_LIB_YANG_TRANSLATION_ERROR,
		.title = "YANG translation error",
		.description = "The northbound subsystem has detected an error while performing a YANG XPath translation",
		.suggestion = "Gather log data and open an Issue",
	},
	{
		.code = EC_LIB_NB_DATABASE,
		.title = "The northbound database wasn't initialized correctly",
		.description = "An error occurred while initializing the northbound database. As a result, the configuration rollback feature won't work as expected.",
		.suggestion = "Ensure permissions are correct for FRR files, users and groups are correct."
	},
	{
		.code = EC_LIB_NB_CB_UNNEEDED,
		.title = "Unneeded northbound callback",
		.description = "The northbound subsystem, during initialization, has detected a callback that doesn't need to be implemented",
		.suggestion = "This is a bug; please report it"
	},
	{
		.code = EC_LIB_NB_CB_CONFIG_VALIDATE,
		.title = "A northbound configuration callback has failed in the VALIDATE phase",
		.description = "A callback used to process a configuration change has returned a validation error",
		.suggestion = "The provided configuration is invalid. Fix any inconsistency and try again.",
	},
	{
		.code = EC_LIB_NB_CB_CONFIG_PREPARE,
		.title = "A northbound configuration callback has failed in the PREPARE phase",
		.description = "A callback used to process a configuration change has returned a resource allocation error",
		.suggestion = "The system might be running out of resources. Check the log for more details.",
	},
	{
		.code = EC_LIB_NB_CB_STATE,
		.title = "A northbound callback for operational data has failed",
		.description = "The northbound subsystem has detected that a callback used to fetch operational data has returned an error",
		.suggestion = "Gather log data and open an Issue",
	},
	{
		.code = EC_LIB_NB_CB_RPC,
		.title = "A northbound RPC callback has failed",
		.description = "The northbound subsystem has detected that a callback used to process YANG RPCs/actions has returned an error",
		.suggestion = "The log message should contain further details on the specific error that occurred; investigate the reported error.",
	},
	{
		.code = EC_LIB_NB_CANDIDATE_INVALID,
		.title = "Invalid candidate configuration",
		.description = "The northbound subsystem failed to validate a candidate configuration",
		.suggestion = "Check the log messages to see the validation errors and edit the candidate configuration to fix them",
	},
	{
		.code = EC_LIB_NB_CANDIDATE_EDIT_ERROR,
		.title = "Failure to edit a candidate configuration",
		.description = "The northbound subsystem failed to edit a candidate configuration",
		.suggestion = "This is a bug; please report it"
	},
	{
		.code = EC_LIB_NB_OPERATIONAL_DATA,
		.title = "Failure to obtain operational data",
		.description = "The northbound subsystem failed to obtain YANG-modeled operational data",
		.suggestion = "This is a bug; please report it"
	},
	{
		.code = EC_LIB_NB_TRANSACTION_CREATION_FAILED,
		.title = "Failure to create a configuration transaction",
		.description = "The northbound subsystem failed to create a configuration transaction",
		.suggestion = "The log message should contain further details on the specific error that occurred; investigate the reported error.",
	},
	{
		.code = EC_LIB_NB_TRANSACTION_RECORD_FAILED,
		.title = "Failure to record a configuration transaction",
		.description = "The northbound subsystem failed to record a configuration transaction in the northbound database",
		.suggestion = "Gather log data and open an Issue",
	},
	{
		.code = END_FERR,
	},
};

static struct log_ref ferr_lib_err[] = {
	{
		.code = EC_LIB_PRIVILEGES,
		.title = "Failure to raise or lower privileges",
		.description = "FRR attempted to raise or lower its privileges and was unable to do so",
		.suggestion = "Ensure that you are running FRR as the frr user and that the user has sufficient privileges to properly access root privileges"
	},
	{
		.code = EC_LIB_VRF_START,
		.title = "VRF Failure on Start",
		.description = "Upon startup FRR failed to properly initialize and startup the VRF subsystem",
		.suggestion = "Ensure that there is sufficient memory to start processes and restart FRR",
	},
	{
		.code = EC_LIB_SOCKET,
		.title = "Socket Error",
		.description = "When attempting to access a socket a system error has occurred and we were unable to properly complete the request",
		.suggestion = "Ensure that there are sufficient system resources available and ensure that the frr user has sufficient permissions to work.  If necessary open an Issue",
	},
	{
		.code = EC_LIB_ZAPI_MISSMATCH,
		.title = "ZAPI Error",
		.description = "A version miss-match has been detected between zebra and client protocol",
		.suggestion = "Two different versions of FRR have been installed and the install is not properly setup.  Completely stop FRR, remove it from the system and reinstall.  Typically only developers should see this issue."
	},
	{
		.code = EC_LIB_ZAPI_ENCODE,
		.title = "ZAPI Error",
		.description = "The ZAPI subsystem has detected an encoding issue, between zebra and a client protocol",
		.suggestion = "Gather data and open an Issue, also Restart FRR"
	},
	{
		.code = EC_LIB_ZAPI_SOCKET,
		.title = "ZAPI Error",
		.description = "The ZAPI subsystem has detected a socket error between zebra and a client",
		.suggestion = "Restart FRR"
	},
	{
		.code = EC_LIB_SYSTEM_CALL,
		.title = "System Call Error",
		.description = "FRR has detected a error from using a vital system call and has probably already exited",
		.suggestion = "Ensure permissions are correct for FRR files, users and groups are correct. Additionally check that sufficient system resources are available."
	},
	{
		.code = EC_LIB_VTY,
		.title = "VTY Subsystem Error",
		.description = "FRR has detected a problem with the specified configuration file",
		.suggestion = "Ensure configuration file exists and has correct permissions for operations Additionally ensure that all config lines are correct as well",
	},
	{
		.code = EC_LIB_INTERFACE,
		.title = "Interface Subsystem Error",
		.description = "FRR has detected a problem with interface data from the kernel as it deviates from what we would expect to happen via normal netlink messaging",
		.suggestion = "Open an Issue with all relevant log files and restart FRR"
	},
	{
		.code = EC_LIB_NS,
		.title = "NameSpace Subsystem Error",
		.description = "FRR has detected a problem with NameSpace data from the kernel as it deviates from what we would expect to happen via normal kernel messaging",
		.suggestion = "Open an Issue with all relevant log files and restart FRR"
	},
	{
		.code = EC_LIB_DEVELOPMENT,
		.title = "Developmental Escape Error",
		.description = "FRR has detected an issue where new development has not properly updated all code paths.",
		.suggestion = "Open an Issue with all relevant log files"
	},
	{
		.code = EC_LIB_ZMQ,
		.title = "ZMQ Subsystem Error",
		.description = "FRR has detected an issue with the Zero MQ subsystem and ZeroMQ is not working properly now",
		.suggestion = "Open an Issue with all relevant log files and restart FRR"
	},
	{
		.code = EC_LIB_UNAVAILABLE,
		.title = "Feature or system unavailable",
		.description = "FRR was not compiled with support for a particular feature, or it is not available on the current platform",
		.suggestion = "Recompile FRR with the feature enabled, or find out what platforms support the feature"
	},
	{
		.code = EC_LIB_YANG_MODULE_LOAD,
		.title = "Unable to load YANG module from the file system",
		.description = "The northbound subsystem has detected an error while loading a YANG module from the file system",
		.suggestion = "Ensure all FRR YANG modules were installed correctly in the system.",
	},
	{
		.code = EC_LIB_YANG_MODULE_LOADED_ALREADY,
		.title = "Attempt to load a YANG module that is already loaded",
		.description = "The northbound subsystem has detected an attempt to load a YANG module that is already loaded",
		.suggestion = "This is a bug; please report it"
	},
	{
		.code = EC_LIB_YANG_DATA_CONVERT,
		.title = "YANG data conversion error",
		.description = "An error has occurred while converting a YANG data value from string to binary representation or vice-versa",
		.suggestion = "Open an Issue with all relevant log files and restart FRR"
	},
	{
		.code = EC_LIB_YANG_DNODE_NOT_FOUND,
		.title = "YANG data node not found",
		.description = "The northbound subsystem failed to find a YANG data node that was supposed to exist",
		.suggestion = "This is a bug; please report it"
	},
	{
		.code = EC_LIB_NB_CB_MISSING,
		.title = "Missing northbound callback",
		.description = "The northbound subsystem, during initialization, has detected a missing callback for one node of the loaded YANG modules",
		.suggestion = "This is a bug; please report it"
	},
	{
		.code = EC_LIB_NB_CB_INVALID_PRIO,
		.title = "Norhtbound callback has an invalid priority",
		.description = "The northbound subsystem, during initialization, has detected a callback whose priority is invalid",
		.suggestion = "This is a bug; please report it"
	},
	{
		.code = EC_LIB_NB_CBS_VALIDATION,
		.title = "Failure to validate the northbound callbacks",
		.description = "The northbound subsystem, during initialization, has detected one or more errors while loading the northbound callbacks",
		.suggestion = "This is a bug; please report it"
	},
	{
		.code = EC_LIB_LIBYANG,
		.title = "The libyang library returned an error",
		.description = "The northbound subsystem has detected that the libyang library returned an error",
		.suggestion = "Open an Issue with all relevant log files and restart FRR"
	},
	{
		.code = EC_LIB_LIBYANG_PLUGIN_LOAD,
		.title = "Failure to load a libyang plugin",
		.description = "The northbound subsystem, during initialization, has detected that a libyang plugin failed to be loaded",
		.suggestion = "Check if the FRR libyang plugins were installed correctly in the system",
	},
	{
		.code = EC_LIB_CONFD_INIT,
		.title = "ConfD initialization error",
		.description = "Upon startup FRR failed to properly initialize and startup the ConfD northbound plugin",
		.suggestion = "Check if ConfD is installed correctly in the system. Also, check if the confd daemon is running.",
	},
	{
		.code = EC_LIB_CONFD_DATA_CONVERT,
		.title = "ConfD data conversion error",
		.description = "An error has occurred while converting a ConfD data value (binary) to a string",
		.suggestion = "Open an Issue with all relevant log files and restart FRR"
	},
	{
		.code = EC_LIB_LIBCONFD,
		.title = "libconfd error",
		.description = "The northbound subsystem has detected that the libconfd library returned an error",
		.suggestion = "Open an Issue with all relevant log files and restart FRR"
	},
	{
		.code = EC_LIB_SYSREPO_INIT,
		.title = "Sysrepo initialization error",
		.description = "Upon startup FRR failed to properly initialize and startup the Sysrepo northbound plugin",
		.suggestion = "Check if Sysrepo is installed correctly in the system",
	},
	{
		.code = EC_LIB_SYSREPO_DATA_CONVERT,
		.title = "Sysrepo data conversion error",
		.description = "An error has occurred while converting a YANG data value to the Sysrepo format",
		.suggestion = "Open an Issue with all relevant log files and restart FRR"
	},
	{
		.code = EC_LIB_LIBSYSREPO,
		.title = "libsysrepo error",
		.description = "The northbound subsystem has detected that the libsysrepo library returned an error",
		.suggestion = "Open an Issue with all relevant log files and restart FRR"
	},
	{
		.code = EC_LIB_GRPC_INIT,
		.title = "gRPC initialization error",
		.description = "Upon startup FRR failed to properly initialize and startup the gRPC northbound plugin",
		.suggestion = "Check if the gRPC libraries are installed correctly in the system.",
	},
	{
		.code = EC_LIB_NB_CB_CONFIG_ABORT,
		.title = "A northbound configuration callback has failed in the ABORT phase",
		.description = "A callback used to process a configuration change has returned an error while trying to abort a change",
		.suggestion = "Gather log data and open an Issue.",
	},
	{
		.code = EC_LIB_NB_CB_CONFIG_APPLY,
		.title = "A northbound configuration callback has failed in the APPLY phase",
		.description = "A callback used to process a configuration change has returned an error while applying the changes",
		.suggestion = "Gather log data and open an Issue.",
	},
	{
		.code = EC_LIB_RESOLVER,
		.title = "DNS Resolution",
		.description = "An error was detected while attempting to resolve a hostname",
		.suggestion = "Ensure that DNS is working properly and the hostname is configured in dns.  If you are still seeing this error, open an issue"
	},
	{
		.code = END_FERR,
	}
};
/* clang-format on */

void lib_error_init(void)
{
	log_ref_add(ferr_lib_warn);
	log_ref_add(ferr_lib_err);
}