iotop/taskstats.cpp

   1 // Copyright (C) 2015 The Android Open Source Project
   2 //
   3 // Licensed under the Apache License, Version 2.0 (the "License");
   4 // you may not use this file except in compliance with the License.
   5 // You may obtain a copy of the License at
   6 //
   7 //      http://www.apache.org/licenses/LICENSE-2.0
   8 //
   9 // Unless required by applicable law or agreed to in writing, software
  10 // distributed under the License is distributed on an "AS IS" BASIS,
  11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 // See the License for the specific language governing permissions and
  13 // limitations under the License.
  14
  15 #include <linux/taskstats.h>
  16 #include <netlink/socket.h>
  17 #include <netlink/genl/ctrl.h>
  18 #include <netlink/genl/genl.h>
  19
  20 #include <algorithm>
  21 #include <memory>
  22
  23 #include <base/logging.h>
  24
  25 #include "taskstats.h"
  26
  27 TaskstatsSocket::TaskstatsSocket()
  28     : nl_(nullptr, nl_socket_free), family_id_(0) {
  29 }
  30
  31 bool TaskstatsSocket::Open() {
  32   std::unique_ptr<nl_sock, decltype(&nl_socket_free)> nl(
  33       nl_socket_alloc(), nl_socket_free);
  34   if (!nl.get()) {
  35     LOG(FATAL) << "Failed to allocate netlink socket";
  36   }
  37
  38   int ret = genl_connect(nl.get());
  39   if (ret < 0) {
  40     LOG(FATAL) << nl_geterror(ret) << std::endl << "Unable to open netlink socket (are you root?)";
  41   }
  42
  43   int family_id = genl_ctrl_resolve(nl.get(), TASKSTATS_GENL_NAME);
  44   if (family_id < 0) {
  45     LOG(FATAL) << nl_geterror(family_id) << std::endl << "Unable to determine taskstats family id (does your kernel support taskstats?)";
  46   }
  47
  48   nl_ = std::move(nl);
  49   family_id_ = family_id;
  50
  51   return true;
  52 }
  53
  54 void TaskstatsSocket::Close() {
  55   nl_.reset();
  56 }
  57
  58 struct TaskStatsRequest {
  59   pid_t requested_pid;
  60   taskstats stats;
  61 };
  62
  63 static pid_t ParseAggregateTaskStats(nlattr* attr, int attr_size,
  64                                      taskstats* stats) {
  65   pid_t received_pid = -1;
  66   nla_for_each_attr(attr, attr, attr_size, attr_size) {
  67     switch (nla_type(attr)) {
  68     case TASKSTATS_TYPE_PID:
  69     case TASKSTATS_TYPE_TGID:
  70       received_pid = nla_get_u32(attr);
  71       break;
  72     case TASKSTATS_TYPE_STATS:
  73     {
  74       int len = static_cast<int>(sizeof(*stats));
  75       len = std::min(len, nla_len(attr));
  76       nla_memcpy(stats, attr, len);
  77       return received_pid;
  78     }
  79     default:
  80       LOG(ERROR) << "unexpected attribute inside AGGR";
  81       return -1;
  82     }
  83   }
  84
  85   return -1;
  86 }
  87
  88 static int ParseTaskStats(nl_msg* msg, void* arg) {
  89   TaskStatsRequest* taskstats_request = static_cast<TaskStatsRequest*>(arg);
  90   genlmsghdr* gnlh = static_cast<genlmsghdr*>(nlmsg_data(nlmsg_hdr(msg)));
  91   nlattr* attr = genlmsg_attrdata(gnlh, 0);
  92
  93   switch (nla_type(attr)) {
  94   case TASKSTATS_TYPE_AGGR_PID:
  95   case TASKSTATS_TYPE_AGGR_TGID:
  96     nlattr* nested_attr = static_cast<nlattr*>(nla_data(attr));
  97     taskstats stats;
  98     pid_t ret;
  99
 100     ret = ParseAggregateTaskStats(nested_attr, nla_len(attr), &stats);
 101     if (ret < 0) {
 102       LOG(ERROR) << "Bad AGGR_PID contents";
 103     } else if (ret == taskstats_request->requested_pid) {
 104       taskstats_request->stats = stats;
 105     } else {
 106       LOG(WARNING) << "got taskstats for unexpected pid " << ret <<
 107           " (expected " << taskstats_request->requested_pid << ", continuing...";
 108     }
 109   }
 110   return NL_OK;
 111 }
 112
 113 bool TaskstatsSocket::GetStats(int pid, int type, TaskStatistics& stats) {
 114   TaskStatsRequest taskstats_request = TaskStatsRequest();
 115   taskstats_request.requested_pid = pid;
 116
 117   std::unique_ptr<nl_msg, decltype(&nlmsg_free)> message(nlmsg_alloc(),
 118                                                          nlmsg_free);
 119
 120   genlmsg_put(message.get(), NL_AUTO_PID, NL_AUTO_SEQ, family_id_, 0, 0,
 121               TASKSTATS_CMD_GET, TASKSTATS_VERSION);
 122   nla_put_u32(message.get(), type, pid);
 123
 124   int result = nl_send_auto_complete(nl_.get(), message.get());
 125   if (result < 0) {
 126     return false;
 127   }
 128
 129   std::unique_ptr<nl_cb, decltype(&nl_cb_put)> callbacks(
 130       nl_cb_alloc(NL_CB_DEFAULT), nl_cb_put);
 131   nl_cb_set(callbacks.get(), NL_CB_VALID, NL_CB_CUSTOM, &ParseTaskStats,
 132             static_cast<void*>(&taskstats_request));
 133
 134   result = nl_recvmsgs(nl_.get(), callbacks.get());
 135   if (result < 0) {
 136     return false;
 137   }
 138   nl_wait_for_ack(nl_.get());
 139
 140   stats = TaskStatistics(taskstats_request.stats);
 141
 142   return true;
 143 }
 144
 145 bool TaskstatsSocket::GetPidStats(int pid, TaskStatistics& stats) {
 146   return GetStats(pid, TASKSTATS_CMD_ATTR_PID, stats);
 147 }
 148
 149 bool TaskstatsSocket::GetTgidStats(int tgid, TaskStatistics& stats) {
 150   bool ret = GetStats(tgid, TASKSTATS_CMD_ATTR_TGID, stats);
 151   if (ret) {
 152     stats.set_pid(tgid);
 153   }
 154   return ret;
 155 }
 156
 157 TaskStatistics::TaskStatistics(const taskstats& taskstats_stats) {
 158   comm_ = std::string(taskstats_stats.ac_comm);
 159   pid_ = taskstats_stats.ac_pid;
 160
 161   uid_ = taskstats_stats.ac_uid;
 162   gid_ = taskstats_stats.ac_gid;
 163   pid_ = taskstats_stats.ac_pid;
 164   ppid_ = taskstats_stats.ac_ppid;
 165
 166   cpu_delay_count_ = taskstats_stats.cpu_count;
 167   cpu_delay_ns_ = taskstats_stats.cpu_delay_total;
 168
 169   block_io_delay_count_ = taskstats_stats.blkio_count;
 170   block_io_delay_ns_ = taskstats_stats.blkio_delay_total;
 171
 172   swap_in_delay_count_ = taskstats_stats.swapin_count;
 173   swap_in_delay_ns_ = taskstats_stats.swapin_delay_total;
 174
 175   reclaim_delay_count_ = taskstats_stats.freepages_count;
 176   reclaim_delay_ns_ = taskstats_stats.freepages_delay_total;
 177
 178   total_delay_ns_ =
 179       cpu_delay_ns_ + block_io_delay_ns_ + swap_in_delay_ns_ + reclaim_delay_ns_;
 180
 181   cpu_time_real_ = taskstats_stats.cpu_run_real_total;
 182   cpu_time_virtual_ = taskstats_stats.cpu_run_virtual_total;
 183
 184   read_bytes_ = taskstats_stats.read_bytes;
 185   write_bytes_ = taskstats_stats.write_bytes;
 186   read_write_bytes_ = read_bytes_ + write_bytes_;
 187   cancelled_write_bytes_ = taskstats_stats.cancelled_write_bytes;
 188   threads_ = 1;
 189 }
 190
 191 void TaskStatistics::AddPidToTgid(const TaskStatistics& pid_statistics) {
 192   // tgid statistics already contain delay values totalled across all pids
 193   // only add IO statistics
 194   read_bytes_            += pid_statistics.read_bytes_;
 195   write_bytes_           += pid_statistics.write_bytes_;
 196   read_write_bytes_      += pid_statistics.read_write_bytes_;
 197   cancelled_write_bytes_ += pid_statistics.cancelled_write_bytes_;
 198   if (pid_ == pid_statistics.pid_) {
 199     comm_ = pid_statistics.comm_;
 200     uid_ = pid_statistics.uid_;
 201     gid_ = pid_statistics.pid_;
 202     ppid_ = pid_statistics.ppid_;
 203   } else {
 204     threads_++;
 205   }
 206 }
 207
 208 // Store new statistics and return the delta from the old statistics
 209 TaskStatistics TaskStatistics::Update(const TaskStatistics& new_statistics) {
 210   TaskStatistics delta = new_statistics;
 211   delta.cpu_delay_count_       -= cpu_delay_count_;
 212   delta.cpu_delay_ns_          -= cpu_delay_ns_;
 213   delta.block_io_delay_count_  -= block_io_delay_count_;
 214   delta.block_io_delay_ns_     -= block_io_delay_ns_;
 215   delta.swap_in_delay_count_   -= swap_in_delay_count_;
 216   delta.swap_in_delay_ns_      -= swap_in_delay_ns_;
 217   delta.reclaim_delay_count_   -= reclaim_delay_count_;
 218   delta.reclaim_delay_ns_      -= reclaim_delay_ns_;
 219   delta.total_delay_ns_        -= total_delay_ns_;
 220   delta.cpu_time_real_         -= cpu_time_real_;
 221   delta.cpu_time_virtual_      -= cpu_time_virtual_;
 222   delta.read_bytes_            -= read_bytes_;
 223   delta.write_bytes_           -= write_bytes_;
 224   delta.read_write_bytes_      -= read_write_bytes_;
 225   delta.cancelled_write_bytes_ -= cancelled_write_bytes_;
 226   *this = new_statistics;
 227   return delta;
 228 }