FTPD daemon and example now build without errors

git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@4371 42af7a65-404d-4744-a932-0658087f49c3
This commit is contained in:
patacongo 2012-02-05 17:36:13 +00:00
parent 200c32b3c6
commit 5c43eed652
10 changed files with 568 additions and 469 deletions

View File

@ -282,7 +282,15 @@ examples/ftpd
configuration if the network is configuration prior to running the
example.
If CONFIG_EXAMPELS_FTPD_NONETINIT is not defined, then the following may
NSH always initializes the network so if CONFIG_NSH_BUILTIN_APPS is
defined, so is CONFIG_EXAMPLES_FTPD_NONETINIT (se it does not explicitly
need to be defined in that case):
CONFIG_NSH_BUILTIN_APPS - Build the FTPD daemon example test as an
NSH built-in function. By default the FTPD daemon will be built
as a standalone application.
If CONFIG_EXAMPLES_FTPD_NONETINIT is not defined, then the following may
be specified to customized the network configuration:
CONFIG_EXAMPLE_FTPD_NOMAC - If the hardware has no MAC address of its
@ -292,6 +300,25 @@ examples/ftpd
10.0.0.1
CONFIG_EXAMPLE_FTPD_NETMASK - The network mask. Default: 255.255.255.0
Other required configuration settings: Of course TCP networking support
is required. But here are a couple that are less obvious:
CONFIG_DISABLE_PTHREAD - pthread support is required
CONFIG_DISABLE_POLL - poll() support is required
Other FTPD configuration options thay may be of interest:
CONFIG_FTPD_VENDORID - The vendor name to use in FTP communications.
Default: "NuttX"
CONFIG_FTPD_SERVERID - The server name to use in FTP communications.
Default: "NuttX FTP Server"
CONFIG_FTPD_CMDBUFFERSIZE - The maximum size of one command. Default:
512 bytes.
CONFIG_FTPD_DATABUFFERSIZE - The size of the I/O buffer for data
transfers. Default: 2048 bytes.
CONFIG_FTPD_WORKERSTACKSIZE - The stacksize to allocate for each
FTP daemon worker thread. Default: 2048 bytes.
The appconfig file (apps/.config) should include:
CONFIGURED_APPS += examples/ftpd

View File

@ -56,12 +56,6 @@ endif
ROOTDEPPATH = --dep-path .
# Buttons built-in application info
APPNAME = ftpd
PRIORITY = SCHED_PRIORITY_DEFAULT
STACKSIZE = 2048
# Common build
VPATH =
@ -84,7 +78,8 @@ $(COBJS): %$(OBJEXT): %.c
.context:
ifeq ($(CONFIG_NSH_BUILTIN_APPS),y)
$(call REGISTER,$(APPNAME),$(PRIORITY),$(STACKSIZE),$(APPNAME)_main)
$(call REGISTER,ftpd_start,SCHED_PRIORITY_DEFAULT,2048,ftpd_start)
$(call REGISTER,ftpd_stop,SCHED_PRIORITY_DEFAULT,2048,ftpd_stop)
@touch $@
endif

View File

