V2 [PATCH 0/3] Add meta-skeleton and a skeleton for init scripts

V2 [PATCH 0/3] Add meta-skeleton and a skeleton for init scripts

[Robert Yang]

Changes of V2:
  * Add the definition of actions to the comment area in skeleton
  * Implement try-restart and force-reload according to their definitions
  * Replace start-stop-daemon with "exec $DAEMON ..." to make it more easier
    to control the output message, so that we would not depend on the output
    of start-stop-daemon
  * Output simple and uniform messages
  * Move the function pidofproc () to ${sysconfdir}/init.d/functions and
    declare that it can't get the pid of a script unless pidof supports "-x".
  * Add /usr/sbin/skeleton-test to make /etc/init.d/skeleton can be run by
    default.

Pull URL: git://git.pokylinux.org/poky-contrib.git
  Branch: robert/init_scripts
  Browse: http://git.pokylinux.org/cgit.cgi/poky-contrib/log/?h=robert/init_scripts

Thanks,
    Robert Yang <liezhi.yang@windriver.com>
---


Robert Yang (3):
  Add the layer meta-skeleton
  Add pidofproc to ${sysconfdir}/init.d/functions
  Add a skeleton for init scripts

 meta-skeleton/conf/layer.conf                      |   10 +
 .../recipes-skeleton/service/service/COPYRIGHT     |   15 ++
 .../recipes-skeleton/service/service/skeleton      |  193 ++++++++++++++++++++
 .../service/service/skeleton_test.c                |   11 +
 .../recipes-skeleton/service/service_0.1.bb        |   32 ++++
 .../initscripts/initscripts-1.0/functions          |   32 +++-
 6 files changed, 291 insertions(+), 2 deletions(-)
 create mode 100644 meta-skeleton/conf/layer.conf
 create mode 100644 meta-skeleton/recipes-skeleton/service/service/COPYRIGHT
 create mode 100644 meta-skeleton/recipes-skeleton/service/service/skeleton
 create mode 100644 meta-skeleton/recipes-skeleton/service/service/skeleton_test.c
 create mode 100644 meta-skeleton/recipes-skeleton/service/service_0.1.bb

V2 [PATCH 1/3] Add the layer meta-skeleton

[Robert Yang]

Add the layer meta-skeleton, it will be used to place the various
canonical examples.

Signed-off-by: Robert Yang <liezhi.yang@windriver.com>
---
 meta-skeleton/conf/layer.conf |   10 ++++++++++
 1 files changed, 10 insertions(+), 0 deletions(-)
 create mode 100644 meta-skeleton/conf/layer.conf

diff --git a/meta-skeleton/conf/layer.conf b/meta-skeleton/conf/layer.conf
new file mode 100644
index 0000000..edb31dd
--- /dev/null
+++ b/meta-skeleton/conf/layer.conf
@@ -0,0 +1,10 @@
+# We have a conf and classes directory, add to BBPATH
+BBPATH := "${BBPATH}:${LAYERDIR}"
+
+# We have a packages directory, add to BBFILES
+BBFILES := "${BBFILES} ${LAYERDIR}/recipes-*/*/*.bb"
+
+BBFILE_COLLECTIONS += "skeleton"
+BBFILE_PATTERN_skeleton := "^${LAYERDIR}/"
+BBFILE_PRIORITY_skeleton = "1"
+
-- 
1.7.1

V2 [PATCH 2/3] Add pidofproc to ${sysconfdir}/init.d/functions

[Robert Yang]

Add pidofproc to ${sysconfdir}/init.d/functions, this is used for
getting the pid of the process. It uses pidof to implement currently, it
may also use the pidfile or ps to implement in the future.

Signed-off-by: Robert Yang <liezhi.yang@windriver.com>
---
 .../initscripts/initscripts-1.0/functions          |   32 ++++++++++++++++++-
 1 files changed, 30 insertions(+), 2 deletions(-)

diff --git a/meta/recipes-core/initscripts/initscripts-1.0/functions b/meta/recipes-core/initscripts/initscripts-1.0/functions
index 689fd32..6a51b3b 100644
--- a/meta/recipes-core/initscripts/initscripts-1.0/functions
+++ b/meta/recipes-core/initscripts/initscripts-1.0/functions
@@ -4,11 +4,39 @@
 #               shell scripts in the /etc/init.d directory.
 #
 
+# NOTE: The pidofproc () doesn't support the process which is a script unless
+#       the pidof supports "-x" option. If you want to use it for such a
+#       process:
+#       1) If there is no "pidof -x", replace the "pidof $1" with another
+#          command like(for core-image-minimal):
+#            ps | awk '/'"$1"'/ {print $1}'
+#       Or
+#       2) If there is "pidof -x", replace "pidof" with "pidof -x".
+pidofproc () {
+        local pid status
+
+        status=0
+        # pidof output null when no program is running, so no "2>/dev/null".
+        pid=`pidof $1` || status=$?
+        case $status in
+          0)
+                echo $pid
+                return 0
+                ;;
+          127)
+                echo "ERROR: command pidof not found" >&2
+                exit 127
+                ;;
+          *)
+                return $status
+                ;;
+        esac
+}
+
 machine_id() {		# return the machine ID
     awk 'BEGIN { FS=": " } /Hardware/ { gsub(" ", "_", $2); print tolower($2) } ' </proc/cpuinfo
 }
 
 killproc() {		# kill the named process(es)
-    pid=`/bin/pidof $1`
-    [ "$pid" != "" ] && kill $pid
+    pid=`pidofproc $1` && kill $pid
 }
