2 * Copyright (c) 2011 Samsung Electronics Co., Ltd All Rights Reserved
4 * Licensed under the Apache License, Version 2.0 (the License);
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an AS IS BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
24 #include "transport.h" /* readx(), writex() */
26 #include "sdbd_plugin.h"
28 #include "commandline_sdbd.h"
30 #include <tzplatform_config.h>
32 #define MAX_PAYLOAD 4096
34 #define A_SYNC 0x434e5953
35 #define A_CNXN 0x4e584e43
36 #define A_OPEN 0x4e45504f
37 #define A_OKAY 0x59414b4f
38 #define A_CLSE 0x45534c43
39 #define A_WRTE 0x45545257
40 #define A_STAT 0x54415453
42 #define A_VERSION 0x02000000 // SDB protocol version
44 #define SDB_VERSION_MAJOR 2 // Used for help/version information
45 #define SDB_VERSION_MINOR 2 // Used for help/version information
46 #define SDB_VERSION_PATCH 31 // Used for help/version information
48 #define SDB_SERVER_VERSION 0 // Increment this when we want to force users to start a new sdb server
50 typedef struct amessage amessage;
51 typedef struct apacket apacket;
52 typedef struct asocket asocket;
53 typedef struct alistener alistener;
54 typedef struct aservice aservice;
55 typedef struct atransport atransport;
56 typedef struct adisconnect adisconnect;
57 typedef struct usb_handle usb_handle;
60 unsigned command; /* command identifier constant */
61 unsigned arg0; /* first argument */
62 unsigned arg1; /* second argument */
63 unsigned data_length; /* length of payload (0 is allowed) */
64 unsigned data_check; /* checksum of data payload */
65 unsigned magic; /* command ^ 0xffffffff */
76 unsigned char data[MAX_PAYLOAD];
79 /* An asocket represents one half of a connection between a local and
80 ** remote entity. A local asocket is bound to a file descriptor. A
81 ** remote asocket is bound to the protocol engine.
84 /* chain pointers for the local/remote list of
85 ** asockets that this asocket lives in
90 /* the unique identifier for this asocket
94 /* flag: set when the socket's peer has closed
95 ** but packets are still queued for delivery
99 /* the asocket we are connected to
104 /* For local asockets, the fde is used to bind
105 ** us to our fd event system. For remote asockets
106 ** these fields are not used.
111 /* queue of apackets waiting to be written
116 /* enqueue is called by our peer when it has data
117 ** for us. It should return 0 if we can accept more
118 ** data or 1 if not. If we return 1, we must call
119 ** peer->ready() when we once again are ready to
122 int (*enqueue)(asocket *s, apacket *pkt);
124 /* ready is called by the peer when it is ready for
125 ** us to send data via enqueue again
127 void (*ready)(asocket *s);
129 /* close is called by the peer when it has gone away.
130 ** we are not allowed to make any further calls on the
131 ** peer once our close method is called.
133 void (*close)(asocket *s);
135 /* socket-type-specific extradata */
138 /* A socket is bound to atransport */
139 atransport *transport;
143 /* the adisconnect structure is used to record a callback that
144 ** will be called whenever a transport is disconnected (e.g. by the user)
145 ** this should be used to cleanup objects that depend on the
146 ** transport (e.g. remote sockets, listeners, etc...)
150 void (*func)(void* opaque, atransport* t);
157 /* a transport object models the connection to a remote device or emulator
158 ** there is one transport per connected device/emulator. a "local transport"
159 ** connects through TCP (for the emulator), while a "usb transport" through
160 ** USB (for real devices)
162 ** note that kTransportHost doesn't really correspond to a real transport
163 ** object, it's a special value used to indicate that a client wants to
164 ** connect to a service implemented within the SDB server itself.
166 typedef enum transport_type {
178 int (*read_from_remote)(apacket *p, atransport *t);
179 int (*write_to_remote)(apacket *p, atransport *t);
180 void (*close)(atransport *t);
181 void (*kick)(atransport *t);
184 int transport_socket;
185 fdevent transport_fde;
188 int connection_state;
191 /* usb handle or socket fd as needed */
195 /* used to identify transports for clients */
198 int sdb_port; // Use for emulators (local transport)
199 char *device_name; // for connection explorer
201 /* a list of adisconnect callbacks called when the transport is kicked */
203 adisconnect disconnects;
207 /* A listener is an entity which binds to a local port
208 ** and, upon receiving a connection on that port, creates
209 ** an asocket to connect the new local connection to a
210 ** specific remote service.
212 ** TODO: some listeners read from the new connection to
213 ** determine what exact service to connect to on the far
224 const char *local_name;
225 const char *connect_to;
226 atransport *transport;
227 adisconnect disconnect;
230 #define UNKNOWN "unknown"
231 #define INFOBUF_MAXLEN 64
232 #define INFO_VERSION "2.2.0"
233 typedef struct platform_info {
234 char platform_info_version[INFOBUF_MAXLEN];
235 char model_name[INFOBUF_MAXLEN]; // Emulator
236 char platform_name[INFOBUF_MAXLEN]; // Tizen
237 char platform_version[INFOBUF_MAXLEN]; // 2.2.1
238 char profile_name[INFOBUF_MAXLEN]; // 2.2.1
241 #define ENABLED "enabled"
242 #define DISABLED "disabled"
243 #define CPUARCH_ARMV6 "armv6"
244 #define CPUARCH_ARMV7 "armv7"
245 #define CPUARCH_X86 "x86"
246 #define CAPBUF_SIZE 4096
247 #define CAPBUF_ITEMSIZE 32
248 typedef struct platform_capabilities
250 char secure_protocol[CAPBUF_ITEMSIZE]; // enabled or disabled
251 char intershell_support[CAPBUF_ITEMSIZE]; // enabled or disabled
252 char filesync_support[CAPBUF_ITEMSIZE]; // push or pull or pushpull or disabled
253 char rootonoff_support[CAPBUF_ITEMSIZE]; // enabled or disabled
254 char zone_support[CAPBUF_ITEMSIZE]; // enabled or disabled
255 char multiuser_support[CAPBUF_ITEMSIZE]; // enabled or disabled
256 char syncwinsz_support[CAPBUF_ITEMSIZE]; // enabled or disabled
257 char usbproto_support[CAPBUF_ITEMSIZE]; // enabled or disabled
258 char sockproto_support[CAPBUF_ITEMSIZE]; // enabled or disabled
260 char cpu_arch[CAPBUF_ITEMSIZE]; // cpu architecture (ex. x86)
261 char profile_name[CAPBUF_ITEMSIZE]; // profile name (ex. mobile)
262 char vendor_name[CAPBUF_ITEMSIZE]; // vendor name (ex. Tizen)
264 char platform_version[CAPBUF_ITEMSIZE]; // platform version (ex. 2.3.0)
265 char product_version[CAPBUF_ITEMSIZE]; // product version (ex. 1.0)
266 char sdbd_version[CAPBUF_ITEMSIZE]; // sdbd version
267 char sdbd_plugin_version[CAPBUF_ITEMSIZE]; // sdbd plugin version
271 #define SDBD_PLUGIN_PATH "/usr/lib/libsdbd_plugin.so"
272 #define SDBD_PLUGIN_INTF "sdbd_plugin_cmd_proc"
273 typedef int (*SDBD_PLUGIN_CMD_PROC_PTR)(const char*, const char*, sdbd_plugin_param);
274 extern SDBD_PLUGIN_CMD_PROC_PTR sdbd_plugin_cmd_proc;
275 int request_plugin_cmd(const char* cmd, const char* in_buf, char *out_buf, unsigned int out_len);
276 int request_plugin_verification(const char* cmd, const char* in_buf);
278 void print_packet(const char *label, apacket *p);
280 asocket *find_local_socket(unsigned id);
281 void install_local_socket(asocket *s);
282 void remove_socket(asocket *s);
283 void close_all_sockets(atransport *t);
285 #define LOCAL_CLIENT_PREFIX "emulator-"
287 asocket *create_local_socket(int fd);
288 asocket *create_local_service_socket(const char *destination);
290 asocket *create_remote_socket(unsigned id, atransport *t);
291 void connect_to_remote(asocket *s, const char *destination);
292 void connect_to_smartsocket(asocket *s);
294 void fatal(const char *fmt, ...);
295 void fatal_errno(const char *fmt, ...);
297 void handle_packet(apacket *p, atransport *t);
298 void send_packet(apacket *p, atransport *t);
300 void get_my_path(char *s, size_t maxLen);
301 int launch_server(int server_port);
302 int sdb_main(int is_daemon, int server_port);
305 /* transports are ref-counted
306 ** get_device_transport does an acquire on your behalf before returning
308 void init_transport_registration(void);
309 int list_transports(char *buf, size_t bufsize);
310 void update_transports(void);
311 void broadcast_transport(apacket *p);
312 int get_connected_count(transport_type type);
314 asocket* create_device_tracker(void);
316 /* Obtain a transport from the available transports.
317 ** If state is != CS_ANY, only transports in that state are considered.
318 ** If serial is non-NULL then only the device with that serial will be chosen.
319 ** If no suitable transport is found, error is set.
321 atransport *acquire_one_transport(int state, transport_type ttype, const char* serial, char **error_out);
322 void add_transport_disconnect( atransport* t, adisconnect* dis );
323 void remove_transport_disconnect( atransport* t, adisconnect* dis );
324 void run_transport_disconnects( atransport* t );
325 void kick_transport( atransport* t );
327 /* initialize a transport object's func pointers and state */
329 int get_available_local_transport_index();
331 int init_socket_transport(atransport *t, int s, int port, int local);
332 void init_usb_transport(atransport *t, usb_handle *usb, int state);
334 /* for MacOS X cleanup */
335 void close_usb_devices();
337 /* cause new transports to be init'd and added to the list */
338 void register_socket_transport(int s, const char *serial, int port, int local, const char *device_name);
340 /* these should only be used for the "sdb disconnect" command */
341 void unregister_transport(atransport *t);
342 void unregister_all_tcp_transports();
344 void register_usb_transport(usb_handle *h, const char *serial, unsigned writeable);
346 /* this should only be used for transports with connection_state == CS_NOPERM */
347 void unregister_usb_transport(usb_handle *usb);
349 atransport *find_transport(const char *serial);
351 atransport* find_emulator_transport_by_sdb_port(int sdb_port);
354 int service_to_fd(const char *name);
356 asocket *host_service_to_socket(const char* name, const char *serial);
361 asocket* create_jdwp_service_socket();
362 asocket* create_jdwp_tracker_service_socket();
363 int create_jdwp_connection_fd(int jdwp_pid);
371 int backup_service(BackupOperation operation, char* args);
372 void framebuffer_service(int fd, void *cookie);
373 void log_service(int fd, void *cookie);
374 void remount_service(int fd, void *cookie);
375 char * get_log_file_path(const char * log_name);
377 int rootshell_mode; // 0: sdk user, 1: root
378 int booting_done; // 0: platform booting is in progess 1: platform booting is done
380 // This is the users and groups config for the platform
382 #define SID_ROOT 0 /* traditional unix root user */
383 #define SID_TTY 5 /* group for /dev/ptmx */
384 #define SID_APP tzplatform_getuid(TZ_USER_NAME) /* application */
385 #define SID_DEVELOPER tzplatform_getuid(TZ_SDK_USER_NAME) /* developer with SDK */
386 #define SID_APP_LOGGING 6509
387 #define SID_SYS_LOGGING 6527
388 #define SID_INPUT 1004
390 #define SDK_USER_NAME tzplatform_getenv(TZ_SDK_USER_NAME)
391 extern uid_t g_sdk_user_id;
392 extern gid_t g_sdk_group_id;
393 extern char* g_sdk_home_dir;
394 extern char* g_sdk_home_dir_env;
397 int is_pwlocked(void);
398 int should_drop_privileges(void);
399 int set_sdk_user_privileges();
400 void set_root_privileges();
402 int get_emulator_forward_port(void);
403 int get_emulator_name(char str[], int str_size);
404 int get_device_name(char str[], int str_size);
405 int get_emulator_hostip(char str[], int str_size);
406 int get_emulator_guestip(char str[], int str_size);
408 /* packet allocator */
409 apacket *get_apacket(void);
410 void put_apacket(apacket *p);
412 int check_header(apacket *p);
413 int check_data(apacket *p);
415 /* define SDB_TRACE to 1 to enable tracing support, or 0 to disable it */
419 /* IMPORTANT: if you change the following list, don't
420 * forget to update the corresponding 'tags' table in
421 * the sdb_trace_init() function implemented in sdb.c
442 * When running inside the emulator, guest's sdbd can connect to 'sdb-debug'
443 * qemud service that can display sdb trace messages (on condition that emulator
444 * has been started with '-debug sdb' option).
447 /* Delivers a trace message to the emulator via QEMU pipe. */
448 void sdb_qemu_trace(const char* fmt, ...);
449 /* Macro to use to send SDB trace messages to the emulator. */
450 #define DQ(...) sdb_qemu_trace(__VA_ARGS__)
452 #define DQ(...) ((void)0)
453 #endif /* !SDB_HOST */
455 extern int sdb_trace_mask;
456 extern unsigned char sdb_trace_output_count;
457 void sdb_trace_init(void);
459 # define SDB_TRACING ((sdb_trace_mask & (1 << TRACE_TAG)) != 0)
461 /* you must define TRACE_TAG before using this macro */
465 int save_errno = errno; \
466 sdb_mutex_lock(&D_lock); \
467 fprintf(stderr, "%s::%s():", \
468 __FILE__, __FUNCTION__); \
469 errno = save_errno; \
470 fprintf(stderr, __VA_ARGS__ ); \
472 sdb_mutex_unlock(&D_lock); \
473 errno = save_errno; \
479 int save_errno = errno; \
480 sdb_mutex_lock(&D_lock); \
481 errno = save_errno; \
482 fprintf(stderr, __VA_ARGS__ ); \
484 sdb_mutex_unlock(&D_lock); \
485 errno = save_errno; \
489 # define D(...) ((void)0)
490 # define DR(...) ((void)0)
491 # define SDB_TRACING 0
496 #define print_packet(tag,p) do {} while (0)
499 #if SDB_HOST_ON_TARGET
500 /* sdb and sdbd are coexisting on the target, so use 26099 for sdb
501 * to avoid conflicting with sdbd's usage of 26098
503 # define DEFAULT_SDB_PORT 26099 /* tizen specific */
505 # define DEFAULT_SDB_PORT 26099 /* tizen specific */
508 # define QEMU_FORWARD_IP "10.0.2.2"
510 #define DEFAULT_SDB_LOCAL_TRANSPORT_PORT 26101 /* tizen specific */
511 #define DEFAULT_SENSORS_LOCAL_TRANSPORT_PORT 26103 /* tizen specific */
513 #define SDB_CLASS 0xff
514 #define SDB_SUBCLASS 0x20 //0x42 /* tizen specific */
515 #define SDB_PROTOCOL 0x02 //0x01 /* tizen specific */
518 void local_init(int port);
519 int local_connect(int port, const char *device_name);
520 int local_connect_arbitrary_ports(int console_port, int sdb_port, const char *device_name);
522 /* usb host/client interface */
526 int usb_write(usb_handle *h, const void *data, int len);
527 int usb_read(usb_handle *h, void *data, int len);
528 int usb_close(usb_handle *h);
529 void usb_kick(usb_handle *h);
532 extern void (*usb_init)();
533 extern void (*usb_cleanup)();
534 extern int (*usb_write)(usb_handle *h, const void *data, int len);
535 extern int (*usb_read)(usb_handle *h, void *data, int len);
536 extern int (*usb_close)(usb_handle *h);
537 extern void (*usb_kick)(usb_handle *h);
539 /* functionfs backend */
541 void ffs_usb_cleanup();
542 int ffs_usb_write(usb_handle *h, const void *data, int len);
543 int ffs_usb_read(usb_handle *h, void *data, int len);
544 int ffs_usb_close(usb_handle *h);
545 void ffs_usb_kick(usb_handle *h);
547 /* kernel sdb gadget backend */
548 void linux_usb_init();
549 void linux_usb_cleanup();
550 int linux_usb_write(usb_handle *h, const void *data, int len);
551 int linux_usb_read(usb_handle *h, void *data, unsigned len);
552 int linux_usb_close(usb_handle *h);
553 void linux_usb_kick(usb_handle *h);
557 /* used for USB device detection */
559 int is_sdb_interface(int vid, int pid, int usb_class, int usb_subclass, int usb_protocol);
562 unsigned host_to_le32(unsigned n);
563 int sdb_commandline(int argc, char **argv);
565 int connection_state(atransport *t);
569 #define CS_BOOTLOADER 1
572 #define CS_RECOVERY 4
573 #define CS_NOPERM 5 /* Insufficient permissions to communicate with the device */
574 #define CS_SIDELOAD 6
578 extern int SHELL_EXIT_NOTIFY_FD;
580 extern SdbdCommandlineArgs sdbd_commandline_args;
583 #define CHUNK_SIZE (64*1024)
585 int sendfailmsg(int fd, const char *reason);
586 int handle_host_request(char *service, transport_type ttype, char* serial, int reply_fd, asocket *s);
587 int copy_packet(apacket* dest, apacket* src);
589 int is_emulator(void);
590 #define DEFAULT_DEVICENAME "unknown"
592 #if SDB_HOST /* tizen-specific */
593 #define DEVICEMAP_SEPARATOR ":"
594 #define DEVICENAME_MAX 256
595 #define VMS_PATH OS_PATH_SEPARATOR_STR "vms" OS_PATH_SEPARATOR_STR // should include sysdeps.h above
597 void register_device_name(const char *device_type, const char *device_name, int port);
598 int get_devicename_from_shdmem(int port, char *device_name);
599 int read_line(const int fd, char* ptr, const size_t maxlen);
603 #define USB_FUNCFS_SDB_PATH "/dev/usbgadget/sdb"
604 #define USB_NODE_FILE "/dev/samsung_sdb"