@ -35,6 +35,16 @@
#ifndef __APPS_EXAMPLES_FTPD_FTPD_H
#define __APPS_EXAMPLES_FTPD_FTPD_H
/****************************************************************************
* Pre-processor Definitions
****************************************************************************/
#include <nuttx/config.h>
#include <stdint.h>
#include <stdbool.h>
#include <stdlib.h>
/****************************************************************************
* Pre-processor Definitions
****************************************************************************/
@ -48,7 +58,7 @@
* configuration if the network is configuration prior to running the
* example.
*
* If CONFIG_EXAMPELS_FTPD_NONETINIT is not defined, then the following may
* If CONFIG_EXAMPLES_FTPD_NONETINIT is not defined, then the following may
* be specified to customized the network configuration:
*
* CONFIG_EXAMPLE_FTPD_NOMAC - If the hardware has no MAC address of its
@ -75,21 +85,33 @@
# define CONFIG_EXAMPLES_FTPD_CLIENTSTACKSIZE 2048
#endif
/* NSH always initializes the network */
#if defined(CONFIG_NSH_BUILTIN_APPS) && !defined(CONFIG_EXAMPLES_FTPD_NONETINIT)
# define CONFIG_EXAMPLES_FTPD_NONETINIT 1
#endif
#ifdef CONFIG_EXAMPLES_FTPD_NONETINIT
# undef CONFIG_EXAMPLE_FTPD_IPADDR
# undef CONFIG_EXAMPLE_FTPD_DRIPADDR
# undef CONFIG_EXAMPLE_FTPD_NETMASK
#else
# ifndef CONFIG_EXAMPLE_FTPD_IPADDR
# define CONFIG_EXAMPLE_FTPD_IPADDR 0x0a000002
# endif
# ifndef CONFIG_EXAMPLE_FTPD_DRIPADDR
# define CONFIG_EXAMPLE_FTPD_DRIPADDR 0x0a000002
# define CONFIG_EXAMPLE_FTPD_DRIPADDR 0x0a000001
# endif
# ifndef CONFIG_EXAMPLE_FTPD_NETMASK
# define CONFIG_EXAMPLE_FTPD_NETMASK 0xffffff00
# endif
#endif
/* Is this being built as an NSH built-in application? */
#ifdef CONFIG_NSH_BUILTIN_APPS
# define MAIN_NAME ftpd_main
# define MAIN_STRING "ftpd_main: "
# define MAIN_NAME ftpd_start
# define MAIN_STRING "ftpd_start: "
#else
# define MAIN_NAME user_start
# define MAIN_STRING "user_start: "
@ -99,6 +121,8 @@
* Public Types
****************************************************************************/
/* This structure describes one entry in a table of accounts */
struct fptd_account_s
{
uint8_t flags;
@ -107,17 +131,34 @@ struct fptd_account_s
FAR const char *home;
};
/* To minimize the probability of name collisitions, all FTPD example
* global data is maintained in single structure.
*/
struct ftpd_globals_s
{
bool initialized;
volatile bool stop;
bool initialized; /* True: Networking is initialized. The
* network must be initialized only once.
*/
#ifdef CONFIG_NSH_BUILTIN_APPS
volatile bool stop; /* True: Request daemon to exit */
volatile bool running; /* True: The daemon is running */
#endif
pid_t pid; /* Task ID of the FTPD daemon. The value
* -1 is a redundant indication that the
* daemon is not running.
*/
};
/****************************************************************************
* Public Function Prototypes
****************************************************************************/
extern struct ftpd_globls_s g_ftpdglobls;
/* To minimize the probability of name collisitions, all FTPD example
* global data is maintained in a single instance of a structure.
*/
extern struct ftpd_globals_s g_ftpdglob;
/****************************************************************************
* Public Function Prototypes

View File

@ -34,6 +34,20 @@
* Included Files
****************************************************************************/
#include <sys/types.h>
#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>
#include <sched.h>
#include <errno.h>
#include <debug.h>
#include <netinet/in.h>
#include <apps/netutils/uiplib.h>
#include <apps/netutils/ftpd.h>
#include "ftpd.h"
/****************************************************************************
@ -48,14 +62,24 @@ static const struct fptd_account_s g_ftpdaccounts[] =
};
#define NACCOUNTS (sizeof(g_ftpdaccounts) / sizeof(struct fptd_account_s))
/****************************************************************************
* Public Data
****************************************************************************/
/* To minimize the probability of name collisitions, all FTPD example
* global data is maintained in a single instance of a structure.
*/
struct ftpd_globals_s g_ftpdglob;
/****************************************************************************
* Private Functions
****************************************************************************/
/****************************************************************************
* Name: shell_netinit
* Name: fptd_netinit
****************************************************************************/
static void shell_netinit(void)
static void fptd_netinit(void)
{
#ifndef CONFIG_EXAMPLES_FTPD_NONETINIT
struct in_addr addr;
@ -98,13 +122,21 @@ static void shell_netinit(void)
static void ftpd_accounts(FTPD_SESSION handle)
{
FAR onst struct fptd_account_s *account;
FAR const struct fptd_account_s *account;
int i;
printf("Adding accounts:\n");
for (i = 0; i < NACCOUNTS; i++)
{
account = &g_ftpdaccounts[i];
ftpd_add_user(handle, account->flags, account->user,
printf("%d. %s account: USER=%s PASSWORD=%s HOME=%s\n",
(account->flags & FTPD_ACCOUNTFLAG_SYSTEM) != 0 ? "Root" : "User",
(account->user) ? "(none)" : account->user,
(account->password) ? "(none)" : account->password,
(account->home) ? "(none)" : account->home);
ftpd_adduser(handle, account->flags, account->user,
account->password, account->home);
}
}
@ -118,12 +150,24 @@ int ftpd_daemon(int s_argc, char **s_argv)
FTPD_SESSION handle;
int ret;
/* The FTPD daemon has been started */
#ifdef CONFIG_NSH_BUILTIN_APPS
g_ftpdglob.running = true;
#endif
printf("FTP daemon [%d] started\n", g_ftpdglob.pid);
/* Open FTPD */
handle = ftpd_open();
if (!handle)
{
ndbg("Failed to open FTPD\n");
printf("FTP daemon [%d] failed to open FTPD\n", g_ftpdglob.pid);
#ifdef CONFIG_NSH_BUILTIN_APPS
g_ftpdglob.running = false;
g_ftpdglob.stop = false;
#endif
g_ftpdglob.pid = -1;
return EXIT_FAILURE;
}
@ -131,16 +175,33 @@ int ftpd_daemon(int s_argc, char **s_argv)
(void)ftpd_accounts(handle);
/* Then drive the FTPD server */
/* Then drive the FTPD server. */
while (g_ftpdglobls.stop == 0)
#ifdef CONFIG_NSH_BUILTIN_APPS
while (g_ftpdglob.stop == 0)
#else
for (;;)
#endif
{
(void)ftpd_run(handle, 1000);
/* If ftpd_session returns success, it means that a new FTP session
* has been started.
*/
ret = ftpd_session(handle, 1000);
printf("FTP daemon [%d] ftpd_session returned %d\n", g_ftpdglob.pid, ret);
}
/* Close the FTPD server and exit */
/* Close the FTPD server and exit (we can get here only if
* CONFIG_NSH_BUILTIN_APPS is defined).
*/
#ifdef CONFIG_NSH_BUILTIN_APPS
printf("FTP daemon [%d] stopping\n", g_ftpdglob.pid);
g_ftpdglob.running = false;
g_ftpdglob.stop = false;
g_ftpdglob.pid = -1;
ftpd_close(handle);
#endif
return EXIT_SUCCESS;
}
@ -148,44 +209,76 @@ int ftpd_daemon(int s_argc, char **s_argv)
* Public Functions
****************************************************************************/
/****************************************************************************
* Name: user_start/ftpd_main
* Name: user_start/ftpd_start
****************************************************************************/
int MAIN_NAME(int s_argc, char **s_argv)
{
FTPD_SESSION handle;
pid_t pid;
int ret;
/* Check if we have already initialized the network */
if (!g_ftpdglobls.initialized)
if (!g_ftpdglob.initialized)
{
/* Bring up the network */
ret = ftpd_netinit();
if (ret < 0)
printf("Initializing the network\n");
fptd_netinit();
/* Initialize daemon state */
g_ftpdglob.initialized = true;
g_ftpdglob.pid = -1;
#ifdef CONFIG_NSH_BUILTIN_APPS
g_ftpdglob.stop = false;
g_ftpdglob.running = false;
#endif
}
/* Then start the new daemon (if it is not already running) */
#ifdef CONFIG_NSH_BUILTIN_APPS
if (g_ftpdglob.stop && g_ftpdglob.running)
{
ndbg("Failed to initialize the network\n");
printf("Waiting for FTP daemon [%d] to stop\n", g_ftpdglob.pid);
return EXIT_FAILURE;
}
g_ftpdglobls.initialized = true;
g_ftpdglobls.stop = false;
}
/* Then start the new daemon */
g_telnetdcommon.daemon = daemon;
pid = TASK_CREATE("Telnet daemon", CONFIG_EXAMPLES_FTPD_PRIO,
CONFIG_EXAMPLES_FTPD_STACKSIZE, ftpd_daemon, NULL);
if (pid < 0)
else
#endif
if (!g_ftpdglob.running)
{
ndbg("Failed to start the telnet daemon: %d\n", errno);
printf("Starting the FTP daemon\n");
g_ftpdglob.pid = TASK_CREATE("FTP daemon", CONFIG_EXAMPLES_FTPD_PRIO,
CONFIG_EXAMPLES_FTPD_STACKSIZE,
ftpd_daemon, NULL);
if (g_ftpdglob.pid < 0)
{
printf("Failed to start the FTP daemon: %d\n", errno);
return EXIT_FAILURE;
}
}
else
{
printf("FTP daemon [%d] is running\n", g_ftpdglob.pid);
}
printf("The FTP daemon is running, pid=%d\n", pid);
return EXIT_SUCCESS;
}
/****************************************************************************
* Name: ftpd_stop
****************************************************************************/
#ifdef CONFIG_NSH_BUILTIN_APPS
int ftpd_stop(int s_argc, char **s_argv)
{
if (!g_ftpdglob.initialized || g_ftpdglob.running)
{
printf("The FTP daemon not running\n");
return EXIT_FAILURE;
}
printf("Stopping the FTP daemon, pid=%d\n", g_ftpdglob.pid);
g_ftpdglob.stop = true;
return EXIT_SUCCESS;
}
#endif