-- 
1.7.1

Re: V2 [PATCH 2/3] Add pidofproc to ${sysconfdir}/init.d/functions

[Darren Hart]

On 05/16/2011 08:19 AM, Robert Yang wrote:
> Add pidofproc to ${sysconfdir}/init.d/functions, this is used for
> getting the pid of the process. It uses pidof to implement currently, it
> may also use the pidfile or ps to implement in the future.
> 
> Signed-off-by: Robert Yang <liezhi.yang@windriver.com>
> ---
>  .../initscripts/initscripts-1.0/functions          |   32 ++++++++++++++++++-
>  1 files changed, 30 insertions(+), 2 deletions(-)
> 
> diff --git a/meta/recipes-core/initscripts/initscripts-1.0/functions b/meta/recipes-core/initscripts/initscripts-1.0/functions
> index 689fd32..6a51b3b 100644
> --- a/meta/recipes-core/initscripts/initscripts-1.0/functions
> +++ b/meta/recipes-core/initscripts/initscripts-1.0/functions
> @@ -4,11 +4,39 @@
>  #               shell scripts in the /etc/init.d directory.
>  #
>  
> +# NOTE: The pidofproc () doesn't support the process which is a script unless
> +#       the pidof supports "-x" option. If you want to use it for such a
> +#       process:
> +#       1) If there is no "pidof -x", replace the "pidof $1" with another
> +#          command like(for core-image-minimal):
> +#            ps | awk '/'"$1"'/ {print $1}'
> +#       Or
> +#       2) If there is "pidof -x", replace "pidof" with "pidof -x".

Please document the variables to newly created functions, for shell
functions, something like:

# pidofproc - print the pid of a process
# $1: the name of the process

> +pidofproc () {
> +        local pid status

This patch uses 8 spaces to indent while the existing file uses 4. The
state of shell script whitespace in the repository is a bit of a
disaster. We can't really go through it all and just correct it for the
sake of consistent whitespace, but when modifying shell scripts, please
do the following:

1) Cleanup the whitespace in the affected file
   Do this before making functional changes to it and submit the
   cleanup as a separate patch.
2) Indent with tabs
3) Do not indent the cases in a case block


> +
> +        status=0
> +        # pidof output null when no program is running, so no "2>/dev/null".
> +        pid=`pidof $1` || status=$?
> +        case $status in

The following is just my opinion, you may ignore it if you disagree:

I find the "do_this || die" syntax to be awkward, and have seen it lead
to non-intuitive errors. For testing the success of a command, consider
removing the status variable and using:

pid=$(pidof $1)
case $? in



> +          0)
> +                echo $pid
> +                return 0
> +                ;;
> +          127)
> +                echo "ERROR: command pidof not found" >&2
> +                exit 127
> +                ;;
> +          *)
> +                return $status
> +                ;;
> +        esac
> +}
> +
>  machine_id() {		# return the machine ID
>      awk 'BEGIN { FS=": " } /Hardware/ { gsub(" ", "_", $2); print tolower($2) } ' </proc/cpuinfo
>  }
>  
>  killproc() {		# kill the named process(es)
> -    pid=`/bin/pidof $1`
> -    [ "$pid" != "" ] && kill $pid
> +    pid=`pidofproc $1` && kill $pid
>  }

-- 
Darren Hart
Intel Open Source Technology Center
Yocto Project - Linux Kernel

V2 [PATCH 3/3] Add a skeleton for init scripts

[Robert Yang]

Add a skeleton for init scripts, the original structure is from
/etc/init.d/skeleton of Ubuntu 10.10, it is in sysvinit_2.87dsf, so add
the COPYRIGHT(GPLv2) of sysvinit_2.87dsf. Modified the original skeleton
a lot to make it as easy as possible, just use posix shell command, and
have tested it with core-image-minimal.

* The skeleton implements the following actions:
  - start, stop, restart, status, try-restart and force-reload.
    # force-reload is a alias of try-restart.

  - not implements reload, since only a few programs have it, just leave
    it as placeholder.

* Add /usr/sbin/skeleton-test to test /etc/init.d/skeleton

