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 #if !SDB_HOST
  27 #include "commandline_sdbd.h"
  28 #endif
  29 #include <tzplatform_config.h>
  30
  31 #define MAX_PAYLOAD 4096
  32
  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
  41 #define A_VERSION 0x02000000        // SDB protocol version
  42
  43 #define SDB_VERSION_MAJOR 2         // Used for help/version information
  44 #define SDB_VERSION_MINOR 2         // Used for help/version information
  45 #define SDB_VERSION_PATCH 31        // Used for help/version information
  46
  47 #define SDB_SERVER_VERSION 0        // Increment this when we want to force users to start a new sdb server
  48
  49 typedef struct amessage amessage;
  50 typedef struct apacket apacket;
  51 typedef struct asocket asocket;
  52 typedef struct alistener alistener;
  53 typedef struct aservice aservice;
  54 typedef struct atransport atransport;
  55 typedef struct adisconnect  adisconnect;
  56 typedef struct usb_handle usb_handle;
  57
  58 struct amessage {
  59     unsigned command;       /* command identifier constant      */
  60     unsigned arg0;          /* first argument                   */
  61     unsigned arg1;          /* second argument                  */
  62     unsigned data_length;   /* length of payload (0 is allowed) */
  63     unsigned data_check;    /* checksum of data payload         */
  64     unsigned magic;         /* command ^ 0xffffffff             */
  65 };
  66
  67 struct apacket
  68 {
  69     apacket *next;
  70
  71     unsigned len;
  72     unsigned char *ptr;
  73
  74     amessage msg;
  75     unsigned char data[MAX_PAYLOAD];
  76 };
  77
  78 /* An asocket represents one half of a connection between a local and
  79 ** remote entity.  A local asocket is bound to a file descriptor.  A
  80 ** remote asocket is bound to the protocol engine.
  81 */
  82 struct asocket {
  83         /* chain pointers for the local/remote list of
  84         ** asockets that this asocket lives in
  85         */
  86     asocket *next;
  87     asocket *prev;
  88
  89         /* the unique identifier for this asocket
  90         */
  91     unsigned id;
  92
  93         /* flag: set when the socket's peer has closed
  94         ** but packets are still queued for delivery
  95         */
  96     int    closing;
  97
  98         /* the asocket we are connected to
  99         */
 100
 101     asocket *peer;
 102
 103         /* For local asockets, the fde is used to bind
 104         ** us to our fd event system.  For remote asockets
 105         ** these fields are not used.
 106         */
 107     fdevent fde;
 108     int fd;
 109
 110         /* queue of apackets waiting to be written
 111         */
 112     apacket *pkt_first;
 113     apacket *pkt_last;
 114
 115         /* enqueue is called by our peer when it has data
 116         ** for us.  It should return 0 if we can accept more
 117         ** data or 1 if not.  If we return 1, we must call
 118         ** peer->ready() when we once again are ready to
 119         ** receive data.
 120         */
 121     int (*enqueue)(asocket *s, apacket *pkt);
 122
 123         /* ready is called by the peer when it is ready for
 124         ** us to send data via enqueue again
 125         */
 126     void (*ready)(asocket *s);
 127
 128         /* close is called by the peer when it has gone away.
 129         ** we are not allowed to make any further calls on the
 130         ** peer once our close method is called.
 131         */
 132     void (*close)(asocket *s);
 133
 134         /* socket-type-specific extradata */
 135     void *extra;
 136
 137         /* A socket is bound to atransport */
 138     atransport *transport;
 139 };
 140
 141
 142 /* the adisconnect structure is used to record a callback that
 143 ** will be called whenever a transport is disconnected (e.g. by the user)
 144 ** this should be used to cleanup objects that depend on the
 145 ** transport (e.g. remote sockets, listeners, etc...)
 146 */
 147 struct  adisconnect
 148 {
 149     void        (*func)(void*  opaque, atransport*  t);
 150     void*         opaque;
 151     adisconnect*  next;
 152     adisconnect*  prev;
 153 };
 154
 155
 156 /* a transport object models the connection to a remote device or emulator
 157 ** there is one transport per connected device/emulator. a "local transport"
 158 ** connects through TCP (for the emulator), while a "usb transport" through
 159 ** USB (for real devices)
 160 **
 161 ** note that kTransportHost doesn't really correspond to a real transport
 162 ** object, it's a special value used to indicate that a client wants to
 163 ** connect to a service implemented within the SDB server itself.
 164 */
 165 typedef enum transport_type {
 166         kTransportUsb,
 167         kTransportLocal,
 168         kTransportAny,
 169         kTransportHost,
 170 } transport_type;
 171
 172 struct atransport
 173 {
 174     atransport *next;
 175     atransport *prev;
 176
 177     int (*read_from_remote)(apacket *p, atransport *t);
 178     int (*write_to_remote)(apacket *p, atransport *t);
 179     void (*close)(atransport *t);
 180     void (*kick)(atransport *t);
 181
 182     int fd;
 183     int transport_socket;
 184     fdevent transport_fde;
 185     int ref_count;
 186     unsigned sync_token;
 187     int connection_state;
 188     transport_type type;
 189
 190         /* usb handle or socket fd as needed */
 191     usb_handle *usb;
 192     int sfd;
 193
 194         /* used to identify transports for clients */
 195     char *serial;
 196     char *product;
 197     int sdb_port; // Use for emulators (local transport)
 198     char *device_name; // for connection explorer
 199
 200         /* a list of adisconnect callbacks called when the transport is kicked */
 201     int          kicked;
 202     adisconnect  disconnects;
 203 };
 204
 205
 206 /* A listener is an entity which binds to a local port
 207 ** and, upon receiving a connection on that port, creates
 208 ** an asocket to connect the new local connection to a
 209 ** specific remote service.
 210 **
 211 ** TODO: some listeners read from the new connection to
 212 ** determine what exact service to connect to on the far
 213 ** side.
 214 */
 215 struct alistener
 216 {
 217     alistener *next;
 218     alistener *prev;
 219
 220     fdevent fde;
 221     int fd;
 222
 223     const char *local_name;
 224     const char *connect_to;
 225     atransport *transport;
 226     adisconnect  disconnect;
 227 };
 228
 229 #define UNKNOWN "unknown"
 230 #define INFOBUF_MAXLEN 64
 231 #define INFO_VERSION "2.2.0"
 232 typedef struct platform_info {
 233     char platform_info_version[INFOBUF_MAXLEN];
 234     char model_name[INFOBUF_MAXLEN]; // Emulator
 235     char platform_name[INFOBUF_MAXLEN]; // Tizen
 236     char platform_version[INFOBUF_MAXLEN]; // 2.2.1
 237     char profile_name[INFOBUF_MAXLEN]; // 2.2.1
 238 } pinfo;
 239
 240 #define ENABLED "enabled"
 241 #define DISABLED "disabled"
 242 #define CAPBUF_SIZE 4096
 243 #define CAPBUF_ITEMSIZE 32
 244 #define CAPBUF_L_ITEMSIZE 256
 245 #define CAPBUF_LL_ITEMSIZE PATH_MAX
 246 #define SDBD_CAP_VERSION_MAJOR 1
 247 #define SDBD_CAP_VERSION_MINOR 0
 248 typedef struct platform_capabilities
 249 {
 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
 259
 260     char log_enable[CAPBUF_ITEMSIZE];    // enabled or disabled
 261     char log_path[CAPBUF_LL_ITEMSIZE];    // path of sdbd log
 262
 263     char cpu_arch[CAPBUF_ITEMSIZE];             // cpu architecture (ex. x86)
 264     char profile_name[CAPBUF_ITEMSIZE];         // profile name (ex. mobile)
 265     char vendor_name[CAPBUF_ITEMSIZE];          // vendor name (ex. Tizen)
 266     char sdk_toolpath[CAPBUF_L_ITEMSIZE];       // sdk tool path
 267     char can_launch[CAPBUF_L_ITEMSIZE];         // target name
 268
 269     char platform_version[CAPBUF_ITEMSIZE];     // platform version (ex. 2.3.0)
 270     char product_version[CAPBUF_ITEMSIZE];      // product version (ex. 1.0)
 271     char sdbd_version[CAPBUF_ITEMSIZE];         // sdbd version
 272     char sdbd_plugin_version[CAPBUF_ITEMSIZE];  // sdbd plugin version
 273     char sdbd_cap_version[CAPBUF_ITEMSIZE];     // capability version
 274 } pcap;
 275 extern pcap g_capabilities;
 276
 277 void print_packet(const char *label, apacket *p);
 278
 279 asocket *find_local_socket(unsigned id);
 280 void install_local_socket(asocket *s);
 281 void remove_socket(asocket *s);
 282 void close_all_sockets(atransport *t);
 283
 284 #define  LOCAL_CLIENT_PREFIX  "emulator-"
 285
 286 asocket *create_local_socket(int fd);
 287 asocket *create_local_service_socket(const char *destination);
 288
 289 asocket *create_remote_socket(unsigned id, atransport *t);
 290 void connect_to_remote(asocket *s, const char *destination);
 291 void connect_to_smartsocket(asocket *s);
 292
 293 void fatal(const char *fmt, ...);
 294 void fatal_errno(const char *fmt, ...);
 295
 296 void handle_packet(apacket *p, atransport *t);
 297 void send_packet(apacket *p, atransport *t);
 298
 299 void get_my_path(char *s, size_t maxLen);
 300 int launch_server(int server_port);
 301 int sdb_main(int is_daemon, int server_port);
 302
 303
 304 /* transports are ref-counted
 305 ** get_device_transport does an acquire on your behalf before returning
 306 */
 307 void init_transport_registration(void);
 308 int  list_transports(char *buf, size_t  bufsize);
 309 void update_transports(void);
 310 void broadcast_transport(apacket *p);
 311 int get_connected_count(transport_type type);
 312
 313 asocket*  create_device_tracker(void);
 314
 315 /* Obtain a transport from the available transports.
 316 ** If state is != CS_ANY, only transports in that state are considered.
 317 ** If serial is non-NULL then only the device with that serial will be chosen.
 318 ** If no suitable transport is found, error is set.
 319 */
 320 atransport *acquire_one_transport(int state, transport_type ttype, const char* serial, char **error_out);
 321 void   add_transport_disconnect( atransport*  t, adisconnect*  dis );
 322 void   remove_transport_disconnect( atransport*  t, adisconnect*  dis );
 323 void   run_transport_disconnects( atransport*  t );
 324 void   kick_transport( atransport*  t );
 325
 326 /* initialize a transport object's func pointers and state */
 327 #if SDB_HOST
 328 int get_available_local_transport_index();
 329 #endif
 330 int  init_socket_transport(atransport *t, int s, int port, int local);
 331 void init_usb_transport(atransport *t, usb_handle *usb, int state);
 332
 333 /* for MacOS X cleanup */
 334 void close_usb_devices();
 335
 336 /* cause new transports to be init'd and added to the list */
 337 void register_socket_transport(int s, const char *serial, int port, int local, const char *device_name);
 338
 339 /* these should only be used for the "sdb disconnect" command */
 340 void unregister_transport(atransport *t);
 341 void unregister_all_tcp_transports();
 342
 343 void register_usb_transport(usb_handle *h, const char *serial, unsigned writeable);
 344
 345 /* this should only be used for transports with connection_state == CS_NOPERM */
 346 void unregister_usb_transport(usb_handle *usb);
 347
 348 atransport *find_transport(const char *serial);
 349 #if SDB_HOST
 350 atransport* find_emulator_transport_by_sdb_port(int sdb_port);
 351 #endif
 352
 353 int service_to_fd(const char *name);
 354 #if SDB_HOST
 355 asocket *host_service_to_socket(const char*  name, const char *serial);
 356 #endif
 357
 358 #if !SDB_HOST
 359 int       init_jdwp(void);
 360 asocket*  create_jdwp_service_socket();
 361 asocket*  create_jdwp_tracker_service_socket();
 362 int       create_jdwp_connection_fd(int  jdwp_pid);
 363 #endif
 364
 365 #if !SDB_HOST
 366 typedef enum {
 367     BACKUP,
 368     RESTORE
 369 } BackupOperation;
 370 int backup_service(BackupOperation operation, char* args);
 371 void framebuffer_service(int fd, void *cookie);
 372 void log_service(int fd, void *cookie);
 373 void remount_service(int fd, void *cookie);
 374 char * get_log_file_path(const char * log_name);
 375
 376 extern int rootshell_mode; // 0: sdk user, 1: root
 377 extern int booting_done; // 0: platform booting is in progess 1: platform booting is done
 378
 379 // 1 if locked, 0 if unlocked
 380 extern int is_pwlocked;
 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 should_drop_privileges(void);
 398 int set_sdk_user_privileges();
 399 void set_root_privileges();
 400 void send_device_status();
 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 #if !TRACE_PACKETS
 416 #define print_packet(tag,p) do {} while (0)
 417 #endif
 418
 419 #if SDB_HOST_ON_TARGET
 420 /* sdb and sdbd are coexisting on the target, so use 26099 for sdb
 421  * to avoid conflicting with sdbd's usage of 26098
 422  */
 423 #  define DEFAULT_SDB_PORT 26099 /* tizen specific */
 424 #else
 425 #  define DEFAULT_SDB_PORT 26099 /* tizen specific */
 426 #endif
 427
 428 #  define QEMU_FORWARD_IP "10.0.2.2"
 429
 430 #define DEFAULT_SDB_LOCAL_TRANSPORT_PORT 26101 /* tizen specific */
 431 #define DEFAULT_SENSORS_LOCAL_TRANSPORT_PORT 26103 /* tizen specific */
 432
 433 #define SDB_CLASS              0xff
 434 #define SDB_SUBCLASS           0x20 //0x42 /* tizen specific */
 435 #define SDB_PROTOCOL           0x02 //0x01 /* tizen specific */
 436
 437
 438 void local_init(int port);
 439 int  local_connect(int  port, const char *device_name);
 440 int  local_connect_arbitrary_ports(int console_port, int sdb_port, const char *device_name);
 441
 442 /* usb host/client interface */
 443 #if SDB_HOST
 444 void usb_init();
 445 void usb_cleanup();
 446 int usb_write(usb_handle *h, const void *data, int len);
 447 int usb_read(usb_handle *h, void *data, size_t len);
 448 int usb_close(usb_handle *h);
 449 void usb_kick(usb_handle *h);
 450 #else
 451
 452 extern void (*usb_init)();
 453 extern void (*usb_cleanup)();
 454 extern int (*usb_write)(usb_handle *h, const void *data, int len);
 455 extern int (*usb_read)(usb_handle *h, void *data, size_t len);
 456 extern int (*usb_close)(usb_handle *h);
 457 extern void (*usb_kick)(usb_handle *h);
 458
 459 /* functionfs backend */
 460 void ffs_usb_init();
 461 void ffs_usb_cleanup();
 462 int ffs_usb_write(usb_handle *h, const void *data, int len);
 463 int ffs_usb_read(usb_handle *h, void *data, size_t len);
 464 int ffs_usb_close(usb_handle *h);
 465 void ffs_usb_kick(usb_handle *h);
 466
 467 /* kernel sdb gadget backend */
 468 void linux_usb_init();
 469 void linux_usb_cleanup();
 470 int linux_usb_write(usb_handle *h, const void *data, int len);
 471 int linux_usb_read(usb_handle *h, void *data, size_t len);
 472 int linux_usb_close(usb_handle *h);
 473 void linux_usb_kick(usb_handle *h);
 474
 475 #endif
 476
 477 /* used for USB device detection */
 478 #if SDB_HOST
 479 int is_sdb_interface(int vid, int pid, int usb_class, int usb_subclass, int usb_protocol);
 480 #endif
 481
 482 unsigned host_to_le32(unsigned n);
 483 int sdb_commandline(int argc, char **argv);
 484
 485 int connection_state(atransport *t);
 486
 487 #define CS_ANY       -1
 488 #define CS_OFFLINE    0
 489 #define CS_BOOTLOADER 1
 490 #define CS_DEVICE     2
 491 #define CS_HOST       3
 492 #define CS_RECOVERY   4
 493 #define CS_NOPERM     5 /* Insufficient permissions to communicate with the device */
 494 #define CS_SIDELOAD   6
 495 #define CS_PWLOCK     10
 496
 497 extern int HOST;
 498 extern int SHELL_EXIT_NOTIFY_FD;
 499 #if !SDB_HOST
 500 extern SdbdCommandlineArgs sdbd_commandline_args;
 501 #endif
 502
 503 #define CHUNK_SIZE (64*1024)
 504 #define SDBD_SHELL_CMD_MAX 4096
 505
 506 int sendfailmsg(int fd, const char *reason);
 507 int handle_host_request(char *service, transport_type ttype, char* serial, int reply_fd, asocket *s);
 508 int copy_packet(apacket* dest, apacket* src);
 509
 510 int is_emulator(void);
 511 #define DEFAULT_DEVICENAME "unknown"
 512
 513 #if SDB_HOST /* tizen-specific */
 514 #define DEVICEMAP_SEPARATOR ":"
 515 #define DEVICENAME_MAX 256
 516 #define VMS_PATH OS_PATH_SEPARATOR_STR "vms" OS_PATH_SEPARATOR_STR // should include sysdeps.h above
 517
 518 void register_device_name(const char *device_type, const char *device_name, int port);
 519 int get_devicename_from_shdmem(int port, char *device_name);
 520 int read_line(const int fd, char* ptr, const size_t maxlen);
 521 #endif
 522 #endif
 523
 524 #define USB_FUNCFS_SDB_PATH "/dev/usbgadget/sdb"
 525 #define USB_NODE_FILE "/dev/samsung_sdb"