src/sdb.h

   1 /*
   2  * Copyright (c) 2011 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   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
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  */
  16
  17 #ifndef __SDB_H
  18 #define __SDB_H
  19
  20 #include <limits.h>
  21 #include <stdlib.h>
  22 #include <stddef.h>
  23
  24 #include "transport.h"  /* readx(), writex() */
  25 #include "fdevent.h"
  26 #include "sdbd_plugin.h"
  27 #if !SDB_HOST
  28 #include "commandline_sdbd.h"
  29 #endif
  30 #include <tzplatform_config.h>
  31
  32 #define MAX_PAYLOAD 4096
  33
  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
  41
  42 #define A_VERSION 0x02000000        // SDB protocol version
  43
  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
  47
  48 #define SDB_SERVER_VERSION 0        // Increment this when we want to force users to start a new sdb server
  49
  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;
  58
  59 struct amessage {
  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             */
  66 };
  67
  68 struct apacket
  69 {
  70     apacket *next;
  71
  72     unsigned len;
  73     unsigned char *ptr;
  74
  75     amessage msg;
  76     unsigned char data[MAX_PAYLOAD];
  77 };
  78
  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.
  82 */
  83 struct asocket {
  84         /* chain pointers for the local/remote list of
  85         ** asockets that this asocket lives in
  86         */
  87     asocket *next;
  88     asocket *prev;
  89
  90         /* the unique identifier for this asocket
  91         */
  92     unsigned id;
  93
  94         /* flag: set when the socket's peer has closed
  95         ** but packets are still queued for delivery
  96         */
  97     int    closing;
  98
  99         /* the asocket we are connected to
 100         */
 101
 102     asocket *peer;
 103
 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.
 107         */
 108     fdevent fde;
 109     int fd;
 110
 111         /* queue of apackets waiting to be written
 112         */
 113     apacket *pkt_first;
 114     apacket *pkt_last;
 115
 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
 120         ** receive data.
 121         */
 122     int (*enqueue)(asocket *s, apacket *pkt);
 123
 124         /* ready is called by the peer when it is ready for
 125         ** us to send data via enqueue again
 126         */
 127     void (*ready)(asocket *s);
 128
 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.
 132         */
 133     void (*close)(asocket *s);
 134
 135         /* socket-type-specific extradata */
 136     void *extra;
 137
 138         /* A socket is bound to atransport */
 139     atransport *transport;
 140 };
 141
 142
 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...)
 147 */
 148 struct  adisconnect
 149 {
 150     void        (*func)(void*  opaque, atransport*  t);
 151     void*         opaque;
 152     adisconnect*  next;
 153     adisconnect*  prev;
 154 };
 155
 156
 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)
 161 **
 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.
 165 */
 166 typedef enum transport_type {
 167         kTransportUsb,
 168         kTransportLocal,
 169         kTransportAny,
 170         kTransportHost,
 171 } transport_type;
 172
 173 struct atransport
 174 {
 175     atransport *next;
 176     atransport *prev;
 177
 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);
 182
 183     int fd;
 184     int transport_socket;
 185     fdevent transport_fde;
 186     int ref_count;
 187     unsigned sync_token;
 188     int connection_state;
 189     transport_type type;
 190
 191         /* usb handle or socket fd as needed */
 192     usb_handle *usb;
 193     int sfd;
 194
 195         /* used to identify transports for clients */
 196     char *serial;
 197     char *product;
 198     int sdb_port; // Use for emulators (local transport)
 199     char *device_name; // for connection explorer
 200
 201         /* a list of adisconnect callbacks called when the transport is kicked */
 202     int          kicked;
 203     adisconnect  disconnects;
 204 };
 205
 206
 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.
 211 **
 212 ** TODO: some listeners read from the new connection to
 213 ** determine what exact service to connect to on the far
 214 ** side.
 215 */
 216 struct alistener
 217 {
 218     alistener *next;
 219     alistener *prev;
 220
 221     fdevent fde;
 222     int fd;
 223
 224     const char *local_name;
 225     const char *connect_to;
 226     atransport *transport;
 227     adisconnect  disconnect;
 228 };
 229
 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
 239 } pinfo;
 240
 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 #define CAPBUF_L_ITEMSIZE 256
 249 typedef struct platform_capabilities
 250 {
 251     char secure_protocol[CAPBUF_ITEMSIZE];      // enabled or disabled
 252     char intershell_support[CAPBUF_ITEMSIZE];   // enabled or disabled
 253     char filesync_support[CAPBUF_ITEMSIZE];     // push or pull or pushpull or disabled
 254     char rootonoff_support[CAPBUF_ITEMSIZE];    // enabled or disabled
 255     char zone_support[CAPBUF_ITEMSIZE];         // enabled or disabled
 256     char multiuser_support[CAPBUF_ITEMSIZE];    // enabled or disabled
 257     char syncwinsz_support[CAPBUF_ITEMSIZE];    // enabled or disabled
 258     char usbproto_support[CAPBUF_ITEMSIZE];     // enabled or disabled
 259     char sockproto_support[CAPBUF_ITEMSIZE];    // enabled or disabled
 260
 261     char cpu_arch[CAPBUF_ITEMSIZE];             // cpu architecture (ex. x86)
 262     char profile_name[CAPBUF_ITEMSIZE];         // profile name (ex. mobile)
 263     char vendor_name[CAPBUF_ITEMSIZE];          // vendor name (ex. Tizen)
 264     char sdk_toolpath[CAPBUF_L_ITEMSIZE];       // sdk tool path
 265
 266     char platform_version[CAPBUF_ITEMSIZE];     // platform version (ex. 2.3.0)
 267     char product_version[CAPBUF_ITEMSIZE];      // product version (ex. 1.0)
 268     char sdbd_version[CAPBUF_ITEMSIZE];         // sdbd version
 269     char sdbd_plugin_version[CAPBUF_ITEMSIZE];  // sdbd plugin version
 270 } pcap;
 271 extern pcap g_capabilities;
 272
 273 #define SDBD_PLUGIN_PATH    "/usr/lib/libsdbd_plugin.so"
 274 #define SDBD_PLUGIN_INTF    "sdbd_plugin_cmd_proc"
 275 typedef int (*SDBD_PLUGIN_CMD_PROC_PTR)(const char*, const char*, sdbd_plugin_param);
 276 extern SDBD_PLUGIN_CMD_PROC_PTR sdbd_plugin_cmd_proc;
 277 int request_plugin_cmd(const char* cmd, const char* in_buf, char *out_buf, unsigned int out_len);
 278 int request_plugin_verification(const char* cmd, const char* in_buf);
 279
 280 void print_packet(const char *label, apacket *p);
 281
 282 asocket *find_local_socket(unsigned id);
 283 void install_local_socket(asocket *s);
 284 void remove_socket(asocket *s);
 285 void close_all_sockets(atransport *t);
 286
 287 #define  LOCAL_CLIENT_PREFIX  "emulator-"
 288
 289 asocket *create_local_socket(int fd);
 290 asocket *create_local_service_socket(const char *destination);
 291
 292 asocket *create_remote_socket(unsigned id, atransport *t);
 293 void connect_to_remote(asocket *s, const char *destination);
 294 void connect_to_smartsocket(asocket *s);
 295
 296 void fatal(const char *fmt, ...);
 297 void fatal_errno(const char *fmt, ...);
 298
 299 void handle_packet(apacket *p, atransport *t);
 300 void send_packet(apacket *p, atransport *t);
 301
 302 void get_my_path(char *s, size_t maxLen);
 303 int launch_server(int server_port);
 304 int sdb_main(int is_daemon, int server_port);
 305
 306
 307 /* transports are ref-counted
 308 ** get_device_transport does an acquire on your behalf before returning
 309 */
 310 void init_transport_registration(void);
 311 int  list_transports(char *buf, size_t  bufsize);
 312 void update_transports(void);
 313 void broadcast_transport(apacket *p);
 314 int get_connected_count(transport_type type);
 315
 316 asocket*  create_device_tracker(void);
 317
 318 /* Obtain a transport from the available transports.
 319 ** If state is != CS_ANY, only transports in that state are considered.
 320 ** If serial is non-NULL then only the device with that serial will be chosen.
 321 ** If no suitable transport is found, error is set.
 322 */
 323 atransport *acquire_one_transport(int state, transport_type ttype, const char* serial, char **error_out);
 324 void   add_transport_disconnect( atransport*  t, adisconnect*  dis );
 325 void   remove_transport_disconnect( atransport*  t, adisconnect*  dis );
 326 void   run_transport_disconnects( atransport*  t );
 327 void   kick_transport( atransport*  t );
 328
 329 /* initialize a transport object's func pointers and state */
 330 #if SDB_HOST
 331 int get_available_local_transport_index();
 332 #endif
 333 int  init_socket_transport(atransport *t, int s, int port, int local);
 334 void init_usb_transport(atransport *t, usb_handle *usb, int state);
 335
 336 /* for MacOS X cleanup */
 337 void close_usb_devices();
 338
 339 /* cause new transports to be init'd and added to the list */
 340 void register_socket_transport(int s, const char *serial, int port, int local, const char *device_name);
 341
 342 /* these should only be used for the "sdb disconnect" command */
 343 void unregister_transport(atransport *t);
 344 void unregister_all_tcp_transports();
 345
 346 void register_usb_transport(usb_handle *h, const char *serial, unsigned writeable);
 347
 348 /* this should only be used for transports with connection_state == CS_NOPERM */
 349 void unregister_usb_transport(usb_handle *usb);
 350
 351 atransport *find_transport(const char *serial);
 352 #if SDB_HOST
 353 atransport* find_emulator_transport_by_sdb_port(int sdb_port);
 354 #endif
 355
 356 int service_to_fd(const char *name);
 357 #if SDB_HOST
 358 asocket *host_service_to_socket(const char*  name, const char *serial);
 359 #endif
 360
 361 #if !SDB_HOST
 362 int       init_jdwp(void);
 363 asocket*  create_jdwp_service_socket();
 364 asocket*  create_jdwp_tracker_service_socket();
 365 int       create_jdwp_connection_fd(int  jdwp_pid);
 366 #endif
 367
 368 #if !SDB_HOST
 369 typedef enum {
 370     BACKUP,
 371     RESTORE
 372 } BackupOperation;
 373 int backup_service(BackupOperation operation, char* args);
 374 void framebuffer_service(int fd, void *cookie);
 375 void log_service(int fd, void *cookie);
 376 void remount_service(int fd, void *cookie);
 377 char * get_log_file_path(const char * log_name);
 378
 379 extern int rootshell_mode; // 0: sdk user, 1: root
 380 extern int booting_done; // 0: platform booting is in progess 1: platform booting is done
 381
 382 // This is the users and groups config for the platform
 383
 384 #define SID_ROOT        0    /* traditional unix root user */
 385
 386 #define SDK_USER_NAME   tzplatform_getenv(TZ_SDK_USER_NAME)
 387 #define SDK_TOOL_PATH   tzplatform_getenv(TZ_SDK_TOOLS)
 388 #define STATIC_SDK_USER_ID      5001
 389 #define STATIC_SDK_GROUP_ID     100
 390 #define STATIC_SDK_HOME_DIR     "/home/owner"
 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;
 395 #endif
 396
 397 int is_pwlocked(void);
 398 int should_drop_privileges(void);
 399 int set_sdk_user_privileges();
 400 void set_root_privileges();
 401
 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);
 407
 408 /* packet allocator */
 409 apacket *get_apacket(void);
 410 void put_apacket(apacket *p);
 411
 412 int check_header(apacket *p);
 413 int check_data(apacket *p);
 414
 415 /* define SDB_TRACE to 1 to enable tracing support, or 0 to disable it */
 416
 417 #define  SDB_TRACE    1
 418
 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
 422  */
 423 typedef enum {
 424     TRACE_SDB = 0,
 425     TRACE_SOCKETS,
 426     TRACE_PACKETS,
 427     TRACE_TRANSPORT,
 428     TRACE_RWX,
 429     TRACE_USB,
 430     TRACE_SYNC,
 431     TRACE_SYSDEPS,
 432     TRACE_JDWP,
 433     TRACE_SERVICES,
 434     TRACE_PROPERTIES,
 435     TRACE_SDKTOOLS
 436 } SdbTrace;
 437
 438 #if SDB_TRACE
 439
 440 #if !SDB_HOST
 441 /*
 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).
 445  */
 446
 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__)
 451 #else
 452 #define DQ(...) ((void)0)
 453 #endif  /* !SDB_HOST */
 454
 455   extern int     sdb_trace_mask;
 456   extern unsigned char    sdb_trace_output_count;
 457   void    sdb_trace_init(void);
 458
 459 #  define SDB_TRACING  ((sdb_trace_mask & (1 << TRACE_TAG)) != 0)
 460
 461   /* you must define TRACE_TAG before using this macro */
 462 #  define  D(...)                                      \
 463         do {                                           \
 464             if (SDB_TRACING) {                         \
 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__ );         \
 471                 fflush(stderr);                        \
 472                 sdb_mutex_unlock(&D_lock);             \
 473                 errno = save_errno;                    \
 474            }                                           \
 475         } while (0)
 476 #  define  DR(...)                                     \
 477         do {                                           \
 478             if (SDB_TRACING) {                         \
 479                 int save_errno = errno;                \
 480                 sdb_mutex_lock(&D_lock);               \
 481                 errno = save_errno;                    \
 482                 fprintf(stderr, __VA_ARGS__ );         \
 483                 fflush(stderr);                        \
 484                 sdb_mutex_unlock(&D_lock);             \
 485                 errno = save_errno;                    \
 486            }                                           \
 487         } while (0)
 488 #else
 489 #  define  D(...)          ((void)0)
 490 #  define  DR(...)         ((void)0)
 491 #  define  SDB_TRACING     0
 492 #endif
 493
 494
 495 #if !TRACE_PACKETS
 496 #define print_packet(tag,p) do {} while (0)
 497 #endif
 498
 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
 502  */
 503 #  define DEFAULT_SDB_PORT 26099 /* tizen specific */
 504 #else
 505 #  define DEFAULT_SDB_PORT 26099 /* tizen specific */
 506 #endif
 507
 508 #  define QEMU_FORWARD_IP "10.0.2.2"
 509
 510 #define DEFAULT_SDB_LOCAL_TRANSPORT_PORT 26101 /* tizen specific */
 511 #define DEFAULT_SENSORS_LOCAL_TRANSPORT_PORT 26103 /* tizen specific */
 512
 513 #define SDB_CLASS              0xff
 514 #define SDB_SUBCLASS           0x20 //0x42 /* tizen specific */
 515 #define SDB_PROTOCOL           0x02 //0x01 /* tizen specific */
 516
 517
 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);
 521
 522 /* usb host/client interface */
 523 #if SDB_HOST
 524 void usb_init();
 525 void usb_cleanup();
 526 int usb_write(usb_handle *h, const void *data, int len);
 527 int usb_read(usb_handle *h, void *data, size_t len);
 528 int usb_close(usb_handle *h);
 529 void usb_kick(usb_handle *h);
 530 #else
 531
 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, size_t len);
 536 extern int (*usb_close)(usb_handle *h);
 537 extern void (*usb_kick)(usb_handle *h);
 538
 539 /* functionfs backend */
 540 void ffs_usb_init();
 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, size_t len);
 544 int ffs_usb_close(usb_handle *h);
 545 void ffs_usb_kick(usb_handle *h);
 546
 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, size_t len);
 552 int linux_usb_close(usb_handle *h);
 553 void linux_usb_kick(usb_handle *h);
 554
 555 #endif
 556
 557 /* used for USB device detection */
 558 #if SDB_HOST
 559 int is_sdb_interface(int vid, int pid, int usb_class, int usb_subclass, int usb_protocol);
 560 #endif
 561
 562 unsigned host_to_le32(unsigned n);
 563 int sdb_commandline(int argc, char **argv);
 564
 565 int connection_state(atransport *t);
 566
 567 #define CS_ANY       -1
 568 #define CS_OFFLINE    0
 569 #define CS_BOOTLOADER 1
 570 #define CS_DEVICE     2
 571 #define CS_HOST       3
 572 #define CS_RECOVERY   4
 573 #define CS_NOPERM     5 /* Insufficient permissions to communicate with the device */
 574 #define CS_SIDELOAD   6
 575 #define CS_PWLOCK     10
 576
 577 extern int HOST;
 578 extern int SHELL_EXIT_NOTIFY_FD;
 579 #if !SDB_HOST
 580 extern SdbdCommandlineArgs sdbd_commandline_args;
 581 #endif
 582
 583 #define CHUNK_SIZE (64*1024)
 584
 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);
 588
 589 int is_emulator(void);
 590 #define DEFAULT_DEVICENAME "unknown"
 591
 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
 596
 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);
 600 #endif
 601 #endif
 602
 603 #define USB_FUNCFS_SDB_PATH "/dev/usbgadget/sdb"
 604 #define USB_NODE_FILE "/dev/samsung_sdb"