* The /etc/init.d/skeleton can be run and output the example messages:
  1) #./skeleton start (test start)
     Starting skeleton ...

  2) #./skeleton start (test start again when running)
     skeleton already running (1078).

  3) #./skeleton status (test status when running)
     skeleton is running (1078).

  4) #./skeleton stop (test stop)
     Stopped skeleton (1078).

  5) #./skeleton stop (test stop again)
     skeleton is not running; none killed.

  6) #./skeleton status (test status when stopped)
     skeleton is not running.

  7) #./skeleton restart (test restart when running)
     Stopped skeleton (1128).
     Starting skeleton ...

  8) #./skeleton restart (test restart when stopped)
     skeleton is not running; none killed.
     Starting skeleton ...

  9)  try-restart (or force-reload) means restart the service if the
      service is already running

     #./skeleton try-restart (test try-restart when stopped)
     skeleton is not running; none killed.

     #./skeleton try-restart (test try-restart when running)
      Stopped skeleton (1181).
      Starting skeleton ...

* Have used syslogd to test it in a real world(with both
  core-image-minimal and core-image-sato)

Signed-off-by: Robert Yang <liezhi.yang@windriver.com>
---
 .../recipes-skeleton/service/service/COPYRIGHT     |   15 ++
 .../recipes-skeleton/service/service/skeleton      |  193 ++++++++++++++++++++
 .../service/service/skeleton_test.c                |   11 +
 .../recipes-skeleton/service/service_0.1.bb        |   32 ++++
 4 files changed, 251 insertions(+), 0 deletions(-)
 create mode 100644 meta-skeleton/recipes-skeleton/service/service/COPYRIGHT
 create mode 100644 meta-skeleton/recipes-skeleton/service/service/skeleton
 create mode 100644 meta-skeleton/recipes-skeleton/service/service/skeleton_test.c
 create mode 100644 meta-skeleton/recipes-skeleton/service/service_0.1.bb

