Merge pull request #645 from skliper/fix484-exec-in-shell

Fix #484, Deprecate shell output command
nasa · May 8, 2020 · d30c229 · d30c229
2 parents b3a9974 + a3230cb
commit d30c229
Show file tree

Hide file tree

Showing 7 changed files with 41 additions and 303 deletions.
diff --git a/cmake/sample_defs/cpu1_msgids.h b/cmake/sample_defs/cpu1_msgids.h
@@ -86,7 +86,11 @@
 #define CFE_TBL_REG_TLM_MID         CFE_MISSION_TLM_MID_BASE1 + CFE_MISSION_TBL_REG_TLM_MSG     /* 0x080C */
 #define CFE_SB_ALLSUBS_TLM_MID      CFE_MISSION_TLM_MID_BASE1 + CFE_MISSION_SB_ALLSUBS_TLM_MSG  /* 0x080D */
 #define CFE_SB_ONESUB_TLM_MID       CFE_MISSION_TLM_MID_BASE1 + CFE_MISSION_SB_ONESUB_TLM_MSG   /* 0x080E */
-#define CFE_ES_SHELL_TLM_MID        CFE_MISSION_TLM_MID_BASE1 + CFE_MISSION_ES_SHELL_TLM_MSG    /* 0x080F */
+
+#ifndef CFE_OMIT_DEPRECATED_6_7
+  #define CFE_ES_SHELL_TLM_MID        CFE_MISSION_TLM_MID_BASE1 + CFE_MISSION_ES_SHELL_TLM_MSG    /* 0x080F */
+#endif
+
 #define CFE_ES_MEMSTATS_TLM_MID     CFE_MISSION_TLM_MID_BASE1 + CFE_MISSION_ES_MEMSTATS_TLM_MSG /* 0x0810 */
 
 /*

diff --git a/fsw/cfe-core/src/es/cfe_es_shell.c b/fsw/cfe-core/src/es/cfe_es_shell.c
@@ -44,6 +44,11 @@
 
 #include <string.h>
 
+#ifndef CFE_OMIT_DEPRECATED_6_7  /* Remove entire file eventually */
+/* Note - Plan to implement the list functions as real commands,
+ * shell output no longer part of cFS Framework, recommend implementation in an app if needed
+ */
+
 #define  CFE_ES_CHECKSIZE 3
 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 /* CFE_ES_ShellOutputCommand() -- Pass thru string to O/S shell or to ES */
@@ -424,3 +429,4 @@ int32 CFE_ES_ListResources(int32 fd)
     */
     return Result;
 }
+#endif /* CFE_OMIT_DEPRECATED_6_7 */
diff --git a/fsw/cfe-core/src/es/cfe_es_task.c b/fsw/cfe-core/src/es/cfe_es_task.c
@@ -255,12 +255,14 @@ int32 CFE_ES_TaskInit(void)
             CFE_SB_ValueToMsgId(CFE_ES_HK_TLM_MID),
             sizeof(CFE_ES_TaskData.HkPacket), true);
 
+#ifndef CFE_OMIT_DEPRECATED_6_7
     /*
     ** Initialize shell output packet (clear user data area)
     */
     CFE_SB_InitMsg(&CFE_ES_TaskData.ShellPacket,
             CFE_SB_ValueToMsgId(CFE_ES_SHELL_TLM_MID),
             sizeof(CFE_ES_TaskData.ShellPacket), true);
+#endif
 
     /*
     ** Initialize single application telemetry packet
@@ -472,12 +474,14 @@ void CFE_ES_TaskPipe(CFE_SB_MsgPtr_t Msg)
                     }
                     break;
 
+#ifndef CFE_OMIT_DEPRECATED_6_7
                 case CFE_ES_SHELL_CC:
                     if (CFE_ES_VerifyCmdLength(Msg, sizeof(CFE_ES_Shell_t)))
                     {
                         CFE_ES_ShellCmd((CFE_ES_Shell_t*)Msg);
                     }
                     break;
+#endif
 
                 case CFE_ES_START_APP_CC:
                     if (CFE_ES_VerifyCmdLength(Msg, sizeof(CFE_ES_StartApp_t)))
@@ -839,7 +843,7 @@ int32 CFE_ES_RestartCmd(const CFE_ES_Restart_t *data)
     return CFE_SUCCESS;
 } /* End of CFE_ES_RestartCmd() */
 
-
+#ifndef CFE_OMIT_DEPRECATED_6_7
 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 /*                                                                 */
 /* CFE_ES_ShellCmd() -- Pass thru string to O/S shell              */
