diff --git a/lib/services/upstart.c b/lib/services/upstart.c index 01130a0683..b5c3477ef3 100644 --- a/lib/services/upstart.c +++ b/lib/services/upstart.c @@ -1,607 +1,673 @@ /* * Original copyright 2010 Senko Rasic * and Ante Karamatic * Later changes copyright 2012-2021 the Pacemaker project contributors * * The version control history for this file may have further details. * * This source code is licensed under the GNU Lesser General Public License * version 2.1 or later (LGPLv2.1+) WITHOUT ANY WARRANTY. */ #include #include #include #include #include #include #include #include #include #include #include #define BUS_NAME "com.ubuntu.Upstart" #define BUS_PATH "/com/ubuntu/Upstart" #define UPSTART_06_API BUS_NAME"0_6" #define UPSTART_JOB_IFACE UPSTART_06_API".Job" #define BUS_PROPERTY_IFACE "org.freedesktop.DBus.Properties" /* http://upstart.ubuntu.com/wiki/DBusInterface */ static DBusConnection *upstart_proxy = NULL; static gboolean upstart_init(void) { static int need_init = 1; if (need_init) { need_init = 0; upstart_proxy = pcmk_dbus_connect(); } if (upstart_proxy == NULL) { return FALSE; } return TRUE; } void upstart_cleanup(void) { if (upstart_proxy) { pcmk_dbus_disconnect(upstart_proxy); upstart_proxy = NULL; } } -static gboolean -upstart_job_by_name(const gchar * arg_name, gchar ** out_unit, int timeout) +/*! + * \internal + * \brief Get the DBus object path corresponding to a job name + * + * \param[in] arg_name Name of job to get path for + * \param[out] path If not NULL, where to store DBus object path + * \param[in] timeout Give up after this many seconds + * + * \return true if object path was found, false otherwise + * \note The caller is responsible for freeing *path if it is non-NULL. + */ +static bool +object_path_for_job(const gchar *arg_name, char **path, int timeout) { -/* - com.ubuntu.Upstart0_6.GetJobByName (in String name, out ObjectPath job) -*/ + /* + com.ubuntu.Upstart0_6.GetJobByName (in String name, out ObjectPath job) + */ DBusError error; DBusMessage *msg; DBusMessage *reply = NULL; - const char *method = "GetJobByName"; + bool rc = false; - if(upstart_init() == FALSE) { - return FALSE; + if (path != NULL) { + *path = NULL; + } + + if (!upstart_init()) { + return false; } msg = dbus_message_new_method_call(BUS_NAME, // target for the method call BUS_PATH, // object to call on - UPSTART_06_API, // interface to call on - method); // method name + UPSTART_06_API, // interface to call on + "GetJobByName"); // method name dbus_error_init(&error); - CRM_LOG_ASSERT(dbus_message_append_args(msg, DBUS_TYPE_STRING, &arg_name, DBUS_TYPE_INVALID)); + CRM_LOG_ASSERT(dbus_message_append_args(msg, DBUS_TYPE_STRING, &arg_name, + DBUS_TYPE_INVALID)); reply = pcmk_dbus_send_recv(msg, upstart_proxy, &error, timeout); dbus_message_unref(msg); if (dbus_error_is_set(&error)) { - crm_err("Could not issue %s for %s: %s", method, arg_name, error.message); + crm_err("Could not get DBus object path for %s: %s", + arg_name, error.message); dbus_error_free(&error); - } else if(!pcmk_dbus_type_check(reply, NULL, DBUS_TYPE_OBJECT_PATH, __func__, __LINE__)) { - crm_err("Invalid return type for %s", method); + } else if (!pcmk_dbus_type_check(reply, NULL, DBUS_TYPE_OBJECT_PATH, + __func__, __LINE__)) { + crm_err("Could not get DBus object path for %s: Invalid return type", + arg_name); } else { - if(out_unit) { - char *path = NULL; - - dbus_message_get_args (reply, NULL, - DBUS_TYPE_OBJECT_PATH, &path, - DBUS_TYPE_INVALID); - - *out_unit = strdup(path); + if (path != NULL) { + dbus_message_get_args(reply, NULL, DBUS_TYPE_OBJECT_PATH, path, + DBUS_TYPE_INVALID); + if (*path != NULL) { + *path = strdup(*path); + } } - dbus_message_unref(reply); - return TRUE; + rc = true; } - if(reply) { + if (reply != NULL) { dbus_message_unref(reply); } - return FALSE; + return rc; } static void fix(char *input, const char *search, char replace) { char *match = NULL; int shuffle = strlen(search) - 1; while (TRUE) { int len, lpc; match = strstr(input, search); if (match == NULL) { break; } crm_trace("Found: %s", match); match[0] = replace; len = strlen(match) - shuffle; for (lpc = 1; lpc <= len; lpc++) { match[lpc] = match[lpc + shuffle]; } } } static char * fix_upstart_name(const char *input) { char *output = strdup(input); fix(output, "_2b", '+'); fix(output, "_2c", ','); fix(output, "_2d", '-'); fix(output, "_2e", '.'); fix(output, "_40", '@'); fix(output, "_5f", '_'); return output; } GList * upstart_job_listall(void) { GList *units = NULL; DBusMessageIter args; DBusMessageIter unit; DBusMessage *msg = NULL; DBusMessage *reply = NULL; const char *method = "GetAllJobs"; DBusError error; int lpc = 0; if (upstart_init() == FALSE) { return NULL; } /* com.ubuntu.Upstart0_6.GetAllJobs (out jobs) */ dbus_error_init(&error); msg = dbus_message_new_method_call(BUS_NAME, // target for the method call BUS_PATH, // object to call on UPSTART_06_API, // interface to call on method); // method name CRM_ASSERT(msg != NULL); reply = pcmk_dbus_send_recv(msg, upstart_proxy, &error, DBUS_TIMEOUT_USE_DEFAULT); dbus_message_unref(msg); if (dbus_error_is_set(&error)) { crm_err("Call to %s failed: %s", method, error.message); dbus_error_free(&error); return NULL; } else if (!dbus_message_iter_init(reply, &args)) { crm_err("Call to %s failed: Message has no arguments", method); dbus_message_unref(reply); return NULL; } if(!pcmk_dbus_type_check(reply, &args, DBUS_TYPE_ARRAY, __func__, __LINE__)) { crm_err("Call to %s failed: Message has invalid arguments", method); dbus_message_unref(reply); return NULL; } dbus_message_iter_recurse(&args, &unit); while (dbus_message_iter_get_arg_type (&unit) != DBUS_TYPE_INVALID) { DBusBasicValue value; const char *job = NULL; char *path = NULL; if(!pcmk_dbus_type_check(reply, &unit, DBUS_TYPE_OBJECT_PATH, __func__, __LINE__)) { crm_warn("Skipping Upstart reply argument with unexpected type"); continue; } dbus_message_iter_get_basic(&unit, &value); if(value.str) { int llpc = 0; path = value.str; job = value.str; while (path[llpc] != 0) { if (path[llpc] == '/') { job = path + llpc + 1; } llpc++; } lpc++; crm_trace("%s -> %s", path, job); units = g_list_append(units, fix_upstart_name(job)); } dbus_message_iter_next (&unit); } dbus_message_unref(reply); crm_trace("Found %d upstart jobs", lpc); return units; } gboolean upstart_job_exists(const char *name) { - return upstart_job_by_name(name, NULL, DBUS_TIMEOUT_USE_DEFAULT); + return object_path_for_job(name, NULL, DBUS_TIMEOUT_USE_DEFAULT); } static char * get_first_instance(const gchar * job, int timeout) { char *instance = NULL; const char *method = "GetAllInstances"; DBusError error; DBusMessage *msg; DBusMessage *reply; DBusMessageIter args; DBusMessageIter unit; dbus_error_init(&error); msg = dbus_message_new_method_call(BUS_NAME, // target for the method call job, // object to call on UPSTART_JOB_IFACE, // interface to call on method); // method name CRM_ASSERT(msg != NULL); dbus_message_append_args(msg, DBUS_TYPE_INVALID); reply = pcmk_dbus_send_recv(msg, upstart_proxy, &error, timeout); dbus_message_unref(msg); if (dbus_error_is_set(&error)) { crm_err("Call to %s failed: %s", method, error.message); dbus_error_free(&error); goto done; } else if(reply == NULL) { crm_err("Call to %s failed: no reply", method); goto done; } else if (!dbus_message_iter_init(reply, &args)) { crm_err("Call to %s failed: Message has no arguments", method); goto done; } if(!pcmk_dbus_type_check(reply, &args, DBUS_TYPE_ARRAY, __func__, __LINE__)) { crm_err("Call to %s failed: Message has invalid arguments", method); goto done; } dbus_message_iter_recurse(&args, &unit); if(pcmk_dbus_type_check(reply, &unit, DBUS_TYPE_OBJECT_PATH, __func__, __LINE__)) { DBusBasicValue value; dbus_message_iter_get_basic(&unit, &value); if(value.str) { instance = strdup(value.str); crm_trace("Result: %s", instance); } } done: if(reply) { dbus_message_unref(reply); } return instance; } +/*! + * \internal + * \brief Parse result of Upstart status check + * + * \param[in] name DBus interface name for property that was checked + * \param[in] state Property value + * \param[in] userdata Status action that check was done for + */ static void -upstart_job_check(const char *name, const char *state, void *userdata) +parse_status_result(const char *name, const char *state, void *userdata) { - svc_action_t * op = userdata; + svc_action_t *op = userdata; - if (state && g_strcmp0(state, "running") == 0) { + if (pcmk__str_eq(state, "running", pcmk__str_none)) { op->rc = PCMK_OCF_OK; + op->status = PCMK_EXEC_DONE; } else { op->rc = PCMK_OCF_NOT_RUNNING; + op->status = PCMK_EXEC_DONE; } - if (op->synchronous == FALSE) { + if (!(op->synchronous)) { services_set_op_pending(op, NULL); services__finalize_async_op(op); } } +#define METADATA_FORMAT \ + "\n" \ + "\n" \ + "\n" \ + " 1.1\n" \ + " \n" \ + " Upstart agent for controlling the system %s service\n" \ + " \n" \ + " Upstart job for %s\n" \ + " \n" \ + " \n" \ + " \n" \ + " \n" \ + " \n" \ + " \n" \ + " \n" \ + " \n" \ + " \n" \ + " \n" \ + "\n" + static char * upstart_job_metadata(const char *name) { - return crm_strdup_printf("\n" - "\n" - "\n" - " 1.0\n" - " \n" - " Upstart agent for controlling the system %s service\n" - " \n" - " %s upstart agent\n" - " \n" - " \n" - " \n" - " \n" - " \n" - " \n" - " \n" - " \n" - " \n" - " \n" - " \n" - " \n" "\n", name, name, name); + return crm_strdup_printf(METADATA_FORMAT, name, name, name); } -static bool -upstart_mask_error(svc_action_t *op, const char *error) +/*! + * \internal + * \brief Set an action result based on a method error + * + * \param[in] op Action to set result for + * \param[in] error Method error + */ +static void +set_result_from_method_error(svc_action_t *op, const DBusError *error) { - crm_trace("Could not issue %s for %s: %s", op->action, op->rsc, error); - if(strstr(error, UPSTART_06_API ".Error.UnknownInstance")) { - if(pcmk__str_eq(op->action, "stop", pcmk__str_casei)) { - crm_trace("Masking %s failure for %s: unknown services are stopped", op->action, op->rsc); - op->rc = PCMK_OCF_OK; + op->rc = PCMK_OCF_UNKNOWN_ERROR; + op->status = PCMK_EXEC_ERROR; - } else if(pcmk__str_eq(op->action, "start", pcmk__str_casei)) { - crm_trace("Mapping %s failure for %s: unknown services are not installed", op->action, op->rsc); - op->rc = PCMK_OCF_NOT_INSTALLED; - op->status = PCMK_EXEC_NOT_INSTALLED; + if (strstr(error->name, UPSTART_06_API ".Error.UnknownInstance")) { + + if (pcmk__str_eq(op->action, "stop", pcmk__str_casei)) { + crm_trace("Masking stop failure (%s) for %s " + "because unknown service can be considered stopped", + error->name, crm_str(op->rsc)); + op->rc = PCMK_OCF_OK; + op->status = PCMK_EXEC_DONE; + return; } - return TRUE; + + op->rc = PCMK_OCF_NOT_INSTALLED; + op->status = PCMK_EXEC_NOT_INSTALLED; } else if (pcmk__str_eq(op->action, "start", pcmk__str_casei) - && strstr(error, UPSTART_06_API ".Error.AlreadyStarted")) { - crm_trace("Mapping %s failure for %s: starting a started resource is allowed", op->action, op->rsc); + && strstr(error->name, UPSTART_06_API ".Error.AlreadyStarted")) { + crm_trace("Masking start failure (%s) for %s " + "because already started resource is OK", + error->name, crm_str(op->rsc)); op->rc = PCMK_OCF_OK; - return TRUE; + op->status = PCMK_EXEC_DONE; + return; } - return FALSE; + crm_err("DBus request for %s of Upstart job %s for resource %s failed: %s", + op->action, op->agent, crm_str(op->rsc), error->message); } +/*! + * \internal + * \brief Process the completion of an asynchronous job start, stop, or restart + * + * \param[in] pending If not NULL, DBus call associated with request + * \param[in] user_data Action that was executed + */ static void -upstart_async_dispatch(DBusPendingCall *pending, void *user_data) +job_method_complete(DBusPendingCall *pending, void *user_data) { DBusError error; DBusMessage *reply = NULL; svc_action_t *op = user_data; - dbus_error_init(&error); - if(pending) { + // Grab the reply + if (pending != NULL) { reply = dbus_pending_call_steal_reply(pending); } + // Determine result + dbus_error_init(&error); if (pcmk_dbus_find_error(pending, reply, &error)) { - - /* ignore "already started" or "not running" errors */ - if (!upstart_mask_error(op, error.name)) { - crm_err("%s for %s: %s", op->action, op->rsc, error.message); - } + set_result_from_method_error(op, &error); dbus_error_free(&error); - } else if (!g_strcmp0(op->action, "stop")) { - /* No return vaue */ + } else if (pcmk__str_eq(op->action, "stop", pcmk__str_none)) { + // Call has no return value + crm_debug("DBus request for stop of %s succeeded", crm_str(op->rsc)); + op->rc = PCMK_OCF_OK; + op->status = PCMK_EXEC_DONE; + + } else if (!pcmk_dbus_type_check(reply, NULL, DBUS_TYPE_OBJECT_PATH, + __func__, __LINE__)) { + crm_warn("DBus request for %s of %s succeeded but " + "return type was unexpected", op->action, crm_str(op->rsc)); op->rc = PCMK_OCF_OK; + op->status = PCMK_EXEC_DONE; } else { - if(!pcmk_dbus_type_check(reply, NULL, DBUS_TYPE_OBJECT_PATH, __func__, __LINE__)) { - crm_warn("Call to %s passed but return type was unexpected", op->action); - op->rc = PCMK_OCF_OK; - - } else { - const char *path = NULL; + const char *path = NULL; - dbus_message_get_args (reply, NULL, - DBUS_TYPE_OBJECT_PATH, &path, - DBUS_TYPE_INVALID); - crm_info("Call to %s passed: %s", op->action, path); - op->rc = PCMK_OCF_OK; - } + dbus_message_get_args(reply, NULL, DBUS_TYPE_OBJECT_PATH, &path, + DBUS_TYPE_INVALID); + crm_debug("DBus request for %s of %s using %s succeeded", + op->action, crm_str(op->rsc), path); + op->rc = PCMK_OCF_OK; + op->status = PCMK_EXEC_DONE; } + // The call is no longer pending CRM_LOG_ASSERT(pending == op->opaque->pending); services_set_op_pending(op, NULL); - services__finalize_async_op(op); - if(reply) { + // Finalize action + services__finalize_async_op(op); + if (reply != NULL) { dbus_message_unref(reply); } } /*! * \internal * \brief Execute an Upstart action * * \param[in] op Action to execute * * \return Standard Pacemaker return code * \retval EBUSY Recurring operation could not be initiated * \retval pcmk_rc_error Synchronous action failed * \retval pcmk_rc_ok Synchronous action succeeded, or asynchronous action * should not be freed (because it already was or is * pending) * * \note If the return value for an asynchronous action is not pcmk_rc_ok, the * caller is responsible for freeing the action. */ int services__execute_upstart(svc_action_t *op) { char *job = NULL; int arg_wait = TRUE; const char *arg_env = "pacemaker=1"; const char *action = op->action; DBusError error; DBusMessage *msg = NULL; DBusMessage *reply = NULL; DBusMessageIter iter, array_iter; CRM_ASSERT(op != NULL); if ((op->action == NULL) || (op->agent == NULL)) { op->rc = PCMK_OCF_NOT_CONFIGURED; op->status = PCMK_EXEC_ERROR_FATAL; goto cleanup; } if (!upstart_init()) { op->rc = PCMK_OCF_UNKNOWN_ERROR; op->status = PCMK_EXEC_ERROR; goto cleanup; } if (pcmk__str_eq(op->action, "meta-data", pcmk__str_casei)) { op->stdout_data = upstart_job_metadata(op->agent); op->rc = PCMK_OCF_OK; op->status = PCMK_EXEC_DONE; goto cleanup; } - if (!upstart_job_by_name(op->agent, &job, op->timeout)) { - crm_debug("Could not find Upstart job '%s' to %s", op->agent, action); + if (!object_path_for_job(op->agent, &job, op->timeout)) { if (pcmk__str_eq(action, "stop", pcmk__str_none)) { op->rc = PCMK_OCF_OK; op->status = PCMK_EXEC_DONE; } else { op->rc = PCMK_OCF_NOT_INSTALLED; op->status = PCMK_EXEC_NOT_INSTALLED; } goto cleanup; } + if (job == NULL) { + // Shouldn't normally be possible -- maybe a memory error + op->rc = PCMK_OCF_UNKNOWN_ERROR; + op->status = PCMK_EXEC_ERROR; + goto cleanup; + } + if (pcmk__strcase_any_of(op->action, "monitor", "status", NULL)) { DBusPendingCall *pending = NULL; char *state = NULL; char *path = get_first_instance(job, op->timeout); op->rc = PCMK_OCF_NOT_RUNNING; op->status = PCMK_EXEC_DONE; if (path == NULL) { goto cleanup; } state = pcmk_dbus_get_property(upstart_proxy, BUS_NAME, path, UPSTART_06_API ".Instance", "state", - op->synchronous? NULL : upstart_job_check, + op->synchronous? NULL : parse_status_result, op, op->synchronous? NULL : &pending, op->timeout); free(path); if (op->synchronous) { - upstart_job_check("state", state, op); + parse_status_result("state", state, op); free(state); - } else if (pending != NULL) { // Successfully initiated async op + } else if (pending == NULL) { + op->rc = PCMK_OCF_UNKNOWN_ERROR; + op->status = PCMK_EXEC_ERROR; + + } else { // Successfully initiated async op free(job); services_set_op_pending(op, pending); services_add_inflight_op(op); return pcmk_rc_ok; } goto cleanup; } else if (pcmk__str_eq(action, "start", pcmk__str_none)) { action = "Start"; } else if (pcmk__str_eq(action, "stop", pcmk__str_none)) { action = "Stop"; } else if (pcmk__str_eq(action, "restart", pcmk__str_none)) { action = "Restart"; } else { op->rc = PCMK_OCF_UNIMPLEMENT_FEATURE; op->status = PCMK_EXEC_ERROR_HARD; goto cleanup; } // Initialize rc/status in case called functions don't set them op->rc = PCMK_OCF_UNKNOWN_ERROR; op->status = PCMK_EXEC_DONE; crm_debug("Calling %s for %s on %s", action, crm_str(op->rsc), job); msg = dbus_message_new_method_call(BUS_NAME, // target for the method call job, // object to call on UPSTART_JOB_IFACE, // interface to call on action); // method name CRM_ASSERT(msg != NULL); dbus_message_iter_init_append (msg, &iter); - - CRM_LOG_ASSERT(dbus_message_iter_open_container (&iter, - DBUS_TYPE_ARRAY, - DBUS_TYPE_STRING_AS_STRING, - &array_iter)); - - CRM_LOG_ASSERT(dbus_message_iter_append_basic (&array_iter, DBUS_TYPE_STRING, &arg_env)); - CRM_LOG_ASSERT(dbus_message_iter_close_container (&iter, &array_iter)); - - CRM_LOG_ASSERT(dbus_message_append_args(msg, DBUS_TYPE_BOOLEAN, &arg_wait, DBUS_TYPE_INVALID)); + CRM_LOG_ASSERT(dbus_message_iter_open_container(&iter, + DBUS_TYPE_ARRAY, + DBUS_TYPE_STRING_AS_STRING, + &array_iter)); + CRM_LOG_ASSERT(dbus_message_iter_append_basic(&array_iter, + DBUS_TYPE_STRING, &arg_env)); + CRM_LOG_ASSERT(dbus_message_iter_close_container(&iter, &array_iter)); + CRM_LOG_ASSERT(dbus_message_append_args(msg, DBUS_TYPE_BOOLEAN, &arg_wait, + DBUS_TYPE_INVALID)); if (!(op->synchronous)) { DBusPendingCall *pending = pcmk_dbus_send(msg, upstart_proxy, - upstart_async_dispatch, op, + job_method_complete, op, op->timeout); - if (pending != NULL) { // Successfully initiated async op + if (pending == NULL) { + op->rc = PCMK_OCF_UNKNOWN_ERROR; + op->status = PCMK_EXEC_ERROR; + goto cleanup; + + } else { // Successfully initiated async op free(job); services_set_op_pending(op, pending); services_add_inflight_op(op); return pcmk_rc_ok; } - goto cleanup; } + // Synchronous call + dbus_error_init(&error); reply = pcmk_dbus_send_recv(msg, upstart_proxy, &error, op->timeout); if (dbus_error_is_set(&error)) { - if (!upstart_mask_error(op, error.name)) { - crm_err("Could not issue %s for %s: %s (%s)", - action, op->rsc, error.message, job); - } + set_result_from_method_error(op, &error); dbus_error_free(&error); } else if (pcmk__str_eq(op->action, "stop", pcmk__str_none)) { // DBus call does not return a value op->rc = PCMK_OCF_OK; op->status = PCMK_EXEC_DONE; } else if (!pcmk_dbus_type_check(reply, NULL, DBUS_TYPE_OBJECT_PATH, __func__, __LINE__)) { crm_warn("Call to %s passed but return type was unexpected", op->action); op->rc = PCMK_OCF_OK; op->status = PCMK_EXEC_DONE; } else { const char *path = NULL; dbus_message_get_args(reply, NULL, DBUS_TYPE_OBJECT_PATH, &path, DBUS_TYPE_INVALID); crm_info("Call to %s passed: %s", op->action, path); op->rc = PCMK_OCF_OK; op->status = PCMK_EXEC_DONE; } cleanup: free(job); if (msg != NULL) { dbus_message_unref(msg); } if (reply != NULL) { dbus_message_unref(reply); } if (op->synchronous) { return (op->rc == PCMK_OCF_OK)? pcmk_rc_ok : pcmk_rc_error; } else { return services__finalize_async_op(op); } }