diff --git a/meta-skeleton/recipes-skeleton/service/service/COPYRIGHT b/meta-skeleton/recipes-skeleton/service/service/COPYRIGHT
new file mode 100644
index 0000000..ec3e171
--- /dev/null
+++ b/meta-skeleton/recipes-skeleton/service/service/COPYRIGHT
@@ -0,0 +1,15 @@
+Sysvinit is Copyright (C) 1991-2004 Miquel van Smoorenburg
+
+    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; if not, write to the Free Software
+    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
diff --git a/meta-skeleton/recipes-skeleton/service/service/skeleton b/meta-skeleton/recipes-skeleton/service/service/skeleton
new file mode 100644
index 0000000..888f9a0
--- /dev/null
+++ b/meta-skeleton/recipes-skeleton/service/service/skeleton
@@ -0,0 +1,193 @@
+#! /bin/sh
+### BEGIN INIT INFO
+# Provides:          skeleton
+# Required-Start:    $local_fs
+# Should-Start:
+# Required-Stop:     $local_fs
+# Should-Stop:
+# Default-Start:     2 3 4 5
+# Default-Stop:      0 1 6
+# Short-Description: Example initscript
+# Description:       This file should be used to construct scripts to be
+#                    placed in /etc/init.d
+### END INIT INFO
+
+# The definition of actions: (From LSB 3.1.0)
+# start         start the service
+# stop          stop the service
+# restart       stop and restart the service if the service is already running,
+#               otherwise start the service
+# try-restart	restart the service if the service is already running
+# reload	cause the configuration of the service to be reloaded without
+#               actually stopping and restarting the service
+# force-reload	cause the configuration to be reloaded if the service supports
+#               this, otherwise restart the service if it is running
+# status	print the current status of the service
+
+# The start, stop, restart, force-reload, and status actions shall be supported
+# by all init scripts; the reload and the try-restart actions are optional
+
+# Common steps to convert this skeleton into a real init script
+# 1) cp skeleton <the_real_name>
+# 2) Set DESC and NAME
+# 3) Check whether the daemon app is /usr/sbin/$NAME, if not, set it.
+# 4) Set DAEMON_ARGS if there is any
+# 5) Remove the useless code
+
+# NOTE: The skeleton doesn't support the daemon which is a script unless the
+#       pidof supports "-x" option, please see more comments for pidofproc ()
+#       in /etc/init.d/functions
+
+# PATH should only include /usr/* if it runs after the mountnfs.sh script
+PATH=/sbin:/usr/sbin:/bin:/usr/bin
+
+DESC="skeleton"
+NAME="skeleton-test"
+DAEMON=/usr/sbin/$NAME
+DAEMON_ARGS=""
+PIDFILE=/var/run/$NAME.pid
+
+. /etc/init.d/functions || exit 1
+
+# Exit if the package is not installed
+[ -x "$DAEMON" ] || exit 0
+
+# Read configuration variable file if it is present
+[ -r /etc/default/$NAME ] && . /etc/default/$NAME
+
+#
+# Function that starts the daemon/service
+#
+do_start() {
+	local status pid
+
+	status=0
+	pid=`pidofproc $NAME` || status=$?
+	case $status in
+	  0)
+		echo "$DESC already running ($pid)."
+		exit 1
+		;;
+	  *)
+		echo "Starting $DESC ..."
+		exec $DAEMON $DAEMON_ARGS >/dev/null 2>&1 || status=$?
+		echo "ERROR: Failed to start $DESC."
+		exit $status
+		;;
+	esac
+
+	# Add code here, if necessary, that waits for the process to be ready
+	# to handle requests from services started subsequently which depend
+	# on this one.  As a last resort, sleep for some time.
+}
+
+#
+# Function that stops the daemon/service
+#
+do_stop() {
+	local pid status
+
+	status=0
+	pid=`pidofproc $NAME` || status=$?
+	case $status in
+	  0)
+		# Exit when fail to stop, the kill would complain when fail
+		kill -s 15 $pid >/dev/null && rm -f $PIDFILE && \
+			echo "Stopped $DESC ($pid)." || exit $?
+		;;
+	  *)
+		echo "$DESC is not running; none killed." >&2
+		;;
+	esac
+
+	# Wait for children to finish too if this is a daemon that forks
+	# and if the daemon is only ever run from this initscript.
+	# If the above conditions are not satisfied then add some other code
+	# that waits for the process to drop all resources that could be
+	# needed by services started subsequently.  A last resort is to
+	# sleep for some time.
+	return $status
+}
+
+#
+# Function that sends a SIGHUP to the daemon/service
+#
+do_reload() {
+	local pid status
+
+	status=0
+        # If the daemon can reload its configuration without
+        # restarting (for example, when it is sent a SIGHUP),
+        # then implement that here.
+	pid=`pidofproc $NAME` || status=$?
+	case $status in
+	  0)
+		echo "Reloading $DESC ..."
+		kill -s 1 $pid || exit $?
+		;;
+	  *)
+		echo "$DESC is not running; none reloaded." >&2
+		;;
+	esac
+	exit $status
+}
+
+
+#
+# Function that shows the daemon/service status
+#
+status_of_proc () {
+	local pid status
+
+	status=0
+	# pidof output null when no program is running, so no "2>/dev/null".
+	pid=`pidofproc $NAME` || status=$?
+	case $status in
+	  0)
+		echo "$DESC is running ($pid)."
+		exit 0
+		;;
+	  *)
+		echo "$DESC is not running." >&2
+		exit $status
+		;;
+	esac
+}
+
+case "$1" in
+  start)
+	do_start
+	;;
+  stop)
+	do_stop || exit $?
+	;;
+  status)
+	status_of_proc
+	;;
+  restart)
+	# Always start the service regardless the status of do_stop
+	do_stop
+	do_start
+	;;
+  try-restart|force-reload)
+	# force-reload is the same as reload or try-restart according
+	# to it's definition, the reload is not implented here, so
+	# force-reload is the alias of try-restart here, but it should
+	# be the alias of reload if reload is implemented.
+	#
+	# Only start the service when do_stop successfully
+	do_stop && do_start
+	;;
+  #reload)
+	# If the "reload" action is implemented properly, then let the
+	# force-reload be the alias of reload, and remove it from
+	# try-restart|force-reload)
+	#
+	#do_reload
+	#;;
+  *)
+	echo "Usage: $0 {start|stop|status|restart|try-restart|force-reload}" >&2
+	exit 3
+	;;
+esac
+
diff --git a/meta-skeleton/recipes-skeleton/service/service/skeleton_test.c b/meta-skeleton/recipes-skeleton/service/service/skeleton_test.c
new file mode 100644
index 0000000..465d430
--- /dev/null
+++ b/meta-skeleton/recipes-skeleton/service/service/skeleton_test.c
@@ -0,0 +1,11 @@
+#include <unistd.h>
+
+/* This demo does nothing except for testing /etc/init.d/skeleton */
+
+int
+main () {
+	daemon (0, 0);
+	while (1) {
+		sleep (1);
+	}
+}
diff --git a/meta-skeleton/recipes-skeleton/service/service_0.1.bb b/meta-skeleton/recipes-skeleton/service/service_0.1.bb
new file mode 100644
index 0000000..22137a5
--- /dev/null
+++ b/meta-skeleton/recipes-skeleton/service/service_0.1.bb
@@ -0,0 +1,32 @@
+DESCRIPTION = "The canonical example of init scripts"
+SECTION = "base"
+LICENSE = "GPLv2"
+LIC_FILES_CHKSUM = "file://${WORKDIR}/COPYRIGHT;md5=349c872e0066155e1818b786938876a4"
+RDEPENDS_${PN} = "initscripts"
+PR = "r0"
+
+SRC_URI = "file://skeleton \
+	   file://skeleton_test.c \
+	   file://COPYRIGHT \
+	   "
+
+CONFFILES_${PN} += "${sysconfdir}/init.d/skeleton"
+
+do_compile () {
+	${CC} ${WORKDIR}/skeleton_test.c -o ${WORKDIR}/skeleton-test
+}
+
+do_install () {
+	install -d ${D}${sysconfdir}/init.d
+	cat ${WORKDIR}/skeleton | \
+	  sed -e 's,/etc,${sysconfdir},g' \
+	      -e 's,/usr/sbin,${sbindir},g' \
+	      -e 's,/var,${localstatedir},g' \
+	      -e 's,/usr/bin,${bindir},g' \
+	      -e 's,/usr,${prefix},g' > ${D}${sysconfdir}/init.d/skeleton
+	chmod a+x ${D}${sysconfdir}/init.d/skeleton
+
+	install -d ${D}${sbindir}
+	install -m 0755 ${WORKDIR}/skeleton-test ${D}${sbindir}/
+}
+
-- 
1.7.1

