From: Arnaud Giersch Date: Wed, 17 Mar 2021 22:45:43 +0000 (+0100) Subject: Lowercase PID in function name (2/2 - public part). X-Git-Tag: v3.27~102 X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/95f0facf354f999b3b4f9623ab947415408e2733 Lowercase PID in function name (2/2 - public part). Changed: sg_actor_get_PID, sg_actor_get_PPID, sg_actor_by_PID --- diff --git a/ChangeLog b/ChangeLog index 67accfc2fe..d7642ea8e9 100644 --- a/ChangeLog +++ b/ChangeLog @@ -25,6 +25,9 @@ S4U: XBT: - Drop simgrid::xbt::demangle. Please use boost::core::demangle instead. +C binding and interface: + - Rename (lowercase) functions sg_actor_get_PID, sg_actor_get_PPID, sg_actor_by_PID. + Documentation: - New section: Configuring the logs from the command line. - New section: Programming API of logs. diff --git a/docs/source/app_s4u.rst b/docs/source/app_s4u.rst index 635016bdf5..0c85251d5e 100644 --- a/docs/source/app_s4u.rst +++ b/docs/source/app_s4u.rst @@ -491,7 +491,7 @@ Retrieving actors .. group-tab:: C - .. doxygenfunction:: sg_actor_by_PID(aid_t pid) + .. doxygenfunction:: sg_actor_by_pid(aid_t pid) .. doxygenfunction:: sg_actor_self() Querying info @@ -525,8 +525,8 @@ Querying info .. group-tab:: C .. doxygenfunction:: sg_actor_get_name(const_sg_actor_t actor) - .. doxygenfunction:: sg_actor_get_PID(const_sg_actor_t actor) - .. doxygenfunction:: sg_actor_get_PPID(const_sg_actor_t actor) + .. doxygenfunction:: sg_actor_get_pid(const_sg_actor_t actor) + .. doxygenfunction:: sg_actor_get_ppid(const_sg_actor_t actor) .. doxygenfunction:: sg_actor_get_properties(const_sg_actor_t actor) .. doxygenfunction:: sg_actor_get_property_value(const_sg_actor_t actor, const char *name) diff --git a/include/simgrid/actor.h b/include/simgrid/actor.h index b8b1481141..62b5fc674d 100644 --- a/include/simgrid/actor.h +++ b/include/simgrid/actor.h @@ -35,9 +35,14 @@ XBT_PUBLIC void sg_actor_set_stacksize(sg_actor_t actor, unsigned size); XBT_PUBLIC void sg_actor_exit(); XBT_PUBLIC void sg_actor_on_exit(void_f_int_pvoid_t fun, void* data); -XBT_PUBLIC aid_t sg_actor_get_PID(const_sg_actor_t actor); -XBT_PUBLIC aid_t sg_actor_get_PPID(const_sg_actor_t actor); -XBT_PUBLIC sg_actor_t sg_actor_by_PID(aid_t pid); +XBT_PUBLIC aid_t sg_actor_get_pid(const_sg_actor_t actor); +XBT_PUBLIC aid_t sg_actor_get_ppid(const_sg_actor_t actor); +XBT_PUBLIC sg_actor_t sg_actor_by_pid(aid_t pid); +XBT_ATTRIB_DEPRECATED_v331("Please use sg_actor_get_pid() instead") XBT_PUBLIC aid_t + sg_actor_get_PID(const_sg_actor_t actor); +XBT_ATTRIB_DEPRECATED_v331("Please use sg_actor_get_ppid() instead") XBT_PUBLIC aid_t + sg_actor_get_PPID(const_sg_actor_t actor); +XBT_ATTRIB_DEPRECATED_v331("Please use sg_actor_by_pid() instead") XBT_PUBLIC sg_actor_t sg_actor_by_PID(aid_t pid); XBT_PUBLIC const char* sg_actor_get_name(const_sg_actor_t actor); XBT_PUBLIC sg_host_t sg_actor_get_host(const_sg_actor_t actor); XBT_PUBLIC const char* sg_actor_get_property_value(const_sg_actor_t actor, const char* name); diff --git a/src/bindings/java/jmsg_process.cpp b/src/bindings/java/jmsg_process.cpp index 3f88eac464..1ab550cafb 100644 --- a/src/bindings/java/jmsg_process.cpp +++ b/src/bindings/java/jmsg_process.cpp @@ -111,7 +111,7 @@ JNIEXPORT void JNICALL Java_org_simgrid_msg_Process_killAll(JNIEnv* env, jclass JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Process_fromPID(JNIEnv * env, jclass cls, jint pid) { - auto const* actor = sg_actor_by_PID(pid); + auto const* actor = sg_actor_by_pid(pid); if (not actor) { jxbt_throw_process_not_found(env, std::string("PID = ") + std::to_string(static_cast(pid))); @@ -131,7 +131,7 @@ JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Process_fromPID(JNIEnv * env, jcl JNIEXPORT jint JNICALL Java_org_simgrid_msg_Process_nativeGetPID(JNIEnv* env, jobject jprocess) { const_sg_actor_t actor = jprocess_to_native(jprocess, env); - return sg_actor_get_PID(actor); + return sg_actor_get_pid(actor); } JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Process_getProperty(JNIEnv *env, jobject jprocess, jobject jname) { diff --git a/src/msg/msg_legacy.cpp b/src/msg/msg_legacy.cpp index 79ea9abece..bcbfd0c027 100644 --- a/src/msg/msg_legacy.cpp +++ b/src/msg/msg_legacy.cpp @@ -62,15 +62,15 @@ void MSG_process_on_exit(int_f_int_pvoid_t fun, void* data) int MSG_process_get_PID(const_sg_actor_t actor) { - return sg_actor_get_PID(actor); + return sg_actor_get_pid(actor); } int MSG_process_get_PPID(const_sg_actor_t actor) { - return sg_actor_get_PPID(actor); + return sg_actor_get_ppid(actor); } -msg_process_t MSG_process_from_PID(int PID) +msg_process_t MSG_process_from_PID(int pid) { - return sg_actor_by_PID(PID); + return sg_actor_by_pid(pid); } const char* MSG_process_get_name(const_sg_actor_t actor) { diff --git a/src/s4u/s4u_Actor.cpp b/src/s4u/s4u_Actor.cpp index 7e619bb774..3770e80372 100644 --- a/src/s4u/s4u_Actor.cpp +++ b/src/s4u/s4u_Actor.cpp @@ -522,7 +522,7 @@ void sg_actor_exit() * This function checks whether @a actor is a valid pointer and return its PID (or 0 in case of problem). */ -aid_t sg_actor_get_PID(const_sg_actor_t actor) +aid_t sg_actor_get_pid(const_sg_actor_t actor) { /* Do not raise an exception here: this function is called by the logs * and the exceptions, so it would be called back again and again */ @@ -537,7 +537,7 @@ aid_t sg_actor_get_PID(const_sg_actor_t actor) * This function checks whether @a actor is a valid pointer and return its parent's PID. * Returns -1 if the actor has not been created by any other actor. */ -aid_t sg_actor_get_PPID(const_sg_actor_t actor) +aid_t sg_actor_get_ppid(const_sg_actor_t actor) { return actor->get_ppid(); } @@ -549,11 +549,26 @@ aid_t sg_actor_get_PPID(const_sg_actor_t actor) * If none is found, @c nullptr is returned. Note that the PID are unique in the whole simulation, not only on a given host. */ -sg_actor_t sg_actor_by_PID(aid_t pid) +sg_actor_t sg_actor_by_pid(aid_t pid) { return simgrid::s4u::Actor::by_pid(pid).get(); } +aid_t sg_actor_get_PID(const_sg_actor_t actor) // XBT_ATTRIB_DEPRECATED_v331 +{ + return sg_actor_get_pid(actor); +} + +aid_t sg_actor_get_PPID(const_sg_actor_t actor) // XBT_ATTRIB_DEPRECATED_v331 +{ + return sg_actor_get_ppid(actor); +} + +sg_actor_t sg_actor_by_PID(aid_t pid) // XBT_ATTRIB_DEPRECATED_v331 +{ + return sg_actor_by_pid(pid); +} + /** @brief Return the name of an actor. */ const char* sg_actor_get_name(const_sg_actor_t actor) {