View File

@ -48,11 +48,34 @@
* Pre-processor Definitions
****************************************************************************/
/* Configuration ************************************************************/
/* Required configuration settings: Of course TCP networking support is
* required. But here are a couple that are less obvious:
*
* CONFIG_DISABLE_PTHREAD - pthread support is required
* CONFIG_DISABLE_POLL - poll() support is required
*
* Other FTPD configuration options thay may be of interest:
*
* CONFIG_FTPD_VENDORID - The vendor name to use in FTP communications.
* Default: "NuttX"
* CONFIG_FTPD_SERVERID - The server name to use in FTP communications.
* Default: "NuttX FTP Server"
* CONFIG_FTPD_CMDBUFFERSIZE - The maximum size of one command. Default:
* 512 bytes.
* CONFIG_FTPD_DATABUFFERSIZE - The size of the I/O buffer for data
* transfers. Default: 2048 bytes.
* CONFIG_FTPD_WORKERSTACKSIZE - The stacksize to allocate for each
* FTP daemon worker thread. Default: 2048 bytes.
*/
#ifdef CONFIG_DISABLE_PTHREAD
# error "pthread support is required (CONFIG_DISABLE_PTHREAD=n)"
#endif
#ifdef CONFIG_DISABLE_POLL
# error "poll() support is required (CONFIG_DISABLE_POLL=n)"
#endif
#ifndef CONFIG_FTPD_VENDORID
# define CONFIG_FTPD_VENDORID "NuttX"
#endif
@ -73,6 +96,13 @@
# define CONFIG_FTPD_WORKERSTACKSIZE 2048
#endif
/* Interface definitions ****************************************************/
#define FTPD_ACCOUNTFLAG_NONE (0)
#define FTPD_ACCOUNTFLAG_ADMIN (1 << 0)
#define FTPD_ACCOUNTFLAG_SYSTEM (1 << 1)
#define FTPD_ACCOUNTFLAG_GUEST (1 << 2)
/****************************************************************************
* Public Types
****************************************************************************/
@ -123,7 +153,7 @@ EXTERN FTPD_SESSION ftpd_open(void);
* Input Parameters:
* handle - A handle previously returned by ftpd_open
* accountflags - The characteristics of this user (see FTPD_ACCOUNTFLAGS_*
* defintiions.
* definitions above).
* user - The user login name. May be NULL indicating that no login is
* required.
* passwd - The user password. May be NULL indicating that no password