Re: V2 [PATCH 3/3] Add a skeleton for init scripts

[Darren Hart]

On 05/16/2011 08:19 AM, Robert Yang wrote:
> Add a skeleton for init scripts, the original structure is from
> /etc/init.d/skeleton of Ubuntu 10.10, it is in sysvinit_2.87dsf, so add
> the COPYRIGHT(GPLv2) of sysvinit_2.87dsf. Modified the original skeleton
> a lot to make it as easy as possible, just use posix shell command, and
> have tested it with core-image-minimal.
> 
> * The skeleton implements the following actions:
>   - start, stop, restart, status, try-restart and force-reload.
>     # force-reload is a alias of try-restart.
> 
>   - not implements reload, since only a few programs have it, just leave
>     it as placeholder.
> 
> * Add /usr/sbin/skeleton-test to test /etc/init.d/skeleton
> 
> * The /etc/init.d/skeleton can be run and output the example messages:
>   1) #./skeleton start (test start)
>      Starting skeleton ...
> 
>   2) #./skeleton start (test start again when running)
>      skeleton already running (1078).
> 
>   3) #./skeleton status (test status when running)
>      skeleton is running (1078).
> 
>   4) #./skeleton stop (test stop)
>      Stopped skeleton (1078).
> 
>   5) #./skeleton stop (test stop again)
>      skeleton is not running; none killed.
> 
>   6) #./skeleton status (test status when stopped)
>      skeleton is not running.
> 
>   7) #./skeleton restart (test restart when running)
>      Stopped skeleton (1128).
>      Starting skeleton ...
> 
>   8) #./skeleton restart (test restart when stopped)
>      skeleton is not running; none killed.
>      Starting skeleton ...
> 
>   9)  try-restart (or force-reload) means restart the service if the
>       service is already running
> 
>      #./skeleton try-restart (test try-restart when stopped)
>      skeleton is not running; none killed.
> 
>      #./skeleton try-restart (test try-restart when running)
>       Stopped skeleton (1181).
>       Starting skeleton ...
> 
> * Have used syslogd to test it in a real world(with both
>   core-image-minimal and core-image-sato)
> 
> Signed-off-by: Robert Yang <liezhi.yang@windriver.com>
> ---
>  .../recipes-skeleton/service/service/COPYRIGHT     |   15 ++
>  .../recipes-skeleton/service/service/skeleton      |  193 ++++++++++++++++++++
>  .../service/service/skeleton_test.c                |   11 +
>  .../recipes-skeleton/service/service_0.1.bb        |   32 ++++
>  4 files changed, 251 insertions(+), 0 deletions(-)
>  create mode 100644 meta-skeleton/recipes-skeleton/service/service/COPYRIGHT
>  create mode 100644 meta-skeleton/recipes-skeleton/service/service/skeleton
>  create mode 100644 meta-skeleton/recipes-skeleton/service/service/skeleton_test.c
>  create mode 100644 meta-skeleton/recipes-skeleton/service/service_0.1.bb
> 
> diff --git a/meta-skeleton/recipes-skeleton/service/service/COPYRIGHT b/meta-skeleton/recipes-skeleton/service/service/COPYRIGHT
> new file mode 100644
> index 0000000..ec3e171
> --- /dev/null
> +++ b/meta-skeleton/recipes-skeleton/service/service/COPYRIGHT
> @@ -0,0 +1,15 @@
> +Sysvinit is Copyright (C) 1991-2004 Miquel van Smoorenburg
> +
> +    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; if not, write to the Free Software
> +    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
> diff --git a/meta-skeleton/recipes-skeleton/service/service/skeleton b/meta-skeleton/recipes-skeleton/service/service/skeleton
> new file mode 100644
> index 0000000..888f9a0
> --- /dev/null
> +++ b/meta-skeleton/recipes-skeleton/service/service/skeleton
> @@ -0,0 +1,193 @@
> +#! /bin/sh
> +### BEGIN INIT INFO
> +# Provides:          skeleton
> +# Required-Start:    $local_fs
> +# Should-Start:
> +# Required-Stop:     $local_fs
> +# Should-Stop:
> +# Default-Start:     2 3 4 5
> +# Default-Stop:      0 1 6
> +# Short-Description: Example initscript
> +# Description:       This file should be used to construct scripts to be
> +#                    placed in /etc/init.d
> +### END INIT INFO
> +
> +# The definition of actions: (From LSB 3.1.0)
> +# start         start the service
> +# stop          stop the service
> +# restart       stop and restart the service if the service is already running,
> +#               otherwise start the service
> +# try-restart	restart the service if the service is already running
> +# reload	cause the configuration of the service to be reloaded without
> +#               actually stopping and restarting the service
> +# force-reload	cause the configuration to be reloaded if the service supports
> +#               this, otherwise restart the service if it is running
> +# status	print the current status of the service
> +
> +# The start, stop, restart, force-reload, and status actions shall be supported
> +# by all init scripts; the reload and the try-restart actions are optional
> +
> +# Common steps to convert this skeleton into a real init script
> +# 1) cp skeleton <the_real_name>
> +# 2) Set DESC and NAME
> +# 3) Check whether the daemon app is /usr/sbin/$NAME, if not, set it.
> +# 4) Set DAEMON_ARGS if there is any
> +# 5) Remove the useless code
> +
> +# NOTE: The skeleton doesn't support the daemon which is a script unless the
> +#       pidof supports "-x" option, please see more comments for pidofproc ()
> +#       in /etc/init.d/functions
> +
> +# PATH should only include /usr/* if it runs after the mountnfs.sh script
> +PATH=/sbin:/usr/sbin:/bin:/usr/bin
> +
> +DESC="skeleton"
> +NAME="skeleton-test"
> +DAEMON=/usr/sbin/$NAME
> +DAEMON_ARGS=""
> +PIDFILE=/var/run/$NAME.pid
> +
> +. /etc/init.d/functions || exit 1
> +
> +# Exit if the package is not installed
> +[ -x "$DAEMON" ] || exit 0
> +
> +# Read configuration variable file if it is present
> +[ -r /etc/default/$NAME ] && . /etc/default/$NAME
> +
> +#
> +# Function that starts the daemon/service
> +#
> +do_start() {
> +	local status pid
> +
> +	status=0
> +	pid=`pidofproc $NAME` || status=$?
> +	case $status in
> +	  0)


