tools/perf/scripts/python/export-to-postgresql.py

   1 # export-to-postgresql.py: export perf data to a postgresql database
   2 # Copyright (c) 2014, Intel Corporation.
   3 #
   4 # This program is free software; you can redistribute it and/or modify it
   5 # under the terms and conditions of the GNU General Public License,
   6 # version 2, as published by the Free Software Foundation.
   7 #
   8 # This program is distributed in the hope it will be useful, but WITHOUT
   9 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  10 # FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  11 # more details.
  12
  13 from __future__ import print_function
  14
  15 import os
  16 import sys
  17 import struct
  18 import datetime
  19
  20 # To use this script you will need to have installed package python-pyside which
  21 # provides LGPL-licensed Python bindings for Qt.  You will also need the package
  22 # libqt4-sql-psql for Qt postgresql support.
  23 #
  24 # The script assumes postgresql is running on the local machine and that the
  25 # user has postgresql permissions to create databases. Examples of installing
  26 # postgresql and adding such a user are:
  27 #
  28 # fedora:
  29 #
  30 #       $ sudo yum install postgresql postgresql-server qt-postgresql
  31 #       $ sudo su - postgres -c initdb
  32 #       $ sudo service postgresql start
  33 #       $ sudo su - postgres
  34 #       $ createuser -s <your user id here>    # Older versions may not support -s, in which case answer the prompt below:
  35 #       Shall the new role be a superuser? (y/n) y
  36 #       $ sudo yum install python-pyside
  37 #
  38 #       Alternately, to use Python3 and/or pyside 2, one of the following:
  39 #               $ sudo yum install python3-pyside
  40 #               $ pip install --user PySide2
  41 #               $ pip3 install --user PySide2
  42 #
  43 # ubuntu:
  44 #
  45 #       $ sudo apt-get install postgresql
  46 #       $ sudo su - postgres
  47 #       $ createuser -s <your user id here>
  48 #       $ sudo apt-get install python-pyside.qtsql libqt4-sql-psql
  49 #
  50 #       Alternately, to use Python3 and/or pyside 2, one of the following:
  51 #
  52 #               $ sudo apt-get install python3-pyside.qtsql libqt4-sql-psql
  53 #               $ sudo apt-get install python-pyside2.qtsql libqt5sql5-psql
  54 #               $ sudo apt-get install python3-pyside2.qtsql libqt5sql5-psql
  55 #
  56 # An example of using this script with Intel PT:
  57 #
  58 #       $ perf record -e intel_pt//u ls
  59 #       $ perf script -s ~/libexec/perf-core/scripts/python/export-to-postgresql.py pt_example branches calls
  60 #       2015-05-29 12:49:23.464364 Creating database...
  61 #       2015-05-29 12:49:26.281717 Writing to intermediate files...
  62 #       2015-05-29 12:49:27.190383 Copying to database...
  63 #       2015-05-29 12:49:28.140451 Removing intermediate files...
  64 #       2015-05-29 12:49:28.147451 Adding primary keys
  65 #       2015-05-29 12:49:28.655683 Adding foreign keys
  66 #       2015-05-29 12:49:29.365350 Done
  67 #
  68 # To browse the database, psql can be used e.g.
  69 #
  70 #       $ psql pt_example
  71 #       pt_example=# select * from samples_view where id < 100;
  72 #       pt_example=# \d+
  73 #       pt_example=# \d+ samples_view
  74 #       pt_example=# \q
  75 #
  76 # An example of using the database is provided by the script
  77 # exported-sql-viewer.py.  Refer to that script for details.
  78 #
  79 # Tables:
  80 #
  81 #       The tables largely correspond to perf tools' data structures.  They are largely self-explanatory.
  82 #
  83 #       samples
  84 #
  85 #               'samples' is the main table. It represents what instruction was executing at a point in time
  86 #               when something (a selected event) happened.  The memory address is the instruction pointer or 'ip'.
  87 #
  88 #       calls
  89 #
  90 #               'calls' represents function calls and is related to 'samples' by 'call_id' and 'return_id'.
  91 #               'calls' is only created when the 'calls' option to this script is specified.
  92 #
  93 #       call_paths
  94 #
  95 #               'call_paths' represents all the call stacks.  Each 'call' has an associated record in 'call_paths'.
  96 #               'calls_paths' is only created when the 'calls' option to this script is specified.
  97 #
  98 #       branch_types
  99 #
 100 #               'branch_types' provides descriptions for each type of branch.
 101 #
 102 #       comm_threads
 103 #
 104 #               'comm_threads' shows how 'comms' relates to 'threads'.
 105 #
 106 #       comms
 107 #
 108 #               'comms' contains a record for each 'comm' - the name given to the executable that is running.
 109 #
 110 #       dsos
 111 #
 112 #               'dsos' contains a record for each executable file or library.
 113 #
 114 #       machines
 115 #
 116 #               'machines' can be used to distinguish virtual machines if virtualization is supported.
 117 #
 118 #       selected_events
 119 #
 120 #               'selected_events' contains a record for each kind of event that has been sampled.
 121 #
 122 #       symbols
 123 #
 124 #               'symbols' contains a record for each symbol.  Only symbols that have samples are present.
 125 #
 126 #       threads
 127 #
 128 #               'threads' contains a record for each thread.
 129 #
 130 # Views:
 131 #
 132 #       Most of the tables have views for more friendly display.  The views are:
 133 #
 134 #               calls_view
 135 #               call_paths_view
 136 #               comm_threads_view
 137 #               dsos_view
 138 #               machines_view
 139 #               samples_view
 140 #               symbols_view
 141 #               threads_view
 142 #
 143 # More examples of browsing the database with psql:
 144 #   Note that some of the examples are not the most optimal SQL query.
 145 #   Note that call information is only available if the script's 'calls' option has been used.
 146 #
 147 #       Top 10 function calls (not aggregated by symbol):
 148 #
 149 #               SELECT * FROM calls_view ORDER BY elapsed_time DESC LIMIT 10;
 150 #
 151 #       Top 10 function calls (aggregated by symbol):
 152 #
 153 #               SELECT symbol_id,(SELECT name FROM symbols WHERE id = symbol_id) AS symbol,
 154 #                       SUM(elapsed_time) AS tot_elapsed_time,SUM(branch_count) AS tot_branch_count
 155 #                       FROM calls_view GROUP BY symbol_id ORDER BY tot_elapsed_time DESC LIMIT 10;
 156 #
 157 #               Note that the branch count gives a rough estimation of cpu usage, so functions
 158 #               that took a long time but have a relatively low branch count must have spent time
 159 #               waiting.
 160 #
 161 #       Find symbols by pattern matching on part of the name (e.g. names containing 'alloc'):
 162 #
 163 #               SELECT * FROM symbols_view WHERE name LIKE '%alloc%';
 164 #
 165 #       Top 10 function calls for a specific symbol (e.g. whose symbol_id is 187):
 166 #
 167 #               SELECT * FROM calls_view WHERE symbol_id = 187 ORDER BY elapsed_time DESC LIMIT 10;
 168 #
 169 #       Show function calls made by function in the same context (i.e. same call path) (e.g. one with call_path_id 254):
 170 #
 171 #               SELECT * FROM calls_view WHERE parent_call_path_id = 254;
 172 #
 173 #       Show branches made during a function call (e.g. where call_id is 29357 and return_id is 29370 and tid is 29670)
 174 #
 175 #               SELECT * FROM samples_view WHERE id >= 29357 AND id <= 29370 AND tid = 29670 AND event LIKE 'branches%';
 176 #
 177 #       Show transactions:
 178 #
 179 #               SELECT * FROM samples_view WHERE event = 'transactions';
 180 #
 181 #               Note transaction start has 'in_tx' true whereas, transaction end has 'in_tx' false.
 182 #               Transaction aborts have branch_type_name 'transaction abort'
 183 #
 184 #       Show transaction aborts:
 185 #
 186 #               SELECT * FROM samples_view WHERE event = 'transactions' AND branch_type_name = 'transaction abort';
 187 #
 188 # To print a call stack requires walking the call_paths table.  For example this python script:
 189 #   #!/usr/bin/python2
 190 #
 191 #   import sys
 192 #   from PySide.QtSql import *
 193 #
 194 #   if __name__ == '__main__':
 195 #           if (len(sys.argv) < 3):
 196 #                   print >> sys.stderr, "Usage is: printcallstack.py <database name> <call_path_id>"
 197 #                   raise Exception("Too few arguments")
 198 #           dbname = sys.argv[1]
 199 #           call_path_id = sys.argv[2]
 200 #           db = QSqlDatabase.addDatabase('QPSQL')
 201 #           db.setDatabaseName(dbname)
 202 #           if not db.open():
 203 #                   raise Exception("Failed to open database " + dbname + " error: " + db.lastError().text())
 204 #           query = QSqlQuery(db)
 205 #           print "    id          ip  symbol_id  symbol                          dso_id  dso_short_name"
 206 #           while call_path_id != 0 and call_path_id != 1:
 207 #                   ret = query.exec_('SELECT * FROM call_paths_view WHERE id = ' + str(call_path_id))
 208 #                   if not ret:
 209 #                           raise Exception("Query failed: " + query.lastError().text())
 210 #                   if not query.next():
 211 #                           raise Exception("Query failed")
 212 #                   print "{0:>6}  {1:>10}  {2:>9}  {3:<30}  {4:>6}  {5:<30}".format(query.value(0), query.value(1), query.value(2), query.value(3), query.value(4), query.value(5))
 213 #                   call_path_id = query.value(6)
 214
 215 pyside_version_1 = True
 216 if not "pyside-version-1" in sys.argv:
 217         try:
 218                 from PySide2.QtSql import *
 219                 pyside_version_1 = False
 220         except:
 221                 pass
 222
 223 if pyside_version_1:
 224         from PySide.QtSql import *
 225
 226 if sys.version_info < (3, 0):
 227         def toserverstr(str):
 228                 return str
 229         def toclientstr(str):
 230                 return str
 231 else:
 232         # Assume UTF-8 server_encoding and client_encoding
 233         def toserverstr(str):
 234                 return bytes(str, "UTF_8")
 235         def toclientstr(str):
 236                 return bytes(str, "UTF_8")
 237
 238 # Need to access PostgreSQL C library directly to use COPY FROM STDIN
 239 from ctypes import *
 240 libpq = CDLL("libpq.so.5")
 241 PQconnectdb = libpq.PQconnectdb
 242 PQconnectdb.restype = c_void_p
 243 PQconnectdb.argtypes = [ c_char_p ]
 244 PQfinish = libpq.PQfinish
 245 PQfinish.argtypes = [ c_void_p ]
 246 PQstatus = libpq.PQstatus
 247 PQstatus.restype = c_int
 248 PQstatus.argtypes = [ c_void_p ]
 249 PQexec = libpq.PQexec
 250 PQexec.restype = c_void_p
 251 PQexec.argtypes = [ c_void_p, c_char_p ]
 252 PQresultStatus = libpq.PQresultStatus
 253 PQresultStatus.restype = c_int
 254 PQresultStatus.argtypes = [ c_void_p ]
 255 PQputCopyData = libpq.PQputCopyData
 256 PQputCopyData.restype = c_int
 257 PQputCopyData.argtypes = [ c_void_p, c_void_p, c_int ]
 258 PQputCopyEnd = libpq.PQputCopyEnd
 259 PQputCopyEnd.restype = c_int
 260 PQputCopyEnd.argtypes = [ c_void_p, c_void_p ]
 261
 262 sys.path.append(os.environ['PERF_EXEC_PATH'] + \
 263         '/scripts/python/Perf-Trace-Util/lib/Perf/Trace')
 264
 265 # These perf imports are not used at present
 266 #from perf_trace_context import *
 267 #from Core import *
 268
 269 perf_db_export_mode = True
 270 perf_db_export_calls = False
 271 perf_db_export_callchains = False
 272
 273 def printerr(*args, **kw_args):
 274         print(*args, file=sys.stderr, **kw_args)
 275
 276 def printdate(*args, **kw_args):
 277         print(datetime.datetime.today(), *args, sep=' ', **kw_args)
 278
 279 def usage():
 280         printerr("Usage is: export-to-postgresql.py <database name> [<columns>] [<calls>] [<callchains>] [<pyside-version-1>]");
 281         printerr("where:  columns            'all' or 'branches'");
 282         printerr("        calls              'calls' => create calls and call_paths table");
 283         printerr("        callchains         'callchains' => create call_paths table");
 284         printerr("        pyside-version-1   'pyside-version-1' => use pyside version 1");
 285         raise Exception("Too few or bad arguments")
 286
 287 if (len(sys.argv) < 2):
 288         usage()
 289
 290 dbname = sys.argv[1]
 291
 292 if (len(sys.argv) >= 3):
 293         columns = sys.argv[2]
 294 else:
 295         columns = "all"
 296
 297 if columns not in ("all", "branches"):
 298         usage()
 299
 300 branches = (columns == "branches")
 301
 302 for i in range(3,len(sys.argv)):
 303         if (sys.argv[i] == "calls"):
 304                 perf_db_export_calls = True
 305         elif (sys.argv[i] == "callchains"):
 306                 perf_db_export_callchains = True
 307         elif (sys.argv[i] == "pyside-version-1"):
 308                 pass
 309         else:
 310                 usage()
 311
 312 output_dir_name = os.getcwd() + "/" + dbname + "-perf-data"
 313 os.mkdir(output_dir_name)
 314
 315 def do_query(q, s):
 316         if (q.exec_(s)):
 317                 return
 318         raise Exception("Query failed: " + q.lastError().text())
 319
 320 printdate("Creating database...")
 321
 322 db = QSqlDatabase.addDatabase('QPSQL')
 323 query = QSqlQuery(db)
 324 db.setDatabaseName('postgres')
 325 db.open()
 326 try:
 327         do_query(query, 'CREATE DATABASE ' + dbname)
 328 except:
 329         os.rmdir(output_dir_name)
 330         raise
 331 query.finish()
 332 query.clear()
 333 db.close()
 334
 335 db.setDatabaseName(dbname)
 336 db.open()
 337
 338 query = QSqlQuery(db)
 339 do_query(query, 'SET client_min_messages TO WARNING')
 340
 341 do_query(query, 'CREATE TABLE selected_events ('
 342                 'id             bigint          NOT NULL,'
 343                 'name           varchar(80))')
 344 do_query(query, 'CREATE TABLE machines ('
 345                 'id             bigint          NOT NULL,'
 346                 'pid            integer,'
 347                 'root_dir       varchar(4096))')
 348 do_query(query, 'CREATE TABLE threads ('
 349                 'id             bigint          NOT NULL,'
 350                 'machine_id     bigint,'
 351                 'process_id     bigint,'
 352                 'pid            integer,'
 353                 'tid            integer)')
 354 do_query(query, 'CREATE TABLE comms ('
 355                 'id             bigint          NOT NULL,'
 356                 'comm           varchar(16))')
 357 do_query(query, 'CREATE TABLE comm_threads ('
 358                 'id             bigint          NOT NULL,'
 359                 'comm_id        bigint,'
 360                 'thread_id      bigint)')
 361 do_query(query, 'CREATE TABLE dsos ('
 362                 'id             bigint          NOT NULL,'
 363                 'machine_id     bigint,'
 364                 'short_name     varchar(256),'
 365                 'long_name      varchar(4096),'
 366                 'build_id       varchar(64))')
 367 do_query(query, 'CREATE TABLE symbols ('
 368                 'id             bigint          NOT NULL,'
 369                 'dso_id         bigint,'
 370                 'sym_start      bigint,'
 371                 'sym_end        bigint,'
 372                 'binding        integer,'
 373                 'name           varchar(2048))')
 374 do_query(query, 'CREATE TABLE branch_types ('
 375                 'id             integer         NOT NULL,'
 376                 'name           varchar(80))')
 377
 378 if branches:
 379         do_query(query, 'CREATE TABLE samples ('
 380                 'id             bigint          NOT NULL,'
 381                 'evsel_id       bigint,'
 382                 'machine_id     bigint,'
 383                 'thread_id      bigint,'
 384                 'comm_id        bigint,'
 385                 'dso_id         bigint,'
 386                 'symbol_id      bigint,'
 387                 'sym_offset     bigint,'
 388                 'ip             bigint,'
 389                 'time           bigint,'
 390                 'cpu            integer,'
 391                 'to_dso_id      bigint,'
 392                 'to_symbol_id   bigint,'
 393                 'to_sym_offset  bigint,'
 394                 'to_ip          bigint,'
 395                 'branch_type    integer,'
 396                 'in_tx          boolean,'
 397                 'call_path_id   bigint)')
 398 else:
 399         do_query(query, 'CREATE TABLE samples ('
 400                 'id             bigint          NOT NULL,'
 401                 'evsel_id       bigint,'
 402                 'machine_id     bigint,'
 403                 'thread_id      bigint,'
 404                 'comm_id        bigint,'
 405                 'dso_id         bigint,'
 406                 'symbol_id      bigint,'
 407                 'sym_offset     bigint,'
 408                 'ip             bigint,'
 409                 'time           bigint,'
 410                 'cpu            integer,'
 411                 'to_dso_id      bigint,'
 412                 'to_symbol_id   bigint,'
 413                 'to_sym_offset  bigint,'
 414                 'to_ip          bigint,'
 415                 'period         bigint,'
 416                 'weight         bigint,'
 417                 'transaction    bigint,'
 418                 'data_src       bigint,'
 419                 'branch_type    integer,'
 420                 'in_tx          boolean,'
 421                 'call_path_id   bigint)')
 422
 423 if perf_db_export_calls or perf_db_export_callchains:
 424         do_query(query, 'CREATE TABLE call_paths ('
 425                 'id             bigint          NOT NULL,'
 426                 'parent_id      bigint,'
 427                 'symbol_id      bigint,'
 428                 'ip             bigint)')
 429 if perf_db_export_calls:
 430         do_query(query, 'CREATE TABLE calls ('
 431                 'id             bigint          NOT NULL,'
 432                 'thread_id      bigint,'
 433                 'comm_id        bigint,'
 434                 'call_path_id   bigint,'
 435                 'call_time      bigint,'
 436                 'return_time    bigint,'
 437                 'branch_count   bigint,'
 438                 'call_id        bigint,'
 439                 'return_id      bigint,'
 440                 'parent_call_path_id    bigint,'
 441                 'flags          integer,'
 442                 'parent_id      bigint)')
 443
 444 do_query(query, 'CREATE VIEW machines_view AS '
 445         'SELECT '
 446                 'id,'
 447                 'pid,'
 448                 'root_dir,'
 449                 'CASE WHEN id=0 THEN \'unknown\' WHEN pid=-1 THEN \'host\' ELSE \'guest\' END AS host_or_guest'
 450         ' FROM machines')
 451
 452 do_query(query, 'CREATE VIEW dsos_view AS '
 453         'SELECT '
 454                 'id,'
 455                 'machine_id,'
 456                 '(SELECT host_or_guest FROM machines_view WHERE id = machine_id) AS host_or_guest,'
 457                 'short_name,'
 458                 'long_name,'
 459                 'build_id'
 460         ' FROM dsos')
 461
 462 do_query(query, 'CREATE VIEW symbols_view AS '
 463         'SELECT '
 464                 'id,'
 465                 'name,'
 466                 '(SELECT short_name FROM dsos WHERE id=dso_id) AS dso,'
 467                 'dso_id,'
 468                 'sym_start,'
 469                 'sym_end,'
 470                 'CASE WHEN binding=0 THEN \'local\' WHEN binding=1 THEN \'global\' ELSE \'weak\' END AS binding'
 471         ' FROM symbols')
 472
 473 do_query(query, 'CREATE VIEW threads_view AS '
 474         'SELECT '
 475                 'id,'
 476                 'machine_id,'
 477                 '(SELECT host_or_guest FROM machines_view WHERE id = machine_id) AS host_or_guest,'
 478                 'process_id,'
 479                 'pid,'
 480                 'tid'
 481         ' FROM threads')
 482
 483 do_query(query, 'CREATE VIEW comm_threads_view AS '
 484         'SELECT '
 485                 'comm_id,'
 486                 '(SELECT comm FROM comms WHERE id = comm_id) AS command,'
 487                 'thread_id,'
 488                 '(SELECT pid FROM threads WHERE id = thread_id) AS pid,'
 489                 '(SELECT tid FROM threads WHERE id = thread_id) AS tid'
 490         ' FROM comm_threads')
 491
 492 if perf_db_export_calls or perf_db_export_callchains:
 493         do_query(query, 'CREATE VIEW call_paths_view AS '
 494                 'SELECT '
 495                         'c.id,'
 496                         'to_hex(c.ip) AS ip,'
 497                         'c.symbol_id,'
 498                         '(SELECT name FROM symbols WHERE id = c.symbol_id) AS symbol,'
 499                         '(SELECT dso_id FROM symbols WHERE id = c.symbol_id) AS dso_id,'
 500                         '(SELECT dso FROM symbols_view  WHERE id = c.symbol_id) AS dso_short_name,'
 501                         'c.parent_id,'
 502                         'to_hex(p.ip) AS parent_ip,'
 503                         'p.symbol_id AS parent_symbol_id,'
 504                         '(SELECT name FROM symbols WHERE id = p.symbol_id) AS parent_symbol,'
 505                         '(SELECT dso_id FROM symbols WHERE id = p.symbol_id) AS parent_dso_id,'
 506                         '(SELECT dso FROM symbols_view  WHERE id = p.symbol_id) AS parent_dso_short_name'
 507                 ' FROM call_paths c INNER JOIN call_paths p ON p.id = c.parent_id')
 508 if perf_db_export_calls:
 509         do_query(query, 'CREATE VIEW calls_view AS '
 510                 'SELECT '
 511                         'calls.id,'
 512                         'thread_id,'
 513                         '(SELECT pid FROM threads WHERE id = thread_id) AS pid,'
 514                         '(SELECT tid FROM threads WHERE id = thread_id) AS tid,'
 515                         '(SELECT comm FROM comms WHERE id = comm_id) AS command,'
 516                         'call_path_id,'
 517                         'to_hex(ip) AS ip,'
 518                         'symbol_id,'
 519                         '(SELECT name FROM symbols WHERE id = symbol_id) AS symbol,'
 520                         'call_time,'
 521                         'return_time,'
 522                         'return_time - call_time AS elapsed_time,'
 523                         'branch_count,'
 524                         'call_id,'
 525                         'return_id,'
 526                         'CASE WHEN flags=0 THEN \'\' WHEN flags=1 THEN \'no call\' WHEN flags=2 THEN \'no return\' WHEN flags=3 THEN \'no call/return\' WHEN flags=6 THEN \'jump\' ELSE CAST ( flags AS VARCHAR(6) ) END AS flags,'
 527                         'parent_call_path_id,'
 528                         'calls.parent_id'
 529                 ' FROM calls INNER JOIN call_paths ON call_paths.id = call_path_id')
 530
 531 do_query(query, 'CREATE VIEW samples_view AS '
 532         'SELECT '
 533                 'id,'
 534                 'time,'
 535                 'cpu,'
 536                 '(SELECT pid FROM threads WHERE id = thread_id) AS pid,'
 537                 '(SELECT tid FROM threads WHERE id = thread_id) AS tid,'
 538                 '(SELECT comm FROM comms WHERE id = comm_id) AS command,'
 539                 '(SELECT name FROM selected_events WHERE id = evsel_id) AS event,'
 540                 'to_hex(ip) AS ip_hex,'
 541                 '(SELECT name FROM symbols WHERE id = symbol_id) AS symbol,'
 542                 'sym_offset,'
 543                 '(SELECT short_name FROM dsos WHERE id = dso_id) AS dso_short_name,'
 544                 'to_hex(to_ip) AS to_ip_hex,'
 545                 '(SELECT name FROM symbols WHERE id = to_symbol_id) AS to_symbol,'
 546                 'to_sym_offset,'
 547                 '(SELECT short_name FROM dsos WHERE id = to_dso_id) AS to_dso_short_name,'
 548                 '(SELECT name FROM branch_types WHERE id = branch_type) AS branch_type_name,'
 549                 'in_tx'
 550         ' FROM samples')
 551
 552
 553 file_header = struct.pack("!11sii", b"PGCOPY\n\377\r\n\0", 0, 0)
 554 file_trailer = b"\377\377"
 555
 556 def open_output_file(file_name):
 557         path_name = output_dir_name + "/" + file_name
 558         file = open(path_name, "wb+")
 559         file.write(file_header)
 560         return file
 561
 562 def close_output_file(file):
 563         file.write(file_trailer)
 564         file.close()
 565
 566 def copy_output_file_direct(file, table_name):
 567         close_output_file(file)
 568         sql = "COPY " + table_name + " FROM '" + file.name + "' (FORMAT 'binary')"
 569         do_query(query, sql)
 570
 571 # Use COPY FROM STDIN because security may prevent postgres from accessing the files directly
 572 def copy_output_file(file, table_name):
 573         conn = PQconnectdb(toclientstr("dbname = " + dbname))
 574         if (PQstatus(conn)):
 575                 raise Exception("COPY FROM STDIN PQconnectdb failed")
 576         file.write(file_trailer)
 577         file.seek(0)
 578         sql = "COPY " + table_name + " FROM STDIN (FORMAT 'binary')"
 579         res = PQexec(conn, toclientstr(sql))
 580         if (PQresultStatus(res) != 4):
 581                 raise Exception("COPY FROM STDIN PQexec failed")
 582         data = file.read(65536)
 583         while (len(data)):
 584                 ret = PQputCopyData(conn, data, len(data))
 585                 if (ret != 1):
 586                         raise Exception("COPY FROM STDIN PQputCopyData failed, error " + str(ret))
 587                 data = file.read(65536)
 588         ret = PQputCopyEnd(conn, None)
 589         if (ret != 1):
 590                 raise Exception("COPY FROM STDIN PQputCopyEnd failed, error " + str(ret))
 591         PQfinish(conn)
 592
 593 def remove_output_file(file):
 594         name = file.name
 595         file.close()
 596         os.unlink(name)
 597
 598 evsel_file              = open_output_file("evsel_table.bin")
 599 machine_file            = open_output_file("machine_table.bin")
 600 thread_file             = open_output_file("thread_table.bin")
 601 comm_file               = open_output_file("comm_table.bin")
 602 comm_thread_file        = open_output_file("comm_thread_table.bin")
 603 dso_file                = open_output_file("dso_table.bin")
 604 symbol_file             = open_output_file("symbol_table.bin")
 605 branch_type_file        = open_output_file("branch_type_table.bin")
 606 sample_file             = open_output_file("sample_table.bin")
 607 if perf_db_export_calls or perf_db_export_callchains:
 608         call_path_file          = open_output_file("call_path_table.bin")
 609 if perf_db_export_calls:
 610         call_file               = open_output_file("call_table.bin")
 611
 612 def trace_begin():
 613         printdate("Writing to intermediate files...")
 614         # id == 0 means unknown.  It is easier to create records for them than replace the zeroes with NULLs
 615         evsel_table(0, "unknown")
 616         machine_table(0, 0, "unknown")
 617         thread_table(0, 0, 0, -1, -1)
 618         comm_table(0, "unknown")
 619         dso_table(0, 0, "unknown", "unknown", "")
 620         symbol_table(0, 0, 0, 0, 0, "unknown")
 621         sample_table(0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0)
 622         if perf_db_export_calls or perf_db_export_callchains:
 623                 call_path_table(0, 0, 0, 0)
 624                 call_return_table(0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0)
 625
 626 unhandled_count = 0
 627
 628 def trace_end():
 629         printdate("Copying to database...")
 630         copy_output_file(evsel_file,            "selected_events")
 631         copy_output_file(machine_file,          "machines")
 632         copy_output_file(thread_file,           "threads")
 633         copy_output_file(comm_file,             "comms")
 634         copy_output_file(comm_thread_file,      "comm_threads")
 635         copy_output_file(dso_file,              "dsos")
 636         copy_output_file(symbol_file,           "symbols")
 637         copy_output_file(branch_type_file,      "branch_types")
 638         copy_output_file(sample_file,           "samples")
 639         if perf_db_export_calls or perf_db_export_callchains:
 640                 copy_output_file(call_path_file,        "call_paths")
 641         if perf_db_export_calls:
 642                 copy_output_file(call_file,             "calls")
 643
 644         printdate("Removing intermediate files...")
 645         remove_output_file(evsel_file)
 646         remove_output_file(machine_file)
 647         remove_output_file(thread_file)
 648         remove_output_file(comm_file)
 649         remove_output_file(comm_thread_file)
 650         remove_output_file(dso_file)
 651         remove_output_file(symbol_file)
 652         remove_output_file(branch_type_file)
 653         remove_output_file(sample_file)
 654         if perf_db_export_calls or perf_db_export_callchains:
 655                 remove_output_file(call_path_file)
 656         if perf_db_export_calls:
 657                 remove_output_file(call_file)
 658         os.rmdir(output_dir_name)
 659         printdate("Adding primary keys")
 660         do_query(query, 'ALTER TABLE selected_events ADD PRIMARY KEY (id)')
 661         do_query(query, 'ALTER TABLE machines        ADD PRIMARY KEY (id)')
 662         do_query(query, 'ALTER TABLE threads         ADD PRIMARY KEY (id)')
 663         do_query(query, 'ALTER TABLE comms           ADD PRIMARY KEY (id)')
 664         do_query(query, 'ALTER TABLE comm_threads    ADD PRIMARY KEY (id)')
 665         do_query(query, 'ALTER TABLE dsos            ADD PRIMARY KEY (id)')
 666         do_query(query, 'ALTER TABLE symbols         ADD PRIMARY KEY (id)')
 667         do_query(query, 'ALTER TABLE branch_types    ADD PRIMARY KEY (id)')
 668         do_query(query, 'ALTER TABLE samples         ADD PRIMARY KEY (id)')
 669         if perf_db_export_calls or perf_db_export_callchains:
 670                 do_query(query, 'ALTER TABLE call_paths      ADD PRIMARY KEY (id)')
 671         if perf_db_export_calls:
 672                 do_query(query, 'ALTER TABLE calls           ADD PRIMARY KEY (id)')
 673
 674         printdate("Adding foreign keys")
 675         do_query(query, 'ALTER TABLE threads '
 676                                         'ADD CONSTRAINT machinefk  FOREIGN KEY (machine_id)   REFERENCES machines   (id),'
 677                                         'ADD CONSTRAINT processfk  FOREIGN KEY (process_id)   REFERENCES threads    (id)')
 678         do_query(query, 'ALTER TABLE comm_threads '
 679                                         'ADD CONSTRAINT commfk     FOREIGN KEY (comm_id)      REFERENCES comms      (id),'
 680                                         'ADD CONSTRAINT threadfk   FOREIGN KEY (thread_id)    REFERENCES threads    (id)')
 681         do_query(query, 'ALTER TABLE dsos '
 682                                         'ADD CONSTRAINT machinefk  FOREIGN KEY (machine_id)   REFERENCES machines   (id)')
 683         do_query(query, 'ALTER TABLE symbols '
 684                                         'ADD CONSTRAINT dsofk      FOREIGN KEY (dso_id)       REFERENCES dsos       (id)')
 685         do_query(query, 'ALTER TABLE samples '
 686                                         'ADD CONSTRAINT evselfk    FOREIGN KEY (evsel_id)     REFERENCES selected_events (id),'
 687                                         'ADD CONSTRAINT machinefk  FOREIGN KEY (machine_id)   REFERENCES machines   (id),'
 688                                         'ADD CONSTRAINT threadfk   FOREIGN KEY (thread_id)    REFERENCES threads    (id),'
 689                                         'ADD CONSTRAINT commfk     FOREIGN KEY (comm_id)      REFERENCES comms      (id),'
 690                                         'ADD CONSTRAINT dsofk      FOREIGN KEY (dso_id)       REFERENCES dsos       (id),'
 691                                         'ADD CONSTRAINT symbolfk   FOREIGN KEY (symbol_id)    REFERENCES symbols    (id),'
 692                                         'ADD CONSTRAINT todsofk    FOREIGN KEY (to_dso_id)    REFERENCES dsos       (id),'
 693                                         'ADD CONSTRAINT tosymbolfk FOREIGN KEY (to_symbol_id) REFERENCES symbols    (id)')
 694         if perf_db_export_calls or perf_db_export_callchains:
 695                 do_query(query, 'ALTER TABLE call_paths '
 696                                         'ADD CONSTRAINT parentfk    FOREIGN KEY (parent_id)    REFERENCES call_paths (id),'
 697                                         'ADD CONSTRAINT symbolfk    FOREIGN KEY (symbol_id)    REFERENCES symbols    (id)')
 698         if perf_db_export_calls:
 699                 do_query(query, 'ALTER TABLE calls '
 700                                         'ADD CONSTRAINT threadfk    FOREIGN KEY (thread_id)    REFERENCES threads    (id),'
 701                                         'ADD CONSTRAINT commfk      FOREIGN KEY (comm_id)      REFERENCES comms      (id),'
 702                                         'ADD CONSTRAINT call_pathfk FOREIGN KEY (call_path_id) REFERENCES call_paths (id),'
 703                                         'ADD CONSTRAINT callfk      FOREIGN KEY (call_id)      REFERENCES samples    (id),'
 704                                         'ADD CONSTRAINT returnfk    FOREIGN KEY (return_id)    REFERENCES samples    (id),'
 705                                         'ADD CONSTRAINT parent_call_pathfk FOREIGN KEY (parent_call_path_id) REFERENCES call_paths (id)')
 706                 do_query(query, 'CREATE INDEX pcpid_idx ON calls (parent_call_path_id)')
 707                 do_query(query, 'CREATE INDEX pid_idx ON calls (parent_id)')
 708
 709         if (unhandled_count):
 710                 printdate("Warning: ", unhandled_count, " unhandled events")
 711         printdate("Done")
 712
 713 def trace_unhandled(event_name, context, event_fields_dict):
 714         global unhandled_count
 715         unhandled_count += 1
 716
 717 def sched__sched_switch(*x):
 718         pass
 719
 720 def evsel_table(evsel_id, evsel_name, *x):
 721         evsel_name = toserverstr(evsel_name)
 722         n = len(evsel_name)
 723         fmt = "!hiqi" + str(n) + "s"
 724         value = struct.pack(fmt, 2, 8, evsel_id, n, evsel_name)
 725         evsel_file.write(value)
 726
 727 def machine_table(machine_id, pid, root_dir, *x):
 728         root_dir = toserverstr(root_dir)
 729         n = len(root_dir)
 730         fmt = "!hiqiii" + str(n) + "s"
 731         value = struct.pack(fmt, 3, 8, machine_id, 4, pid, n, root_dir)
 732         machine_file.write(value)
 733
 734 def thread_table(thread_id, machine_id, process_id, pid, tid, *x):
 735         value = struct.pack("!hiqiqiqiiii", 5, 8, thread_id, 8, machine_id, 8, process_id, 4, pid, 4, tid)
 736         thread_file.write(value)
 737
 738 def comm_table(comm_id, comm_str, *x):
 739         comm_str = toserverstr(comm_str)
 740         n = len(comm_str)
 741         fmt = "!hiqi" + str(n) + "s"
 742         value = struct.pack(fmt, 2, 8, comm_id, n, comm_str)
 743         comm_file.write(value)
 744
 745 def comm_thread_table(comm_thread_id, comm_id, thread_id, *x):
 746         fmt = "!hiqiqiq"
 747         value = struct.pack(fmt, 3, 8, comm_thread_id, 8, comm_id, 8, thread_id)
 748         comm_thread_file.write(value)
 749
 750 def dso_table(dso_id, machine_id, short_name, long_name, build_id, *x):
 751         short_name = toserverstr(short_name)
 752         long_name = toserverstr(long_name)
 753         build_id = toserverstr(build_id)
 754         n1 = len(short_name)
 755         n2 = len(long_name)
 756         n3 = len(build_id)
 757         fmt = "!hiqiqi" + str(n1) + "si"  + str(n2) + "si" + str(n3) + "s"
 758         value = struct.pack(fmt, 5, 8, dso_id, 8, machine_id, n1, short_name, n2, long_name, n3, build_id)
 759         dso_file.write(value)
 760
 761 def symbol_table(symbol_id, dso_id, sym_start, sym_end, binding, symbol_name, *x):
 762         symbol_name = toserverstr(symbol_name)
 763         n = len(symbol_name)
 764         fmt = "!hiqiqiqiqiii" + str(n) + "s"
 765         value = struct.pack(fmt, 6, 8, symbol_id, 8, dso_id, 8, sym_start, 8, sym_end, 4, binding, n, symbol_name)
 766         symbol_file.write(value)
 767
 768 def branch_type_table(branch_type, name, *x):
 769         name = toserverstr(name)
 770         n = len(name)
 771         fmt = "!hiii" + str(n) + "s"
 772         value = struct.pack(fmt, 2, 4, branch_type, n, name)
 773         branch_type_file.write(value)
 774
 775 def sample_table(sample_id, evsel_id, machine_id, thread_id, comm_id, dso_id, symbol_id, sym_offset, ip, time, cpu, to_dso_id, to_symbol_id, to_sym_offset, to_ip, period, weight, transaction, data_src, branch_type, in_tx, call_path_id, *x):
 776         if branches:
 777                 value = struct.pack("!hiqiqiqiqiqiqiqiqiqiqiiiqiqiqiqiiiBiq", 18, 8, sample_id, 8, evsel_id, 8, machine_id, 8, thread_id, 8, comm_id, 8, dso_id, 8, symbol_id, 8, sym_offset, 8, ip, 8, time, 4, cpu, 8, to_dso_id, 8, to_symbol_id, 8, to_sym_offset, 8, to_ip, 4, branch_type, 1, in_tx, 8, call_path_id)
 778         else:
 779                 value = struct.pack("!hiqiqiqiqiqiqiqiqiqiqiiiqiqiqiqiqiqiqiqiiiBiq", 22, 8, sample_id, 8, evsel_id, 8, machine_id, 8, thread_id, 8, comm_id, 8, dso_id, 8, symbol_id, 8, sym_offset, 8, ip, 8, time, 4, cpu, 8, to_dso_id, 8, to_symbol_id, 8, to_sym_offset, 8, to_ip, 8, period, 8, weight, 8, transaction, 8, data_src, 4, branch_type, 1, in_tx, 8, call_path_id)
 780         sample_file.write(value)
 781
 782 def call_path_table(cp_id, parent_id, symbol_id, ip, *x):
 783         fmt = "!hiqiqiqiq"
 784         value = struct.pack(fmt, 4, 8, cp_id, 8, parent_id, 8, symbol_id, 8, ip)
 785         call_path_file.write(value)
 786
 787 def call_return_table(cr_id, thread_id, comm_id, call_path_id, call_time, return_time, branch_count, call_id, return_id, parent_call_path_id, flags, parent_id, *x):
 788         fmt = "!hiqiqiqiqiqiqiqiqiqiqiiiq"
 789         value = struct.pack(fmt, 12, 8, cr_id, 8, thread_id, 8, comm_id, 8, call_path_id, 8, call_time, 8, return_time, 8, branch_count, 8, call_id, 8, return_id, 8, parent_call_path_id, 4, flags, 8, parent_id)
 790         call_file.write(value)