File diff suppressed because it is too large Load Diff

View File

@ -50,12 +50,11 @@
/****************************************************************************
* Pre-processor Definitions
****************************************************************************/
/* FPTD Definitions *********************************************************/
/* Networking definitions ***************************************************/
# define FTPD_ACCOUNTFLAG_NONE (0)
# define FTPD_ACCOUNTFLAG_ADMIN (1 << 0)
# define FTPD_ACCOUNTFLAG_SYSTEM (1 << 1)
# define FTPD_ACCOUNTFLAG_GUEST (1 << 2)
#define FTPD_PROTOCOL_TCP (6) /* TCP protocol number */
/* FPTD Definitions *********************************************************/
#define FTPD_SESSIONFLAG_USER (1 << 0)
#define FTPD_SESSIONFLAG_RESTARTPOS (1 << 1)
@ -130,22 +129,22 @@ struct ftpd_stream_s
union ftpd_sockaddr_u addr; /* Network address */
socklen_t addrlen; /* Length of the address */
size_t buflen; /* Length of the buffer */
uint8_t *buffer; /* Pointer to the buffer */
char *buffer; /* Pointer to the buffer */
};
struct ftpd_session_s
{
FAR struct ftpd_server_s shadow;
FAR struct ftpd_server_s *server;
FAR struct ftpd_account_s *head;
FAR struct ftpd_account_s *curr;
uint8_t flags; /* See TPD_SESSIONFLAG_* definitions */
int txtimeout;
int rxtimeout;
int txtimeout;
/* Command */
struct ftpd_stream_s cmd;
FAR char *cmd;
FAR char *command;
FAR char *param;
/* Data */
@ -160,7 +159,7 @@ struct ftpd_session_s
/* Current user */
FAR char *user;
uint8_t m_type; /* See enum ftpd_sessiontype_e */
uint8_t type; /* See enum ftpd_sessiontype_e */
FAR char *home;
FAR char *work;
FAR char *renamefrom;
@ -170,7 +169,7 @@ typedef int (*ftpd_cmdhandler_t)(struct ftpd_session_s *);
struct ftpd_cmd_s
{
FAR const char *cmd; /* The command string */
FAR const char *command; /* The command string */
ftpd_cmdhandler_t handler; /* The function that handles the command */
uint8_t flags; /* See FTPD_CMDFLAGS_* definitions */
};

View File

@ -40,8 +40,8 @@ include $(APPDIR)/Make.defs
# NSH Library
ASRCS =
CSRCS = nsh_parse.c nsh_console.c nsh_fscmds.c nsh_ddcmd.c nsh_proccmds.c \
nsh_mmcmds.c nsh_envcmds.c nsh_dbgcmds.c
CSRCS = nsh_init.c nsh_parse.c nsh_console.c nsh_fscmds.c nsh_ddcmd.c \
nsh_proccmds.c nsh_mmcmds.c nsh_envcmds.c nsh_dbgcmds.c
ifeq ($(CONFIG_NSH_BUILTIN_APPS),y)
CSRCS += nsh_apps.c

102
nshlib/nsh_init.c Normal file
View File

@ -0,0 +1,102 @@
/****************************************************************************
* apps/nshlib/nsh_init.c
*
* Copyright (C) 2007-2012 Gregory Nutt. All rights reserved.
* Author: Gregory Nutt <gnutt@nuttx.org>
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* 3. Neither the name NuttX nor the names of its contributors may be
* used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
****************************************************************************/
/****************************************************************************
* Included Files
****************************************************************************/
#include <nuttx/config.h>
#include "nsh.h"
/****************************************************************************
* Definitions
****************************************************************************/
/****************************************************************************
* Private Types
****************************************************************************/
/****************************************************************************
* Private Function Prototypes
****************************************************************************/
/****************************************************************************
* Private Data
****************************************************************************/
/****************************************************************************
* Public Data
****************************************************************************/
/****************************************************************************
* Private Functions
****************************************************************************/
/****************************************************************************
* Public Functions
****************************************************************************/
/****************************************************************************
* Name: nsh_initialize
*
* Description:
* This nterfaces is used to initialize the NuttShell (NSH).
* nsh_initialize() should be called one during application start-up prior
* to executing either nsh_consolemain() or nsh_telnetstart().
*
* Input Parameters:
* None
*
* Returned Value:
* None
*
****************************************************************************/
void nsh_initialize(void)
{
/* Mount the /etc filesystem */
(void)nsh_romfsetc();
/* Perform architecture-specific initialization (if available) */
(void)nsh_archinitialize();
/* Bring up the network */
(void)nsh_netinit();
}

View File

@ -1017,37 +1017,6 @@ static inline int nsh_nice(FAR struct nsh_vtbl_s *vtbl, FAR char **ppcmd, FAR ch
* Public Functions
****************************************************************************/
/****************************************************************************
* Name: nsh_initialize
*
* Description:
* This nterfaces is used to initialize the NuttShell (NSH).
* nsh_initialize() should be called one during application start-up prior
* to executing either nsh_consolemain() or nsh_telnetstart().
*
* Input Parameters:
* None
*
* Returned Value:
* None
*
****************************************************************************/
void nsh_initialize(void)
{
/* Mount the /etc filesystem */
(void)nsh_romfsetc();
/* Perform architecture-specific initialization (if available) */
(void)nsh_archinitialize();
/* Bring up the network */
(void)nsh_netinit();
}
/****************************************************************************
* Name: nsh_parse
*