Don't indent cases from the outer case block


> +		echo "$DESC already running ($pid)."
> +		exit 1
> +		;;
> +	  *)
> +		echo "Starting $DESC ..."
> +		exec $DAEMON $DAEMON_ARGS >/dev/null 2>&1 || status=$?
> +		echo "ERROR: Failed to start $DESC."
> +		exit $status
> +		;;
> +	esac
> +
> +	# Add code here, if necessary, that waits for the process to be ready
> +	# to handle requests from services started subsequently which depend
> +	# on this one.  As a last resort, sleep for some time.
> +}
> +
> +#
> +# Function that stops the daemon/service
> +#
> +do_stop() {
> +	local pid status
> +
> +	status=0
> +	pid=`pidofproc $NAME` || status=$?
> +	case $status in
> +	  0)


Same.


> +		# Exit when fail to stop, the kill would complain when fail
> +		kill -s 15 $pid >/dev/null && rm -f $PIDFILE && \
> +			echo "Stopped $DESC ($pid)." || exit $?
> +		;;
> +	  *)
> +		echo "$DESC is not running; none killed." >&2
> +		;;
> +	esac
> +
> +	# Wait for children to finish too if this is a daemon that forks
> +	# and if the daemon is only ever run from this initscript.
> +	# If the above conditions are not satisfied then add some other code
> +	# that waits for the process to drop all resources that could be
> +	# needed by services started subsequently.  A last resort is to
> +	# sleep for some time.
> +	return $status
> +}
> +
> +#
> +# Function that sends a SIGHUP to the daemon/service
> +#
> +do_reload() {
> +	local pid status
> +
> +	status=0
> +        # If the daemon can reload its configuration without
> +        # restarting (for example, when it is sent a SIGHUP),
> +        # then implement that here.
> +	pid=`pidofproc $NAME` || status=$?
> +	case $status in
> +	  0)


Same


> +		echo "Reloading $DESC ..."
> +		kill -s 1 $pid || exit $?
> +		;;
> +	  *)
> +		echo "$DESC is not running; none reloaded." >&2
> +		;;
> +	esac
> +	exit $status
> +}
> +
> +
> +#
> +# Function that shows the daemon/service status
> +#
> +status_of_proc () {
> +	local pid status
> +
> +	status=0
> +	# pidof output null when no program is running, so no "2>/dev/null".
> +	pid=`pidofproc $NAME` || status=$?
> +	case $status in
> +	  0)


Same


> +		echo "$DESC is running ($pid)."
> +		exit 0
> +		;;
> +	  *)
> +		echo "$DESC is not running." >&2
> +		exit $status
> +		;;
> +	esac
> +}
> +
> +case "$1" in
> +  start)


Same


> +	do_start
> +	;;
> +  stop)
> +	do_stop || exit $?
> +	;;
> +  status)
> +	status_of_proc
> +	;;
> +  restart)
> +	# Always start the service regardless the status of do_stop


of the status


> +	do_stop
> +	do_start
> +	;;
> +  try-restart|force-reload)
> +	# force-reload is the same as reload or try-restart according
> +	# to it's definition, the reload is not implented here, so


typo: should be "its", possessive pronoun, no apostrophe

typo: should be "implemented"