@@ -884,7 +888,7 @@ int32 CFE_ES_ShellCmd(const CFE_ES_Shell_t *data)
 
     return CFE_SUCCESS;
 } /* End of CFE_ES_ShellCmd() */
-
+#endif /* CFE_OMIT_DEPRECATED_6_7 */
 
 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 /*                                                                 */

diff --git a/fsw/cfe-core/src/es/cfe_es_task.h b/fsw/cfe-core/src/es/cfe_es_task.h
@@ -77,11 +77,12 @@ typedef struct
   */
   CFE_ES_HousekeepingTlm_t     HkPacket;
 
-
+#ifndef CFE_OMIT_DEPRECATED_6_7
   /*
   ** ES Shell output telemetry packet
   */
   CFE_ES_ShellTlm_t  ShellPacket;
+#endif
 
   /*
   ** Single application telemetry packet
@@ -152,7 +153,9 @@ int32 CFE_ES_HousekeepingCmd(const CCSDS_CommandPacket_t *data);
 int32 CFE_ES_NoopCmd(const CFE_ES_Noop_t *Cmd);
 int32 CFE_ES_ResetCountersCmd(const CFE_ES_ResetCounters_t *data);
 int32 CFE_ES_RestartCmd(const CFE_ES_Restart_t *data);
+#ifndef CFE_OMIT_DEPRECATED_6_7
 int32 CFE_ES_ShellCmd(const CFE_ES_Shell_t *data);
+#endif
 int32 CFE_ES_StartAppCmd(const CFE_ES_StartApp_t *data);
 int32 CFE_ES_StopAppCmd(const CFE_ES_StopApp_t *data);
 int32 CFE_ES_RestartAppCmd(const CFE_ES_RestartApp_t *data);

diff --git a/fsw/cfe-core/src/inc/cfe_es_msg.h b/fsw/cfe-core/src/inc/cfe_es_msg.h
@@ -170,7 +170,9 @@
 */
 #define CFE_ES_RESTART_CC              2
 
-/** \cfeescmd Executive Services O/S Shell Command
+#ifndef CFE_OMIT_DEPRECATED_6_7
+/** \cfeescmd DEPRECATED: Executive Services O/S Shell Command
+**  \deprecated
 **
 **  \par Description
 **       This command passes an ASCII string as a command line to the
@@ -217,6 +219,7 @@
 **  \sa 
 */
 #define CFE_ES_SHELL_CC            3
+#endif /* CFE_OMIT_DEPRECATED_6_7 */
 
 /** \cfeescmd Load and Start an Application
 **
@@ -1152,8 +1155,10 @@ typedef struct
     CFE_ES_RestartCmd_Payload_t Payload;
 } CFE_ES_Restart_t;
 
+#ifndef CFE_OMIT_DEPRECATED_6_7
 /**
-** \brief Shell Command
+** \brief DEPRECATED: Shell Command
+** \deprecated
 **
 ** For command details, see #CFE_ES_SHELL_CC
 **
@@ -1166,11 +1171,16 @@ typedef struct
                                                                 be written */
 } CFE_ES_ShellCmd_Payload_t;
 
+/**
+ * \deprecated
+ */
 typedef struct
 {
     uint8                       CmdHeader[CFE_SB_CMD_HDR_SIZE];    /**< \brief cFE Software Bus Command Message Header */
     CFE_ES_ShellCmd_Payload_t   Payload;
 } CFE_ES_Shell_t;
+#endif /* CFE_OMIT_DEPRECATED_6_7 */
+
 
 /**
 ** \brief Payload format for commands which accept a single file name
@@ -1575,20 +1585,26 @@ typedef struct
 
 } CFE_ES_HousekeepingTlm_t;
 
+#ifndef CFE_OMIT_DEPRECATED_6_7
 /** 
-**  \cfeestlm OS Shell Output Packet
+**  \cfeestlm DEPRECATED: OS Shell Output Packet
+**  \deprecated
 **/
 typedef struct
 {
   char                  ShellOutput[CFE_MISSION_ES_MAX_SHELL_PKT];  /**< \brief ASCII text string containing output from OS Shell
                                                                  that was received in response to an OS Shell Command */
 } CFE_ES_ShellPacket_Payload_t;
 
+/**
+ * \deprecated
+ */
 typedef struct
 {
     uint8                           TlmHeader[CFE_SB_TLM_HDR_SIZE]; /**< \brief cFE Software Bus Telemetry Message Header */
     CFE_ES_ShellPacket_Payload_t    Payload;
 }CFE_ES_ShellTlm_t;
+#endif /* CFE_OMIT_DEPRECATED_6_7 */
 
 /*************************************************************************/