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 "commandline_sdbd.h"
27 #include <tzplatform_config.h>
29 #define MAX_PAYLOAD_V1 (4*1024)
30 #define MAX_PAYLOAD_V2 (256*1024)
31 #define MAX_PAYLOAD MAX_PAYLOAD_V2
33 #define A_SYNC 0x434e5953
34 #define A_CNXN 0x4e584e43
35 #define A_OPEN 0x4e45504f
36 #define A_OKAY 0x59414b4f
37 #define A_CLSE 0x45534c43
38 #define A_WRTE 0x45545257
39 #define A_STAT 0x54415453
40 #define A_ENCR 0x40682018 // encryption 메시지
42 #ifdef SUPPORT_ENCRYPT
43 #define ENCR_SET_ON_REQ 0 // encryption hello 메시지
44 #define ENCR_SET_ON_OK 1 // encryption ack 메시지
45 #define ENCR_SET_OFF 2 // encryption mode off 메시지
46 #define ENCR_GET 3 // encryption status get 메시지
47 #define ENCR_ON_FAIL 4 // encryption on 실패 메시지
48 #define ENCR_OFF_FAIL 5 // encryption off 실패 메시지
49 #define ENCR_ON 1 // encryption on 상태
50 #define ENCR_OFF 0 // encryption off 상태
53 #define A_VERSION 0x02000000 // SDB protocol version
55 #define SDB_VERSION_MAJOR 2 // Used for help/version information
56 #define SDB_VERSION_MINOR 2 // Used for help/version information
57 #define SDB_VERSION_PATCH 31 // Used for help/version information
59 #define SDB_SERVER_VERSION 0 // Increment this when we want to force users to start a new sdb server
61 typedef struct amessage amessage;
62 typedef struct apacket apacket;
63 typedef struct asocket asocket;
64 typedef struct alistener alistener;
65 typedef struct aservice aservice;
66 typedef struct atransport atransport;
67 typedef struct adisconnect adisconnect;
68 typedef struct usb_handle usb_handle;
71 unsigned command; /* command identifier constant */
72 unsigned arg0; /* first argument */
73 unsigned arg1; /* second argument */
74 unsigned data_length; /* length of payload (0 is allowed) */
75 unsigned data_check; /* checksum of data payload */
76 unsigned magic; /* command ^ 0xffffffff */
87 unsigned char data[MAX_PAYLOAD];
90 /* An asocket represents one half of a connection between a local and
91 ** remote entity. A local asocket is bound to a file descriptor. A
92 ** remote asocket is bound to the protocol engine.
95 /* chain pointers for the local/remote list of
96 ** asockets that this asocket lives in
101 /* the unique identifier for this asocket
105 /* flag: set when the socket's peer has closed
106 ** but packets are still queued for delivery
110 /* the asocket we are connected to
115 /* For local asockets, the fde is used to bind
116 ** us to our fd event system. For remote asockets
117 ** these fields are not used.
122 /* queue of apackets waiting to be written
127 /* enqueue is called by our peer when it has data
128 ** for us. It should return 0 if we can accept more
129 ** data or 1 if not. If we return 1, we must call
130 ** peer->ready() when we once again are ready to
133 int (*enqueue)(asocket *s, apacket *pkt);
135 /* ready is called by the peer when it is ready for
136 ** us to send data via enqueue again
138 void (*ready)(asocket *s);
140 /* close is called by the peer when it has gone away.
141 ** we are not allowed to make any further calls on the
142 ** peer once our close method is called.
144 void (*close)(asocket *s);
146 /* socket-type-specific extradata */
149 /* A socket is bound to atransport */
150 atransport *transport;
154 /* the adisconnect structure is used to record a callback that
155 ** will be called whenever a transport is disconnected (e.g. by the user)
156 ** this should be used to cleanup objects that depend on the
157 ** transport (e.g. remote sockets, listeners, etc...)
161 void (*func)(void* opaque, atransport* t);
168 /* a transport object models the connection to a remote device or emulator
169 ** there is one transport per connected device/emulator. a "local transport"
170 ** connects through TCP (for the emulator), while a "usb transport" through
171 ** USB (for real devices)
173 ** note that kTransportHost doesn't really correspond to a real transport
174 ** object, it's a special value used to indicate that a client wants to
175 ** connect to a service implemented within the SDB server itself.
177 typedef enum transport_type {
189 int (*read_from_remote)(apacket *p, atransport *t);
190 int (*write_to_remote)(apacket *p, atransport *t);
191 void (*close)(atransport *t);
192 void (*kick)(atransport *t);
195 int transport_socket;
196 fdevent transport_fde;
199 int connection_state;
202 /* usb handle or socket fd as needed */
206 /* used to identify transports for clients */
209 int sdb_port; // Use for emulators (local transport)
210 char *device_name; // for connection explorer
212 /* a list of adisconnect callbacks called when the transport is kicked */
214 adisconnect disconnects;
215 int protocol_version;
218 #ifdef SUPPORT_ENCRYPT
219 unsigned encryption; // 해당 연결이 암호화 모드인지 확인하는 flag , 0 = no-encryption / 1 = encryption
220 int sessionID; // 암호화 세션 ID, 암호화 map에 대한 key
225 /* A listener is an entity which binds to a local port
226 ** and, upon receiving a connection on that port, creates
227 ** an asocket to connect the new local connection to a
228 ** specific remote service.
230 ** TODO: some listeners read from the new connection to
231 ** determine what exact service to connect to on the far
242 const char *local_name;
243 const char *connect_to;
244 atransport *transport;
245 adisconnect disconnect;
248 #define UNKNOWN "unknown"
249 #define INFOBUF_MAXLEN 64
250 #define INFO_VERSION "2.2.0"
251 typedef struct platform_info {
252 char platform_info_version[INFOBUF_MAXLEN];
253 char model_name[INFOBUF_MAXLEN]; // Emulator
254 char platform_name[INFOBUF_MAXLEN]; // Tizen
255 char platform_version[INFOBUF_MAXLEN]; // 2.2.1
256 char profile_name[INFOBUF_MAXLEN]; // 2.2.1
259 #define ENABLED "enabled"
260 #define DISABLED "disabled"
261 #define CAPBUF_SIZE 4096
262 #define CAPBUF_ITEMSIZE 32
263 #define CAPBUF_L_ITEMSIZE 256
264 #define CAPBUF_LL_ITEMSIZE PATH_MAX
265 #define SDBD_CAP_VERSION_MAJOR 1
266 #define SDBD_CAP_VERSION_MINOR 0
267 typedef struct platform_capabilities
269 char secure_protocol[CAPBUF_ITEMSIZE]; // enabled or disabled
270 char intershell_support[CAPBUF_ITEMSIZE]; // enabled or disabled
271 char filesync_support[CAPBUF_ITEMSIZE]; // push or pull or pushpull or disabled
272 char rootonoff_support[CAPBUF_ITEMSIZE]; // enabled or disabled
273 char zone_support[CAPBUF_ITEMSIZE]; // enabled or disabled
274 char multiuser_support[CAPBUF_ITEMSIZE]; // enabled or disabled
275 char syncwinsz_support[CAPBUF_ITEMSIZE]; // enabled or disabled
276 char usbproto_support[CAPBUF_ITEMSIZE]; // enabled or disabled
277 char sockproto_support[CAPBUF_ITEMSIZE]; // enabled or disabled
278 char appcmd_support[CAPBUF_ITEMSIZE]; // enabled or disabled
279 char encryption_support[CAPBUF_ITEMSIZE]; // enabled or disabled
280 char appid2pid_support[CAPBUF_ITEMSIZE]; // enabled or disabled
281 char pkgcmd_debugmode[CAPBUF_ITEMSIZE]; // enabled or disabled
282 char root_permission[CAPBUF_ITEMSIZE]; // enabled or disabled
284 char log_enable[CAPBUF_ITEMSIZE]; // enabled or disabled
285 char log_path[CAPBUF_LL_ITEMSIZE]; // path of sdbd log
287 char cpu_arch[CAPBUF_ITEMSIZE]; // cpu architecture (ex. x86)
288 char profile_name[CAPBUF_ITEMSIZE]; // profile name (ex. mobile)
289 char vendor_name[CAPBUF_ITEMSIZE]; // vendor name (ex. Tizen)
290 char sdk_toolpath[CAPBUF_L_ITEMSIZE]; // sdk tool path
291 char can_launch[CAPBUF_L_ITEMSIZE]; // target name
292 char device_name[CAPBUF_ITEMSIZE]; // device name
294 char platform_version[CAPBUF_ITEMSIZE]; // platform version (ex. 2.3.0)
295 char product_version[CAPBUF_ITEMSIZE]; // product version (ex. 1.0)
296 char sdbd_version[CAPBUF_ITEMSIZE]; // sdbd version
297 char sdbd_plugin_version[CAPBUF_ITEMSIZE]; // sdbd plugin version
298 char sdbd_cap_version[CAPBUF_ITEMSIZE]; // capability version
300 extern pcap g_capabilities;
302 void print_packet(const char *label, apacket *p);
304 asocket *find_local_socket(unsigned id);
305 void install_local_socket(asocket *s);
306 void remove_socket(asocket *s);
307 void close_all_sockets(atransport *t);
309 #define LOCAL_CLIENT_PREFIX "emulator-"
311 asocket *create_local_socket(int fd);
312 asocket *create_local_service_socket(const char *destination);
314 asocket *create_remote_socket(unsigned id, atransport *t);
315 void connect_to_remote(asocket *s, const char *destination);
316 void connect_to_smartsocket(asocket *s);
317 size_t asock_get_max_payload(asocket *s);
319 void fatal(const char *fmt, ...);
320 void fatal_errno(const char *fmt, ...);
322 void handle_packet(apacket *p, atransport *t);
323 void send_packet(apacket *p, atransport *t);
325 void get_my_path(char *s, size_t maxLen);
326 int launch_server(int server_port);
327 int sdb_main(int server_port);
330 /* transports are ref-counted
331 ** get_device_transport does an acquire on your behalf before returning
333 void init_transport_registration(void);
334 int list_transports(char *buf, size_t bufsize);
335 void update_transports(void);
336 void broadcast_transport(apacket *p);
337 int get_connected_count(transport_type type);
339 asocket* create_device_tracker(void);
341 /* Obtain a transport from the available transports.
342 ** If state is != CS_ANY, only transports in that state are considered.
343 ** If serial is non-NULL then only the device with that serial will be chosen.
344 ** If no suitable transport is found, error is set.
346 atransport *acquire_one_transport(int state, transport_type ttype, const char* serial, char **error_out);
347 void add_transport_disconnect( atransport* t, adisconnect* dis );
348 void remove_transport_disconnect( atransport* t, adisconnect* dis );
349 void run_transport_disconnects( atransport* t );
350 void kick_transport( atransport* t );
352 /* initialize a transport object's func pointers and state */
353 int init_socket_transport(atransport *t, int s, int port, int local);
354 void init_usb_transport(atransport *t, usb_handle *usb, int state);
356 /* for MacOS X cleanup */
357 void close_usb_devices();
359 /* cause new transports to be init'd and added to the list */
360 void register_socket_transport(int s, const char *serial, int port, int local, const char *device_name);
362 /* these should only be used for the "sdb disconnect" command */
363 void unregister_transport(atransport *t);
364 void unregister_all_tcp_transports();
366 void register_usb_transport(usb_handle *h, const char *serial, unsigned writeable);
368 /* this should only be used for transports with connection_state == CS_NOPERM */
369 void unregister_usb_transport(usb_handle *usb);
371 atransport *find_transport(const char *serial);
373 int service_to_fd(const char *name);
376 asocket* create_jdwp_service_socket();
377 asocket* create_jdwp_tracker_service_socket();
378 int create_jdwp_connection_fd(int jdwp_pid);
384 int backup_service(BackupOperation operation, char* args);
385 void framebuffer_service(int fd, void *cookie);
386 void log_service(int fd, void *cookie);
387 void remount_service(int fd, void *cookie);
388 char * get_log_file_path(const char * log_name);
390 extern int rootshell_mode; // 0: sdk user, 1: root
391 extern int booting_done; // 0: platform booting is in progess 1: platform booting is done
393 // 1 if locked, 0 if unlocked
394 extern int is_pwlocked;
396 // This is the users and groups config for the platform
398 #define SID_ROOT 0 /* traditional unix root user */
400 #define SDK_USER_NAME tzplatform_getenv(TZ_SDK_USER_NAME)
401 #define SDK_TOOL_PATH tzplatform_getenv(TZ_SDK_TOOLS)
402 #define STATIC_SDK_USER_ID 5001
403 #define STATIC_SDK_GROUP_ID 100
404 #define STATIC_SDK_HOME_DIR "/home/owner"
405 extern uid_t g_sdk_user_id;
406 extern gid_t g_sdk_group_id;
407 extern char* g_sdk_home_dir;
408 extern char* g_sdk_home_dir_env;
410 #define ROOT_USER_NAME "root"
411 #define STATIC_ROOT_USER_ID 0
412 #define STATIC_ROOT_GROUP_ID 0
413 #define STATIC_ROOT_HOME_DIR "/root"
414 extern uid_t g_root_user_id;
415 extern gid_t g_root_group_id;
416 extern char* g_root_home_dir;
417 extern char* g_root_home_dir_env;
419 int should_drop_privileges(void);
420 void send_device_status();
421 int set_sdk_user_privileges(int is_drop_capability_after_fork);
422 int set_root_privileges();
424 int get_emulator_forward_port(void);
425 int get_emulator_name(char str[], int str_size);
426 int get_device_name(char str[], int str_size);
427 int get_emulator_hostip(char str[], int str_size);
428 int get_emulator_guestip(char str[], int str_size);
430 /* packet allocator */
431 apacket *get_apacket(void);
432 void put_apacket(apacket *p);
434 int check_header(apacket *p, atransport *t);
435 int check_data(apacket *p);
438 #define print_packet(tag,p) do {} while (0)
441 #if SDB_HOST_ON_TARGET
442 /* sdb and sdbd are coexisting on the target, so use 26099 for sdb
443 * to avoid conflicting with sdbd's usage of 26098
445 # define DEFAULT_SDB_PORT 26099 /* tizen specific */
447 # define DEFAULT_SDB_PORT 26099 /* tizen specific */
450 # define QEMU_FORWARD_IP "10.0.2.2"
452 #define DEFAULT_SDB_LOCAL_TRANSPORT_PORT 26101 /* tizen specific */
453 #define DEFAULT_SENSORS_LOCAL_TRANSPORT_PORT 26103 /* tizen specific */
455 #define SDB_CLASS 0xff
456 #define SDB_SUBCLASS 0x20 //0x42 /* tizen specific */
457 #define SDB_PROTOCOL 0x02 //0x01 /* tizen specific */
460 void local_init(int port);
461 int local_connect(int port, const char *device_name);
462 int local_connect_arbitrary_ports(int console_port, int sdb_port, const char *device_name);
464 /* usb host/client interface */
465 extern void (*usb_init)();
466 extern void (*usb_cleanup)();
467 extern int (*usb_write)(usb_handle *h, const void *data, int len);
468 extern int (*usb_read)(usb_handle *h, void *data, size_t len);
469 extern int (*usb_close)(usb_handle *h);
470 extern void (*usb_kick)(usb_handle *h);
472 /* functionfs backend */
474 void ffs_usb_cleanup();
475 int ffs_usb_write(usb_handle *h, const void *data, int len);
476 int ffs_usb_read(usb_handle *h, void *data, size_t len);
477 int ffs_usb_close(usb_handle *h);
478 void ffs_usb_kick(usb_handle *h);
480 /* kernel sdb gadget backend */
481 void linux_usb_init();
482 void linux_usb_cleanup();
483 int linux_usb_write(usb_handle *h, const void *data, int len);
484 int linux_usb_read(usb_handle *h, void *data, size_t len);
485 int linux_usb_close(usb_handle *h);
486 void linux_usb_kick(usb_handle *h);
488 unsigned host_to_le32(unsigned n);
489 int sdb_commandline(int argc, char **argv);
491 int connection_state(atransport *t);
495 #define CS_BOOTLOADER 1
498 #define CS_RECOVERY 4
499 #define CS_NOPERM 5 /* Insufficient permissions to communicate with the device */
500 #define CS_SIDELOAD 6
504 extern int SHELL_EXIT_NOTIFY_FD;
505 extern SdbdCommandlineArgs sdbd_commandline_args;
507 #define CHUNK_SIZE (64*1024)
508 #define SDBD_SHELL_CMD_MAX 4096
510 int sendfailmsg(int fd, const char *reason);
511 int handle_host_request(char *service, transport_type ttype, char* serial, int reply_fd, asocket *s);
512 int copy_packet(apacket* dest, apacket* src);
514 int is_emulator(void);
515 #define DEFAULT_DEVICENAME "unknown"
517 #define USB_FUNCFS_SDB_PATH "/dev/usb-funcs/sdb"
518 #define USB_NODE_FILE "/dev/samsung_sdb"
519 int create_subprocess(const char *cmd, pid_t *pid, char * const argv[], char * const envp[]);
520 void get_env(char *key, char **env);
522 #define RESERVE_CAPABILITIES_AFTER_FORK 0
523 #define DROP_CAPABILITIES_AFTER_FORK 1