> +	# force-reload is the alias of try-restart here, but it should
> +	# be the alias of reload if reload is implemented.
> +	#
> +	# Only start the service when do_stop successfully


successfully -> succeeds


> +	do_stop && do_start
> +	;;
> +  #reload)
> +	# If the "reload" action is implemented properly, then let the
> +	# force-reload be the alias of reload, and remove it from
> +	# try-restart|force-reload)
> +	#
> +	#do_reload
> +	#;;
> +  *)
> +	echo "Usage: $0 {start|stop|status|restart|try-restart|force-reload}" >&2
> +	exit 3
> +	;;
> +esac
> +
> diff --git a/meta-skeleton/recipes-skeleton/service/service/skeleton_test.c b/meta-skeleton/recipes-skeleton/service/service/skeleton_test.c
> new file mode 100644
> index 0000000..465d430
> --- /dev/null
> +++ b/meta-skeleton/recipes-skeleton/service/service/skeleton_test.c
> @@ -0,0 +1,11 @@
> +#include <unistd.h>
> +
> +/* This demo does nothing except for testing /etc/init.d/skeleton */
> +
> +int
> +main () {
> +	daemon (0, 0);
> +	while (1) {
> +		sleep (1);
> +	}
> +}
> diff --git a/meta-skeleton/recipes-skeleton/service/service_0.1.bb b/meta-skeleton/recipes-skeleton/service/service_0.1.bb
> new file mode 100644
> index 0000000..22137a5
> --- /dev/null
> +++ b/meta-skeleton/recipes-skeleton/service/service_0.1.bb
> @@ -0,0 +1,32 @@
> +DESCRIPTION = "The canonical example of init scripts"
> +SECTION = "base"
> +LICENSE = "GPLv2"
> +LIC_FILES_CHKSUM = "file://${WORKDIR}/COPYRIGHT;md5=349c872e0066155e1818b786938876a4"
> +RDEPENDS_${PN} = "initscripts"
> +PR = "r0"
> +
> +SRC_URI = "file://skeleton \
> +	   file://skeleton_test.c \
> +	   file://COPYRIGHT \
> +	   "
> +
> +CONFFILES_${PN} += "${sysconfdir}/init.d/skeleton"
> +
> +do_compile () {
> +	${CC} ${WORKDIR}/skeleton_test.c -o ${WORKDIR}/skeleton-test
> +}
> +
> +do_install () {
> +	install -d ${D}${sysconfdir}/init.d
> +	cat ${WORKDIR}/skeleton | \
> +	  sed -e 's,/etc,${sysconfdir},g' \
> +	      -e 's,/usr/sbin,${sbindir},g' \
> +	      -e 's,/var,${localstatedir},g' \
> +	      -e 's,/usr/bin,${bindir},g' \
> +	      -e 's,/usr,${prefix},g' > ${D}${sysconfdir}/init.d/skeleton
> +	chmod a+x ${D}${sysconfdir}/init.d/skeleton
> +
> +	install -d ${D}${sbindir}
> +	install -m 0755 ${WORKDIR}/skeleton-test ${D}${sbindir}/
> +}
> +

-- 
Darren Hart
Intel Open Source Technology Center
Yocto Project - Linux Kernel

Re: V2 [PATCH 0/3] Add meta-skeleton and a skeleton for init scripts

[Darren Hart]

On 05/16/2011 08:18 AM, Robert Yang wrote:
> Changes of V2:
>   * Add the definition of actions to the comment area in skeleton
>   * Implement try-restart and force-reload according to their definitions
>   * Replace start-stop-daemon with "exec $DAEMON ..." to make it more easier
>     to control the output message, so that we would not depend on the output
>     of start-stop-daemon


What was the motivation for this change? We don't want to veer to far
from what people are accustomed to using as this will increase the
amount of work to maintain the initscripts that we reuse from packages.


>   * Output simple and uniform messages


While I support this (and asked for it), if we have to rewrite more or
less standard infrastructure to do it, then we probably should just live
with it.

Thoughts?


>   * Move the function pidofproc () to ${sysconfdir}/init.d/functions and
>     declare that it can't get the pid of a script unless pidof supports "-x".
>   * Add /usr/sbin/skeleton-test to make /etc/init.d/skeleton can be run by
>     default.
> 
> Pull URL: git://git.pokylinux.org/poky-contrib.git
>   Branch: robert/init_scripts
>   Browse: http://git.pokylinux.org/cgit.cgi/poky-contrib/log/?h=robert/init_scripts


Thanks Robert, some more comments inline with the patches.

--
Darren

