-
Notifications
You must be signed in to change notification settings - Fork 8
/
shell.c
1266 lines (1105 loc) · 32.3 KB
/
shell.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* MicroShell (µSh)
*
* Authors: Simon Kuenzer <simon.kuenzer@neclab.eu>
*
*
* Copyright (c) 2013-2017, NEC Europe Ltd., NEC Corporation All rights reserved.
*
* 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 of the copyright holder 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 HOLDER 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.
*
*/
#if defined linux || defined __OSV__
#define USE_FOPENCOOKIE
#endif
#ifdef USE_FOPENCOOKIE
#define _GNU_SOURCE
#include <stdio.h>
#endif
#include <target/sys.h>
#include <errno.h>
#include <sched.h>
#include <fcntl.h>
#include <unistd.h>
#include <time.h>
#include "likely.h"
#ifdef SHELL_DEBUG
#define ENABLE_DEBUG
#endif
#include "debug.h"
#ifdef HAVE_LWIP
#include <lwip/tcp.h>
#else
typedef int err_t;
#endif
#include "shell.h"
#define MAX_NB_CMDS 64
#define MAX_NB_ARGS 96
#define ARGB_LEN 256
#define MAX_NB_SESS 8
#ifdef HAVE_LWIP
#define SH_RXBUFLEN 2048 /* input buffer size for TCP: has to be a power of 2! */
#define SH_RXBUFMASK (SH_RXBUFLEN - 1)
#define SH_TCP_PRIO TCP_PRIO_MIN
#define SH_LISTEN_PORT 23 /* telnet */
#define SH_TCPKEEPALIVE_TIMEOUT 120 /* = x sec */
#define SH_TCPKEEPALIVE_IDLE 60 /* = x sec */
#endif
#define SESSNAME_MAXLEN 16
#define SESSNAME_LFMT "lsh%u"
#ifdef HAVE_LWIP
#define SESSNAME_RFMT "rsh%u"
#endif
#ifndef SHELL_INFO
#define SHELL_INFO "µShell - A minimalistic CLI\nCopyright 2013-2014 NEC Laboratories Europe Ltd."
#endif
#ifndef SHELL_WELCOME
#define SHELL_WELCOME SHELL_INFO"\nWelcome to Mini-OS!"
#endif
#ifndef SHELL_GOODBYE
#define SHELL_GOODBYE "logout"
#endif
#ifndef SHELL_PROMPT
#define SHELL_PROMPT "µsh#"
#endif
#define SH_TELNET_IAC (0xFF)
#define SH_TELNET_CMD_WILL (0xFB)
#define SH_TELNET_CMD_DONT (0xFE)
#define SH_TELNET_CMD_DO (0xFD)
#define SH_TELNET_CMD_WONT (0xFC)
#define SH_TELNET_OPT_BINARY (0x00)
#define SH_TELNET_OPT_ECHO (0x01)
#define SH_TELNET_OPT_SUPPRGAHEAD (0x03)
#define SH_TELNET_OPT_STATUS (0x05)
#define SH_TELNET_OPT_TTYPE (0x18)
#define SH_TELNET_SB (0xFA)
#define SH_TELNET_SE (0xF0)
#ifndef min
#define min(a, b) \
({ __typeof__ (a) __a = (a); \
__typeof__ (b) __b = (b); \
__a < __b ? __a : __b; })
#endif
#ifndef min3
#define min3(a, b, c) \
min(min((a), (b)), (c))
#endif
struct shell {
struct tcp_pcb *tpcb;
struct timeval ts_start;
const char *info;
const char *welcome;
const char *goodbye;
/* commands register */
char *cmd_str[MAX_NB_CMDS];
shfunc_ptr_t cmd_func[MAX_NB_CMDS];
/* shell sessions */
uint32_t nb_sess;
uint32_t max_nb_sess;
struct shell_sess *sess[MAX_NB_SESS];
};
enum shell_sess_state
{
SSS_NONE = 0,
SSS_ESTABLISHED,
SSS_CLOSING,
SSS_KILLING
};
enum shell_sess_type
{
SST_LOCAL = 0,
#ifdef HAVE_LWIP
SST_REMOTE,
#endif
};
struct shell_sess {
/* session settings */
uint32_t id;
char name[SESSNAME_MAXLEN];
enum shell_sess_type type;
enum shell_sess_state state;
struct timeval ts_start;
char *prompt;
int echo; /* echo input */
int respawn; /* respawn a closed session? */
/* session thread */
struct thread *thread;
/* console i/o */
FILE *cio; /* stdin/stdout of session */
#ifdef USE_FOPENCOOKIE
cookie_io_functions_t cio_funcs;
#endif
int cons_fd; /* serial console on SSS_LOCAL */
#ifdef HAVE_LWIP
struct tcp_pcb *tpcb; /* TCP PCB */
/* rx buffer (tcp session) */
char cio_rxbuf[SH_RXBUFLEN];
uint16_t cio_rxbuf_ridx;
uint16_t cio_rxbuf_widx;
#endif
};
static struct shell *sh = NULL; /* will be initialized first */
static int shcmd_info(FILE *cio, int argc, char *argv[]);
static int shcmd_help(FILE *cio, int argc, char *argv[]);
static int shcmd_xargs(FILE *cio, int argc, char *argv[]);
static int shcmd_sexec(FILE *cio, int argc, char *argv[]);
static int shcmd_clear(FILE *cio, int argc, char *argv[]);
static int shcmd_repeat(FILE *cio, int argc, char *argv[]);
static int shcmd_time(FILE *cio, int argc, char *argv[]);
static int shcmd_uptime(FILE *cio, int argc, char *argv[]);
static int shcmd_who(FILE *cio, int argc, char *argv[]);
static int shcmd_exit(FILE *cio, int argc, char *argv[]);
#ifdef SHELL_DEBUG
static int shcmd_args(FILE *cio, int argc, char *argv[]);
#endif
static int shcmd_date(FILE *cio, int argc, char *argv[]);
static int shcmd_echo(FILE *cio, int argc, char *argv[]);
static err_t shlsess_accept(void);
static void shlsess_close (struct shell_sess *sess);
#ifdef HAVE_LWIP
static err_t shrsess_accept(void *argp, struct tcp_pcb *new_tpcb, err_t err);
static void shrsess_close (struct shell_sess *sess);
static err_t shrsess_recv (void *argp, struct tcp_pcb *tpcb, struct pbuf *p, err_t err);
static void shrsess_error (void *argp, err_t err);
static err_t shrsess_poll (void *argp, struct tcp_pcb *tpcb);
#endif
int init_shell(unsigned int en_lsess, unsigned int nb_rsess)
{
int32_t i;
err_t err;
sh = malloc(sizeof(*sh));
if (!sh) {
errno = ENOMEM;
goto err_out;
}
gettimeofday(&sh->ts_start, NULL); /* timestamp of shell creation */
sh->welcome = SHELL_WELCOME;
sh->goodbye = SHELL_GOODBYE;
for (i = 0; i < MAX_NB_CMDS; i++) {
sh->cmd_str[i] = NULL;
sh->cmd_func[i] = NULL;
}
for (i = 0; i < MAX_NB_SESS; i++) {
sh->sess[i] = NULL;
}
sh->max_nb_sess = min(nb_rsess + (en_lsess ? 1 : 0), MAX_NB_SESS);
sh->nb_sess = 0;
/* register TCP listener */
#ifdef HAVE_LWIP
if (nb_rsess) {
sh->tpcb = tcp_new();
if (!sh->tpcb) {
errno = ENOMEM;
goto err_free_sh;
}
err = tcp_bind(sh->tpcb, IP_ADDR_ANY, SH_LISTEN_PORT);
if (err != ERR_OK) {
errno = ENOMEM;
goto err_free_tcp;
}
sh->tpcb = tcp_listen(sh->tpcb);
tcp_arg(sh->tpcb, sh);
tcp_accept(sh->tpcb, shrsess_accept); /* register session accept */
} else {
sh->tpcb = NULL;
}
#endif
/* register default commands (ignore errors) */
shell_register_cmd("help", shcmd_help);
shell_register_cmd("info", shcmd_info);
shell_register_cmd("exit", shcmd_exit);
shell_register_cmd("clear", shcmd_clear);
shell_register_cmd("echo", shcmd_echo);
shell_register_cmd("xargs", shcmd_xargs);
shell_register_cmd("sexec", shcmd_sexec);
shell_register_cmd("who", shcmd_who);
shell_register_cmd("time", shcmd_time);
shell_register_cmd("repeat", shcmd_repeat);
shell_register_cmd("uptime", shcmd_uptime);
shell_register_cmd("date", shcmd_date);
#ifdef SHELL_DEBUG
shell_register_cmd("args", shcmd_args);
#endif
/* create a local shell session on stdin/stdout */
if (en_lsess)
shlsess_accept();
return 0;
#ifdef HAVE_LWIP
err_free_tcp:
if (nb_rsess)
tcp_close(sh->tpcb);
#endif
err_free_sh:
free(sh);
err_out:
return -1;
}
void exit_shell(void)
{
uint32_t i;
int wait;
#ifdef HAVE_LWIP
/* disable tcp listener */
if (sh->tpcb)
tcp_accept(sh->tpcb, NULL);
#endif
/* close all opened sessions and wait for their exit */
do {
wait = 0;
for (i = 0; i < MAX_NB_SESS; i++) {
if (sh->sess[i]) {
sh->sess[i]->state = SSS_CLOSING;
wait = 1;
}
}
schedule();
} while (wait);
#ifdef HAVE_LWIP
if (sh->tpcb)
tcp_close(sh->tpcb);
#endif
for (i = 0; i < MAX_NB_CMDS; i++) {
if(sh->cmd_str[i])
free(sh->cmd_str[i]);
}
free(sh);
}
static int32_t shell_get_free_sess_id(void)
{
int32_t i = 0;
while (sh->sess[i] && i < sh->max_nb_sess)
i++;
if (i == sh->max_nb_sess)
return -1; /* no session id available */
return i;
}
/* --------------------------------------
* Command handling
* -------------------------------------- */
static int32_t shell_get_cmd_index(const char *cmd)
{
int32_t i;
for (i = 0; i < MAX_NB_CMDS; i++) {
if (sh->cmd_str[i]) {
if (strcmp(sh->cmd_str[i], cmd) == 0)
return i; /* found */
}
}
errno = ENOENT;
return -1; /* not found */
}
int shell_register_cmd(const char *cmd, shfunc_ptr_t func)
{
uint32_t i;
BUG_ON(sh == NULL);
/* search for cmd */
if (!shell_get_cmd_index(cmd) < 0) {
/* cmd already registered */
errno = EEXIST;
return -1;
}
/* search for a free slot */
for (i = 0; i < MAX_NB_CMDS; i++) {
if (!sh->cmd_str[i])
break; /* found a slot */
}
if (i == MAX_NB_CMDS) {
/* no slot found for cmd */
errno = ENOSPC;
return -1;
}
/* register cmd */
sh->cmd_str[i] = strdup(cmd);
if (!sh->cmd_str[i]) {
errno = ENOMEM;
return -1;
}
sh->cmd_func[i] = func;
printd("Command %i ('%s') registered (func=@%p)\n", i, cmd, func);
return 0;
}
void shell_unregister_cmd(const char *cmd)
{
int32_t i;
BUG_ON(sh == NULL);
i = shell_get_cmd_index(cmd);
if (i >= 0) {
free(sh->cmd_str[i]);
sh->cmd_func[i] = NULL;
sh->cmd_str[i] = NULL;
printd("Command %i ('%s') unregistered\n", i, cmd);
}
}
static void sh_telnet_negotiation(FILE *cio, uint8_t cmd, uint8_t arg, struct shell_sess *sess)
{
printd("Negotiation commands are unsupported for now, ignoring...\n");
}
static int sh_exec(FILE *cio, char *argb, size_t argb_len)
{
char *argv[MAX_NB_ARGS];
int argc;
int ret;
size_t i;
int32_t cmdi;
int prev_was_whitespace;
/* parse argument line (fillup argv) */
argc = 0;
prev_was_whitespace = 1;
for (i = 0; i < argb_len && argc < MAX_NB_ARGS; i++) {
switch (argb[i]) {
case '\0': /* end of string */
goto out;
break;
case ' ': /* white spaces */
case '\r':
case '\n':
case '\t':
case '\v':
argb[i] = '\0';
prev_was_whitespace = 1;
break;
case '\'': /* quotes */
case '"':
/* QUOTES NOT SUPPORTED YET */
default:
if (prev_was_whitespace) {
argv[argc++] = &argb[i];
prev_was_whitespace = 0;
}
break;
}
}
out:
if (argc == 0) {
printd("Ignoring empty command\n");
return 0; /* nothing was typed */
}
cmdi = shell_get_cmd_index(argv[0]);
if (cmdi < 0) {
printd("%s: command not found\n", argv[0]);
fprintf(cio, "%s: command not found\n", argv[0]);
return 0;
}
ret = sh->cmd_func[cmdi](cio, argc, argv);
if (ret < 0)
fprintf(cio, "%s: command returned %d\n", argv[0], ret);
printd("%s: command returned %d\n", argv[0], ret);
return ret;
}
/* the shell session thread */
static void sh_session(void *argp)
{
struct shell_sess *sess = argp;
char argb[ARGB_LEN]; /* argument buffer */
uint8_t tsnb[2]; /* telnet session negotiation buffer */
size_t argb_p;
size_t tsnb_p;
int ret;
int in_tsn;
int in_tsn_sb;
respawn:
argb_p = 0;
tsnb_p = 0;
in_tsn = 0;
in_tsn_sb = 0;
if (sh->welcome)
fprintf(sess->cio, "\n%s\n", sh->welcome);
for (;;) {
/* print prompt */
if (sess->prompt)
fprintf(sess->cio, "%s ", sess->prompt);
fflush(sess->cio);
/* read sess->argb from cio */
argb_p = 0;
while (argb_p < sizeof(argb) - 1) {
if (sess->state == SSS_CLOSING ||
sess->state == SSS_KILLING)
goto terminate;
ret = fgetc(sess->cio);
printd("%s: fgetc: %d %c\n", sess->name, ret, ret > 0 ? ret : '\0');
if (ret == EOF) {
printd("%s: fgetc returned EOF: Connection closed\n", sess->name);
goto terminate;
}
argb[argb_p] = (char) ret;
if (sess->state == SSS_CLOSING ||
sess->state == SSS_KILLING)
goto terminate;
/* telnet negotiation command */
if ((unsigned char) argb[argb_p] == SH_TELNET_IAC) {
if (in_tsn && tsnb_p == 0) {
/* doubled 0xFF means a single 0xFF data byte */
in_tsn = 0;
goto parse;
} else if (!in_tsn) {
/* start of IAC */
in_tsn = 1;
tsnb_p = 0;
continue;
}
}
if (in_tsn) {
if (in_tsn_sb) {
/* wait for subsequence end */
if ((unsigned char) argb[argb_p] == SH_TELNET_SE) {
/* we don't support subnegotiations: ignore */
in_tsn = 0;
in_tsn_sb = 0;
printd("Ignored telnet subnegotiation\n");
}
continue; /* ignore subnegotiation characters */
}
tsnb[tsnb_p++] = (uint8_t) argb[argb_p];
if (tsnb_p == 1 && tsnb[1] == SH_TELNET_SB) {
in_tsn_sb = 1;
} else if (tsnb_p == 2) { /* command completed */
in_tsn = 0;
printd("Received telnet negotiation command: %02X %02X\n",
tsnb[0], tsnb[1]);
sh_telnet_negotiation(sess->cio, tsnb[0], tsnb[1], sess);
}
continue;
}
parse:
switch ((unsigned char) argb[argb_p]) {
case 0x0a: /* new line \n */
case 0x0d: /* enter \r */
goto exec_cmd;
case 0x7f: /* delete */
argb[argb_p] = '\0';
if (argb_p > 0) {
argb_p--;
/* print destructive backspace */
if (sess->echo) {
fprintf(sess->cio, "%s", "\b \b");
fflush(sess->cio);
}
}
break;
case 0x20 ... 0x7e: /* ASCII chars */
if (sess->echo) {
fprintf(sess->cio, "%c", argb[argb_p]);
fflush(sess->cio);
}
argb_p++;
break;
default:
printd("Ignoring non-ASCII/control character: %02x\n",
(unsigned char) argb[argb_p]);
break;
}
}
exec_cmd:
if (sess->echo)
fprintf(sess->cio, "\n");
printd("Parsing command line: %s\n", argb);
ret = sh_exec(sess->cio, argb, argb_p + 1);
fflush(sess->cio);
printd("Command line parsing finished: return code %d\n", ret);
if (ret == SH_CLOSE) {
printd("Close session\n");
sess->state = SSS_CLOSING;
break;
}
}
if (sh->goodbye)
fprintf(sess->cio, "%s\n", sh->goodbye);
fflush(sess->cio);
if (sess->respawn)
goto respawn;
terminate:
printd("Terminate session %s\n", sess->name);
#ifdef HAVE_LWIP
if (sess->type == SST_REMOTE)
shrsess_close(sess);
else
#endif
shlsess_close(sess);
}
/* --------------------------------------
* Local session handling
* -------------------------------------- */
static err_t shlsess_accept(void)
{
struct shell_sess *sess;
err_t err;
if (sh->nb_sess == sh->max_nb_sess) {
err = ERR_MEM;
goto err_out;
}
sess = malloc(sizeof(*sess));
if (!sess) {
err = ERR_MEM;
goto err_out;
}
#ifdef __MINIOS__
sess->cons_fd = open("/var/log/", O_RDWR); /* workaround to
* access stdin/stdout */
if (sess->cons_fd < 0) {
err = ERR_ABRT;
goto err_free_sess;
}
sess->cio = fdopen(sess->cons_fd, "r+");
#else
sess->cio = stdin; /* FIXME */
#endif
sess->tpcb = NULL;
sess->type = SST_LOCAL;
sess->state = SSS_NONE;
sess->echo = 1; /* enable echo of input on console */
sess->respawn = 1; /* enable session respawning */
gettimeofday(&sess->ts_start, NULL);
sess->prompt = strdup(SHELL_PROMPT);
if (!sess->prompt) {
err = ERR_MEM;
goto err_close_cons;
}
sess->id = shell_get_free_sess_id();
snprintf(sess->name, SESSNAME_MAXLEN, SESSNAME_LFMT, sess->id);
sess->thread = create_thread(sess->name, sh_session, sess);
if (!sess->thread) {
err = ERR_MEM;
goto err_free_prompt;
}
sh->sess[sess->id] = sess; /* register session */
sh->nb_sess++;
printd("Local session opened (%s)\n", sess->name);
return ERR_OK;
err_free_prompt:
free(sess->prompt);
err_close_cons:
close(sess->cons_fd);
err_free_sess:
free(sess);
err_out:
return err;
}
static void shlsess_close(struct shell_sess *sess)
{
BUG_ON(sess->type != SST_LOCAL);
/* unregister session */
sh->sess[sess->id]=NULL;
sh->nb_sess--;
free(sess->prompt);
/* close console descriptor */
fclose(sess->cio);
printd("Local session closed (%s)\n", sess->name);
free(sess);
}
/* --------------------------------------
* Remote session handling
* -------------------------------------- */
#ifdef HAVE_LWIP
#define RXBUF_NB_AVAIL(s) ((SH_RXBUFLEN + (s)->cio_rxbuf_widx - (s)->cio_rxbuf_ridx) & SH_RXBUFMASK)
#define RXBUF_NB_FREE(s) ((SH_RXBUFMASK + (s)->cio_rxbuf_ridx - (s)->cio_rxbuf_widx) & SH_RXBUFMASK)
#ifdef USE_FOPENCOOKIE
static ssize_t shrsess_cio_read(void *argp, char *buf, size_t maxlen)
#else
static int shrsess_cio_read(void *argp, char *buf, int maxlen)
#endif
{
struct shell_sess *sess = argp;
#ifdef USE_FOPENCOOKIE
ssize_t i, avail;
#else
int i, avail;
#endif
printd("%s: Read incoming data (max: %d bytes)...\n", sess->name, maxlen);
retry:
if (sess->state == SSS_CLOSING || sess->state == SSS_KILLING) {
errno = EIO;
return -1;
}
avail = min(RXBUF_NB_AVAIL(sess), maxlen);
if ((avail == 0) && (maxlen > 0)) {
/* we need to wait for further input of data */
schedule(); /* TODO: use wait queue */
goto retry;
}
for (i = 0; i < avail; i++) {
buf[i] = sess->cio_rxbuf[sess->cio_rxbuf_ridx];
sess->cio_rxbuf_ridx = (sess->cio_rxbuf_ridx + 1) & SH_RXBUFMASK;
}
printd("%s: Received %d bytes from client\n", sess->name, avail);
return avail;
}
#ifdef USE_FOPENCOOKIE
static ssize_t shrsess_cio_write(void *argp, const char *buf, size_t len)
#else
static int shrsess_cio_write(void *argp, const char *buf, size_t len)
#endif
{
struct shell_sess *sess = argp;
struct tcp_pcb *pcb = sess->tpcb;
register size_t l, s;
err_t err = ERR_OK;
u16_t slen;
s = 0;
l = len;
err = ERR_OK;
if (sess->state == SSS_CLOSING ||
sess->state == SSS_KILLING)
return (ssize_t) len;
try_next:
slen = (u16_t) min3(l, tcp_sndbuf(pcb), UINT16_MAX);
if (slen == 0)
goto out;
printd("%s: Sending %d bytes to client...\n", sess->name, slen);
try_again:
printd("tcp_write(buf=@%p, slen=%"PRIu16", left=%"PRIu64", sndbuf=%"PRIu32", sndqueuelen=%"PRIu16")\n",
buf, slen, l, (u32_t) tcp_sndbuf(pcb), (u16_t) tcp_sndqueuelen(pcb));
err = tcp_write(pcb, buf, slen, TCP_WRITE_FLAG_COPY | (l > 0 ? TCP_WRITE_FLAG_MORE : 0x0));
if (unlikely(err == ERR_MEM)) {
if (slen <= 1 || !tcp_sndbuf(pcb) ||
(tcp_sndqueuelen(pcb) >= TCP_SND_QUEUELEN)) {
/* retry later because of high memory pressure */
goto out;
} else {
printd("tcp_write returned memory error, retry with half send length\n", err);
slen >>= 1; /* l /= 2 */
goto try_again;
}
}
if (likely(err == ERR_OK)) {
s += slen;
l -= slen;
if (l > 0) {
buf = (const void *) ((uintptr_t) buf + slen);
goto try_next;
}
}
out:
if (s < len) {
printd("Sent %"PRIu64"/%"PRIu64" bytes, try again later\n", (uint64_t) s, (uint64_t) len);
schedule(); /* TODO: block & unblock */
if (sess->state == SSS_CLOSING ||
sess->state == SSS_KILLING)
return (ssize_t) len;
goto try_next;
}
tcp_output(pcb);
printd("Sent %"PRIu64"/%"PRIu64" bytes\n", (uint64_t) s, (uint64_t) len);
return (ssize_t) s;
}
static err_t shrsess_accept(void *argp, struct tcp_pcb *new_tpcb, err_t err)
{
struct shell_sess *sess;
if (err != ERR_OK) {
goto err_out;
}
if (sh->nb_sess == sh->max_nb_sess) {
err = ERR_MEM;
goto err_out;
}
sess = malloc(sizeof(*sess));
if (!sess) {
err = ERR_MEM;
goto err_out;
}
sess->tpcb = new_tpcb;
sess->type = SST_REMOTE;
sess->state = SSS_ESTABLISHED;
sess->echo = 0; /* no echo of input on console */
sess->respawn = 0; /* no session respawning */
sess->prompt = strdup(SHELL_PROMPT);
if (!sess->prompt) {
err = ERR_MEM;
goto err_free_sess;
}
gettimeofday(&sess->ts_start, NULL);
sess->id = shell_get_free_sess_id();
sess->cio_rxbuf_ridx = 0;
sess->cio_rxbuf_widx = 0;
#ifdef USE_FOPENCOOKIE
sess->cio_funcs.read = shrsess_cio_read;
sess->cio_funcs.write = shrsess_cio_write;
sess->cio_funcs.seek = NULL;
sess->cio_funcs.close = NULL;
sess->cio = fopencookie(sess, "r+", sess->cio_funcs);
#else
sess->cio = funopen(sess,
shrsess_cio_read,
shrsess_cio_write,
NULL, NULL);
#endif
if (!sess->cio) {
err = ERR_MEM;
goto err_free_prompt;
}
snprintf(sess->name, SESSNAME_MAXLEN, SESSNAME_RFMT, sess->id);
sess->thread = create_thread(sess->name, sh_session, sess);
if (!sess->thread) {
err = ERR_MEM;
goto err_free_prompt;
}
tcp_arg(sess->tpcb, sess); /* argp for callbacks */
tcp_recv(sess->tpcb, shrsess_recv); /* recv callback */
tcp_sent(sess->tpcb, NULL); /* sent ack callback */
tcp_err(sess->tpcb, shrsess_error); /* err callback */
tcp_poll(sess->tpcb, shrsess_poll, 0); /* poll callback */
tcp_setprio(sess->tpcb, SH_TCP_PRIO);
/* TCP keepalive */
sess->tpcb->so_options |= SOF_KEEPALIVE;
sess->tpcb->keep_intvl = (SH_TCPKEEPALIVE_TIMEOUT * 1000);
sess->tpcb->keep_idle = (SH_TCPKEEPALIVE_IDLE * 1000);
sess->tpcb->keep_cnt = 1;
sh->sess[sess->id] = sess; /* register session */
sh->nb_sess++;
printd("Remote session opened (%s)\n", sess->name);
return ERR_OK;
err_free_prompt:
free(sess->prompt);
err_free_sess:
free(sess);
err_out:
return err;
}
static void shrsess_close(struct shell_sess *sess)
{
err_t err;
BUG_ON(sess->type != SST_REMOTE);
/* unregister session */
sh->sess[sess->id]=NULL;
sh->nb_sess--;
free(sess->prompt);
/* close console descriptor */
fclose(sess->cio);
/* disable tcp connection */
tcp_arg(sess->tpcb, NULL);
tcp_sent(sess->tpcb, NULL);
tcp_recv(sess->tpcb, NULL);
tcp_sent(sess->tpcb, NULL);
tcp_err(sess->tpcb, NULL);
tcp_poll(sess->tpcb, NULL, 0);
/* terminate connection */
if (sess->state != SSS_KILLING) {
err = tcp_close(sess->tpcb);
if (unlikely(err != ERR_OK))
tcp_abort(sess->tpcb);
} /* on SSS_KILLING tpcb is not touched */
/* release memory */
printd("Remote session closed (%s)\n", sess->name);
free(sess);
}
static err_t shrsess_recv(void *argp, struct tcp_pcb *tpcb, struct pbuf *p, err_t err)
{
struct shell_sess *sess = (struct shell_sess *) argp;
struct pbuf *q;
uint16_t i, j, r, rl;
if (!p || err != ERR_OK) {
if (p) {
/* Inform TCP that we have taken the data */
tcp_recved(sess->tpcb, p->tot_len);
pbuf_free(p);
}
/* close connection */
printd("Unexpected close of session %s: Killing session...\n", sess->name);
sess->state = SSS_CLOSING;
return ERR_OK;
}
/* take the data (if receive buffer is too small: drop the rest) */
rl = (uint16_t) min(p->tot_len, RXBUF_NB_FREE(sess));
r = 0;
for(q = p, i = 0; q != NULL && r < rl; i += q->len, q = q->next) {
for (j = 0; j < q->len && r < rl; j++) {
sess->cio_rxbuf[sess->cio_rxbuf_widx] = *(((char *) q->payload) + j);
sess->cio_rxbuf_widx = (sess->cio_rxbuf_widx + 1) & SH_RXBUFMASK;
r++;
}
}
tcp_recved(sess->tpcb, p->tot_len);
pbuf_free(p);
schedule();
return ERR_OK;
}
static void shrsess_error(void *argp, err_t err)
{
struct shell_sess *sess = (struct shell_sess *) argp;
printd("Receive error on %s: Killing session...\n", sess->name);
sess->state = SSS_KILLING; /* kill connection on errors */
}
static err_t shrsess_poll(void *argp, struct tcp_pcb *tpcb)
{
struct shell_sess *sess = (struct shell_sess *) argp;
LWIP_UNUSED_ARG(sess);
/* TODO */
return ERR_OK;
}
#endif
/* --------------------------------------
* Default commands
* -------------------------------------- */
static int shcmd_info(FILE *cio, int argc, char *argv[])
{
/* print session id and version */
fprintf(cio, "%s\n", SHELL_INFO);
return 0;
}
static int shcmd_help(FILE *cio, int argc, char *argv[])
{
/* list available commands */
int32_t i;
for (i = 0; i < MAX_NB_CMDS; i++){
if (sh->cmd_str[i])
fprintf(cio, " %s\n", sh->cmd_str[i]);
}
return 0;
}