> 
> Thanks,
>     Robert Yang <liezhi.yang@windriver.com>
> ---
> 
> 
> Robert Yang (3):
>   Add the layer meta-skeleton
>   Add pidofproc to ${sysconfdir}/init.d/functions
>   Add a skeleton for init scripts
> 
>  meta-skeleton/conf/layer.conf                      |   10 +
>  .../recipes-skeleton/service/service/COPYRIGHT     |   15 ++
>  .../recipes-skeleton/service/service/skeleton      |  193 ++++++++++++++++++++
>  .../service/service/skeleton_test.c                |   11 +
>  .../recipes-skeleton/service/service_0.1.bb        |   32 ++++
>  .../initscripts/initscripts-1.0/functions          |   32 +++-
>  6 files changed, 291 insertions(+), 2 deletions(-)
>  create mode 100644 meta-skeleton/conf/layer.conf
>  create mode 100644 meta-skeleton/recipes-skeleton/service/service/COPYRIGHT
>  create mode 100644 meta-skeleton/recipes-skeleton/service/service/skeleton
>  create mode 100644 meta-skeleton/recipes-skeleton/service/service/skeleton_test.c
>  create mode 100644 meta-skeleton/recipes-skeleton/service/service_0.1.bb
> 

-- 
Darren Hart
Intel Open Source Technology Center
Yocto Project - Linux Kernel

Re: V2 [PATCH 0/3] Add meta-skeleton and a skeleton for init scripts

[Robert Yang]

On 05/17/2011 01:46 AM, Darren Hart wrote:
>
>
> On 05/16/2011 08:18 AM, Robert Yang wrote:
>> Changes of V2:
>>    * Add the definition of actions to the comment area in skeleton
>>    * Implement try-restart and force-reload according to their definitions
>>    * Replace start-stop-daemon with "exec $DAEMON ..." to make it more easier
>>      to control the output message, so that we would not depend on the output
>>      of start-stop-daemon
>
>
> What was the motivation for this change? We don't want to veer to far
> from what people are accustomed to using as this will increase the
> amount of work to maintain the initscripts that we reuse from packages.
>

Hi Darren,

Thank you for your detailed review, the disadvantages of use start-stop-daemon:
1) The different version of start-stop-daemon output different messages, for
    example, the output in yocto is different from Ubuntu 10.10.

2) Its output is not uniform, for example:
    - If the daemon is running and do_start:
      $DAEMON already running.
      $PID
    - If the daemon is running and do_stop:
      Stopped $NAME ($PID).
    - If the daemon is not running and do_stop:
      No $NAME found running; none killed.

    We can see that it uses either $DAEMON(e.g., /usr/sbin/skeleton) or
    $NAME(e.g., skeleton). If we want to use start-stop-daemon, we have two
    solutions:
    - Patch start_stop_daemon.c in busybox, but other programs may depend on
      the output of start-stop-daemon.
    - Use awk, sed and pipe(|) to format its output, but as Richard suggested
      that we should try to avoid the fork.

3) While I'm looking into start_stop_daemon.c, it ran "exec ( ... )"  and
    "kill ( ... )" when start and stop a daemon after some additional checks,
    not all these checks are needed by us for we are in embedded systems. So
    use "exec" and "kill" is faster than start-stop-daemon.

I think that a better solution is do much work on start_stop_daemon.c, so
that we can have our start-stop-daemon, maybe we can do it on another case?

Thanks
// Robert

>
>>    * Output simple and uniform messages
>
>
> While I support this (and asked for it), if we have to rewrite more or
> less standard infrastructure to do it, then we probably should just live
> with it.
>
> Thoughts?
>
>
>>    * Move the function pidofproc () to ${sysconfdir}/init.d/functions and
>>      declare that it can't get the pid of a script unless pidof supports "-x".
>>    * Add /usr/sbin/skeleton-test to make /etc/init.d/skeleton can be run by
>>      default.
>>
>> Pull URL: git://git.pokylinux.org/poky-contrib.git
>>    Branch: robert/init_scripts
>>    Browse: http://git.pokylinux.org/cgit.cgi/poky-contrib/log/?h=robert/init_scripts
>
>
> Thanks Robert, some more comments inline with the patches.
>
> --
> Darren
>
>>
>> Thanks,
>>      Robert Yang<liezhi.yang@windriver.com>
>> ---
>>
>>
>> Robert Yang (3):
>>    Add the layer meta-skeleton
>>    Add pidofproc to ${sysconfdir}/init.d/functions
>>    Add a skeleton for init scripts
>>
>>   meta-skeleton/conf/layer.conf                      |   10 +
>>   .../recipes-skeleton/service/service/COPYRIGHT     |   15 ++
>>   .../recipes-skeleton/service/service/skeleton      |  193 ++++++++++++++++++++
>>   .../service/service/skeleton_test.c                |   11 +
>>   .../recipes-skeleton/service/service_0.1.bb        |   32 ++++
>>   .../initscripts/initscripts-1.0/functions          |   32 +++-
>>   6 files changed, 291 insertions(+), 2 deletions(-)
>>   create mode 100644 meta-skeleton/conf/layer.conf
>>   create mode 100644 meta-skeleton/recipes-skeleton/service/service/COPYRIGHT
>>   create mode 100644 meta-skeleton/recipes-skeleton/service/service/skeleton
>>   create mode 100644 meta-skeleton/recipes-skeleton/service/service/skeleton_test.c
>>   create mode 100644 meta-skeleton/recipes-skeleton/service/service_0.1.bb
>>
>